build: implement dependency version consistency check (#892)

Kamil Sobol · web-flow · commit 04f06783784b · 2024-01-09T12:29:58.000-08:00
* build: implement dependency version consistency check

* fix build
diff --git a/.changeset/eight-suits-nail.md b/.changeset/eight-suits-nail.md
@@ -0,0 +1,21 @@
+---
+'@aws-amplify/deployed-backend-client': patch
+'@aws-amplify/backend-output-schemas': patch
+'@aws-amplify/integration-tests': patch
+'@aws-amplify/backend-deployer': patch
+'@aws-amplify/backend-function': patch
+'@aws-amplify/model-generator': patch
+'@aws-amplify/auth-construct-alpha': patch
+'@aws-amplify/backend-secret': patch
+'create-amplify': patch
+'@aws-amplify/form-generator': patch
+'@aws-amplify/client-config': patch
+'@aws-amplify/platform-core': patch
+'@aws-amplify/backend-auth': patch
+'@aws-amplify/backend-data': patch
+'@aws-amplify/backend': patch
+'@aws-amplify/sandbox': patch
+'@aws-amplify/backend-cli': patch
+---
+
+Implement consistent dependency declaration check. Bumped dependencies where necessary.
diff --git a/.eslint_dictionary.json b/.eslint_dictionary.json
@@ -58,6 +58,7 @@
   "invoker",
   "javascript",
   "jsdoc",
+  "jsons",
   "keyof",
   "lang",
   "linux",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -53,10 +53,10 @@
   },
   "homepage": "https://github.com/aws-amplify/amplify-backend#readme",
   "devDependencies": {
-    "@aws-sdk/client-amplify": "^3.440.0",
-    "@aws-sdk/client-cloudformation": "^3.421.0",
-    "@aws-sdk/client-cognito-identity-provider": "^3.421.0",
-    "@aws-sdk/client-s3": "^3.421.0",
+    "@aws-sdk/client-amplify": "^3.465.0",
+    "@aws-sdk/client-cloudformation": "^3.465.0",
+    "@aws-sdk/client-cognito-identity-provider": "^3.465.0",
+    "@aws-sdk/client-s3": "^3.465.0",
     "@changesets/cli": "^2.26.1",
     "@microsoft/api-extractor": "^7.34.4",
     "@shopify/eslint-plugin": "^43.0.0",
@@ -76,7 +76,7 @@
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-spellcheck": "^0.0.20",
     "eslint-plugin-unicorn": "^46.0.0",
-    "execa": "^7.1.1",
+    "execa": "^8.0.1",
     "fs-extra": "^11.1.1",
     "glob": "^10.1.0",
     "husky": "^8.0.3",
diff --git a/packages/auth-construct/package.json b/packages/auth-construct/package.json
@@ -19,7 +19,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-amplify/backend-output-schemas": "^0.5.0",
-    "@aws-amplify/backend-output-storage": "^0.2.7",
+    "@aws-amplify/backend-output-storage": "^0.2.8",
     "@aws-amplify/plugin-types": "^0.7.0",
     "@aws-sdk/util-arn-parser": "^3.465.0"
   },
diff --git a/packages/backend-auth/package.json b/packages/backend-auth/package.json
@@ -19,7 +19,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-amplify/auth-construct-alpha": "^0.5.0",
-    "@aws-amplify/backend-output-storage": "0.2.8",
+    "@aws-amplify/backend-output-storage": "^0.2.8",
     "@aws-amplify/plugin-types": "^0.7.0"
   },
   "devDependencies": {
diff --git a/packages/backend-data/package.json b/packages/backend-data/package.json
@@ -27,7 +27,7 @@
     "constructs": "^10.0.0"
   },
   "dependencies": {
-    "@aws-amplify/backend-output-storage": "0.2.8",
+    "@aws-amplify/backend-output-storage": "^0.2.8",
     "@aws-amplify/backend-output-schemas": "^0.5.0",
     "@aws-amplify/data-construct": "^1.4.1",
     "@aws-amplify/plugin-types": "^0.7.0",
diff --git a/packages/backend-deployer/package.json b/packages/backend-deployer/package.json
@@ -20,7 +20,7 @@
   "dependencies": {
     "@aws-amplify/platform-core": "^0.4.0",
     "@aws-amplify/plugin-types": "^0.7.0",
-    "execa": "^7.2.0",
+    "execa": "^8.0.1",
     "tsx": "^4.6.1"
   },
   "peerDependencies": {
diff --git a/packages/backend-function/package.json b/packages/backend-function/package.json
@@ -18,14 +18,14 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-amplify/backend-output-storage": "0.2.8",
+    "@aws-amplify/backend-output-storage": "^0.2.8",
     "@aws-amplify/plugin-types": "^0.7.0",
-    "execa": "^7.1.1"
+    "execa": "^8.0.1"
   },
   "devDependencies": {
     "@aws-amplify/backend-platform-test-stubs": "^0.3.1",
     "@aws-amplify/platform-core": "^0.4.0",
-    "@aws-sdk/client-ssm": "^3.398.0",
+    "@aws-sdk/client-ssm": "^3.465.0",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
diff --git a/packages/backend-output-schemas/package.json b/packages/backend-output-schemas/package.json
@@ -19,9 +19,9 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@aws-amplify/plugin-types": "0.7.0"
+    "@aws-amplify/plugin-types": "^0.7.0"
   },
   "peerDependencies": {
-    "zod": "^3.21.4"
+    "zod": "^3.22.2"
   }
 }
