aws-local-stepfunctions 1.2.0 → 1.3.1

package/build/main.d.ts

@@ -15,15 +15,15 @@ type JSONObject = {
 };
 type JSONValue = JSONPrimitiveValue | JSONObject | JSONArray;
 
-type PayloadTemplate = JSONObject;
+type PayloadTemplate = JSONObject | JSONArray;
 interface CanHaveInputPath {
     InputPath?: string | null;
 }
 interface CanHaveParameters {
-    Parameters?: PayloadTemplate;
+    Parameters?: JSONValue;
 }
 interface CanHaveResultSelector {
-    ResultSelector?: PayloadTemplate;
+    ResultSelector?: JSONValue;
 }
 interface CanHaveResultPath {
     ResultPath?: string | null;
@@ -189,7 +189,15 @@ interface StateMachineDefinition {
     TimeoutSeconds?: number;
 }
 
-type Context = Record<string, unknown>;
+type ContextExecution = {
+    Input?: JSONValue;
+    StartTime?: string;
+    [other: string]: unknown;
+};
+type Context = {
+    Execution?: ContextExecution;
+    [other: string]: unknown;
+};
 
 declare class ErrorWithCause extends Error {
     #private;
@@ -332,6 +340,9 @@ type TaskStateResourceLocalHandler = {
 type WaitStateTimeOverride = {
     [waitStateName: string]: number;
 };
+type RetryIntervalOverrides = {
+    [retryableStateName: string]: number | number[];
+};
 interface Overrides {
     /**
      * Pass an object to this option to override a `Task` state to run a local function,
@@ -343,6 +354,11 @@ interface Overrides {
      * instead of pausing for the duration specified by the `Seconds`, `Timestamp`, `SecondsPath`, or `TimestampPath` fields.
      */
     waitTimeOverrides?: WaitStateTimeOverride;
+    /**
+     * Pass an object to this option to override the duration in milliseconds a retrier in a `Retry` field waits before retrying the state,
+     * instead of pausing for the duration calculated by the `IntervalSeconds`, `BackoffRate`, `MaxDelaySeconds`, and `JitterStrategy` fields.
+     */
+    retryIntervalOverrides?: RetryIntervalOverrides;
 }
 interface ValidationOptions {
     /**

package/build/main.node.cjs

@@ -135,6 +135,8 @@ function isPlainObj(value) {
   return !!value && Object.getPrototypeOf(value) === Object.prototype;
 }
 function sleep(ms, abortSignal) {
+  if (ms === 0)
+    return;
   return new Promise((resolve) => {
     if (abortSignal?.aborted) {
       return resolve();
@@ -913,9 +915,18 @@ function processInputPath(path, input, context) {
   return jsonPathQuery(path, input, context);
 }
 function processPayloadTemplate(payloadTemplate, json, context) {
+  if (typeof payloadTemplate !== "object" || payloadTemplate === null) {
+    return payloadTemplate;
+  }
+  if (Array.isArray(payloadTemplate)) {
+    return payloadTemplate.map((value) => processPayloadTemplate(value, json, context));
+  }
   const resolvedProperties = Object.entries(payloadTemplate).map(([key, value]) => {
     let sanitizedKey = key;
     let resolvedValue = value;
+    if (Array.isArray(value)) {
+      resolvedValue = value.map((innerValue) => processPayloadTemplate(innerValue, json, context));
+    }
     if (isPlainObj(value)) {
       resolvedValue = processPayloadTemplate(value, json, context);
     }
@@ -1719,7 +1730,10 @@ var StateExecutor = class {
         input,
         error
       );
-      const { shouldRetry, waitTimeBeforeRetry, retrierIndex } = this.shouldRetry(error);
+      const { shouldRetry, waitTimeBeforeRetry, retrierIndex } = this.shouldRetry(
+        error,
+        options.runOptions?.overrides?.retryIntervalOverrides
+      );
       if (shouldRetry) {
         const stateDefinition = this.stateDefinition;
         await sleep(waitTimeBeforeRetry, options.abortSignal);
@@ -1778,20 +1792,29 @@ var StateExecutor = class {
   /**
    * Decide whether this state should be retried, according to the `Retry` field.
    */
-  shouldRetry(error) {
+  shouldRetry(error, retryIntervalOverrides) {
     if (!("Retry" in this.stateDefinition)) {
       return { shouldRetry: false };
     }
     for (let i = 0; i < this.stateDefinition.Retry.length; i++) {
       const retrier = this.stateDefinition.Retry[i];
+      let intervalOverride = null;
+      if (retryIntervalOverrides?.[this.stateName] !== void 0) {
+        const override = retryIntervalOverrides[this.stateName];
+        if (typeof override === "number") {
+          intervalOverride = override / 1e3;
+        } else if (override[i] !== void 0 && override[i] >= 0) {
+          intervalOverride = override[i] / 1e3;
+        }
+      }
       const jitterStrategy = retrier.JitterStrategy ?? DEFAULT_JITTER_STRATEGY;
       const maxAttempts = retrier.MaxAttempts ?? DEFAULT_MAX_ATTEMPTS;
       const intervalSeconds = retrier.IntervalSeconds ?? DEFAULT_INTERVAL_SECONDS;
       const backoffRate = retrier.BackoffRate ?? DEFAULT_BACKOFF_RATE;
-      const waitInterval = intervalSeconds * Math.pow(backoffRate, this.retrierAttempts[i]);
+      const waitInterval = intervalOverride ?? intervalSeconds * Math.pow(backoffRate, this.retrierAttempts[i]);
       const retryable = error.isRetryable ?? true;
-      let waitTimeBeforeRetry = clamp(waitInterval, 1, retrier.MaxDelaySeconds) * 1e3;
-      if (jitterStrategy === "FULL") {
+      let waitTimeBeforeRetry = clamp(waitInterval, 0, retrier.MaxDelaySeconds) * 1e3;
+      if (jitterStrategy === "FULL" && intervalOverride === null) {
         waitTimeBeforeRetry = getRandomNumber(0, waitTimeBeforeRetry);
       }
       for (const retrierError of retrier.ErrorEquals) {
@@ -2264,7 +2287,14 @@ var StateMachine = class {
    */
   async execute(input, options, cleanupFn) {
     options.eventLogger.dispatchExecutionStartedEvent(input);
-    const context = options.runOptions?.context ?? {};
+    const context = {
+      ...options.runOptions?.context,
+      Execution: {
+        ...options.runOptions?.context?.Execution,
+        Input: input,
+        StartTime: (/* @__PURE__ */ new Date()).toISOString()
+      }
+    };
     let currState = this.definition.States[this.definition.StartAt];
     let currStateName = this.definition.StartAt;
     let currInput = (0, import_cloneDeep3.default)(input);

package/build/main.node.esm.js

@@ -97,6 +97,8 @@ function isPlainObj(value) {
   return !!value && Object.getPrototypeOf(value) === Object.prototype;
 }
 function sleep(ms, abortSignal) {
+  if (ms === 0)
+    return;
   return new Promise((resolve) => {
     if (abortSignal?.aborted) {
       return resolve();
@@ -875,9 +877,18 @@ function processInputPath(path, input, context) {
   return jsonPathQuery(path, input, context);
 }
 function processPayloadTemplate(payloadTemplate, json, context) {
+  if (typeof payloadTemplate !== "object" || payloadTemplate === null) {
+    return payloadTemplate;
+  }
+  if (Array.isArray(payloadTemplate)) {
+    return payloadTemplate.map((value) => processPayloadTemplate(value, json, context));
+  }
   const resolvedProperties = Object.entries(payloadTemplate).map(([key, value]) => {
     let sanitizedKey = key;
     let resolvedValue = value;
+    if (Array.isArray(value)) {
+      resolvedValue = value.map((innerValue) => processPayloadTemplate(innerValue, json, context));
+    }
     if (isPlainObj(value)) {
       resolvedValue = processPayloadTemplate(value, json, context);
     }
@@ -1681,7 +1692,10 @@ var StateExecutor = class {
         input,
         error
       );
-      const { shouldRetry, waitTimeBeforeRetry, retrierIndex } = this.shouldRetry(error);
+      const { shouldRetry, waitTimeBeforeRetry, retrierIndex } = this.shouldRetry(
+        error,
+        options.runOptions?.overrides?.retryIntervalOverrides
+      );
       if (shouldRetry) {
         const stateDefinition = this.stateDefinition;
         await sleep(waitTimeBeforeRetry, options.abortSignal);
@@ -1740,20 +1754,29 @@ var StateExecutor = class {
   /**
    * Decide whether this state should be retried, according to the `Retry` field.
    */
-  shouldRetry(error) {
+  shouldRetry(error, retryIntervalOverrides) {
     if (!("Retry" in this.stateDefinition)) {
       return { shouldRetry: false };
     }
     for (let i = 0; i < this.stateDefinition.Retry.length; i++) {
       const retrier = this.stateDefinition.Retry[i];
+      let intervalOverride = null;
+      if (retryIntervalOverrides?.[this.stateName] !== void 0) {
+        const override = retryIntervalOverrides[this.stateName];
+        if (typeof override === "number") {
+          intervalOverride = override / 1e3;
+        } else if (override[i] !== void 0 && override[i] >= 0) {
+          intervalOverride = override[i] / 1e3;
+        }
+      }
       const jitterStrategy = retrier.JitterStrategy ?? DEFAULT_JITTER_STRATEGY;
       const maxAttempts = retrier.MaxAttempts ?? DEFAULT_MAX_ATTEMPTS;
       const intervalSeconds = retrier.IntervalSeconds ?? DEFAULT_INTERVAL_SECONDS;
       const backoffRate = retrier.BackoffRate ?? DEFAULT_BACKOFF_RATE;
-      const waitInterval = intervalSeconds * Math.pow(backoffRate, this.retrierAttempts[i]);
+      const waitInterval = intervalOverride ?? intervalSeconds * Math.pow(backoffRate, this.retrierAttempts[i]);
       const retryable = error.isRetryable ?? true;
-      let waitTimeBeforeRetry = clamp(waitInterval, 1, retrier.MaxDelaySeconds) * 1e3;
-      if (jitterStrategy === "FULL") {
+      let waitTimeBeforeRetry = clamp(waitInterval, 0, retrier.MaxDelaySeconds) * 1e3;
+      if (jitterStrategy === "FULL" && intervalOverride === null) {
         waitTimeBeforeRetry = getRandomNumber(0, waitTimeBeforeRetry);
       }
       for (const retrierError of retrier.ErrorEquals) {
@@ -2226,7 +2249,14 @@ var StateMachine = class {
    */
   async execute(input, options, cleanupFn) {
     options.eventLogger.dispatchExecutionStartedEvent(input);
-    const context = options.runOptions?.context ?? {};
+    const context = {
+      ...options.runOptions?.context,
+      Execution: {
+        ...options.runOptions?.context?.Execution,
+        Input: input,
+        StartTime: (/* @__PURE__ */ new Date()).toISOString()
+      }
+    };
     let currState = this.definition.States[this.definition.StartAt];
     let currStateName = this.definition.StartAt;
     let currInput = cloneDeep3(input);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aws-local-stepfunctions",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Execute an AWS Step Function state machine locally",
   "keywords": [
     "aws",
@@ -54,13 +54,13 @@
   "devDependencies": {
     "@tsconfig/node16-strictest": "^1.0.4",
     "@types/crypto-js": "^4.2.1",
-    "@types/jest": "^29.5.8",
-    "@types/lodash": "^4.14.201",
-    "@types/node": "^18.18.9",
+    "@types/jest": "^29.5.11",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^18.19.3",
     "@types/picomatch": "^2.3.3",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "eslint": "^8.53.0",
+    "eslint": "^8.56.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-prettier": "^4.2.1",
     "prettier": "^2.8.8",
@@ -69,8 +69,8 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@aws-sdk/client-lambda": "^3.450.0",
-    "@aws-sdk/credential-providers": "^3.450.0",
+    "@aws-sdk/client-lambda": "^3.481.0",
+    "@aws-sdk/credential-providers": "^3.481.0",
     "asl-validator": "^3.8.2",
     "commander": "^11.1.0",
     "crypto-js": "^4.2.0",