@cumulus/aws-client 11.0.0 → 11.1.1

package/DynamoDb.d.ts

@@ -2,31 +2,34 @@
  * @module DynamoDb
  */
 import pRetry from 'p-retry';
-import { DocumentClient } from 'aws-sdk/lib/dynamodb/document_client';
+import { CreateTableInput, DeleteTableInput, ScanInput } from '@aws-sdk/client-dynamodb';
+import { DynamoDBDocument, GetCommandInput, ScanCommandInput, ScanCommandOutput } from '@aws-sdk/lib-dynamodb';
 /**
  * Call DynamoDb client get
  *
- * See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#get-property)
+ * See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
  * for descriptions of `params` and the return data.
  *
  * @param {Object} params
  * @param {string} params.tableName - Table name to read
- * @param {AWS.DynamoDB.DocumentClient.Key} params.item - Key identifying object to get
- * @param {AWS.DynamoDB.DocumentClient} params.client - Instance of a DynamoDb DocumentClient
+ * @param {GetCommandInput.Key} params.item - Key identifying object to get
+ * @param {DynamoDBDocument} params.client - Instance of a DynamoDb DocumentClient
  * @param {Object} params.getParams - Additional parameters for DocumentClient.get()
  * @returns {Promise<Object>}
  * @throws {RecordDoesNotExist} if a record cannot be found
  */
 export declare const get: (params: {
     tableName: string;
-    item: AWS.DynamoDB.DocumentClient.Key;
-    client: AWS.DynamoDB.DocumentClient;
-    getParams?: object | undefined;
-}) => Promise<DocumentClient.AttributeMap>;
+    item: GetCommandInput['Key'];
+    client: DynamoDBDocument;
+    getParams?: object;
+}) => Promise<{
+    [key: string]: any;
+}>;
 /**
  * Call DynamoDb client scan
  *
- * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property)
+ * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
  * for descriptions of `params` and the return data.
  *
  * @param {Object} params
@@ -34,59 +37,59 @@ export declare const get: (params: {
  */
 export declare const scan: (params: {
     tableName: string;
-    client: AWS.DynamoDB.DocumentClient;
+    client: DynamoDBDocument;
     query?: {
         filter?: string | undefined;
-        names?: DocumentClient.ExpressionAttributeNameMap | undefined;
-        values?: DocumentClient.ExpressionAttributeValueMap | undefined;
+        names?: ScanInput['ExpressionAttributeNames'];
+        values?: ScanCommandInput['ExpressionAttributeValues'];
     } | undefined;
     fields?: string | undefined;
     limit?: number | undefined;
     select: string;
-    startKey?: DocumentClient.Key | undefined;
-}) => Promise<import("aws-sdk/lib/request").PromiseResult<DocumentClient.ScanOutput, import("aws-sdk").AWSError>>;
+    startKey?: ScanInput['ExclusiveStartKey'];
+}) => Promise<ScanCommandOutput>;
 /**
  * Do a parallel scan of DynamoDB table using a document client.
  *
  * See https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan.
- * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property).
+ * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html).
  *
  * @param {Object} params
  * @param {number} params.totalSegments
  *   Total number of segments to divide table into for parallel scanning
- * @param {DocumentClient.ScanInput} params.scanParams
+ * @param {ScanInput} params.scanParams
  *   Params for the DynamoDB client scan operation
  *   See https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html
  * @param {function} params.processItemsFunc - Function used to process returned items by scan
- * @param {DocumentClient} [params.dynamoDbClient] - Instance of Dynamo DB document client
+ * @param {DynamoDBDocument} [params.dynamoDbClient] - Instance of Dynamo DB document client
  * @param {pRetry.Options} [params.retryOptions] - Retry options for scan operations
  * @returns {Promise}
  */
 export declare const parallelScan: (params: {
     totalSegments: number;
-    scanParams: DocumentClient.ScanInput;
-    processItemsFunc: (items: DocumentClient.ItemList) => Promise<void>;
-    dynamoDbClient?: DocumentClient | undefined;
+    scanParams: ScanCommandInput;
+    processItemsFunc: (items: ScanCommandOutput['Items']) => Promise<void>;
+    dynamoDbClient: DynamoDBDocument;
     retryOptions?: pRetry.Options | undefined;
 }) => Promise<void[]>;
 /**
  * Create a DynamoDB table and then wait for the table to exist
  *
  * @param {Object} params - the same params that you would pass to AWS.createTable
- *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createTable-property
+ *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/dynamodb.html#createtable
  * @returns {Promise<Object>} the output of the createTable call
  *
  * @static
  */
