@izara_project/izara-core-library-asynchronous-flow 1.0.40 → 1.0.42

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.40",
+  "version": "1.0.42",
   "description": "Shared asynchronous flow logic",
   "type": "module",
   "main": "index.js",

package/src/asyncFlowSharedLib.js

@@ -28,11 +28,48 @@ import { sqs } from '@izara_project/izara-core-library-external-request';
 
 import { identifierUuid } from '@izara_project/izara-shared-core';
 
+/**
+ * Helper to safely join a prefix and an ID with a single underscore.
+ * Ensures no duplicate underscores between them.
+ * @param {string} id
+ * @param {string} [prefix='']
+ * @returns {string}
+ */
+function _joinPrefixAndId(id, prefix = '') {
+  if (!prefix) return id;
+
+  const cleanPrefix = prefix.endsWith('_') ? prefix.slice(0, -1) : prefix;
+  const cleanId = id.startsWith('_') ? id.slice(1) : id;
+
+  return `${cleanPrefix}_${cleanId}`;
+}
+
+/**
+ * Create awaitingStepId by concatenating prefix and partitionKey.
+ * If prefix ends with an underscore, it's removed before concatenation.
+ * If partitionKey starts with an underscore, it's removed before concatenation.
+ * This ensures a clean "PREFIX_PARTITIONKEY" format without double underscores.
+ *
+ * @param {string} partitionKey
+ * @param {string} [prefix='']
+ * @returns {string}
+ */
 function createAwaitingStepId(partitionKey, prefix = '') {
-  return prefix + partitionKey;
+  return _joinPrefixAndId(partitionKey, prefix);
 }
