@izara_project/izara-core-library-asynchronous-flow 1.0.35 → 1.0.37

package/index.js

@@ -8,98 +8,19 @@ License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU Affero General Public License for more details.
 
 You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
-import {
-  createFieldNameUniqueRequestId,
-  createConcatenatedAwaitingStepId,
-  createConcatenatedPendingStepId,
-  createAwaitingStepId,
-  createPendingStepId,
-  createParentFlowId,
-  explodePendingStepId,
-  createFieldNameCacheComplete,
-  createFieldNameStatus,
-  checkUniqueRequestProcessing,
-  checkTimeCacheComplete,
-  checkAndGetTimeCacheComplete,
-  checkCacheUniqueRequestId,
-  validateStartKeyParam,
-  validateMultipleInvocations
-} from './src/asyncFlowSharedLib.js';
-
-import {
-  createAwaitingStep,
-  findPendingStepIdsAwaitingStep,
-  findPendingStepsAwaitingStep,
-  findPendingStepAwaitingStep,
-  findPendingStepAwaitingStepWithCallingFlow,
-  removeAwaitingStep,
-  removeAwaitingStepWithCheckUniqueRequestId
-} from './src/awaitingStep.js';
-
-import {
-  createAwaitingMultipleStepsWithAdditionalAttributes,
-  initAwaitingStepsWithAttrs,
-  createAwaitingMultipleSteps,
-  createNewAwaitingMultipleStep,
-  findPendingStepIdsAwaitingMultipleSteps,
-  findPendingStepsAwaitingMultipleSteps,
-  findPendingStepAwaitingMultipleSteps,
-  findAwaitingMultipleStepByPending,
-  checkAllAwaitingStepsFinishedShared,
-  checkAllAwaitingStepsFinished,
-  checkAllAwaitingStepsFinishedWithReturnParams,
-  clearAllAwaitingSteps,
-  removeAwaitingMultipleStep,
-  createAwaitingMultipleStepsWithAdditionalAttributesAndPublish
-} from './src/awaitingMultipleSteps.js';
+import * as asyncFlowSharedLib from './src/asyncFlowSharedLib.js';
+import * as awaitingStep from './src/awaitingStep.js';
+import * as awaitingMultipleSteps from './src/awaitingMultipleSteps.js';
 
 export default {
-  //  asyncFlowSharedLib
-  createFieldNameUniqueRequestId,
-  createConcatenatedAwaitingStepId,
-  createConcatenatedPendingStepId,
-  createAwaitingStepId,
-  createPendingStepId,
-  createParentFlowId,
-  explodePendingStepId,
-  createFieldNameCacheComplete,
-  createFieldNameStatus,
-  checkUniqueRequestProcessing,
-  checkTimeCacheComplete,
-  checkAndGetTimeCacheComplete,
-  checkCacheUniqueRequestId,
-  validateStartKeyParam,
-  validateMultipleInvocations,
-
-  //  awaitingStep
-  createAwaitingStep,
-  findPendingStepIdsAwaitingStep,
-  findPendingStepsAwaitingStep,
-  findPendingStepAwaitingStep,
-  findPendingStepAwaitingStepWithCallingFlow,
-  removeAwaitingStep,
-  removeAwaitingStepWithCheckUniqueRequestId,
-
-  //  awaitingMultipleSteps
-  createAwaitingMultipleStepsWithAdditionalAttributes,
-  initAwaitingStepsWithAttrs,
-  createAwaitingMultipleSteps,
-  createNewAwaitingMultipleStep,
-  findPendingStepIdsAwaitingMultipleSteps,
-  findPendingStepsAwaitingMultipleSteps,
-  findPendingStepAwaitingMultipleSteps,
-  findAwaitingMultipleStepByPending,
-  checkAllAwaitingStepsFinishedShared,
-  checkAllAwaitingStepsFinished,
-  checkAllAwaitingStepsFinishedWithReturnParams,
-  clearAllAwaitingSteps,
-  removeAwaitingMultipleStep,
-  createAwaitingMultipleStepsWithAdditionalAttributesAndPublish
+  ...asyncFlowSharedLib,
+  ...awaitingStep,
+  ...awaitingMultipleSteps
 };

package/package.json