-export declare function createAndWaitForDynamoDbTable(params: AWS.DynamoDB.CreateTableInput): Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/dynamodb").CreateTableOutput, import("aws-sdk").AWSError>>;
+export declare function createAndWaitForDynamoDbTable(params: CreateTableInput): Promise<import("@aws-sdk/client-dynamodb").CreateTableCommandOutput>;
 /**
  * Delete a DynamoDB table and then wait for the table to not exist
  *
  * @param {Object} params - the same params that you would pass to AWS.deleteTable
- *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteTable-property
+ *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/dynamodb.html#deletetable
  * @returns {Promise}
  *
  * @static
  */
-export declare function deleteAndWaitForDynamoDbTableNotExists(params: AWS.DynamoDB.DeleteTableInput): Promise<import("aws-sdk/lib/request").PromiseResult<import("aws-sdk/clients/dynamodb").DescribeTableOutput, import("aws-sdk").AWSError>>;
+export declare function deleteAndWaitForDynamoDbTableNotExists(params: DeleteTableInput): Promise<void>;
 //# sourceMappingURL=DynamoDb.d.ts.map

package/DynamoDb.js

@@ -10,38 +10,40 @@ exports.deleteAndWaitForDynamoDbTableNotExists = exports.createAndWaitForDynamoD
 const p_map_1 = __importDefault(require("p-map"));
 const p_retry_1 = __importDefault(require("p-retry"));
 const range_1 = __importDefault(require("lodash/range"));
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const errors_1 = require("@cumulus/errors");
 const services_1 = require("./services");
 const utils_1 = require("./utils");
 /**
  * Call DynamoDb client get
  *
- * See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#get-property)
+ * See [DocumentClient.get()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
  * for descriptions of `params` and the return data.
  *
  * @param {Object} params
  * @param {string} params.tableName - Table name to read
- * @param {AWS.DynamoDB.DocumentClient.Key} params.item - Key identifying object to get
- * @param {AWS.DynamoDB.DocumentClient} params.client - Instance of a DynamoDb DocumentClient
+ * @param {GetCommandInput.Key} params.item - Key identifying object to get
+ * @param {DynamoDBDocument} params.client - Instance of a DynamoDb DocumentClient
  * @param {Object} params.getParams - Additional parameters for DocumentClient.get()
  * @returns {Promise<Object>}
  * @throws {RecordDoesNotExist} if a record cannot be found
  */
