@izara_project/izara-core-library-asynchronous-flow 1.0.30 → 1.0.32

package/index.js

@@ -15,14 +15,91 @@ 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/>.
 */
 
-// Import the Asynchronous Flow shared library functions
-import * as asyncFlowSharedLib from './src/asyncFlowSharedLib.js';
-import * as awaitingStep from './src/awaitingStep.js';
-import * as awaitingMultipleSteps from './src/awaitingMultipleSteps.js';
+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';
 
-// Combine all functions from the imported modules into a single export object.
 export default {
-  ...asyncFlowSharedLib,
-  ...awaitingStep,
-  ...awaitingMultipleSteps
+  //  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
 };

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.30",
+  "version": "1.0.32",
   "description": "Shared asynchronous flow logic",
   "type": "module",
   "main": "index.js",
@@ -28,10 +28,10 @@
     "@izara_project/izara-core-library-dynamodb": "^1.0.19",
     "@izara_project/izara-core-library-external-request": "^1.0.30",
     "@izara_project/izara-core-library-logger": "^1.0.9",
-    "@izara_project/izara-core-library-sqs": "^1.0.7"
+    "@izara_project/izara-core-library-sqs": "^1.0.7",
+    "@izara_project/izara-core-library-sns": "^1.0.8",
+    "@izara_project/izara-shared-core": "^1.0.12"
   },
   "peerDependenciesMeta": {},
-  "dependencies": {
-    "@izara_project/izara-shared-core": "^1.0.12"
-  }
+  "dependencies": {}
 }

package/src/asyncFlowSharedLib.js

@@ -26,6 +26,8 @@ import sqsSharedLib from '@izara_project/izara-core-library-sqs';
 // External service interactions
 import { sqs } from '@izara_project/izara-core-library-external-request';
 
+import { identifierUuid } from '@izara_project/izara-shared-core';
+
 /**
  * Create a field name for storing the unique-request id, with optional prefix.
  * @param {string} prefix
@@ -84,6 +86,16 @@ export function createPendingStepId(identifierId, prefix = '') {
   return prefix + identifierId;
 }
 
+/**
+ * Create parent Flow Id.
+ * @async
+ * @param {string} [prefix=''] - The prefix to prepend to the parent Ids.
+ * @returns {string} The parent Flow Id created.
+ */
+export function createParentFlowId(prefix = '') {
+  return (prefix ? `${prefix}_` : '') + identifierUuid.generate();
+}
+
 /**
  * Remove the known prefix from a pendingStepId and validate it is not equal to the prefix.
  * If prefix is empty, the original ID is returned.
@@ -183,7 +195,7 @@ export async function checkUniqueRequestProcessing(
       uniqueRequestIdFieldName
     );
 
-    //loop 3 times incase status changes, on 3rd iteration throw error (so checks 2 times)
+    //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(
@@ -202,7 +214,7 @@ export async function checkUniqueRequestProcessing(
       let returnStatus = 'process';
 
       if (!existingRecord) {
-        // return ["recordNotFound", null]; // cannot return null, js cannot found object and throw error and dont know where it is?
+        // 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
@@ -267,7 +279,7 @@ export async function checkUniqueRequestProcessing(
   }
 }
 
-// ----- Helper funtion, common use case in triggerFlow ---------
+// ----- Helper function, common use case in triggerFlow ---------
 /**
  * Convenience wrapper around checkAndGetTimeCacheComplete.
  * Returns [isSameOrUnset, uniqueRequestIdWhenComplete].
@@ -497,7 +509,7 @@ export async function validateMultipleInvocations(
       QueueUrl: await sqsSharedLib.sqsQueueUrl(_izContext, queueName)
     };
     _izContext.logger.debug(
-      `Send mesage to Dsq:${queueName} `,
+      `Send message to Dsq:${queueName} `,
       messageReInvokeFunction
     );
     await sqs.sendMessage(_izContext, messageReInvokeFunction);

package/src/awaitingMultipleSteps.js

@@ -17,8 +17,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import { NoRetryError } from '@izara_project/izara-core-library-core';
 import dynamodbSharedLib from '@izara_project/izara-core-library-dynamodb';
+import { sns } from '@izara_project/izara-core-library-external-request';
+import snsSharedLib from '@izara_project/izara-core-library-sns';
 
-import { identifierUuid } from '@izara_project/izara-shared-core';
+import { createParentFlowId } from './asyncFlowSharedLib.js';
 
 //====================================== AwaitingMultipleSteps
 // AwaitingMultipleSteps is when a flow is awaiting multiple external flows before it can continue
@@ -199,73 +201,52 @@ export async function createAwaitingMultipleSteps(
  * @async
  * @param {IzContext} _izContext
  * @param {string} pendingStepId
- * @param {number} countAwaitingMultipleSteps
+ * @param {string[]} parendIds
  * @param {Object.<string, any>} [additionalAttributes={}] - Shared attributes stored for every step in AwaitingMultipleStepByPending.
  *   The same object is applied to all steps (caller cannot know the generated UUIDs beforehand).
- * @returns {Promise<string[]>} The list of awaiting step IDs created.
+ * @returns {Promise<string>} The awaiting  step ID created.
  */