@@ -3,7 +3,7 @@
   "author": "Sven Mason <thebarbariansven@gmail.com>",
   "license": "AGPL-3.0-or-later",
   "homepage": "https://bitbucket.org/izara-core-libraries/izara-core-library-asynchronous-flow#readme",
-  "version": "1.0.35",
+  "version": "1.0.37",
   "description": "Shared asynchronous flow logic",
   "type": "module",
   "main": "index.js",

package/src/asyncFlowSharedLib.js

@@ -105,22 +105,15 @@ export function createParentFlowId(prefix = '') {
  * @throws {NoRetryError} If the stripped value equals the prefix (invalid)
  */
 export function explodePendingStepId(pendingStepId, prefix = '') {
-  if (!pendingStepId) {
-    throw NoRetryError('pendingStepId is required');
-  }
+  if (!pendingStepId) throw new NoRetryError('pendingStepId is required');
+  if (!prefix) return pendingStepId;
 
-  if (prefix === '') {
-    return pendingStepId;
-  } else {
-    let identifierId = pendingStepId.slice(prefix.length);
-    // ** validate identifierId == prefix
-    if (identifierId == prefix) {
-      throw new NoRetryError('IdentifierId should not be like prefix.');
-    }
+  const identifierId = pendingStepId.slice(prefix.length);
+  if (identifierId === prefix)
+    throw new NoRetryError('IdentifierId should not be like prefix.');
 
-    Logger.debug('return explode:', identifierId);
-    return identifierId;
-  }
+  Logger.debug('return explode:', identifierId);
+  return identifierId;
 }
 
 // copy from izara-core-library-trigger-cache
@@ -195,7 +188,7 @@ export async function checkUniqueRequestProcessing(
   );
 
   if (!tableName || !primaryKey) {
-    throw NoRetryError('tableName and primaryKey are required');
+    throw new NoRetryError('tableName and primaryKey are required');
   }
 
   try {
@@ -204,94 +197,60 @@ export async function checkUniqueRequestProcessing(
       _izContext.uniqueRequestId
     );
 
-    let uniqueRequestId = _izContext.uniqueRequestId;
-    if (overwriteUniqueRequestId) {
-      uniqueRequestId = overwriteUniqueRequestId;
-    }
-
-    // add prefix
+    const uniqueRequestId =
+      overwriteUniqueRequestId || _izContext.uniqueRequestId;
     uniqueRequestIdFieldName = createFieldNameUniqueRequestId(
       prefix,
       uniqueRequestIdFieldName
     );
 
-    //loop 3 times incas status changes, on 3rd iteration throw error (so checks 2 times)
-    for (let i = 1; i <= 3; i++) {
-      if (i == 3) {
-        throw new NoRetryError(
-          `unable to set uniqueRequestId in table ${tableName}, record`,
-          primaryKey
-        );
-      }
-      //* get record from dynamo
-      let existingRecord = await dynamodbSharedLib.getItem(
+    for (let i = 0; i < 2; i++) {
+      const existingRecord = await dynamodbSharedLib.getItem(
         _izContext,
         dynamodbSharedLib.tableName(_izContext, tableName),
         primaryKey
       );
-      _izContext.logger.debug('existingRecord:', existingRecord);
 
-      let returnStatus = 'process';
+      if (!existingRecord) return ['recordNotFound', {}];
 
-      if (!existingRecord) {
-        // return ["recordNotFound", null]; // cannot return null, js cannot found object and throw error and don't know where it is?
-        return ['recordNotFound', {}];
-      } else if (!existingRecord[uniqueRequestIdFieldName]) {
-        // uniqueRequestId not yet exist
+      const currentReqId = existingRecord[uniqueRequestIdFieldName];
+      if (currentReqId === uniqueRequestId) return ['process', existingRecord];
+      if (currentReqId) return ['stop', existingRecord];
 
-        let updateAttributes = [
-          {
-            attributeName: uniqueRequestIdFieldName,
-            action: 'set',
-            value: _izContext.uniqueRequestId
-          }
-        ];
-        //* conditional check uniqueRequestId still not exist in case another thread added
-        const queryElementsWhenUpdate = {
-          logicalElements: [
+      try {
+        const updateRecord = await dynamodbSharedLib.updateItem(
+          _izContext,
+          dynamodbSharedLib.tableName(_izContext, tableName),
+          primaryKey,
+          [
             {
-              type: 'function',
-              function: 'attribute_not_exists',
-              attribute: uniqueRequestIdFieldName
+              attributeName: uniqueRequestIdFieldName,
+              action: 'set',
+              value: _izContext.uniqueRequestId
             }
           ],
-          returnValues: 'ALL_NEW'
-        };
-        // // ----- main query ---------
-        let updateRecord = null;
-        try {
-          updateRecord = await dynamodbSharedLib.updateItem(
-            _izContext,
-            dynamodbSharedLib.tableName(_izContext, tableName),
-            primaryKey,
-            updateAttributes,
-            queryElementsWhenUpdate,
-            { complexAttributes: true } // force to complex
-          );
-
-          return [returnStatus, updateRecord];
-        } catch (err) {
-          // catch error when put and handle errors.
-          _izContext.logger.debug('updateItem storedCache expired err', err);
-          if (err.name == 'ConditionalCheckFailedException') {
-            continue;
-          } else {
-            // e.g. ProvisionedThroughputExceededException
-            // throw new Error('Unhandled Error when putItem', err) // TT, if throw will stop
-            throw err; // TT, if throw will stop
-          }
-        } //end catch err
-      } else if (existingRecord[uniqueRequestIdFieldName] !== uniqueRequestId) {
-        // when another request/uniqueRequestId need to stop process
-        return ['stop', existingRecord];
-      } else if (existingRecord[uniqueRequestIdFieldName] == uniqueRequestId) {
-        // if existingRecord[uniqueRequestIdFieldName] == uniqueRequestId then return "process
-        return [returnStatus, existingRecord];
+          {
+            logicalElements: [
+              {
+                type: 'function',
+                function: 'attribute_not_exists',
+                attribute: uniqueRequestIdFieldName
+              }
+            ],
+            returnValues: 'ALL_NEW'
+          },
+          { complexAttributes: true }
+        );
+        return ['process', updateRecord];
+      } catch (err) {
+        if (err.name === 'ConditionalCheckFailedException') continue;
+        throw err;
       }
-    } // end loop 2 times
-    //should never get here
+    }
+
     throw new NoRetryError(
-      'unexpected logic flow in checkUniqueRequestProcessing'
+      `unable to set uniqueRequestId in table ${tableName}, record`,
+      primaryKey
     );
   } catch (err) {
     _izContext.logger.error('ERROR checkUniqueRequestProcessing:', err);
@@ -327,7 +286,7 @@ export async function checkTimeCacheComplete(
   });
 
   if (!fullMainTableName || !keyValues || !timeCacheComplete || !prefix) {
-    throw NoRetryError(
+    throw new NoRetryError(
       'fullMainTableName, keyValues, timeCacheComplete and prefix are required'
     );
   }
@@ -437,21 +396,14 @@ export async function checkCacheUniqueRequestId(
   checkUniqueRequestId,
   uniqueRequestIdCompleteFieldName
 ) {
-  let cacheObject = await dynamodbSharedLib.getItem(
+  const cacheObject = await dynamodbSharedLib.getItem(
     _izContext,
     fullMainTableName,
     keyValues
   );
   _izContext.logger.debug('cacheObject', cacheObject);
 
-  if (
-    !cacheObject[uniqueRequestIdCompleteFieldName] ||
-    cacheObject[uniqueRequestIdCompleteFieldName] !== checkUniqueRequestId
-  ) {
-    return false;
-  } else {
-    return true;
-  }
+  return cacheObject[uniqueRequestIdCompleteFieldName] === checkUniqueRequestId;
 }
 
 //====================================== end Multiple Lambda Invocations (Logic pagination of handling results)
@@ -492,17 +444,16 @@ export function validateStartKeyParam(
     );
   }
 
-  if (startKey && Object.keys(startKey).length != 0) {
+  if (startKey && Object.keys(startKey).length !== 0) {
     if (!startKey[partitionKeyFieldName] || !startKey[sortKeyFieldName]) {
       throw new NoRetryError(
         'validateStartKeyParam: Invalid startKey, missing partitionKeyFieldName or sortKeyFieldName'
       );
     }
-  } else {
-    startKey = null; // if empty set to null so lib functions process correctly
+    return startKey;
   }
 
-  return startKey;
+  return null;
 }
 
 /**