Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add cdk error mapping for error 'command cdk not found' #2294

Merged
merged 2 commits into from
Dec 4, 2024

Conversation

Amplifiyer
Copy link
Contributor

Problem

Sometimes yarn customers are running into this issue during sandbox run. I'm able to reproduce this by having sandbox running with yarn and deleting node_modules (or perhaps a custom clean script) and making a file change in the backend.

Changes

Add error mapping to let customers know to install their dependencies again.

Validation

Checklist

  • If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
  • If this PR requires a change to the Project Architecture README, I have included that update in this PR.
  • If this PR requires a docs update, I have linked to that docs PR above.
  • If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@Amplifiyer Amplifiyer requested a review from a team as a code owner December 4, 2024 17:38
Copy link

changeset-bot bot commented Dec 4, 2024

🦋 Changeset detected

Latest commit: 0951101

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@aws-amplify/backend-deployer Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

errorRegex: /Command cdk not found/,
humanReadableErrorMessage: 'Unable to detect cdk installation',
resolutionMessage:
"Install the dependencies in your project by running 'yarn install' or 'npm install'",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Install the dependencies in your project by running 'yarn install' or 'npm install'",
"Make sure that dependencies in your project are installed with your package manager.",

or "Make sure that dependencies in your project are installed with your package manager. For example, by running 'yarn install' or 'npm install'",

We also support pnpm. The message should be formed in such a way that customer is encouraged to try their desired package manager. Otherwise some will just run these commands blindly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@Amplifiyer Amplifiyer merged commit daaedb6 into main Dec 4, 2024
40 checks passed
@Amplifiyer Amplifiyer deleted the cdk_error branch December 4, 2024 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants