@izara_project/izara-core-library-asynchronous-flow 1.0.5 → 1.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@izara_project/izara-core-library-asynchronous-flow",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Shared asynchronous flow logic",
   "main": "index.js",
   "scripts": {

package/src/AsyncFlowSharedLib.js

@@ -28,46 +28,46 @@ const sqsSharedLib = require('@izara_project/izara-core-library-sqs');
 // External service interactions
 const { sqs } = require('@izara_project/izara-core-library-external-request');
 
-module.exports.createFieldNameUniqueRequestId = (
+function createFieldNameUniqueRequestId(
   prefix,
   uniqueRequestIdFieldName = 'UniqueRequestId'
-) => {
+) {
   return prefix + uniqueRequestIdFieldName;
 }
 
-module.exports.createConcatenatedAwaitingStepId = (
+function createConcatenatedAwaitingStepId(
   partitionKey,
   sortId,
   prefix = ""
-) => {
+) {
   return prefix + partitionKey + "_" + sortId
 }
 
-module.exports.createConcatenatedPendingStepId = (
+function createConcatenatedPendingStepId(
   parentId,
   childId
-) => {
+) {
   return parentId + "_" + childId
 }
 
-module.exports.createAwaitingStepId = (
+function createAwaitingStepId(
   partitionKey,
   prefix = ""
-) => {
+) {
   return prefix + partitionKey
 }
 
-module.exports.createPendingStepId = (
+function createPendingStepId(
   identifierId,
   prefix = ""
-) => {
+) {
   return prefix + identifierId
 }
 
-module.exports.explodePendingStepId = (
+function explodePendingStepId(
   pendingStepId,
   prefix = ""
-) => {
+) {
   if (prefix === "") {
     return pendingStepId;
   } else {
@@ -84,10 +84,10 @@ module.exports.explodePendingStepId = (
 }
 
 // copy from izara-core-library-trigger-cache
-module.exports.createFieldNameCacheComplete = (prefix = 'cache') => { // timeStamp
+function createFieldNameCacheComplete(prefix = 'cache') {
   return prefix + 'CacheComplete';
 }
-module.exports.createFieldNameStatus = (prefix = 'cache') => {
+function createFieldNameStatus(prefix = 'cache') {
   return prefix + 'Status';
 }
 
@@ -98,13 +98,13 @@ module.exports.createFieldNameStatus = (prefix = 'cache') => {
 // logic can prepend any prefix to awaitingStepId if want to be share one table and differentiate different external step ids
 
 //not yet used ?
-module.exports.createAwaitingMultipleStepsWithAdditionalAttributes = async (
+async function createAwaitingMultipleStepsWithAdditionalAttributes(
   _izContext,
   records, // array of object including properties: awaitingStepId / (optional) additionalAttributes
   pendingStepId,
   tableName = "AwaitingMultipleSteps",
   byPendingTableName = "AwaitingMultipleStepByPending"
-) => {
+) {
   _izContext.logger.debug("Lib:createAwaitingMultipleStepsWithAdditionalAttributes", {
     records: records,
     pendingStepId: pendingStepId,
@@ -146,13 +146,13 @@ module.exports.createAwaitingMultipleStepsWithAdditionalAttributes = async (
 
 }
 
-module.exports.createAwaitingMultipleSteps = async (
+async function createAwaitingMultipleSteps(
   _izContext,
   records, // array of awaitingStepIds
   pendingStepId,
   tableName = "AwaitingMultipleSteps",
   byPendingTableName = "AwaitingMultipleStepByPending"
-) => {
+) {
   _izContext.logger.debug("Lib:createAwaitingMultipleSteps", {
     records: records,
     pendingStepId: pendingStepId,
@@ -201,13 +201,13 @@ module.exports.createAwaitingMultipleSteps = async (
 // One awaitingStepId can have multiple pendingStepIds that are awaiting it
 // logic can prepend any prefix to awaitingStepId if want to be share one table and differentiate different external step ids
 
-module.exports.createAwaitingStep = async (
+async function createAwaitingStep(
   _izContext,
   awaitingStepId,
   pendingStepId,
   tableName = "AwaitingStep",
   additionalAttributes = {} // save in top level
-) => {
+) {
 
   let attributesWhenCreate = {
     awaitingStepId: awaitingStepId,
@@ -230,11 +230,11 @@ module.exports.createAwaitingStep = async (
 
 
 
-module.exports.findPendingStepIdsAwaitingStep = async (
+async function findPendingStepIdsAwaitingStep(
   _izContext,
   awaitingStepId,
   tableName = "AwaitingStep"
-) => {
+) {
 
   let pendingStepIds = [];
 
@@ -253,11 +253,11 @@ module.exports.findPendingStepIdsAwaitingStep = async (
   return pendingStepIds
 }
 
-module.exports.findPendingStepsAwaitingStep = async (
+async function findPendingStepsAwaitingStep(
   _izContext,
   awaitingStepId,
   tableName = "AwaitingStep"
-) => {
+) {
 
   let listPendingSteps = await dynamodbSharedLib.query(
     _izContext,
@@ -272,14 +272,14 @@ module.exports.findPendingStepsAwaitingStep = async (
 
 
 
-module.exports.checkAllAwaitingStepsFinished = async (
+async function checkAllAwaitingStepsFinished(
   _izContext,
   pendingStepId,
   currentAwaitingStepId = null,
   tableName = 'AwaitingMultipleSteps',
   byPendingTableName = "AwaitingMultipleStepByPending"
   // indexName = ''
-) => {
+) {
   _izContext.logger.debug("Lib:checkAllAwaitingStepsFinished", {
     pendingStepId: pendingStepId,
     currentAwaitingStepId: currentAwaitingStepId,
@@ -384,12 +384,12 @@ module.exports.checkAllAwaitingStepsFinished = async (
   // return true;
 }
 
-module.exports.clearAllAwaitingSteps = async (
+async function clearAllAwaitingSteps(
   _izContext,
   pendingStepId,
   tableName = 'AwaitingMultipleSteps',
   byPendingTableName = "AwaitingMultipleStepByPending"
-) => {
+) {
   _izContext.logger.debug("Lib:clearAllAwaitingSteps", {
     pendingStepId: pendingStepId,
     tableName: tableName,
@@ -442,12 +442,12 @@ module.exports.clearAllAwaitingSteps = async (
 }
 
 
-module.exports.removeAwaitingStep = async (
+async function removeAwaitingStep(
   _izContext,
   awaitingStepId,
   pendingStepId,
   tableName = "AwaitingStep"
-) => {
+) {
 
   await dynamodbSharedLib.deleteItem(
     _izContext,
@@ -459,13 +459,13 @@ module.exports.removeAwaitingStep = async (
   );
 }
 
-module.exports.removeAwaitingMultipleStep = async (
+async function removeAwaitingMultipleStep(
   _izContext,
   awaitingStepId,
   pendingStepId,
   tableName = "AwaitingMultipleSteps",
   byPendingTableName = "AwaitingMultipleStepByPending"
-) => {
+) {
   _izContext.logger.debug("Lib:removeAwaitingMultipleStep", {
     awaitingStepId: awaitingStepId,
     pendingStepId: pendingStepId,
@@ -502,14 +502,14 @@ module.exports.removeAwaitingMultipleStep = async (
 }
 
 // only works with AwaitingStep, does not work with AwaitingMultipleSteps, need to make new function that checks conditional pass? If pass delete from byPending table too
-module.exports.removeAwaitingStepWithCheckUniqueRequestId = async (
+async function removeAwaitingStepWithCheckUniqueRequestId(
   _izContext,
   awaitingStepId,
   pendingStepId,
   checkUniqueRequestId,
   prefix = "",
   tableName = "AwaitingStep"
-) => {
+) {
 
   // if logicalElements add queryElements.logicalElements
   // set condition uniqueRequestId match with exists
@@ -561,14 +561,14 @@ module.exports.removeAwaitingStepWithCheckUniqueRequestId = async (
 
  * @returns [string] [returnStatus, existingRecord]
  */
-module.exports.checkUniqueRequestProcessing = async (
+async function checkUniqueRequestProcessing(
   _izContext,
   tableName,
   primaryKey,
   prefix = '',
   overwriteUniqueRequestId = null,
   uniqueRequestIdFieldName = "UniqueRequestId" // if set will check/add this fieldname with _izContext.uniqueRequestId value
-) => {
+) {
   try {
 
     _izContext.logger.debug('current uniqueRequestId:', _izContext.uniqueRequestId)
@@ -666,13 +666,13 @@ module.exports.checkUniqueRequestProcessing = async (
 };
 
 // ----- Helper funtion, common use case in triggerFlow ---------
-module.exports.checkTimeCacheComplete = async (
+async function checkTimeCacheComplete(
   _izContext,
   fullMainTableName,
   keyValues,
   timeCacheComplete,
   prefix
-) => {
+) {
   let [returnValue, newTimeCacheComplete, uniqueRequestId] = await this.checkAndGetTimeCacheComplete(
     _izContext,
     fullMainTableName,
@@ -682,13 +682,13 @@ module.exports.checkTimeCacheComplete = async (
   );
   return [returnValue, uniqueRequestId];
 }
-module.exports.checkAndGetTimeCacheComplete = async (
+async function checkAndGetTimeCacheComplete(
   _izContext,
   fullMainTableName,
   keyValues,
   timeCacheComplete,
   prefix
-) => {
+) {
   _izContext.logger.debug('event checkTimeCacheComplete', {
     fullMainTableName: fullMainTableName,
     keyValues: keyValues,
@@ -734,13 +734,13 @@ module.exports.checkAndGetTimeCacheComplete = async (
 
 
 // ----- shared both stored cache and triggered cache, check uniqueRequestId changed ---------
-module.exports.checkCacheUniqueRequestId = async (
+async function checkCacheUniqueRequestId(
   _izContext,
   fullMainTableName,
   keyValues,
   checkUniqueRequestId,
   uniqueRequestIdCompleteFieldName
-) => {
+) {
 
   let cacheObject = await dynamodbSharedLib.getItem(
     _izContext,
@@ -813,38 +813,41 @@ module.exports.checkCacheUniqueRequestId = async (
 
 //====================================== end Multiple Lambda Invocations (Logic pagination of handling results)
 
-module.exports.validateStartKeyParam = (
+function validateStartKeyParam(
   _izContext,
   startKey,
   partitionKeyFieldName,
-  sortKeyFieldName = null
-) => {
+  sortKeyFieldName
+) {
+  const stringNotEmptyRegex = /^[A-Za-z0-9_-]+$/;
+
+  if (
+    !partitionKeyFieldName || !sortKeyFieldName
+    || !stringNotEmptyRegex.test(partitionKeyFieldName)
+    || !stringNotEmptyRegex.test(sortKeyFieldName)
+  ) {
+    throw new NoRetryError("validateStartKeyParam: Invalid partitionKeyFieldName or sortKeyFieldName");
+  }
 
   if (startKey && Object.keys(startKey).length != 0) {
-    if (
-      startKey.constructor !== Object ||
-      !startKey[partitionKeyFieldName]
-    ) {
-      startKey = false; // we can type check for false to see if invalid
-    }
-    if (sortKeyFieldName !== null && sortKeyFieldName !== undefined && !startKey[sortKeyFieldName]) {
-      startKey = false;
+    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 (not want empty object)
+    startKey = null; // if empty set to null so lib functions process correctly
   }
 
   return startKey;
 }
 
 
-module.exports.validateMultipleInvocations = async (
+async function validateMultipleInvocations(
   _izContext,
   messageProperty,
   passOnStartKey = {},
   numberInvocation,
   queueName
-) => {
+) {
   _izContext.logger.debug("Lib:validateMultipleInvocations", {
     messageProperty: messageProperty,
     passOnStartKey: passOnStartKey,
@@ -877,3 +880,41 @@ module.exports.validateMultipleInvocations = async (
     throw (err)
   }
 }
+
+module.exports = {
+  // Helper functions
+  createFieldNameUniqueRequestId,
+  createConcatenatedAwaitingStepId,
+  createConcatenatedPendingStepId,
+  createAwaitingStepId,
+  createPendingStepId,
+  explodePendingStepId,
+  createFieldNameCacheComplete,
+  createFieldNameStatus,
+
+  // AwaitingMultipleSteps functions
+  createAwaitingMultipleStepsWithAdditionalAttributes,
+  createAwaitingMultipleSteps,
+  checkAllAwaitingStepsFinished,
+  clearAllAwaitingSteps,
+  removeAwaitingMultipleStep,
+
+  // AwaitingStep functions
+  createAwaitingStep,
+  findPendingStepIdsAwaitingStep,
+  findPendingStepsAwaitingStep,
+  removeAwaitingStep,
+  removeAwaitingStepWithCheckUniqueRequestId,
+
+  // Unique Request Processing functions
+  checkUniqueRequestProcessing,
+
+  // Cache functions
+  checkTimeCacheComplete,
+  checkAndGetTimeCacheComplete,
+  checkCacheUniqueRequestId,
+
+  // Validation functions
+  validateStartKeyParam,
+  validateMultipleInvocations
+};