@izara_project/izara-core-library-asynchronous-flow 1.0.25 → 1.0.28

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

package/src/awaitingMultipleSteps.js

@@ -300,17 +300,7 @@ export async function findAwaitingMultipleStepByPending(
   return listAwaitingSteps.Items;
 }
 
-/**
- * Same as checkAllAwaitingStepsFinished but writes errors/additionalAttributes to the *_ByPending row.
- * @async
- * @param {IzContext} _izContext
- * @param {string} pendingStepId
- * @param {string|null} [currentAwaitingStepId=null]
- * @param {any[]} [errorsFound=[]]
- * @param {Attrs} [additionalAttributes={}]
- * @returns {Promise<boolean>}
- */
-export async function checkAllAwaitingStepsFinished(
+export async function checkAllAwaitingStepsFinishedShared(
   _izContext,
   pendingStepId,
   currentAwaitingStepId = null,
@@ -338,35 +328,114 @@ export async function checkAllAwaitingStepsFinished(
       }
     );
   }
-  let listPendingStepIds = await dynamodbSharedLib.query(
+}
+
+
+/**
+ * Same as checkAllAwaitingStepsFinished but writes errors/additionalAttributes to the *_ByPending row.
+ * @async
+ * @param {IzContext} _izContext
+ * @param {string} pendingStepId
+ * @param {string|null} [currentAwaitingStepId=null]
+ * @param {any[]} [errorsFound=[]]
+ * @param {Attrs} [additionalAttributes={}]
+ * @returns {Promise<boolean>}
+ */
+export async function checkAllAwaitingStepsFinished(
+  _izContext,
+  pendingStepId,
+  currentAwaitingStepId = null,
+  errorsFound = [],
+  additionalAttributes = {}
+) {
+  await checkAllAwaitingStepsFinishedShared(
+    _izContext,
+    pendingStepId,
+    currentAwaitingStepId,
+    errorsFound,
+    additionalAttributes
+  );
+
+  const items = await dynamodbSharedLib.query(
     _izContext,
     dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleStepByPending'),
-    {
-      pendingStepId: pendingStepId
-    },
-    {
-      limit: 50 // arbitrary limit so not pull too many results, need >2 because some others might be marked as "complete" = true
-    }
+    { pendingStepId },
+    { limit: 50 }
   );
-  for (let idx = 0; idx < listPendingStepIds.Items.length; idx++) {
-    // if have error found return errorsFound
-    // wrap function
-
-    if (
-      currentAwaitingStepId &&
-      listPendingStepIds.Items[idx].awaitingStepId == currentAwaitingStepId
-    ) {
-      continue;
+
+  for (const item of items.Items) {
+    if (item.awaitingStepId === currentAwaitingStepId) continue;
+    if (!item.complete) return false;
+  }
+
+  return true;
+}
+
+
+/**
+ * Checks if all awaiting steps for a pending step are complete after marking the current one as complete.
+ * If all steps are finished, it returns `true` and an object containing the `additionalAttributes` from each of the completed steps, indexed by their `awaitingStepId`.
+ * If any other step is not yet complete, it returns `[false, null]`.
+ * @async
+ * @param {IzContext} _izContext
+ * @param {string} pendingStepId
+ * @param {string|null} [currentAwaitingStepId=null] - The step that has just finished.
+ * @param {any[]} [errorsFound=[]]
+ * @param {Attrs} [additionalAttributes={}]
+ * @returns {Promise<[boolean, Record<string, any>|null]>} A tuple indicating completion status and the collected attributes, or null if not all steps are complete.
+ */
+export async function checkAllAwaitingStepsFinishedWithReturnParams(
+  _izContext,
+  pendingStepId,
+  currentAwaitingStepId = null,
+  errorsFound = [],
+  additionalAttributes = {}
+) {
+  _izContext.logger.debug('Lib:checkAllAwaitingStepsFinishedWithReturnParams', {
+    pendingStepId,
+    currentAwaitingStepId,
+    errorsFound,
+    additionalAttributes
+  });
+
+  await checkAllAwaitingStepsFinishedShared(
+    _izContext,
+    pendingStepId,
+    currentAwaitingStepId,
+    errorsFound,
+    additionalAttributes
+  );
+
+  const awaitingStepItems = await dynamodbSharedLib.query(
+    _izContext,
+    dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleStepByPending'),
+    { pendingStepId },
+    { limit: 50 }
+  );
+
+  _izContext.logger.debug('awaitingStepItems:::', awaitingStepItems);
+
+  const collectedAttributes = {};
+  const collectedErrors = [];
+
+  for (const item of awaitingStepItems.Items) {
+    if (item.awaitingStepId !== currentAwaitingStepId && !item.complete) {
+      return [false, null, collectedErrors];
+    }
+
+    if (item.errorsFound?.length > 0) {
+      collectedErrors.push(...item.errorsFound);
     }
-    // if any record found not set to complete then there are steps not yet finished
-    if (!listPendingStepIds.Items[idx].complete) {
-      return false;
+
+    if (item.additionalAttributes) {
+      collectedAttributes[item.awaitingStepId] = item.additionalAttributes;
     }
   }
 
-  return true; // all passed
+  return [true, collectedAttributes, collectedErrors];
 }
 
+
 /**
  * Remove all awaiting records for a given pendingStepId from both tables.
  * @async
@@ -487,77 +556,4 @@ export async function removeAwaitingMultipleStep(
     );
   }
   await Promise.all(promiseArray);
-}
-
-/**
- * Checks if all awaiting steps for a pending step are complete after marking the current one as complete.
- * If all steps are finished, it returns `true` and an object containing the `additionalAttributes` from each of the completed steps, keyed by their `awaitingStepId`.
- * If any other step is not yet complete, it returns `[false, null]`.
- * @async
- * @param {IzContext} _izContext
- * @param {string} pendingStepId
- * @param {string|null} [currentAwaitingStepId=null] - The step that has just finished.
- * @param {any[]} [errorsFound=[]]
- * @param {Attrs} [additionalAttributes={}]
- * @returns {Promise<[boolean, Record<string, any>|null]>} A tuple indicating completion status and the collected attributes, or null if not all steps are complete.
- */
-export async function syncAndCheckStepsCompletion(
-  _izContext,
-  pendingStepId,
-  currentAwaitingStepId = null,
-  errorsFound = [],
-  additionalAttributes = {}
-) {
-  _izContext.logger.debug(
-    'Lib:checkAllAwaitingMultipleStepsFinishedWithErrorAndReturnAdditionalAttributes',
-    {
-      pendingStepId,
-      currentAwaitingStepId,
-      errorsFound,
-      additionalAttributes
-    }
-  );
-
-  if (currentAwaitingStepId) {
-    await dynamodbSharedLib.updateItem(
-      _izContext,
-      dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleStepByPending'),
-      { pendingStepId, awaitingStepId: currentAwaitingStepId },
-      {
-        complete: true,
-        errorsFound,
-        additionalAttributes
-      }
-    );
-  }
-
-  const awaitingStepItems = await dynamodbSharedLib.query(
-    _izContext,
-    dynamodbSharedLib.tableName(_izContext, 'AwaitingMultipleStepByPending'),
-    { pendingStepId },
-    {
-      limit: 50
-    }
-  );
-
-  _izContext.logger.debug('awaitingStepItems:::', awaitingStepItems);
-
-  const collectedAttributes = {};
-  const collectedErrors = [];
-
-  for (const item of awaitingStepItems.Items) {
-    if (item.awaitingStepId !== currentAwaitingStepId && !item.complete) {
-      return [false, null, []];
-    }
-
-    if (item.errorsFound?.length > 0) {
-      collectedErrors.push(...item.errorsFound);
-    }
-
-    if (item.additionalAttributes) {
-      collectedAttributes[item.awaitingStepId] = item.additionalAttributes;
-    }
-  }
-
-  return [true, collectedAttributes, collectedErrors];
-}
+}