diff --git a/packages/backend-secret/package.json b/packages/backend-secret/package.json
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-amplify/plugin-types": "^0.7.0",
     "@aws-amplify/platform-core": "^0.4.0",
-    "@aws-sdk/client-ssm": "^3.398.0"
+    "@aws-sdk/client-ssm": "^3.465.0"
   },
   "devDependencies": {
-    "@aws-sdk/types": "^3.370.0"
+    "@aws-sdk/types": "^3.465.0"
   }
 }
diff --git a/packages/backend/package.json b/packages/backend/package.json
@@ -31,7 +31,7 @@
     "@aws-amplify/backend-storage": "^0.4.1",
     "@aws-amplify/platform-core": "^0.4.0",
     "@aws-amplify/plugin-types": "^0.7.0",
-    "@aws-sdk/client-amplify": "^3.440.0"
+    "@aws-sdk/client-amplify": "^3.465.0"
   },
   "peerDependencies": {
     "aws-cdk-lib": "^2.110.1",
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -38,19 +38,19 @@
     "@aws-amplify/model-generator": "^0.2.4",
     "@aws-amplify/platform-core": "^0.4.0",
     "@aws-amplify/sandbox": "^0.3.11",
-    "@aws-sdk/credential-provider-ini": "^3.360.0",
-    "@aws-sdk/credential-providers": "^3.360.0",
-    "@aws-sdk/region-config-resolver": "^3.433.0",
+    "@aws-sdk/credential-provider-ini": "^3.465.0",
+    "@aws-sdk/credential-providers": "^3.465.0",
+    "@aws-sdk/region-config-resolver": "^3.465.0",
     "@smithy/node-config-provider": "^2.1.3",
-    "@smithy/shared-ini-file-loader": "^2.2.2",
-    "execa": "^7.2.0",
+    "@smithy/shared-ini-file-loader": "^2.2.5",
+    "execa": "^8.0.1",
     "is-ci": "^3.0.1",
-    "open": "^8.4.0",
+    "open": "^9.1.0",
     "yargs": "^17.7.2",
-    "zod": "^3.21.4"
+    "zod": "^3.22.2"
   },
   "peerDependencies": {
-    "@aws-sdk/types": "^3.347.0"
+    "@aws-sdk/types": "^3.465.0"
   },
   "devDependencies": {
     "@types/yargs": "^17.0.24"
diff --git a/packages/cli/src/commands/open/open.ts b/packages/cli/src/commands/open/open.ts
@@ -1,4 +1,4 @@
-import opn from 'open';
+import opn, { Options } from 'open';
 import { ChildProcess } from 'child_process';
 import { Printer } from '@aws-amplify/cli-core';
 
@@ -8,7 +8,7 @@ import { Printer } from '@aws-amplify/cli-core';
 export class Open {
   static open = async (
     target: string,
-    options: opn.Options
+    options: Options
   ): Promise<ChildProcess | void> => {
     let childProcess: ChildProcess;
     try {
diff --git a/packages/client-config/package.json b/packages/client-config/package.json
@@ -26,14 +26,14 @@
     "@aws-amplify/backend-output-schemas": "^0.5.0",
     "@aws-amplify/deployed-backend-client": "^0.3.6",
     "@aws-amplify/model-generator": "^0.2.4",
-    "@aws-sdk/client-amplify": "^3.376.0",
-    "@aws-sdk/client-cloudformation": "^3.376.0",
-    "@aws-sdk/client-ssm": "^3.398.0",
-    "@aws-sdk/credential-providers": "^3.370.0",
-    "zod": "^3.21.4"
+    "@aws-sdk/client-amplify": "^3.465.0",
+    "@aws-sdk/client-cloudformation": "^3.465.0",
+    "@aws-sdk/client-ssm": "^3.465.0",
+    "@aws-sdk/credential-providers": "^3.465.0",
+    "zod": "^3.22.2"
   },
   "devDependencies": {
     "@aws-amplify/platform-core": "^0.4.0",
-    "@aws-sdk/types": "^3.370.0"
+    "@aws-sdk/types": "^3.465.0"
   }
 }
diff --git a/packages/create-amplify/package.json b/packages/create-amplify/package.json
@@ -17,8 +17,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-amplify/cli-core": "^0.2.0",
-    "@aws-amplify/platform-core": "0.4.0",
-    "execa": "^7.2.0",
+    "@aws-amplify/platform-core": "^0.4.0",
+    "execa": "^8.0.1",
     "yargs": "^17.7.2"
   }
 }