-exports.get = (0, utils_1.improveStackTrace)(async (params) => {
+const get = async (params) => {
     const { client, getParams = {}, item, tableName, } = params;
     const getResponse = await client.get({
         ...getParams,
         TableName: tableName,
         Key: item,
-    }).promise();
+    });
     if (getResponse.Item)
         return getResponse.Item;
     throw new errors_1.RecordDoesNotExist(`No record found for ${JSON.stringify(item)} in ${tableName}`);
-});
+};
+exports.get = get;
 /**
  * Call DynamoDb client scan
  *
- * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property)
+ * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html)
  * for descriptions of `params` and the return data.
  *
  * @param {Object} params
@@ -73,7 +75,7 @@ exports.scan = (0, utils_1.improveStackTrace)(async (params) => {
     if (startKey) {
         scanParams.ExclusiveStartKey = startKey;
     }
-    const response = await client.scan(scanParams).promise();
+    const response = await client.scan(scanParams);
     // recursively go through all the records
     if (response.LastEvaluatedKey) {
         const more = await (0, exports.scan)({
@@ -98,21 +100,21 @@ exports.scan = (0, utils_1.improveStackTrace)(async (params) => {
  * Do a parallel scan of DynamoDB table using a document client.
  *
  * See https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan.
- * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property).
+ * See [DocumentClient.scan()](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html).
  *
  * @param {Object} params
  * @param {number} params.totalSegments
  *   Total number of segments to divide table into for parallel scanning
- * @param {DocumentClient.ScanInput} params.scanParams
+ * @param {ScanInput} params.scanParams
  *   Params for the DynamoDB client scan operation
  *   See https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html
  * @param {function} params.processItemsFunc - Function used to process returned items by scan
- * @param {DocumentClient} [params.dynamoDbClient] - Instance of Dynamo DB document client
+ * @param {DynamoDBDocument} [params.dynamoDbClient] - Instance of Dynamo DB document client
  * @param {pRetry.Options} [params.retryOptions] - Retry options for scan operations
  * @returns {Promise}
  */
 const parallelScan = async (params) => {
-    const { totalSegments, scanParams, processItemsFunc, dynamoDbClient = (0, services_1.dynamodbDocClient)(), retryOptions, } = params;
+    const { totalSegments, scanParams, processItemsFunc, dynamoDbClient, retryOptions, } = params;
     return await (0, p_map_1.default)((0, range_1.default)(totalSegments), async (_, segmentIndex) => {
         let exclusiveStartKey;
         const segmentScanParams = {
@@ -122,7 +124,7 @@ const parallelScan = async (params) => {
         };
         /* eslint-disable no-await-in-loop */
         do {
-            const { Items = [], LastEvaluatedKey, } = await (0, p_retry_1.default)(() => dynamoDbClient.scan(segmentScanParams).promise(), retryOptions);
+            const { Items = [], LastEvaluatedKey, } = await (0, p_retry_1.default)(() => dynamoDbClient.scan(segmentScanParams), retryOptions);
             exclusiveStartKey = LastEvaluatedKey;
             segmentScanParams.ExclusiveStartKey = exclusiveStartKey;
             await processItemsFunc(Items);
@@ -138,14 +140,19 @@ exports.parallelScan = parallelScan;
  * Create a DynamoDB table and then wait for the table to exist
  *
  * @param {Object} params - the same params that you would pass to AWS.createTable
- *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#createTable-property
+ *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/dynamodb.html#createtable
  * @returns {Promise<Object>} the output of the createTable call
  *
  * @static
  */
 async function createAndWaitForDynamoDbTable(params) {
-    const createTableResult = await (0, services_1.dynamodb)().createTable(params).promise();
-    await (0, services_1.dynamodb)().waitFor('tableExists', { TableName: params.TableName }).promise();
+    const dynamoDbClient = (0, services_1.dynamodb)();
+    const createTableResult = await dynamoDbClient.createTable(params);
+    await (0, client_dynamodb_1.waitUntilTableExists)({
+        client: dynamoDbClient,
+        minDelay: 1,
+        maxWaitTime: 3,
+    }, { TableName: params.TableName });
     return createTableResult;
 }
 exports.createAndWaitForDynamoDbTable = createAndWaitForDynamoDbTable;
@@ -153,14 +160,19 @@ exports.createAndWaitForDynamoDbTable = createAndWaitForDynamoDbTable;
  * Delete a DynamoDB table and then wait for the table to not exist
  *
  * @param {Object} params - the same params that you would pass to AWS.deleteTable
- *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#deleteTable-property
+ *   See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/classes/dynamodb.html#deletetable
  * @returns {Promise}
  *
  * @static
  */
 async function deleteAndWaitForDynamoDbTableNotExists(params) {
-    await (0, services_1.dynamodb)().deleteTable(params).promise();
-    return (0, services_1.dynamodb)().waitFor('tableNotExists', { TableName: params.TableName }).promise();
+    const dynamoDbClient = (0, services_1.dynamodb)();
+    await dynamoDbClient.deleteTable(params);
+    await (0, client_dynamodb_1.waitUntilTableNotExists)({
+        client: dynamoDbClient,
+        minDelay: 1,
+        maxWaitTime: 3,
+    }, { TableName: params.TableName });
 }
 exports.deleteAndWaitForDynamoDbTableNotExists = deleteAndWaitForDynamoDbTableNotExists;
 //# sourceMappingURL=DynamoDb.js.map

package/DynamoDbSearchQueue.js

@@ -83,12 +83,17 @@ class DynamoDbSearchQueue {
     async fetchItems() {
         let response;
         do {
-            response = await this.dynamodbDocClient[this.searchType](this.params).promise(); // eslint-disable-line no-await-in-loop, max-len
-            if (response.LastEvaluatedKey)
+            if (this.searchType === 'scan') {
+                response = await this.dynamodbDocClient.scan(this.params); // eslint-disable-line no-await-in-loop, max-len
+            }
+            else if (this.searchType === 'query') {
+                response = await this.dynamodbDocClient.query(this.params); // eslint-disable-line no-await-in-loop, max-len
+            }
+            if (response === null || response === void 0 ? void 0 : response.LastEvaluatedKey)
                 this.params.ExclusiveStartKey = response.LastEvaluatedKey;
-        } while ((response.Items || []).length === 0 && response.LastEvaluatedKey);
-        this.items = (response.Items || []);
-        if (!response.LastEvaluatedKey)
+        } while (((response === null || response === void 0 ? void 0 : response.Items) || []).length === 0 && (response === null || response === void 0 ? void 0 : response.LastEvaluatedKey));
+        this.items = ((response === null || response === void 0 ? void 0 : response.Items) || []);
+        if (!(response === null || response === void 0 ? void 0 : response.LastEvaluatedKey))
             this.items.push(null);
     }
 }