+
+/**
+ * Create pendingStepId by concatenating prefix and identifierId.
+ * If prefix ends with an underscore, it's removed before concatenation.
+ * If identifierId starts with an underscore, it's removed before concatenation.
+ * This ensures a clean "PREFIX_IDENTIFIER" format without double underscores.
+ *
+ * @param {string} identifierId
+ * @param {string} [prefix='']
+ * @returns {string}
+ */
 function createPendingStepId(identifierId, prefix = '') {
-  return prefix + identifierId;
+  return _joinPrefixAndId(identifierId, prefix);
 }
 
 /**
@@ -76,7 +113,7 @@ function createConcatenatedPendingStepId(parentId, childId) {
  * @returns {string} The parent Flow Id created.
  */
 function createParentFlowId(prefix = '') {
-  return (prefix ? `${prefix}_` : '') + identifierUuid();
+  return _joinPrefixAndId(identifierUuid(), prefix);
 }
 
 /**

package/src/awaitingMultipleSteps.js

@@ -19,7 +19,10 @@ 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 { createParentFlowId } from './asyncFlowSharedLib.js';
+import {
+  createParentFlowId,
+  createPendingStepId
+} from './asyncFlowSharedLib.js';
 
 function _assertPendingStepId(pendingStepId) {
   if (!pendingStepId) {
@@ -97,15 +100,18 @@ async function _queryAwaitingStepsByPendingStepId(_izContext, pendingStepId) {
  * @async
  * @param {IzContext} _izContext - The Izara context.
  * @param {string} pendingStepId - The ID of the pending step that is waiting.
- * @param {Array<object>} [records=[]] - Array of step items containing awaitingStepId and optional attributes.
+ * @param {Array<object>} [records=[]] - Array of step items.
+ * @param {string} [records[].awaitingStepId] - Optional ID of the awaiting step. If not provided, a random UUID will be generated.
+ * @param {object} [records[].message] - Optional message payload to publish if flowType is provided.
+ * @param {object} [records[].flowType] - Optional flowType override for this specific step record.
+ * @param {string} records[].flowType.flowTag - Tag identifying the flow.
+ * @param {string} records[].flowType.serviceTag - Tag identifying the service.
  * @param {object} [options={}] - Optional configurations.
  * @param {string} [options.prefix=''] - Prefix to prepend to pendingStepId.
- * @param {object} [options.additionalAttributes={}] - Additional attributes to associate with each pending step record.
- * @param {object} [options.publishConfig=null] - SQS/SNS publish configuration if starting external tasks.
- * @param {Array<object>} options.publishConfig.messages - Messages to publish.
- * @param {object} options.publishConfig.flowType - Flow schema/service metadata.
- * @param {string} options.publishConfig.flowType.flowTag - Tag identifying the flow.
- * @param {string} options.publishConfig.flowType.serviceTag - Tag identifying the service.
+ * @param {object} [options.additionalAttributes={}] - Default additional attributes to associate with each pending step record.
+ * @param {object|null} [options.flowType=null] - Default flow schema/service metadata if starting external tasks.
+ * @param {string} [options.flowType.flowTag] - Tag identifying the default flow.
+ * @param {string} [options.flowType.serviceTag] - Tag identifying the default service.
  * @returns {Promise<string|undefined>} The awaitingStepId of the first mapped record.
  */
 export async function createAwaitingMultipleSteps(
@@ -114,30 +120,20 @@ export async function createAwaitingMultipleSteps(
   records = [],
   options = {}
 ) {
-  const {
-    prefix = '',
-    additionalAttributes = {},
-    publishConfig = null
-  } = options;
+  const { prefix = '', additionalAttributes = {}, flowType = null } = options;
 
   _izContext.logger.debug('[Lib:AsyncFlow:createAwaitingMultipleSteps] Input', {
     pendingStepId,
     options
   });
 
-  const formattedPrefix = prefix
-    ? prefix.endsWith('_')
-      ? prefix
-      : `${prefix}_`
-    : '';
-  const finalPendingStepId =
-    formattedPrefix && !pendingStepId.startsWith(formattedPrefix)
-      ? formattedPrefix + pendingStepId
-      : pendingStepId;
+  const finalPendingStepId = createPendingStepId(pendingStepId, prefix);
+
+  const hasFlowPublish = flowType || records.some(r => r.flowType);
 
   let finalRecords = records;
 
-  if (finalRecords.length === 0 && !publishConfig) {
+  if (finalRecords.length === 0 && !hasFlowPublish) {
     finalRecords = [
       {
         awaitingStepId: createParentFlowId(prefix),
@@ -146,28 +142,34 @@ export async function createAwaitingMultipleSteps(
     ];
   }
 
-  if (publishConfig) {
-    const { messages, flowType = {} } = publishConfig;
-    const { flowTag, serviceTag } = flowType;
-
-    if (!Array.isArray(messages)) {
-      throw new NoRetryError('messages must be an array');
-    }
-
-    if (!flowTag || !serviceTag) {
-      throw new NoRetryError('flowType must both flowTag serviceTag');
-    }
-
-    finalRecords = messages.map(message => {
-      const parentFlowId = createParentFlowId(prefix);
+  if (hasFlowPublish) {
+    finalRecords = records.map(record => {
+      const recordFlowType = record.flowType || flowType;
+
+      if (
+        !recordFlowType ||
+        !recordFlowType.flowTag ||
+        !recordFlowType.serviceTag
+      ) {
+        throw new NoRetryError(
+          'record.flowType must have both flowTag and serviceTag'
+        );
+      }
 
+      const awaitingStepId =
+        record.awaitingStepId || createParentFlowId(prefix);
       return {
-        awaitingStepId: parentFlowId,
+        awaitingStepId,
         additionalAttributes,
         message: {
-          ...message,
-          parentFlowId
-        }
+          ...record.message,
+          parentFlowId: awaitingStepId
+        },
+        topicArn: snsSharedLib.snsTopicArnByFlowSchema(
+          _izContext,
+          recordFlowType.flowTag,
+          recordFlowType.serviceTag
+        )
       };
     });
   }
@@ -194,19 +196,12 @@ export async function createAwaitingMultipleSteps(
     }
   );
 
-  if (publishConfig) {
-    const topicArn = snsSharedLib.snsTopicArnByFlowSchema(
-      _izContext,
-      publishConfig.flowType.flowTag,
-      publishConfig.flowType.serviceTag
-    );
-
+  if (hasFlowPublish) {
     await Promise.all(
-      finalRecords.map(({ message }) =>
+      finalRecords.map(({ message, topicArn }) =>
         sns.publishAsync(_izContext, {
           TopicArn: `${topicArn}_In`,
-          Message: JSON.stringify(message),
-          MessageAttributes: {}
+          Message: JSON.stringify(message)
         })
       )
     );
@@ -387,7 +382,8 @@ export async function checkAllAwaitingStepsFinishedWithReturnParams(
       isComplete: false,
       collectedAttributes: null,
       collectedErrors: [],
-      returnValues: null
+      returnValues: null,
+      additionalAttributes: awaitingStepItems[0]?.additionalAttributes || null
     };
   }