diff --git a/packages/deployed-backend-client/package.json b/packages/deployed-backend-client/package.json
@@ -20,10 +20,10 @@
   "dependencies": {
     "@aws-amplify/backend-output-schemas": "^0.5.0",
     "@aws-amplify/platform-core": "^0.4.0",
-    "@aws-sdk/client-amplify": "^3.329.0",
-    "@aws-sdk/client-cloudformation": "^3.329.0",
-    "@aws-sdk/client-s3": "^3.329.0",
-    "@aws-sdk/types": "^3.413.0",
+    "@aws-sdk/client-amplify": "^3.465.0",
+    "@aws-sdk/client-cloudformation": "^3.465.0",
+    "@aws-sdk/client-s3": "^3.465.0",
+    "@aws-sdk/types": "^3.465.0",
     "zod": "^3.22.2"
   }
 }
diff --git a/packages/form-generator/package.json b/packages/form-generator/package.json
@@ -22,9 +22,9 @@
     "@aws-amplify/codegen-ui": "^2.19.4",
     "@aws-amplify/codegen-ui-react": "^2.19.4",
     "@aws-amplify/graphql-docs-generator": "^4.1.0",
-    "@aws-sdk/client-amplifyuibuilder": "^3.398.0",
-    "@aws-sdk/client-appsync": "^3.398.0",
-    "@aws-sdk/client-s3": "^3.400.0",
+    "@aws-sdk/client-amplifyuibuilder": "^3.465.0",
+    "@aws-sdk/client-appsync": "^3.465.0",
+    "@aws-sdk/client-s3": "^3.465.0",
     "@graphql-codegen/core": "^4.0.0",
     "@graphql-codegen/typescript": "^2.8.3",
     "graphql": "^15.8.0",
diff --git a/packages/integration-tests/package.json b/packages/integration-tests/package.json
@@ -10,13 +10,13 @@
     "@aws-amplify/client-config": "^0.5.0",
     "@aws-amplify/data-schema": "^0.12.9",
     "@aws-amplify/platform-core": "^0.4.0",
-    "@aws-sdk/client-amplify": "^3.440.0",
-    "@aws-sdk/client-cloudformation": "^3.421.0",
-    "@aws-sdk/client-lambda": "^3.460.0",
+    "@aws-sdk/client-amplify": "^3.465.0",
+    "@aws-sdk/client-cloudformation": "^3.465.0",
+    "@aws-sdk/client-lambda": "^3.465.0",
     "@aws-sdk/credential-providers": "^3.465.0",
     "@smithy/shared-ini-file-loader": "^2.2.5",
     "aws-cdk-lib": "^2.110.1",
-    "constructs": "^10.3.0",
+    "constructs": "^10.0.0",
     "execa": "^8.0.1",
     "fs-extra": "^11.1.1",
     "glob": "^10.2.7",
diff --git a/packages/model-generator/package.json b/packages/model-generator/package.json
@@ -19,13 +19,13 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@aws-amplify/backend-output-schemas": "^0.5.0",
-    "@aws-amplify/deployed-backend-client": "^0.3.5",
+    "@aws-amplify/deployed-backend-client": "^0.3.6",
     "@aws-amplify/graphql-generator": "^0.1.3",
     "@aws-amplify/graphql-types-generator": "^3.4.4",
