@openfn/ws-worker 1.5.0 → 1.5.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ws-worker
 
+## 1.5.1
+
+### Patch Changes
+
+- a08fb47: Update CLI docs
+  Add WORKER_MAX_SOCKET_TIMEOUT_SECONDS
+
 ## 1.5.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -65,6 +65,7 @@ declare type ServerOptions = {
         min?: number;
         max?: number;
     };
+    socketTimeoutSeconds?: number;
     payloadLimitMb?: number;
 };
 interface ServerApp extends Koa {

package/dist/index.js

@@ -29,7 +29,7 @@ var name, version, description, main, type, scripts, bin, author, license, depen
 var init_package = __esm({
   "package.json"() {
     name = "@openfn/ws-worker";
-    version = "1.5.0";
+    version = "1.5.1";
     description = "A Websocket Worker to connect Lightning to a Runtime Engine";
     main = "dist/index.js";
     type = "module";
@@ -167,7 +167,7 @@ var waitForRuns = (app, logger) => new Promise((resolve) => {
     log();
     app.events.on(INTERNAL_RUN_COMPLETE, onRunComplete);
   } else {
-    logger.debug("No active rns detected");
+    logger.debug("No active runs detected, closing immediately");
     resolve();
   }
 });
@@ -242,7 +242,10 @@ var claim = (app, logger = mockLogger, options = {}) => {
     }
     logger.debug("requesting run...");
     app.queueChannel.push(CLAIM, { demand: 1 }).receive("ok", ({ runs }) => {
-      logger.debug(`pulled ${runs.length} runs`);
+      logger.debug(
+        `claimed ${runs.length} runs: `,
+        runs.map((r) => r.id).join(",")
+      );
       if (!runs?.length) {
         return reject(new Error("No runs returned"));
       }
@@ -265,10 +268,10 @@ var claim = (app, logger = mockLogger, options = {}) => {
         app.execute(run);
         resolve();
       });
-    }).receive("error", () => {
-      logger.debug("pull err");
+    }).receive("error", (e) => {
+      logger.error("Error on claim", e);
     }).receive("timeout", () => {
-      logger.debug("pull timeout");
+      logger.error("TIMEOUT on claim. Runs may be lost.");
       reject(new Error("timeout"));
     });
   });
