@ikonintegration/ikapi 3.1.37 → 3.2.0

package/index.js

@@ -48,6 +48,7 @@ module.exports = {
       IKDBDDBQueryUpdate: require("./src/Database/DDB/IKDBQueryUpdate.js").default,
       IKDBDDBQueryDelete: require("./src/Database/DDB/IKDBQueryDelete.js").default,
       IKDBDDBQueryBatchWrite: require("./src/Database/DDB/IKDBQueryBatchWrite.js").default,
+      IKDBDDBQueryBatchGet: require("./src/Database/DDB/IKDBQueryBatchGet.js").default,
       IKDBDDBQueryTransactionalWrite: require("./src/Database/DDB/IKDBQueryTransactionalWrite.js").default,
       IKDBDDBExpressionOperator: require("./src/Database/DDB/IKDBBaseExpression.js").IKDBExpressionOperator,
     //Legacy
@@ -57,6 +58,7 @@ module.exports = {
       IKDBQueryUpdate: require("./src/Database/DDB/IKDBQueryUpdate.js").default,
       IKDBQueryDelete: require("./src/Database/DDB/IKDBQueryDelete.js").default,
       IKDBQueryBatchWrite: require("./src/Database/DDB/IKDBQueryBatchWrite.js").default,
+      IKDBQueryBatchGet: require("./src/Database/DDB/IKDBQueryBatchGet.js").default,
       IKDBQueryTransactionalWrite: require("./src/Database/DDB/IKDBQueryTransactionalWrite.js").default,
       IKDBExpressionOperator: require("./src/Database/DDB/IKDBBaseExpression.js").IKDBExpressionOperator,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikonintegration/ikapi",
-  "version": "3.1.37",
+  "version": "3.2.0",
   "description": "",
   "main": "index.js",
   "module": "main.js",
@@ -18,7 +18,7 @@
     "@aws-sdk/node-http-handler": "3.190.0",
     "@aws-sdk/util-dynamodb": "3.190.0",
     "@aws-sdk/util-endpoints": "3.190.0",
-    "@ikonintegration/mod-resources-tracker-client": "0.0.18",
+    "@ikonintegration/mod-resources-tracker-client": "0.0.19",
     "abind": "^1.0.5",
     "bluebird": "^3.7.2",
     "email-templates": "^8.0.8",

package/src/Database/DDB/IKDBBaseQuery.js

@@ -7,6 +7,7 @@ export default class IKDBDDBBaseQuery extends IKDBBaseQuery {
   constructor(optIndexName) {
     super();
     this.keyValues = {};
+    this.batchKeyValues = {};
     this.filter = new IKDBBaseExpression();
     this.keyConditional = new IKDBBaseExpression();
     this.conditional = new IKDBBaseExpression();
@@ -19,6 +20,17 @@ export default class IKDBDDBBaseQuery extends IKDBBaseQuery {
   }
   //Key
   appendKey(value, keyName, prefix) { this.keyValues[keyName] = (prefix != undefined && value.indexOf(prefix) != 0 ? prefix + value : value); }
+  //Batch
+  appendBatchKeys(keys, dbTableName) { // keys = [{ keyName: { value, prefix }, keyName2: { value, prefix } }]
+    if (this.batchKeyValues[dbTableName]) this.batchKeyValues[dbTableName] = [];
+    for (const key of keys) {
+      let keysObj = {};
+      for (const keyName in key) {
+        keysObj = { ...keysObj, [keyName]: key[keyName].prefix != undefined && key[keyName].value.indexOf(key[keyName].prefix) != 0 ? key[keyName].prefix + key[keyName].value : key[keyName].value };
+      }
+      this.batchKeyValues[dbTableName].push(keysObj);
+    }
+  }
 
   //Inheritance support
   _rawQuery(dbTableName, isTransaction) {
@@ -44,6 +56,8 @@ export default class IKDBDDBBaseQuery extends IKDBBaseQuery {
     expression = this.__buildFilterExpression(expression);
     //Key expression
     expression = this.__buildKeysExpression(expression);
+    //Batch key expression
+    expression = this.__buildBatchKeysExpression(expression);
     //Exclusive start key
     expression = this.__buildExclusiveStartKey(expression);
     return expression;
@@ -56,6 +70,22 @@ export default class IKDBDDBBaseQuery extends IKDBBaseQuery {
       }
     } return expression;
   }
+  __buildBatchKeysExpression(expression) { // example this.batchKeyValue {"tableName":[{"pk": "prefixsessionID","sk": "v0"},{"pk": "prefixsessionID2","sk": "v02"}]}
+    if (Object.keys(this.batchKeyValues).length > 0) {
+      for (let dbName of Object.keys(this.batchKeyValues)) {
+        for (let dbKeys of this.batchKeyValues[dbName]) {
+          if (!expression.RequestItems) expression.RequestItems = {};
+          if (!expression.RequestItems[dbName]) expression.RequestItems[dbName] = {};
+          if (!expression.RequestItems[dbName].Keys) expression.RequestItems[dbName].Keys = [];
+          let keysObj = {};
+          for (const keyName in dbKeys) {
+            keysObj = { ...keysObj, [keyName]: Utils.encapsulateForDB(dbKeys[keyName]) };
+          }
+          expression.RequestItems[dbName].Keys.push({ ...keysObj });
+        }
+      }
+    } return expression;
+  }
   __buildConditionalExpression(expression) {
     let expObj = this.conditional.buildExpression();
     //Check items and exp separately because they are not dependant

package/src/Database/DDB/IKDBQueryBatchGet.js

@@ -0,0 +1,37 @@
+import IKDBBaseQuery from './IKDBBaseQuery';
+import Utils from './../../API/IKUtils';
+//
+export default class IKDBQueryBatchGet extends IKDBBaseQuery {
+  constructor(optIndexName) {
+    super(optIndexName);
+  }
+  async run(dbManager, appendingItems) {
+    const localConsole = (dbManager.transaction ? dbManager.transaction.logger : console);
+    const resp = await this.rawRun(dbManager, appendingItems);
+    if (resp.Items) {
+      let unmarshalled = Utils.decapsulateForDB(resp.Items);
+      localConsole.debug('Parsed result: ', unmarshalled);
+      //Check for appending items from previous query
+      if (appendingItems && appendingItems.length > 0) {
+        unmarshalled = unmarshalled.concat(appendingItems);
+      }
+      return unmarshalled;
+    } return null;
+  }
+  async rawRun(dbManager, appendingItems) {
+    const localConsole = (dbManager.transaction ? dbManager.transaction.logger : console);
+    const query = {
+      ...this._rawQuery()
+    };
+    localConsole.log('Batch getting items: ', query, appendingItems ? appendingItems.length : null);
+    const resp = await dbManager.connection.batchGetItem(query);
+    localConsole.debug('Raw result: ', resp);
+    this._incrementTrackerStats(resp, dbManager);
+    return resp;
+  }
+
+  /* tracker support */
+  _incrementTrackerStats(resp, dbManager) {
+    if (resp && resp.ConsumedCapacity && resp.ConsumedCapacity.CapacityUnits) dbManager.stats.readUnits += parseFloat(resp.ConsumedCapacity.CapacityUnits);
+  }
+}