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

Prefer amplify errors in generators #2035

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Prefer amplify errors in generators #2035

merged 1 commit into from
Sep 20, 2024

Conversation

sobolk
Copy link
Member

@sobolk sobolk commented Sep 20, 2024

Changes

This PR revises expectations about errors for X-generator packages to prefer Amplify Errors.

Reasons:

  1. We already use Amplify Errors in them. Changing that would be a break.
  2. Translating errors in CLI would leak implementation details. This is unwanted.
  3. In order to surface necessary information each of them would need to use error system similar to Amplify Errors.
  4. Amplify Errors are part if platform-types. I.e. usable not only in "cli-ish" packages.

Out of scope

I fixed only one violation which was simple and left rest for the future. The priority is to establish these rules.

Validation

PR checks.

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.

@sobolk sobolk requested a review from a team as a code owner September 20, 2024 20:09
Copy link

changeset-bot bot commented Sep 20, 2024

🦋 Changeset detected

Latest commit: 8414a85

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

This PR includes changesets to release 3 packages
Name Type
@aws-amplify/schema-generator Patch
@aws-amplify/model-generator Patch
@aws-amplify/form-generator 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

@sobolk sobolk merged commit e325044 into main Sep 20, 2024
38 checks passed
@sobolk sobolk deleted the error-rules-revision branch September 20, 2024 20:31
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.

3 participants