feat!: Remove AWS SDK V2 Dependency (#1180)

texastony · web-flow · commit 1d742489b436 · 2023-07-05T16:10:42.000-07:00
* feat!: Drop Support &amp; Dependency on AWS SDK V2


BREAKING CHANGE:
The AWS Encryption SDK for JavaScript:
- requires the AWS SDK for JavaScript V3's kms-client (if using the KMS Keyring).
- no longer requires the AWS SDK V2
- no longer tests against nor supports NodeJS 12 or 14
diff --git a/buildspec.yml b/buildspec.yml
@@ -3,42 +3,46 @@ version: 0.2
 batch:
   fast-fail: false
   build-list:
-    - identifier: testNodejsLatest
-      buildspec: codebuild/nodejs_latest.yml
+    - identifier: testNodejs20
+      buildspec: codebuild/nodejs20.yml
       env:
         image: aws/codebuild/standard:5.0
-    - identifier: testNodejs14
-      buildspec: codebuild/nodejs14.yml
+    - identifier: testNodejs18
+      buildspec: codebuild/nodejs18.yml
       env:
         image: aws/codebuild/standard:5.0
     - identifier: testNodejs16
       buildspec: codebuild/nodejs16.yml
       env:
         image: aws/codebuild/standard:5.0
-    - identifier: testBrowser
-      buildspec: codebuild/browser.yml
+    - identifier: testBrowser18
+      buildspec: codebuild/browser18.yml
       env:
         image: aws/codebuild/standard:5.0
     - identifier: compliance
       buildspec: codebuild/compliance.yml
       env:
         image: aws/codebuild/standard:5.0
-    - identifier: testVectorsNodejsLatest
-      buildspec: codebuild/test_vectors/nodejs_latest.yml
+    - identifier: testVectorsNodejs16
+      buildspec: codebuild/test_vectors/nodejs16.yml
       env:
         variables:
           PUBLISH_LOCAL: "true"
         image: aws/codebuild/standard:5.0
-    - identifier: testVectorsNodejs14
-      buildspec: codebuild/test_vectors/nodejs14.yml
+    - identifier: testVectorsNodejs18
+      buildspec: codebuild/test_vectors/nodejs18.yml
       env:
+        variables:
+          PUBLISH_LOCAL: "true"
         image: aws/codebuild/standard:5.0
-    - identifier: testVectorsNodejs16
-      buildspec: codebuild/test_vectors/nodejs16.yml
+    - identifier: testVectorsNodejs20
+      buildspec: codebuild/test_vectors/nodejs20.yml
       env:
+        variables:
+          PUBLISH_LOCAL: "true"
         image: aws/codebuild/standard:5.0
-    - identifier: testVectorsBrowser
-      buildspec: codebuild/test_vectors/browser.yml
+    - identifier: testVectorsBrowser18
+      buildspec: codebuild/test_vectors/browser18.yml
       env:
         variables:
           PUBLISH_LOCAL: "true"
diff --git a/codebuild/browser18.yml b/codebuild/browser18.yml
diff --git a/codebuild/compliance.yml b/codebuild/compliance.yml
@@ -6,9 +6,8 @@ env:
 
 phases:
   install:
-    runtime-versions:
-      nodejs: latest
     commands:
+      - n 18
       - npm ci --unsafe-perm
   build:
     commands:
diff --git a/codebuild/nodejs18.yml b/codebuild/nodejs18.yml
@@ -6,11 +6,14 @@ env:
 
 phases:
   install:
-    runtime-versions:
-      nodejs: 14
     commands:
+      - n 18
+      - node -v
+      - npm -v
       - npm ci --unsafe-perm
       - npm run build
   build:
     commands:
+      - npm -v
+      - node -v
       - npm run coverage-node
diff --git a/codebuild/nodejs20.yml b/codebuild/nodejs20.yml
@@ -7,7 +7,7 @@ env:
 phases:
   install:
     commands:
-      - n 18
+      - n 20
       - node --version ; npm --version
       - npm ci --unsafe-perm
       - npm run build
diff --git a/codebuild/release/prod-release.yml b/codebuild/release/prod-release.yml
@@ -9,22 +9,22 @@ batch:
       buildspec: codebuild/compliance.yml
 
 # Unit Tests
-    - identifier: testNodejsLatest
-      buildspec: codebuild/nodejs_latest.yml
+    - identifier: testNodejs20
+      buildspec: codebuild/nodejs20.yml
       env:
         image: aws/codebuild/standard:5.0
-    - identifier: testBrowser
-      buildspec: codebuild/browser.yml
+    - identifier: testBrowser18
+      buildspec: codebuild/browser18.yml
 
 # Integration Tests
-    - identifier: testVectorsNodejsLatest
-      buildspec: codebuild/test_vectors/nodejs_latest.yml
+    - identifier: testVectorsNodejs20
+      buildspec: codebuild/test_vectors/nodejs20.yml
       env:
         variables:
           PUBLISH_LOCAL: "true"
         image: aws/codebuild/standard:5.0
-    - identifier: testVectorsBrowser
-      buildspec: codebuild/test_vectors/browser.yml
+    - identifier: testVectorsBrowser18
+      buildspec: codebuild/test_vectors/browser18.yml
       env:
         variables:
           PUBLISH_LOCAL: "true"
@@ -34,10 +34,10 @@ batch:
     - identifier: version
       depend-on:
         - compliance
-        - testNodejsLatest
-        - testBrowser
-        - testVectorsNodejsLatest
-        - testVectorsBrowser
+        - testNodejs20
+        - testBrowser18
+        - testVectorsNodejs20
+        - testVectorsBrowser18
       buildspec: codebuild/release/version.yml
 
 # Publish the release to npm
@@ -50,15 +50,15 @@ batch:
     - identifier: validateNodejs
       depend-on:
         - publish
-      buildspec: codebuild/test_vectors/nodejs_latest.yml
+      buildspec: codebuild/test_vectors/nodejs20.yml
       env:
         variables:
           PUBLISH_LOCAL: "false"
         image: aws/codebuild/standard:5.0
     - identifier: validateBrowser
       depend-on:
         - publish
-      buildspec: codebuild/test_vectors/browser.yml
+      buildspec: codebuild/test_vectors/browser18.yml
       env:
         variables:
           PUBLISH_LOCAL: "false"
diff --git a/codebuild/release/publish.yml b/codebuild/release/publish.yml
@@ -18,7 +18,7 @@ phases:
       - npm install otplib --no-save
       - npm run build
     runtime-versions:
-      nodejs: 14
+      nodejs: 16
   pre_build:
     commands:
       - git checkout $BRANCH
diff --git a/codebuild/release/version.yml b/codebuild/release/version.yml
@@ -13,7 +13,7 @@ phases:
     commands:
       - npm ci --unsafe-perm
     runtime-versions:
-      nodejs: 14
+      nodejs: 16
   pre_build:
     commands:
       - git config --global user.name "aws-crypto-tools-ci-bot"
diff --git a/codebuild/test_vectors/browser18.yml b/codebuild/test_vectors/browser18.yml
@@ -9,7 +9,7 @@ phases:
   install:
     commands:
       - n 18
-      - npm ci
+      - npm ci --unsafe-perm
       - |-
         if [ "$PUBLISH_LOCAL" = "true" ]; then
           npm run build
diff --git a/codebuild/test_vectors/nodejs12.yml b/codebuild/test_vectors/nodejs12.yml
diff --git a/codebuild/test_vectors/nodejs14.yml b/codebuild/test_vectors/nodejs14.yml
diff --git a/codebuild/test_vectors/nodejs16.yml b/codebuild/test_vectors/nodejs16.yml
@@ -9,14 +9,17 @@ phases:
   install:
     commands:
       - n 16
-      - node -v
-      - npm -v
       - npm ci --unsafe-perm
-      - npm run build
+      - |-
+        if [ "$PUBLISH_LOCAL" = "true" ]; then
+          npm run build
+        fi
   build:
     commands:
-      - npm -v
       - node -v
-      - npm run verdaccio-publish
+      - |-
+        if [ "$PUBLISH_LOCAL" = "true" ]; then
+          npm run verdaccio-publish
+        fi
       - npm run verdaccio-node-decrypt
       - npm run verdaccio-node-encrypt
diff --git a/codebuild/test_vectors/nodejs18.yml b/codebuild/test_vectors/nodejs18.yml
@@ -9,13 +9,14 @@ phases:
   install:
     commands:
       - n 18
-      - npm ci
+      - npm ci --unsafe-perm
       - |-
         if [ "$PUBLISH_LOCAL" = "true" ]; then
           npm run build
         fi
   build:
     commands:
+      - node -v
       - |-
         if [ "$PUBLISH_LOCAL" = "true" ]; then
           npm run verdaccio-publish
diff --git a/codebuild/test_vectors/nodejs20.yml b/codebuild/test_vectors/nodejs20.yml
@@ -0,0 +1,25 @@
+version: 0.2
+
+env:
+  variables:
+    NODE_OPTIONS: "--max-old-space-size=4096"
+    NPM_CONFIG_UNSAFE_PERM: true
+
+phases:
+  install:
+    commands:
+      - n 20
+      - npm ci --unsafe-perm
+      - |-
+        if [ "$PUBLISH_LOCAL" = "true" ]; then
+          npm run build
+        fi
+  build:
+    commands:
+      - node -v
+      - |-
+        if [ "$PUBLISH_LOCAL" = "true" ]; then
+          npm run verdaccio-publish
+        fi
+      - npm run verdaccio-node-decrypt
+      - npm run verdaccio-node-encrypt
diff --git a/modules/integration-browser/package.json b/modules/integration-browser/package.json
@@ -19,10 +19,10 @@
   "dependencies": {
     "@aws-crypto/client-browser": "file:../client-browser",
     "@aws-crypto/integration-vectors": "file:../integration-vectors",
-    "@aws-sdk/credential-provider-node": "^3.11.0",
-    "@aws-sdk/karma-credential-loader": "3.38.0",
-    "@aws-sdk/util-base64-browser": "^3.10.0",
-    "@aws-sdk/util-utf8-browser": "3.23.0",
+    "@aws-sdk/credential-provider-node": "^3.362.0",
+    "@aws-sdk/karma-credential-loader": "^3.38.0",
+    "@aws-sdk/util-base64-browser": "^3.209.0",
+    "@aws-sdk/util-utf8-browser": "^3.23.0",
     "@trust/keyto": "^1.0.1",
     "@types/got": "^9.6.9",
     "@types/stream-to-promise": "^2.2.0",
diff --git a/modules/kms-keyring-browser/package.json b/modules/kms-keyring-browser/package.json
@@ -22,7 +22,7 @@
     "@aws-crypto/kms-keyring": "file:../kms-keyring",
     "@aws-crypto/material-management-browser": "file:../material-management-browser",
     "@aws-crypto/web-crypto-backend": "file:../web-crypto-backend",
-    "aws-sdk": "^2.1360.0",
+    "@aws-sdk/client-kms": "^3.363.0",
     "tslib": "^2.2.0"
   },
   "sideEffects": false,
diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts
@@ -23,7 +23,7 @@ import {
   KeyringWebCrypto,
   Newable,
 } from '@aws-crypto/material-management-browser'
-import { KMS } from 'aws-sdk'
+import { KMS, KMSClientConfig } from '@aws-sdk/client-kms'
 import { version } from './version'
 const getKmsClient = getClient(KMS, {
   customUserAgent: `AwsEncryptionSdkJavascriptBrowser/${version}`,
@@ -33,10 +33,7 @@ const cacheKmsClients = cacheClients(getKmsClient)
 export type KmsKeyringWebCryptoInput = Partial<
   KmsKeyringInput<AwsEsdkKMSInterface>
 >
-export type KMSWebCryptoConstructible = KMSConstructible<
-  KMS,
-  KMS.ClientConfiguration
->
+export type KMSWebCryptoConstructible = KMSConstructible<KMS, KMSClientConfig>
 export type KmsWebCryptoClientSupplier = KmsClientSupplier<AwsEsdkKMSInterface>
 
 export class KmsKeyringBrowser extends KmsKeyringClass<
diff --git a/modules/kms-keyring-node/package.json b/modules/kms-keyring-node/package.json
@@ -21,7 +21,7 @@
   "dependencies": {
     "@aws-crypto/kms-keyring": "file:../kms-keyring",
     "@aws-crypto/material-management-node": "file:../material-management-node",
-    "aws-sdk": "^2.1360.0",
+    "@aws-sdk/client-kms": "^3.362.0",
     "tslib": "^2.2.0"
   },
   "sideEffects": false,
diff --git a/modules/kms-keyring-node/src/kms_keyring_node.ts b/modules/kms-keyring-node/src/kms_keyring_node.ts
@@ -18,18 +18,15 @@ import {
   Newable,
   NodeAlgorithmSuite,
 } from '@aws-crypto/material-management-node'
-import { KMS } from 'aws-sdk'
+import { KMS, KMSClientConfig } from '@aws-sdk/client-kms'
 import { version } from './version'
 const getKmsClient = getClient(KMS, {
   customUserAgent: `AwsEncryptionSdkJavascriptNodejs/${version}`,
 })
 const cacheKmsClients = cacheClients(getKmsClient)
 
 export type KmsKeyringNodeInput = Partial<KmsKeyringInput<AwsEsdkKMSInterface>>
-export type KMSNodeConstructible = KMSConstructible<
-  KMS,
-  KMS.ClientConfiguration
->
+export type KMSNodeConstructible = KMSConstructible<KMS, KMSClientConfig>
 export type KmsNodeClientSupplier = KmsClientSupplier<AwsEsdkKMSInterface>
 
 export class KmsKeyringNode extends KmsKeyringClass<
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/util/local_verdaccio_publish b/util/local_verdaccio_publish