-export async function createNewAwaitingMultipleSteps(
+export async function createNewAwaitingMultipleStep(
   _izContext,
   pendingStepId,
-  countAwaitingMultipleSteps,
   prefix = '',
   additionalAttributes = {}
 ) {
   _izContext.logger.debug(
-    '[Lib:AsyncFlow:createNewAwaitingMultipleSteps] Input: ',
+    '[Lib:AsyncFlow:createNewAwaitingMultipleStep] Input: ',
     {
       pendingStepId,
-      countAwaitingMultipleSteps,
       additionalAttributes
     }
   );
 
-  const parendIds = Array.from(
-    { length: countAwaitingMultipleSteps },
-    () => (prefix ? `${prefix}_` : '') + identifierUuid.generate()
-  );
-
-  const promiseArray = [];
+  const parentFlowId = createParentFlowId(prefix);
 
-  for (const parendId of parendIds) {
-    const attributesWhenCreate = {
-      awaitingStepId: parendId,
-      pendingStepId: pendingStepId,
-      complete: false,
-      errorsFound: []
-    };
-    promiseArray.push(
-      dynamodbSharedLib.putItem(
-        _izContext,
-        dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleSteps'),
-        attributesWhenCreate
-      )
-    );
-
-    const attributesForPending = {
-      ...attributesWhenCreate,
-      additionalAttributes: additionalAttributes
-    };
+  const attributesWhenCreate = {
+    awaitingStepId: parentFlowId,
+    pendingStepId: pendingStepId,
+    complete: false,
+    errorsFound: []
+  };
 
-    promiseArray.push(
-      dynamodbSharedLib.putItem(
-        _izContext,
-        dynamodbSharedLib.tableName(
-          _izContext,
-          'AwaitingMultipleStepByPending'
-        ),
-        attributesForPending
-      )
-    );
+  await dynamodbSharedLib.putItem(
+    _izContext,
+    dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleSteps'),
+    attributesWhenCreate
+  );
 
-    _izContext.logger.debug('putItem:AwaitingMultipleStepByPending', {
-      awaitingStepId: attributesWhenCreate.awaitingStepId
-    });
-  }
+  const attributesForPending = {
+    ...attributesWhenCreate,
+    additionalAttributes: additionalAttributes
+  };
 
-  await Promise.all(promiseArray);
+  await dynamodbSharedLib.putItem(
+    _izContext,
+    dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleStepByPending'),
+    attributesForPending
+  );
 
-  return parendIds;
+  return parentFlowId;
 }
 
 /**
@@ -653,3 +634,58 @@ export async function removeAwaitingMultipleStep(
   }
   await Promise.all(promiseArray);
 }
+
+export async function createAwaitingMultipleStepsWithAdditionalAttributesAndPublish(
+  _izContext,
+  messages,
+  flowType = {},
+  additionalAttributes = {},
+  pendingStepId
+) {
+  if (!Array.isArray(messages)) {
+    throw new Error('messages must be an array');
+  }
+
+  const flowTag = flowType.flowTag;
+  const serviceTag = flowType.serviceTag;
+
+  if (flowTag === undefined || serviceTag === undefined) {
+    throw new Error('flowType must have both flowTag and serviceTag');
+  }
+
+  _izContext.logger.debug(
+    'Lib:createAwaitingMultipleStepsWithAdditionalAttributesAndPublish',
+    { count: messages.length, pendingStepId, flowType }
+  );
+
+  const topicArn = snsSharedLib.snsTopicArn(
+    _izContext,
+    flowType.flowTag,
+    flowType.serviceTag ?? null
+  );
+
+  const messagesWithParentId = await Promise.all(
+    messages.map(async message => {
+      const parentFlowId = await createNewAwaitingMultipleStep(
+        _izContext,
+        pendingStepId,
+        `${flowTag}${serviceTag}`,
+        additionalAttributes
+      );
+      return {
+        ...message,
+        parentFlowId
+      };
+    })
+  );
+
+  await Promise.all(
+    messagesWithParentId.map(message =>
+      sns.publishAsync(_izContext, {
+        TopicArn: topicArn,
+        Message: JSON.stringify(message),
+        MessageAttributes: {}
+      })
+    )
+  );
+}