@cumulus/common 10.1.2 → 11.1.1

package/key-pair-provider.d.ts

@@ -2,7 +2,12 @@
  * Provides encryption and decryption methods with a consistent API but
  * differing mechanisms for dealing with encryption keys.
  */
+import { Readable } from 'stream';
+import { S3 } from '@aws-sdk/client-s3';
 export { KMS } from './kms';
+export declare const buildS3Client: () => S3;
+export declare const getObjectStreamContents: (objectReadStream: Readable) => Promise<string>;
+export declare const retrieveKey: (keyId: string, bucket?: string | undefined, stack?: string | undefined) => Promise<string | undefined>;
 /**
  * Provides encryption and decryption methods using a keypair stored in S3
  */

package/key-pair-provider.js

@@ -7,10 +7,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultProvider = exports.S3KeyPairProvider = exports.KMS = void 0;
-const noop_1 = __importDefault(require("lodash/noop"));
-const aws_sdk_1 = __importDefault(require("aws-sdk"));
+exports.DefaultProvider = exports.S3KeyPairProvider = exports.retrieveKey = exports.getObjectStreamContents = exports.buildS3Client = exports.KMS = void 0;
 const node_forge_1 = __importDefault(require("node-forge"));
+const stream_1 = require("stream");
+const client_s3_1 = require("@aws-sdk/client-s3");
 const util_1 = require("./util");
 const test_utils_1 = require("./test-utils");
 var kms_1 = require("./kms");
@@ -27,30 +27,47 @@ const getLocalStackHost = () => {
 const buildS3Client = () => {
     var _a;
     const region = (_a = process.env.AWS_DEFAULT_REGION) !== null && _a !== void 0 ? _a : 'us-east-1';
-    aws_sdk_1.default.config.update({ region });
-    // Workaround upload hangs. See: https://github.com/andrewrk/node-s3-client/issues/74'
-    // @ts-expect-error
-    aws_sdk_1.default.util.update(aws_sdk_1.default.S3.prototype, { addExpect100Continue: noop_1.default });
-    aws_sdk_1.default.config.setPromisesDependency(Promise);
     const options = {
         apiVersion: '2006-03-01',
+        region,
     };
     if ((0, test_utils_1.inTestMode)()) {
-        options.accessKeyId = 'my-access-key-id';
         options.endpoint = `http://${getLocalStackHost()}:4566`;
         options.region = 'us-east-1';
-        options.s3ForcePathStyle = true;
-        options.secretAccessKey = 'my-secret-access-key';
+        options.forcePathStyle = true;
+        options.credentials = {
+            accessKeyId: 'my-access-key-id',
+            secretAccessKey: 'my-secret-access-key',
+        };
     }
-    return new aws_sdk_1.default.S3(options);
+    return new client_s3_1.S3(options);
 };
+exports.buildS3Client = buildS3Client;
+const getObjectStreamContents = (objectReadStream) => new Promise((resolve, reject) => {
+    try {
+        const responseDataChunks = [];
+        objectReadStream.once('error', (error) => reject(error));
+        objectReadStream.on('data', (chunk) => responseDataChunks.push(chunk));
+        // Once the stream has no more data, join the chunks into a string and
+        // return the string
+        objectReadStream.once('end', () => resolve(responseDataChunks.join('')));
+    }
+    catch (error) {
+        reject(error);
+    }
+});
+exports.getObjectStreamContents = getObjectStreamContents;
 const getTextObject = async (bucket, key) => {
-    const s3 = buildS3Client();
+    const s3 = (0, exports.buildS3Client)();
     const { Body } = await s3.getObject({
         Bucket: bucket,
         Key: key,
-    }).promise();
-    return Body ? Body.toString() : undefined;
+    });
+    let data;
+    if (Body && Body instanceof stream_1.Readable) {
+        data = await (0, exports.getObjectStreamContents)(Body);
+    }
+    return data;
 };
 const retrieveKey = async (keyId, bucket = process.env.system_bucket, stack = process.env.stackName) => {
     if (!bucket) {
@@ -67,6 +84,7 @@ const retrieveKey = async (keyId, bucket = process.env.system_bucket, stack = pr
         throw new Error(`Failed to retrieve S3KeyPair key from s3://${bucket}/${key}: ${error.message}`);
     }
 };
+exports.retrieveKey = retrieveKey;
 /**
  * Provides encryption and decryption methods using a keypair stored in S3
  */
@@ -86,7 +104,7 @@ class S3KeyPairProvider {
         (0, util_1.deprecate)('@cumulus/common/key-pair-provider', '1.17.0', '@cumulus/aws-client/KMS.encrypt');
         // Download the publickey
         const pki = node_forge_1.default.pki;
-        const pub = await retrieveKey(keyId, bucket, stack);
+        const pub = await (0, exports.retrieveKey)(keyId, bucket, stack);
         if (!pub) {
             throw new Error('Unable to retrieve public key');
         }
@@ -107,7 +125,7 @@ class S3KeyPairProvider {
     static async decrypt(str, keyId = 'private.pem', bucket, stack) {
         (0, util_1.deprecate)('@cumulus/common/key-pair-provider', '1.17.0', '@cumulus/aws-client/KMS.decryptBase64String');
         const pki = node_forge_1.default.pki;
-        const priv = await retrieveKey(keyId, bucket, stack);
+        const priv = await (0, exports.retrieveKey)(keyId, bucket, stack);
         if (!priv) {
             throw new Error('Unable to retrieve private key');
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/common",
-  "version": "10.1.2",
+  "version": "11.1.1",
   "description": "Common utilities used across tasks",
   "keywords": [
     "GIBS",
@@ -41,8 +41,11 @@
   "author": "Cumulus Authors",
   "license": "Apache-2.0",
   "dependencies": {
-    "@cumulus/errors": "10.1.2",
-    "@cumulus/logger": "10.1.2",
+    "@aws-sdk/client-s3": "^3.53.0",
+    "@aws-sdk/signature-v4-crt": "^3.53.0",
+    "@cumulus/aws-client": "11.1.1",
+    "@cumulus/errors": "11.1.1",
+    "@cumulus/logger": "11.1.1",
     "ajv": "^6.12.3",
     "aws-sdk": "^2.585.0",
     "follow-redirects": "^1.2.4",
@@ -50,7 +53,7 @@
     "is-ip": "^3.1.0",
     "jsonpath-plus": "^3.0.0",
     "lodash": "^4.17.21",
-    "node-forge": "^1.0.0",
+    "node-forge": "^1.3.0",
     "p-limit": "^2.0.0",
     "p-map": "^1.2.0",
     "p-retry": "^4.2.0",
@@ -64,5 +67,5 @@
     "@types/node-forge": "^0.9.5",
     "@types/url-join": "^4.0.0"
   },
-  "gitHead": "3b59753fa85064549b70ad8ed4a4ee213c5af313"
+  "gitHead": "07fe682da23821434372759fb1948b081da429b5"
 }

package/util.d.ts

@@ -27,7 +27,7 @@ export declare const deprecate: (name: string, version: string, alternative?: st
  *
  * @alias module:util
  */
-export declare const removeNilProperties: <T extends object>(obj: T) => import("lodash").Dictionary<any>;
+export declare const removeNilProperties: <T extends object>(obj: T) => T;
 /**
  * Test if a value is included in a list of items
  *