@openfn/ws-worker 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # ws-worker
 
+## 0.5.0
+
+### Minor Changes
+
+- Add state-props-to-remove option
+- Updated dependencies [56b6e44]
+  - @openfn/engine-multi@0.2.6
+  - @openfn/runtime@0.2.4
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -24,8 +24,6 @@ The worker will use the WORKER_SECRET env var (which you should have set for Lig
 mix lightning.gen_worker_keys
 ```
 
-### WS Server
-
 To start a `ws-worker` server, run:
 
 ```
@@ -40,6 +38,10 @@ Pass a custom lightining url with `-l ws://localhost:1234/worker`. (Note that yo
 
 Use `-l mock` to connect to a lightning mock server (on the default port).
 
+## Options
+
+For a list of supported worker and engine options, see src/start.ts
+
 ## Watched Server
 
 You can start a dev server (which rebuilds on save) by running:

package/dist/index.js

@@ -376,7 +376,7 @@ import { timestamp } from "@openfn/logger";
 // package.json
 var package_default = {
   name: "@openfn/ws-worker",
-  version: "0.4.0",
+  version: "0.5.0",
   description: "A Websocket Worker to connect Lightning to a Runtime Engine",
   main: "dist/index.js",
   type: "module",

package/dist/start.js

@@ -5362,7 +5362,7 @@ import { timestamp } from "@openfn/logger";
 // package.json
 var package_default = {
   name: "@openfn/ws-worker",
-  version: "0.4.0",
+  version: "0.5.0",
   description: "A Websocket Worker to connect Lightning to a Runtime Engine",
   main: "dist/index.js",
   type: "module",
@@ -5878,7 +5878,12 @@ function createServer(engine, options = {}) {
 var server_default = createServer;
 
 // src/start.ts
-var { WORKER_REPO_DIR, WORKER_SECRET, MAX_RUN_MEMORY } = process.env;
+var {
+  WORKER_REPO_DIR,
+  WORKER_SECRET,
+  MAX_RUN_MEMORY,
+  STATE_PROPS_TO_REMOVE
+} = process.env;
 var args = yargs_default(hideBin(process.argv)).command("server", "Start a ws-worker server").option("port", {
   alias: "p",
   description: "Port to run the server on",
@@ -5914,6 +5919,10 @@ var args = yargs_default(hideBin(process.argv)).command("server", "Start a ws-wo
   description: "max concurrent workers",
   default: 5,
   type: "number"
+}).option("state-props-to-remove", {
+  description: "A list of properties to remove from the final state returned by a job",
+  default: STATE_PROPS_TO_REMOVE ?? ["configuration", "response"],
+  type: "array"
 }).option("run-memory", {
   description: "Maximum memory allocated to a single run, in mb",
   type: "number",
@@ -5956,7 +5965,8 @@ if (args.mock) {
   createRTE({
     repoDir: args.repoDir,
     memoryLimitMb: args.runMemory,
-    maxWorkers: args.capacity
+    maxWorkers: args.capacity,
+    statePropsToRemove: args.statePropsToRemove
   }).then((engine) => {
     logger.debug("engine created");
     engineReady(engine);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -22,9 +22,9 @@
     "koa-logger": "^3.2.1",
     "phoenix": "^1.7.7",
     "ws": "^8.14.1",
-    "@openfn/engine-multi": "0.2.5",
-    "@openfn/logger": "0.0.19",
-    "@openfn/runtime": "0.2.3"
+    "@openfn/engine-multi": "0.2.6",
+    "@openfn/runtime": "0.2.4",
+    "@openfn/logger": "0.0.19"
   },
   "devDependencies": {
     "@types/koa": "^2.13.5",
@@ -41,7 +41,7 @@
     "tsup": "^6.2.3",
     "typescript": "^4.6.4",
     "yargs": "^17.6.2",
-    "@openfn/lightning-mock": "1.1.7"
+    "@openfn/lightning-mock": "1.1.8"
   },
   "files": [
     "dist",