-    "@aws-sdk/client-appsync": "^3.398.0",
-    "@aws-sdk/client-s3": "^3.414.0",
-    "@aws-sdk/credential-providers": "^3.414.0",
-    "@aws-sdk/types": "^3.413.0",
+    "@aws-sdk/client-appsync": "^3.465.0",
+    "@aws-sdk/client-s3": "^3.465.0",
+    "@aws-sdk/credential-providers": "^3.465.0",
+    "@aws-sdk/types": "^3.465.0",
     "graphql": "^15.8.0"
   },
   "devDependencies": {
diff --git a/packages/platform-core/package.json b/packages/platform-core/package.json
@@ -26,7 +26,7 @@
     "@aws-amplify/plugin-types": "^0.7.0",
     "@aws-sdk/client-sts": "3.445.0",
     "is-ci": "^3.0.1",
-    "uuid": "9.0.1",
-    "zod": "^3.21.4"
+    "uuid": "^9.0.1",
+    "zod": "^3.22.2"
   }
 }
diff --git a/packages/sandbox/package.json b/packages/sandbox/package.json
@@ -21,12 +21,12 @@
     "@aws-amplify/backend-deployer": "0.4.4",
     "@aws-amplify/backend-secret": "^0.4.0",
     "@aws-amplify/cli-core": "^0.2.0",
-    "@aws-amplify/client-config": "0.5.0",
+    "@aws-amplify/client-config": "^0.5.0",
     "@aws-amplify/deployed-backend-client": "^0.3.6",
     "@aws-amplify/platform-core": "^0.4.0",
-    "@aws-sdk/credential-providers": "^3.382.0",
-    "@aws-sdk/types": "^3.378.0",
-    "@aws-sdk/client-cloudformation": "^3.421.0",
+    "@aws-sdk/credential-providers": "^3.465.0",
+    "@aws-sdk/types": "^3.465.0",
+    "@aws-sdk/client-cloudformation": "^3.465.0",
     "@parcel/watcher": "^2.3.0",
     "debounce-promise": "^3.1.2",
     "glob": "^10.2.7",
diff --git a/scripts/components/dependencies_validator.test.ts b/scripts/components/dependencies_validator.test.ts
@@ -4,6 +4,7 @@ import { DependenciesValidator } from './dependencies_validator.js';
 import { ExecaChildProcess } from 'execa';
 import fsp from 'fs/promises';
 import { fileURLToPath } from 'url';
+import { glob } from 'glob';
 
 void describe('Dependency validator', () => {
   const execaMock = mock.fn();
@@ -109,4 +110,30 @@ void describe('Dependency validator', () => {
       }
     );
   });
+
+  void it('can detect inconsistent dependency declarations', async () => {
+    await assert.rejects(
+      async () => {
+        const packagePaths = await glob(
+          'scripts/components/test-resources/dependency-version-consistency-test-packages/*'
+        );
+        await new DependenciesValidator(
+          packagePaths,
+          {},
+          execaMock as never
+        ).validate();
+      },
+      (err: Error) => {
+        assert.ok(
+          err.message.includes('is declared using inconsistent versions')
+        );
+        assert.ok(err.message.includes('glob'));
+        assert.ok(err.message.includes('zod'));
+        assert.ok(err.message.includes('yargs'));
+        assert.ok(err.message.includes('package1'));
+        assert.ok(err.message.includes('package2'));
+        return true;
+      }
+    );
+  });
 });
diff --git a/scripts/components/dependencies_validator.ts b/scripts/components/dependencies_validator.ts
diff --git a/scripts/components/test-resources/dependency-version-consistency-test-packages/package1/package.json b/scripts/components/test-resources/dependency-version-consistency-test-packages/package1/package.json
diff --git a/scripts/components/test-resources/dependency-version-consistency-test-packages/package2/package.json b/scripts/components/test-resources/dependency-version-consistency-test-packages/package2/package.json

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,9 @@`
`19`	`19`	`},`
`20`	`20`	`"license": "Apache-2.0",`
`21`	`21`	`"devDependencies": {`
`22`		`- "@aws-amplify/plugin-types": "0.7.0"`
	`22`	`+ "@aws-amplify/plugin-types": "^0.7.0"`
`23`	`23`	`},`
`24`	`24`	`"peerDependencies": {`
`25`		`- "zod": "^3.21.4"`
	`25`	`+ "zod": "^3.22.2"`
`26`	`26`	`}`
`27`	`27`	`}`