aws-local-stepfunctions 0.7.0 → 1.1.0

package/README.md

@@ -2,11 +2,30 @@
 
 A TypeScript implementation of the [Amazon States Language specification](https://states-language.net/spec.html).
 
-This package lets you run AWS Step Functions completely locally, both in Node.js and in the browser!
+This package lets you run AWS Step Functions state machines completely locally, both in Node.js and in the browser!
+
+<p align="left">
+  <a href="/LICENSE">
+    <img alt="Project license (MIT)" src="https://img.shields.io/github/license/nibble-4bits/aws-local-stepfunctions">
+  </a>
+  <a href="https://github.com/nibble-4bits/aws-local-stepfunctions/actions/workflows/pr-run-tests.yml">
+    <img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/nibble-4bits/aws-local-stepfunctions/pr-run-tests.yml">
+  </a>
+  <a href="https://www.npmjs.com/package/aws-local-stepfunctions">
+    <img alt="Latest npm version" src="https://img.shields.io/npm/v/aws-local-stepfunctions">
+  </a>
+  <a href="https://www.npmjs.com/package/aws-local-stepfunctions">
+    <img alt="node-lts" src="https://img.shields.io/node/v-lts/aws-local-stepfunctions">
+  </a>
+  <a href="https://www.npmjs.com/package/aws-local-stepfunctions">
+    <img alt="npm type definitions" src="https://img.shields.io/npm/types/aws-local-stepfunctions">
+  </a>
+</p>
 
 ## Table of contents
 
 - [Features](#features)
+- [Use cases](#use-cases)
 - [Installation](#installation)
 - [Importing](#importing)
   - [Node.js](#nodejs)
@@ -22,6 +41,7 @@ This package lets you run AWS Step Functions completely locally, both in Node.js
   - [Overriding Task and Wait states](#overriding-task-and-wait-states)
     - [Task state override](#task-state-override)
     - [Wait state override](#wait-state-override)
+  - [Passing a custom Context Object](#passing-a-custom-context-object)
   - [Disabling ASL validations](#disabling-asl-validations)
   - [Exit codes](#exit-codes)
 - [Examples](#examples)
@@ -31,6 +51,16 @@ This package lets you run AWS Step Functions completely locally, both in Node.js
 
 To see the list of features defined in the specification that have full support, partial support, or no support, refer to [this document](/docs/feature-support.md).
 
+## Use cases
+
+Why would you want to use this package? Below is a non-exhaustive list of use cases for `aws-local-stepfunctions`:
+
+- Testing state machines changes locally before deploying them to AWS.
+- Testing the integration between a state machine and the Lambda functions associated with it in `Task` states.
+- Debugging the code of associated Lambda functions interactively using the [`Task` state resource override feature](/docs/feature-support.md#task-state-resource-override).
+- Debugging a state machine by using the [event logs feature](/docs/feature-support.md#execution-event-logs), to better understand the transitions between states and how data flows between them.
+- Running state machines in the browser (not possible with [AWS Step Functions Local](https://docs.aws.amazon.com/step-functions/latest/dg/sfn-local.html)).
+
 ## Installation
 
 ```sh
@@ -84,6 +114,8 @@ The constructor takes the following parameters:
   - `validationOptions?`: An object that specifies how the definition should be validated.
     - `checkPaths`: If set to `false`, won't validate JSONPaths.
     - `checkArn`: If set to `false`, won't validate ARN syntax in `Task` states.
+    - `noValidate`: If set to `true`, will skip validation of the definition entirely.
+      > NOTE: Use this option at your own risk, there are no guarantees when passing an invalid or non-standard definition to the state machine. Running it might result in undefined/unsupported behavior.
   - `awsConfig?`: An object that specifies the [AWS region and credentials](/docs/feature-support.md#providing-aws-credentials-and-region-to-execute-lambda-functions-specified-in-task-states) to use when invoking a Lambda function in a `Task` state. If not set, the AWS config will be resolved based on the [credentials provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) of the AWS SDK for JavaScript V3. You don't need to use this option if you have a [shared config/credentials file](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) (for example, if you have the [AWS CLI](https://aws.amazon.com/cli/) installed) or if you use a local override for all of your `Task` states.
     - `region`: The AWS region where the Lambda functions are created.
     - `credentials`: An object that specifies which type of credentials to use.
@@ -117,10 +149,7 @@ const stateMachine = new StateMachine(machineDefinition, {
 
 ### `StateMachine.run(input[, options])`
 
-Runs the state machine with the given `input` parameter and returns an object with the following properties:
-
-- `abort`: A function that takes no parameters and doesn't return any value. If called, [aborts the execution](/docs/feature-support.md#abort-a-running-execution) and throws an `ExecutionAbortedError`, unless the `noThrowOnAbort` option is set.
-- `result`: A `Promise` that resolves with the execution result once it finishes.
+Runs the state machine with the given `input`.
 
 Each execution is independent of all others, meaning that you can concurrently call this method as many times as needed, without worrying about race conditions.
 
@@ -132,6 +161,15 @@ Each execution is independent of all others, meaning that you can concurrently c
     - `taskResourceLocalHandlers?`: An [object that overrides](/docs/feature-support.md#task-state-resource-override) the resource of the specified `Task` states to run a local function.
     - `waitTimeOverrides?`: An [object that overrides](/docs/feature-support.md#wait-state-duration-override) the wait duration of the specified `Wait` states. The specified override duration should be in milliseconds.
   - `noThrowOnAbort?`: If this option is set to `true`, aborting the execution will simply return `null` as result instead of throwing.
+  - `context?`: An object that will be used as the [Context Object](https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html) for the execution. If not passed, the Context Object will default to an empty object. This option is useful to mock the Context Object in case your definition references it in a JSONPath.
+
+#### Return value
+
+Returns an object that has the following properties:
+
+- `result`: A `Promise` that resolves with the result of the execution, if it ends successfully.
+- `abort`: A function that takes no parameters and doesn't return any value. If called, [aborts the execution](/docs/feature-support.md#abort-a-running-execution) and throws an `ExecutionAbortedError`, unless the `noThrowOnAbort` option is set.
+- `eventLogs`: An `AsyncGenerator` that [produces a log of events](/docs/feature-support.md#execution-event-logs) as the execution runs. To learn more about the events, their type, and their format, see the [following document](/docs/execution-event-logs.md).
 
 #### Basic example:
 
@@ -212,7 +250,11 @@ Note that each line of the output corresponds to the result of each input, in th
 
 ### Passing input from stdin
 
-`local-sfn` can also read the execution input from the standard input. For example, assume you have the following text file, called `inputs.txt`, and you want to pass the contents of the file as inputs to `local-sfn`:
+`local-sfn` can also read the execution input from the standard input.
+
+If the first line of stdin can be parsed as a single JSON value, then `local-sfn` will consider each line as an input. Otherwise, the entire stdin will be considered as a single JSON input.
+
+For example, assume you have the following text file, called `inputs.txt`, and you want to pass the contents of the file as inputs to `local-sfn`:
 
 ```txt
 { "num1": 1, "num2": 2 }
@@ -220,6 +262,8 @@ Note that each line of the output corresponds to the result of each input, in th
 { "num1": 5, "num2": 6 }
 ```
 
+Because the first line is parsable as JSON, `local-sfn` will process each line as a single input.
+
 You can then run the following command to pass the inputs of the text file to `local-sfn`:
 
 ```sh
@@ -232,7 +276,16 @@ Alternatively, using input redirection:
 local-sfn -f state-machine.json < inputs.txt
 ```
 
-When reading from stdin, `local-sfn` will take each line and use it as an input. Hence, to avoid any parsing errors, make sure the output of the command you're piping into `local-sfn` prints each input in a new line.
+On the other hand, assume you have this additional file, called `input.json`:
+
+```json
+{
+  "num1": 5,
+  "num2": 3
+}
+```
+
+If you pass this file as input, `local-sfn` will automatically detect that it is a single, multiline JSON value and process it as a single value.
 
 ### Overriding Task and Wait states
 
@@ -299,14 +352,58 @@ local-sfn \
 
 This command would execute the state machine, and override `Wait` states `WaitResponse` and `PauseUntilSignal` to pause the execution for 1500 and 250 milliseconds, respectively. The `Delay` state wouldn't be paused at all, since the override value is set to 0.
 
+### Passing a custom Context Object
+
+If the JSONPaths in your definition reference the Context Object, you can provide a mock Context Object by passing either the `--context` or the `--context-file` option. For example, given the following definition:
+
+```json
+{
+  "StartAt": "Get execution context data",
+  "States": {
+    "Get execution context data": {
+      "Type": "Pass",
+      "Parameters": {
+        "execId.$": "$$.Execution.Id",
+        "execName.$": "$$.Execution.Name"
+      },
+      "End": true
+    }
+  }
+}
+```
+
+And given the following `context.json` file:
+
+```json
+{
+  "Execution": {
+    "Id": "arn:aws:states:us-east-1:123456789012:execution:stateMachineName:executionName",
+    "Name": "executionName"
+  }
+}
+```
+
+You could provide the Context Object to the execution in the following manner:
+
+```sh
+local-sfn \
+  -f state-machine.json \
+  --context-file context.json \
+  '{}'
+```
+
 ### Disabling ASL validations
 
 Before attempting to run the state machine with the given inputs, the state machine definition itself is validated to check that:
 
 - JSONPath strings are valid.
 - ARNs in the `Resource` field of `Task` states are valid.
+- There are no invalid fields.
+- All states in the definition can be reached.
+
+If any of these checks fail, `local-sfn` will print the validation error and exit. To partially suppress this behavior, you can pass the `--no-jsonpath-validation` option, to suppress JSONPath validation; and the `--no-arn-validation` option, to suppress ARN validation.
 
-If any of these two checks fail, `local-sfn` will print the validation error and exit. To suppress this behavior, you can pass the `--no-jsonpath-validation` option, to suppress JSONPath validation; and the `--no-arn-validation` option, to suppress ARN validation.
+Alternatively, if you want to completely disable all validations, you can pass the `--no-validation` option. Be aware that passing this option implies no guarantees if the provided definition is invalid or contains non-standard fields: running it might result in undefined/unsupported behavior, so use at your own risk.
 
 ### Exit codes
 

package/{build → bin}/CLI.cjs

@@ -38,13 +38,14 @@ var import_readline = __toESM(require("readline"), 1);
 var import_commander = require("commander");
 
 // package.json
-var version = "0.7.0";
+var version = "1.1.0";
 
 // src/cli/ArgumentParsers.ts
 var import_fs = require("fs");
 var import_child_process = require("child_process");
 
 // src/util/index.ts
+var isBrowserEnvironment = typeof window !== "undefined" && typeof window.document !== "undefined";
 function tryJSONParse(jsonStr) {
   try {
     return JSON.parse(jsonStr);
@@ -110,6 +111,33 @@ function parseOverrideWaitOption(value, previous = {}) {
   previous[waitStateName] = Number(duration);
   return previous;
 }
+function parseContextOption(command, context) {
+  const jsonOrError = tryJSONParse(context);
+  if (jsonOrError instanceof Error) {
+    command.error(
+      `error: parsing of context object passed in option '--context <json>' failed: ${jsonOrError.message}`,
+      {
+        exitCode: 1 /* PreExecutionFailure */
+      }
+    );
+  }
+  return jsonOrError;
+}
+function parseContextFileOption(command, contextFile) {
+  let file;
+  try {
+    file = (0, import_fs.readFileSync)(contextFile).toString();
+  } catch (error) {
+    command.error(`error: ${error.message}`, { exitCode: 1 /* PreExecutionFailure */ });
+  }
+  const jsonOrError = tryJSONParse(file);
+  if (jsonOrError instanceof Error) {
+    command.error(`error: parsing of context object in file '${contextFile}' failed: ${jsonOrError.message}`, {
+      exitCode: 1 /* PreExecutionFailure */
+    });
+  }
+  return jsonOrError;
+}
 function parseInputArguments(command, value, previous = []) {
   const jsonOrError = tryJSONParse(value);
   if (jsonOrError instanceof Error) {
@@ -121,14 +149,15 @@ function parseInputArguments(command, value, previous = []) {
 }
 
 // src/cli/CommandHandler.ts
-var import_main = require("./main.node.cjs");
+var import_main = require("../build/main.node.cjs");
 async function commandAction(inputs, options, command) {
   let stateMachine;
   try {
     stateMachine = new import_main.StateMachine(options.definition ?? options.definitionFile, {
       validationOptions: {
         checkPaths: options.jsonpathValidation,
-        checkArn: options.arnValidation
+        checkArn: options.arnValidation,
+        noValidate: !options.validation
       }
     });
   } catch (error) {
@@ -139,7 +168,8 @@ async function commandAction(inputs, options, command) {
       overrides: {
         taskResourceLocalHandlers: options.overrideTask,
         waitTimeOverrides: options.overrideWait
-      }
+      },
+      context: options.context ?? options.contextFile
     });
     return result;
   });
@@ -204,11 +234,26 @@ Example calls:
       "-w, --override-wait <mapping>",
       "Override a Wait state to pause for the specified amount of milliseconds, instead of pausing for the duration specified in the state definition. The mapping value has to be provided in the format [WaitStateToOverride]:[number]."
     ).argParser(parseOverrideWaitOption)
+  ).addOption(
+    new import_commander.Option(
+      "--context <json>",
+      "A JSON object that will be passed to each execution as the context object."
+    ).argParser((value) => parseContextOption(command, value))
+  ).addOption(
+    new import_commander.Option(
+      "--context-file <path>",
+      "Path to a file containing a JSON object that will be passed to each execution as the context object."
+    ).argParser((value) => parseContextFileOption(command, value))
   ).addOption(
     new import_commander.Option("--no-jsonpath-validation", "Disable validation of JSONPath strings in the state machine definition.")
-  ).addOption(new import_commander.Option("--no-arn-validation", "Disable validation of ARNs in the state machine definition.")).argument(
+  ).addOption(new import_commander.Option("--no-arn-validation", "Disable validation of ARNs in the state machine definition.")).addOption(
+    new import_commander.Option(
+      "--no-validation",
+      "Disable validation of the state machine definition entirely. Use this option at your own risk, there are no guarantees when passing an invalid or non-standard definition to the state machine. Running it might result in undefined/unsupported behavior."
+    )
+  ).argument(
     "[inputs...]",
-    "Input data for the state machine, can be any valid JSON value. Each input represents a state machine execution. If reading from the standard input, each line will be considered as an input.",
+    "Input data for the state machine, can be any valid JSON value. Each input represents a state machine execution.\n\nWhen reading from the standard input, if the first line can be parsed as a single JSON value, then each line will be considered as an input. Otherwise, the entire standard input will be considered as a single JSON input.",
     (value, previous) => parseInputArguments(command, value, previous)
   ).hook("preAction", preActionHook).action(commandAction);
   return command;
@@ -226,6 +271,11 @@ if (require.main === module) {
       for await (const line of rl) {
         stdin.push(line);
       }
+      const firstLineJSON = tryJSONParse(stdin[0]);
+      if (firstLineJSON instanceof Error) {
+        await program.parseAsync([...process.argv, stdin.join("").trim()]);
+        return;
+      }
       await program.parseAsync([...process.argv, ...stdin.filter((line) => line)]);
     }
   })();