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

scripts/check_dependencies.ts

@@ -21,5 +21,17 @@ await new DependenciesValidator(
       ],
     },
   },
-  [['aws-cdk', 'aws-cdk-lib']]
+  [['aws-cdk', 'aws-cdk-lib']],
+  [
+    {
+      dependencyName: 'execa',
+      globalDependencyVersion: '^8.0.1',
+      exceptions: [
+        {
+          packageName: '@aws-amplify/plugin-types',
+          dependencyVersion: '^5.1.1',
+        },
+      ],
+    },
+  ]
 ).validate();

scripts/components/dependencies_validator.test.ts

@@ -41,6 +41,7 @@ void describe('Dependency validator', () => {
             },
           },
           [],
+          [],
           execaMock as never
         ).validate(),
       (err: Error) => {
@@ -65,6 +66,7 @@ void describe('Dependency validator', () => {
             },
           },
           [],
+          [],
           execaMock as never
         ).validate(),
       (err: Error) => {
@@ -88,6 +90,7 @@ void describe('Dependency validator', () => {
         },
       },
       [],
+      [],
       execaMock as never
     ).validate();
   });
@@ -106,6 +109,7 @@ void describe('Dependency validator', () => {
             },
           },
           [],
+          [],
           execaMock as never
         ).validate(),
       (err: Error) => {
@@ -129,6 +133,7 @@ void describe('Dependency validator', () => {
           packagePaths,
           {},
           [],
+          [],
           execaMock as never
         ).validate();
       },
@@ -156,6 +161,7 @@ void describe('Dependency validator', () => {
       packagePaths,
       {},
       [],
+      [],
       execaMock as never
     );
 
@@ -185,6 +191,7 @@ void describe('Dependency validator', () => {
           packagePaths,
           {},
           [['aws-cdk', 'aws-cdk-lib']],
+          [],
           execaMock as never
         ).validate();
       },

scripts/components/dependencies_validator.ts

@@ -12,6 +12,12 @@ export type DependencyRule =
       allowList: Array<string>;
     };
 
+export type DependencyWithKnownException = {
+  dependencyName: string;
+  globalDependencyVersion: string;
+  exceptions: Array<{ packageName: string; dependencyVersion: string }>;
+};
+
 type NpmListOutputItem = {
   name?: string;
   dependencies?: Record<string, NpmListOutputItem>;
@@ -47,14 +53,16 @@ export class DependenciesValidator {
   /**
    * Creates dependency validator
    * @param packagePaths paths of packages to validate
-   * @param dependencyRules dependency exclusion and inclusion rules
+   * @param disallowedDependencies dependency exclusion and inclusion rules
    * @param linkedDependencies dependencies that should be versioned with the same version
+   * @param knownInconsistentDependencies dependencies that are known to violate the consistency check
    * @param execa in order to inject execa mock in tests
    */
   constructor(
     private packagePaths: Array<string>,
-    private dependencyRules: Record<string, DependencyRule>,
+    private disallowedDependencies: Record<string, DependencyRule>,
     private linkedDependencies: Array<Array<string>>,
+    private knownInconsistentDependencies: Array<DependencyWithKnownException>,
     private execa = _execa
   ) {}
 
@@ -202,9 +210,9 @@ export class DependenciesValidator {
         // skip if self referencing
         continue;
       }
-      if (dependencyName in this.dependencyRules) {
+      if (dependencyName in this.disallowedDependencies) {
         const dependencyRule: DependencyRule =
-          this.dependencyRules[dependencyName];
+          this.disallowedDependencies[dependencyName];
         const isViolating =
           dependencyRule.denyAll ||
           !dependencyRule.allowList.includes(packageName);
@@ -243,20 +251,34 @@ export class DependenciesValidator {
   private getPackageVersionDeclarationPredicate = async (
     packageName: string
   ): Promise<DependencyVersionPredicate> => {
-    if (packageName === 'execa') {
+    if (
+      this.knownInconsistentDependencies.find(
+        (a) => a.dependencyName === packageName
+      ) !== undefined
+    ) {
       // @aws-amplify/plugin-types can depend on execa@^5.1.1 as a workaround for https://github.com/aws-amplify/amplify-backend/issues/962
       // all other packages must depend on execa@^8.0.1
       // this can be removed once execa is patched
+      const inconsistentDependency = this.knownInconsistentDependencies.find(
+        (x) => x.dependencyName === packageName
+      );
       return (declarations) => {
         const validationResult = declarations.every(
           ({ dependentPackageName, version }) =>
-            (dependentPackageName === '@aws-amplify/plugin-types' &&
-              version === '^5.1.1') ||
-            version === '^8.0.1'
+            inconsistentDependency!.exceptions.find(
+              (a) => a.packageName === dependentPackageName
+            )?.dependencyVersion ||
+            version === inconsistentDependency!.globalDependencyVersion
         );
         return (
           validationResult ||
-          `${packageName} dependency declarations must depend on version ^8.0.1 except in @aws-amplify/plugin-types where it must depend on ^5.1.1.`
+          `${packageName} dependency declarations must depend on version ${
+            inconsistentDependency!.globalDependencyVersion
+          } except in the following packages` +
+            inconsistentDependency!.exceptions.forEach(
+              (exception) =>
+                `, ${exception.packageName} where it must depend on ${exception.dependencyVersion}`
+            )
         );
       };
     } else if ((await this.getRepoPackageNames()).includes(packageName)) {