@@ -942,7 +945,7 @@ var generateWorkerToken = async (secret, workerId, logger) => {
 var worker_token_default = generateWorkerToken;
 
 // src/channels/worker-queue.ts
-var connectToWorkerQueue = (endpoint, serverId, secret, logger, SocketConstructor = PhxSocket) => {
+var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger, SocketConstructor = PhxSocket) => {
   const events = new EventEmitter();
   worker_token_default(secret, serverId, logger).then(async (token) => {
     const pkg = await Promise.resolve().then(() => (init_package(), package_exports));
@@ -953,7 +956,8 @@ var connectToWorkerQueue = (endpoint, serverId, secret, logger, SocketConstructo
     };
     const socket = new SocketConstructor(endpoint, {
       params,
-      transport: WebSocket
+      transport: WebSocket,
+      timeout: timeout * 1e3
     });
     let didOpen = false;
     socket.onOpen(() => {
@@ -985,7 +989,7 @@ var connectToWorkerQueue = (endpoint, serverId, secret, logger, SocketConstructo
 var worker_queue_default = connectToWorkerQueue;
 
 // src/server.ts
-var DEFAULT_PORT = 1234;
+var DEFAULT_PORT = 2222;
 var MIN_BACKOFF = 1e3;
 var MAX_BACKOFF = 1e3 * 30;
 function connect(app, logger, options = {}) {
@@ -1007,13 +1011,12 @@ function connect(app, logger, options = {}) {
         options.maxWorkflows
       );
     } else {
+      const port = app.server?.address().port;
       logger.break();
-      logger.warn("Workloop not starting");
+      logger.warn("Noloop active: workloop has not started");
       logger.info("This server will not auto-pull work from lightning.");
       logger.info("You can manually claim by posting to /claim, eg:");
-      logger.info(
-        `  curl -X POST http://locahost:${options.port || DEFAULT_PORT}/claim`
-      );
+      logger.info(`  curl -X POST http://localhost:${port}/claim`);
       logger.break();
     }
   };
@@ -1037,7 +1040,13 @@ function connect(app, logger, options = {}) {
     );
     logger.debug(e);
   };
-  worker_queue_default(options.lightning, app.id, options.secret, logger).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
+  worker_queue_default(
+    options.lightning,
+    app.id,
+    options.secret,
+    options.socketTimeoutSeconds,
+    logger
+  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
 }
 function createServer(engine, options = {}) {
   const logger = options.logger || createMockLogger2();

package/dist/start.js

@@ -37,7 +37,7 @@ var name, version, description, main, type, scripts, bin, author, license, depen
 var init_package = __esm({
   "package.json"() {
     name = "@openfn/ws-worker";
-    version = "1.5.0";
+    version = "1.5.1";
     description = "A Websocket Worker to connect Lightning to a Runtime Engine";
     main = "dist/index.js";
     type = "module";
@@ -306,7 +306,7 @@ var waitForRuns = (app, logger2) => new Promise((resolve5) => {
     log();
     app.events.on(INTERNAL_RUN_COMPLETE, onRunComplete);
   } else {
-    logger2.debug("No active rns detected");
+    logger2.debug("No active runs detected, closing immediately");
     resolve5();
   }
 });
@@ -381,7 +381,10 @@ var claim = (app, logger2 = mockLogger, options = {}) => {
     }
     logger2.debug("requesting run...");
     app.queueChannel.push(CLAIM, { demand: 1 }).receive("ok", ({ runs }) => {
-      logger2.debug(`pulled ${runs.length} runs`);
+      logger2.debug(
+        `claimed ${runs.length} runs: `,
+        runs.map((r) => r.id).join(",")
+      );
       if (!runs?.length) {
         return reject(new Error("No runs returned"));
       }
@@ -404,10 +407,10 @@ var claim = (app, logger2 = mockLogger, options = {}) => {
         app.execute(run2);
         resolve5();
       });
-    }).receive("error", () => {
-      logger2.debug("pull err");
+    }).receive("error", (e) => {
+      logger2.error("Error on claim", e);
     }).receive("timeout", () => {
-      logger2.debug("pull timeout");
+      logger2.error("TIMEOUT on claim. Runs may be lost.");
       reject(new Error("timeout"));
     });
   });
@@ -1081,7 +1084,7 @@ var generateWorkerToken = async (secret, workerId, logger2) => {
 var worker_token_default = generateWorkerToken;
 
 // src/channels/worker-queue.ts
-var connectToWorkerQueue = (endpoint, serverId, secret, logger2, SocketConstructor = PhxSocket) => {
+var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger2, SocketConstructor = PhxSocket) => {
   const events = new EventEmitter2();
   worker_token_default(secret, serverId, logger2).then(async (token) => {
     const pkg = await Promise.resolve().then(() => (init_package(), package_exports));
@@ -1092,7 +1095,8 @@ var connectToWorkerQueue = (endpoint, serverId, secret, logger2, SocketConstruct
     };
     const socket = new SocketConstructor(endpoint, {
       params,
-      transport: WebSocket
+      transport: WebSocket,
+      timeout: timeout * 1e3
     });
     let didOpen = false;
     socket.onOpen(() => {
@@ -1124,7 +1128,7 @@ var connectToWorkerQueue = (endpoint, serverId, secret, logger2, SocketConstruct
 var worker_queue_default = connectToWorkerQueue;
 
 // src/server.ts
-var DEFAULT_PORT = 1234;
+var DEFAULT_PORT = 2222;
 var MIN_BACKOFF = 1e3;
 var MAX_BACKOFF = 1e3 * 30;
 function connect(app, logger2, options = {}) {
@@ -1146,13 +1150,12 @@ function connect(app, logger2, options = {}) {
         options.maxWorkflows
       );
     } else {
+      const port = app.server?.address().port;
       logger2.break();
-      logger2.warn("Workloop not starting");
+      logger2.warn("Noloop active: workloop has not started");
       logger2.info("This server will not auto-pull work from lightning.");
       logger2.info("You can manually claim by posting to /claim, eg:");
-      logger2.info(
-        `  curl -X POST http://locahost:${options.port || DEFAULT_PORT}/claim`
-      );
+      logger2.info(`  curl -X POST http://localhost:${port}/claim`);
       logger2.break();
     }
   };
@@ -1176,7 +1179,13 @@ function connect(app, logger2, options = {}) {
     );
     logger2.debug(e);
   };
-  worker_queue_default(options.lightning, app.id, options.secret, logger2).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
+  worker_queue_default(
+    options.lightning,
+    app.id,
+    options.secret,
+    options.socketTimeoutSeconds,
+    logger2
+  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
 }
 function createServer(engine, options = {}) {
   const logger2 = options.logger || createMockLogger2();
@@ -6124,6 +6133,9 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // src/util/cli.ts
+var DEFAULT_PORT2 = 2222;
+var DEFAULT_WORKER_CAPACITY = 5;
+var DEFAULT_SOCKET_TIMEOUT_SECONDS = 10;
 function setArg(argValue, envValue, defaultValue) {
   if (Array.isArray(defaultValue) && !argValue && typeof envValue === "string") {
     return envValue.split(",");
@@ -6146,11 +6158,12 @@ function parseArgs(argv) {
     WORKER_PORT,
     WORKER_REPO_DIR,
     WORKER_SECRET,
-    WORKER_STATE_PROPS_TO_REMOVE
+    WORKER_STATE_PROPS_TO_REMOVE,
+    WORKER_SOCKET_TIMEOUT_SECONDS
   } = process.env;
   const parser2 = yargs_default(hideBin(argv)).command("server", "Start a ws-worker server").option("port", {
     alias: "p",
-    description: "Port to run the server on. Env: WORKER_PORT",
+    description: `Port to run the server on. Default ${DEFAULT_PORT2}. Env: WORKER_PORT`,
     type: "number"
   }).option("lightning", {
     alias: ["l", "lightning-service-url"],
@@ -6161,6 +6174,8 @@ function parseArgs(argv) {
   }).option("secret", {
     alias: "s",
     description: "Worker secret. (comes from WORKER_SECRET by default). Env: WORKER_SECRET"
+  }).option("socket-timeout", {
+    description: `Timeout for websockets to Lighting, in seconds. Defaults to 10.`
   }).option("lightning-public-key", {
     description: "Base64-encoded public key. Used to verify run tokens. Env: WORKER_LIGHTNING_PUBLIC_KEY"
   }).option("log", {
@@ -6176,7 +6191,7 @@ function parseArgs(argv) {
   }).option("backoff", {
     description: "Claim backoff rules: min/max (in seconds). Env: WORKER_BACKOFF"
   }).option("capacity", {
-    description: "max concurrent workers. Env: WORKER_CAPACITY",
+    description: `max concurrent workers. Default ${DEFAULT_WORKER_CAPACITY}. Env: WORKER_CAPACITY`,
     type: "number"
   }).option("state-props-to-remove", {
     description: "A list of properties to remove from the final state returned by a job. Env: WORKER_STATE_PROPS_TO_REMOVE",
@@ -6195,7 +6210,7 @@ function parseArgs(argv) {
   const args2 = parser2.parse();
   return {
     ...args2,
-    port: setArg(args2.port, WORKER_PORT, 2222),
+    port: setArg(args2.port, WORKER_PORT, DEFAULT_PORT2),
     lightning: setArg(
       args2.lightning,
       WORKER_LIGHTNING_SERVICE_URL,
@@ -6209,7 +6224,7 @@ function parseArgs(argv) {
     ),
     log: setArg(args2.log, WORKER_LOG_LEVEL, "debug"),
     backoff: setArg(args2.backoff, WORKER_BACKOFF, "1/10"),
-    capacity: setArg(args2.capacity, WORKER_CAPACITY, 5),
+    capacity: setArg(args2.capacity, WORKER_CAPACITY, DEFAULT_WORKER_CAPACITY),
     statePropsToRemove: setArg(
       args2.statePropsToRemove,
       WORKER_STATE_PROPS_TO_REMOVE,
@@ -6221,6 +6236,11 @@ function parseArgs(argv) {
       args2.maxRunDurationSeconds,
       WORKER_MAX_RUN_DURATION_SECONDS,
       300
+    ),
+    socketTimeoutSeconds: setArg(
+      args2.socketTimeoutSeconds,
+      WORKER_SOCKET_TIMEOUT_SECONDS,
+      DEFAULT_SOCKET_TIMEOUT_SECONDS
     )
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -23,8 +23,8 @@
     "phoenix": "1.7.10",
     "ws": "^8.14.1",
     "@openfn/engine-multi": "1.2.1",
-    "@openfn/logger": "1.0.1",
     "@openfn/lexicon": "^1.0.2",
+    "@openfn/logger": "1.0.1",
     "@openfn/runtime": "1.4.1"
   },
   "devDependencies": {