aws-local-stepfunctions 0.6.0 → 1.0.0

package/README.md

@@ -2,7 +2,25 @@
 
 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
 
@@ -16,6 +34,15 @@ This package lets you run AWS Step Functions completely locally, both in Node.js
 - [API](#api)
   - [Constructor](#constructor-new-statemachinedefinition-statemachineoptions)
   - [StateMachine.run](#statemachineruninput-options)
+- [CLI](#cli)
+  - [Basic usage](#basic-usage)
+  - [Passing input from stdin](#passing-input-from-stdin)
+  - [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)
 - [License](#license)
 
@@ -49,7 +76,7 @@ import { StateMachine } from 'aws-local-stepfunctions';
 
 You can import the bundled package directly into a browser script as an ES module, from one of the following CDNs:
 
-> NOTE: The following examples will import the latest package version. Refer to the CDNs websites to know about other ways in which you can specify the package URL (for example, to import a specific version).
+> NOTE: The following examples will import the latest package version. Refer to the CDNs websites to know about other ways in which you can specify the package URL (for example, to import a specific version or a minified version).
 
 #### [unpkg](https://unpkg.com/)
 
@@ -111,8 +138,9 @@ const stateMachine = new StateMachine(machineDefinition, {
 
 Runs the state machine with the given `input` parameter and returns an object with the following properties:
 
+- `result`: A `Promise` that resolves with the result of the execution once it terminates.
 - `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.
+- `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).
 
 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.
 
@@ -122,8 +150,9 @@ Each execution is independent of all others, meaning that you can concurrently c
 - `options?`:
   - `overrides?`: An object to override the behavior of certain states:
     - `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 specifed override duration should be in milliseconds.
+    - `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.
 
 #### Basic example:
 
@@ -149,6 +178,222 @@ const result = await execution.result; // wait until the execution finishes to g
 console.log(result); // log the result of the execution
 ```
 
+## CLI
+
+In addition to the JavaScript API, `aws-local-stepfunctions` also provides a command-line interface. The CLI allows you to run one or several executions without having to create a Node.js script.
+
+To use the CLI as a global shell command, you need to install the package globally:
+
+```sh
+npm install -g aws-local-stepfunctions
+```
+
+After installing the package, the command `local-sfn` will be available in your shell.
+
+### Basic usage
+
+The simplest way to use the CLI is by passing either the `-d, --definition` or the `-f, --definition-file` option, along with the input(s) for the state machine. For example:
+
+```sh
+local-sfn \
+  -f state-machine.json \
+  '{ "num1": 1, "num2": 2 }' \
+  '{ "num1": 3, "num2": 4 }' \
+  '{ "num1": 5, "num2": 6 }'
+```
+
+This command would execute the state machine defined in file `state-machine.json` with `'{ "num1": 1, "num2": 2 }'`, `'{ "num1": 3, "num2": 4 }'`, and `'{ "num1": 5, "num2": 6 }'` as inputs. Each input corresponds to a state machine execution, and each execution is run independently, so the failure of one execution doesn't mean the failure of all of the other executions.
+
+Now, suppose the state machine in file `state-machine.json` is defined as a single `Task` state that calls a Lambda function that adds `num1` and `num2`:
+
+<a id="cli-state-machine"></a>
+
+```json
+{
+  "StartAt": "AddNumbers",
+  "States": {
+    "AddNumbers": {
+      "Type": "Task",
+      "Resource": "arn:aws:lambda:us-east-1:123456789012:function:AddNumbers",
+      "End": true
+    }
+  }
+}
+```
+
+Then, the output of the `local-sfn` command above may look something like this:
+
+```sh
+3
+7
+11
+```
+
+Note that each line of the output corresponds to the result of each input, in the same order that the inputs were given to the command.
+
+### Passing input from stdin
+
+`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 }
+{ "num1": 3, "num2": 4 }
+{ "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
+cat inputs.txt | local-sfn -f state-machine.json
+```
+
+Alternatively, using input redirection:
+
+```sh
+local-sfn -f state-machine.json < inputs.txt
+```
+
+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
+
+As explained in the Feature support document, it's possible to override the default actions of [`Task` states](/docs/feature-support.md#task-state-resource-override) and [`Wait` states](/docs/feature-support.md#wait-state-duration-override).
+
+#### Task state override
+
+To override a `Task` state, pass the `-t, --override-task` option. This option takes as value the name of the `Task` state you want to override, and a path to a script or program that will be executed instead of the resource specified in the state definition. The state name and the path must be separated by a colon `:`.
+
+Using the same [state machine definition](#cli-state-machine) as before, if you wanted to override the `AddNumbers` state to run a custom script, you can do it like this:
+
+```sh
+local-sfn -f state-machine.json -t AddNumbers:./override.sh '{ "num1": 1, "num2": 2 }'
+```
+
+This command would run the state machine, but instead of invoking the Lambda function specified in the `Resource` field of the `AddNumbers` state, the `override.sh` script would be executed.
+
+Now, suppose the `override.sh` script is defined like this:
+
+```sh
+#!/bin/sh
+
+TASK_INPUT=$1 # First argument is the input to the overridden Task state
+echo "$TASK_INPUT" | jq '.num1 + .num2' # Use jq to add "num1" and "num2", and print result to stdout
+```
+
+When overriding a `Task` state, the overriding executable will be passed the input to the `Task` state as first argument, which can then be used to compute the task result. Similarly, the executable must print the task result as a JSON value to the standard output, so `local-sfn` can then read stdout and use the value as the result of the `Task` state. If the executable terminates with an exit code different from `0`, its standard error will be printed and the execution will be marked as a failure.
+
+Additionally, you can pass the `-t, --override-task` option multiple times, to override more than one `Task` state. For example:
+
+```sh
+local-sfn
+  -f state-machine.json \
+  -t AddNumbers:./override.sh \
+  -t SendRequest:./request.py \
+  -t ProcessImage:./proc_image \
+  '{ "num1": 1, "num2": 2 }'
+```
+
+This command would execute the state machine, and override `Task` states `AddNumbers`, `SendRequest`, and `ProcessImage` to run the `override.sh` shell script, the `request.py` Python script, and the `proc_image` program, respectively.
+
+#### Wait state override
+
+To override the duration of a `Wait` state, pass the `-w, --override-wait` option. This option takes as value the name of the `Wait` state you want to override, and a number that represents the amount in milliseconds that you want to pause the execution for. The state name and the milliseconds amount must be separated by a colon `:`.
+
+For example:
+
+```sh
+local-sfn -f state-machine.json -w WaitResponse:1500 '{ "num1": 1, "num2": 2 }'
+```
+
+This command would execute the state machine, and when entering the `WaitResponse` `Wait` state, the execution would be paused for 1500 milliseconds (1.5 seconds), disregarding the `Seconds`, `Timestamp`, `SecondsPath`, or `TimestampPath` fields that could've been specified in the definition of `WaitResponse`.
+
+In the same way as the `-t, --override-task` option, you can pass the `-w, --override-wait` option multiple times, to override more than one `Wait` state. For example:
+
+```sh
+local-sfn \
+  -f state-machine.json \
+  -w WaitResponse:1500 \
+  -w PauseUntilSignal:250 \
+  -w Delay:0 \
+  '{ "num1": 1, "num2": 2 }'
+```
+
+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.
+
+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.
+
+### Exit codes
+
+`local-sfn` can terminate with the following exit codes:
+
+| Exit code | Explanation                                                                          |
+| :-------: | ------------------------------------------------------------------------------------ |
+|     0     | The state machine was executed, and all executions ran successfully.                 |
+|     1     | An error occurred before the state machine could be executed (e.g. a parsing error). |
+|     2     | The state machine was executed, but at least one execution had an error.             |
+
 ## Examples
 
 You can check more examples and options usage in the [examples](/examples) directory.

package/build/CLI.cjs

@@ -0,0 +1,279 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/cli/CLI.ts
+var CLI_exports = {};
+__export(CLI_exports, {
+  makeProgram: () => makeProgram
+});
+module.exports = __toCommonJS(CLI_exports);
+var import_readline = __toESM(require("readline"), 1);
+var import_commander = require("commander");
+
+// package.json
+var version = "1.0.0";
+
+// src/cli/ArgumentParsers.ts
+var import_fs = require("fs");
+var import_child_process = require("child_process");
+
+// src/util/index.ts
+function tryJSONParse(jsonStr) {
+  try {
+    return JSON.parse(jsonStr);
+  } catch (error) {
+    return error;
+  }
+}
+
+// src/cli/ArgumentParsers.ts
+function parseDefinitionOption(command, definition) {
+  const jsonOrError = tryJSONParse(definition);
+  if (jsonOrError instanceof Error) {
+    command.error(
+      `error: parsing of state machine definition passed in option '-d, --definition <definition>' failed: ${jsonOrError.message}`,
+      {
+        exitCode: 1 /* PreExecutionFailure */
+      }
+    );
+  }
+  return jsonOrError;
+}
+function parseDefinitionFileOption(command, definitionFile) {
+  let file;
+  try {
+    file = (0, import_fs.readFileSync)(definitionFile).toString();
+  } catch (error) {
+    command.error(`error: ${error.message}`, { exitCode: 1 /* PreExecutionFailure */ });
+  }
+  const jsonOrError = tryJSONParse(file);
+  if (jsonOrError instanceof Error) {
+    command.error(
+      `error: parsing of state machine definition in file '${definitionFile}' failed: ${jsonOrError.message}`,
+      { exitCode: 1 /* PreExecutionFailure */ }
+    );
+  }
+  return jsonOrError;
+}
+function parseOverrideTaskOption(value, previous = {}) {
+  const [taskStateName, scriptPath] = value.split(":");
+  previous[taskStateName] = (input) => {
+    const spawnResult = (0, import_child_process.spawnSync)(scriptPath, [JSON.stringify(input)]);
+    if (spawnResult.error) {
+      throw new Error(
+        `Attempt to run task override '${scriptPath}' for state '${taskStateName}' failed: ${spawnResult.error.message}`
+      );
+    }
+    if (spawnResult.status !== 0) {
+      throw new Error(`${scriptPath} ('${taskStateName}'): ${spawnResult.stderr.toString()}`);
+    }
+    const overrideResult = spawnResult.stdout.toString();
+    const jsonOrError = tryJSONParse(overrideResult);
+    if (jsonOrError instanceof Error) {
+      throw new Error(
+        `Parsing of output '${overrideResult}' from task override '${scriptPath}' for state '${taskStateName}' failed: ${jsonOrError.message}`
+      );
+    }
+    return Promise.resolve(jsonOrError);
+  };
+  return previous;
+}
+function parseOverrideWaitOption(value, previous = {}) {
+  const [waitStateName, duration] = value.split(":");
+  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) {
+    command.error(`error: parsing of input value '${value}' failed: ${jsonOrError.message}`, {
+      exitCode: 1 /* PreExecutionFailure */
+    });
+  }
+  return previous.concat(jsonOrError);
+}
+
+// src/cli/CommandHandler.ts
+var import_main = require("./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
+      }
+    });
+  } catch (error) {
+    command.error(`error: ${error.message}`);
+  }
+  const resultsPromises = inputs.map((input) => {
+    const { result } = stateMachine.run(input, {
+      overrides: {
+        taskResourceLocalHandlers: options.overrideTask,
+        waitTimeOverrides: options.overrideWait
+      },
+      context: options.context ?? options.contextFile
+    });
+    return result;
+  });
+  const results = await Promise.allSettled(resultsPromises);
+  let exitCode = 0 /* Success */;
+  for (const result of results) {
+    if (result.status === "fulfilled") {
+      console.log(result.value);
+    } else {
+      exitCode = 2 /* StateMachineExecutionFailure */;
+      let msg = result.reason.message;
+      if (result.reason instanceof import_main.ExecutionTimeoutError) {
+        msg = "Execution timed out";
+      }
+      console.log(msg.trim());
+    }
+  }
+  process.exitCode = exitCode;
+}
+function preActionHook(thisCommand) {
+  const options = thisCommand.opts();
+  if (thisCommand.args.length === 0) {
+    thisCommand.help();
+  }
+  if (!options["definition"] && !options["definitionFile"]) {
+    thisCommand.error(
+      "error: missing either option '-d, --definition <definition>' or option '-f, --definition-file <path>'",
+      { exitCode: 1 /* PreExecutionFailure */ }
+    );
+  }
+}
+
+// src/cli/CLI.ts
+function makeProgram() {
+  const command = new import_commander.Command();
+  command.name("local-sfn").description(
+    `Execute an Amazon States Language state machine with the given inputs.
+The result of each execution will be output in a new line and in the same order as its corresponding input.`
+  ).helpOption("-h, --help", "Print help for command and exit.").configureHelp({ helpWidth: 80 }).addHelpText(
+    "after",
+    `
+Exit codes:
+  0	All executions ran successfully.
+  1	An error occurred before the state machine could be executed.
+  2	At least one execution had an error.
+
+Example calls:
+  $ local-sfn -f state-machine.json '{ "num1": 2, "num2": 2 }'
+  $ local-sfn -f state-machine.json -t SendRequest:./override.sh -w WaitResponse:2000 '{ "num1": 2, "num2": 2 }'
+  $ cat inputs.txt | local-sfn -f state-machine.json`
+  ).version(version, "-V, --version", "Print the version number and exit.").addOption(
+    new import_commander.Option("-d, --definition <definition>", "A JSON definition of a state machine.").conflicts("definition-file").argParser((value) => parseDefinitionOption(command, value))
+  ).addOption(
+    new import_commander.Option("-f, --definition-file <path>", "Path to a file containing a JSON state machine definition.").conflicts("definition").argParser((value) => parseDefinitionFileOption(command, value))
+  ).addOption(
+    new import_commander.Option(
+      "-t, --override-task <mapping>",
+      "Override a Task state to run an executable file or script, instead of calling the service specified in the 'Resource' field of the state definition. The mapping value has to be provided in the format [TaskStateToOverride]:[path/to/override/script]. The override script will be passed the input of the Task state as first argument, which can then be used to compute the task result. The script must print the task result as a JSON value to the standard output."
+    ).argParser(parseOverrideTaskOption)
+  ).addOption(
+    new import_commander.Option(
+      "-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(
+    "[inputs...]",
+    "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;
+}
+if (require.main === module) {
+  (async function() {
+    const program = makeProgram();
+    if (process.stdin.isTTY) {
+      await program.parseAsync();
+    } else {
+      const rl = import_readline.default.createInterface({
+        input: process.stdin
+      });
+      const stdin = [];
+      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)]);
+    }
+  })();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  makeProgram
+});