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

feat: Add option to for dependency validator to allow list dependencies that can violate consistency check #1920

Merged
merged 20 commits into from
Aug 30, 2024

Conversation

ShadowCat567
Copy link
Contributor

@ShadowCat567 ShadowCat567 commented Aug 26, 2024

Problem

Issue number, if available:
#966

Changes

  • Added new parameter to DependenciesValidator that tracks the dependencies that are known to violate the consistency check
  • Renamed the parameter dependenciesRule to disallowedDependenies for better clarity
  • updated the function getPackageVersionDeclarationPredicate() so it is able to use the new parameter in DependenciesValidator to handle dependencies that are known to be inconsistent
  • updated test coverage to reflect changes (see Validation for description of added tests)
  • updated existing tests to accommodate additional parameter in DependenciesValidator

Corresponding docs PR, if applicable:
N/A

Validation

Added tests for instances where:

  • multiple packages rely on different versions of the same dependency
  • multiple dependencies are known to have inconsistent versions
  • differentiation between known and unknown inconsistent dependencies

All tests successful

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.

Copy link

changeset-bot bot commented Aug 26, 2024

⚠️ No Changeset found

Latest commit: 9a0f60b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Member

@sobolk sobolk left a comment

Choose a reason for hiding this comment

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

This is looking good.
I left two suggestions.
And we should add at least one test or add to one of existing tests to cover this new aspect.

scripts/components/dependencies_validator.ts Outdated Show resolved Hide resolved
scripts/components/dependencies_validator.ts Outdated Show resolved Hide resolved
sobolk
sobolk previously approved these changes Aug 29, 2024
@ShadowCat567 ShadowCat567 marked this pull request as ready for review August 29, 2024 19:47
@ShadowCat567 ShadowCat567 requested review from a team as code owners August 29, 2024 19:47
@sobolk sobolk changed the title [wip] feat: Add option to for dependency validator to allow list dependencies that can violate consistency check feat: Add option to for dependency validator to allow list dependencies that can violate consistency check Aug 29, 2024
@ShadowCat567 ShadowCat567 merged commit 5f48700 into aws-amplify:main Aug 30, 2024
37 checks passed
@ShadowCat567 ShadowCat567 deleted the Dependency-validator branch August 30, 2024 19:25
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