@openfn/ws-worker 1.14.2 → 1.14.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ws-worker
 
+## 1.14.3
+
+### Patch Changes
+
+- 032430f: Increase timeout on claim events
+- 0957412: Stop trying to claim after the queue has been closed
+
 ## 1.14.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -78,6 +78,7 @@ type ServerOptions = {
     sentryEnv?: string;
     socketTimeoutSeconds?: number;
     messageTimeoutSeconds?: number;
+    claimTimeoutSeconds?: number;
     payloadLimitMb?: number;
     collectionsVersion?: string;
     collectionsUrl?: string;

package/dist/index.js

@@ -1052,7 +1052,16 @@ var generateWorkerToken = async (secret, workerId, logger) => {
 var worker_token_default = generateWorkerToken;
 
 // src/channels/worker-queue.ts
-var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger, SocketConstructor = PhxSocket) => {
+var DEFAULT_MESSAGE_TIMEOUT_SECONDS = 30;
+var DEFAULT_CLAIM_TIMEOUT_SECONDS = 60 * 60;
+var connectToWorkerQueue = (endpoint, serverId, secret, logger, options) => {
+  const {
+    // Sets the DEFAULT timeout for all messages on the websocket
+    // This can be overridden by different channels (although we tend not to)
+    messageTimeout = DEFAULT_MESSAGE_TIMEOUT_SECONDS,
+    claimTimeout = DEFAULT_CLAIM_TIMEOUT_SECONDS,
+    SocketConstructor = PhxSocket
+  } = options;
   const events = new EventEmitter();
   Sentry5.addBreadcrumb({
     category: "lifecycle",
@@ -1073,7 +1082,7 @@ var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger, So
     const socket = new SocketConstructor(endpoint, {
       params,
       transport: WebSocket,
-      timeout: timeout * 1e3,
+      timeout: messageTimeout * 1e3,
       reconnectAfterMs: (tries) => Math.max(tries * 1e3)
     });
     let didOpen = false;
@@ -1091,7 +1100,7 @@ var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger, So
         events.emit("message", ev, load);
         return load;
       };
-      channel.join().receive("ok", () => {
+      channel.join(claimTimeout * 1e3).receive("ok", () => {
         logger.debug("Connected to worker queue socket");
         events.emit("connect", { socket, channel });
       }).receive("error", (e) => {
@@ -1178,13 +1187,12 @@ function connect(app, logger, options = {}) {
       });
     }
   };
-  worker_queue_default(
-    options.lightning,
-    app.id,
-    options.secret,
-    options.socketTimeoutSeconds,
-    logger
-  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError).on("message", onMessage);
+  worker_queue_default(options.lightning, app.id, options.secret, logger, {
+    // TODO: options.socketTimeoutSeconds wins because this is what USED to be used
+    // But it's deprecated and should be removed soon
+    messageTimeout: options.socketTimeoutSeconds ?? options.messageTimeoutSeconds,
+    claimTimeout: options.claimTimeoutSeconds
+  }).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError).on("message", onMessage);
 }
 async function setupCollections(options, logger) {
   if (options.collectionsUrl) {

package/dist/start.js

@@ -1192,7 +1192,16 @@ var generateWorkerToken = async (secret, workerId, logger2) => {
 var worker_token_default = generateWorkerToken;
 
 // src/channels/worker-queue.ts
-var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger2, SocketConstructor = PhxSocket) => {
+var DEFAULT_MESSAGE_TIMEOUT_SECONDS = 30;
+var DEFAULT_CLAIM_TIMEOUT_SECONDS = 60 * 60;
+var connectToWorkerQueue = (endpoint, serverId, secret, logger2, options) => {
+  const {
+    // Sets the DEFAULT timeout for all messages on the websocket
+    // This can be overridden by different channels (although we tend not to)
+    messageTimeout = DEFAULT_MESSAGE_TIMEOUT_SECONDS,
+    claimTimeout = DEFAULT_CLAIM_TIMEOUT_SECONDS,
+    SocketConstructor = PhxSocket
+  } = options;
   const events = new EventEmitter2();
   Sentry5.addBreadcrumb({
     category: "lifecycle",
@@ -1213,7 +1222,7 @@ var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger2, S
     const socket = new SocketConstructor(endpoint, {
       params,
       transport: WebSocket,
-      timeout: timeout * 1e3,
+      timeout: messageTimeout * 1e3,
       reconnectAfterMs: (tries) => Math.max(tries * 1e3)
     });
     let didOpen = false;
@@ -1231,7 +1240,7 @@ var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger2, S
         events.emit("message", ev, load);
         return load;
       };
-      channel.join().receive("ok", () => {
+      channel.join(claimTimeout * 1e3).receive("ok", () => {
         logger2.debug("Connected to worker queue socket");
         events.emit("connect", { socket, channel });
       }).receive("error", (e) => {
@@ -1318,13 +1327,12 @@ function connect(app, logger2, options = {}) {
       });
     }
   };
-  worker_queue_default(
-    options.lightning,
-    app.id,
-    options.secret,
-    options.socketTimeoutSeconds,
-    logger2
-  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError).on("message", onMessage);
+  worker_queue_default(options.lightning, app.id, options.secret, logger2, {
+    // TODO: options.socketTimeoutSeconds wins because this is what USED to be used
+    // But it's deprecated and should be removed soon
+    messageTimeout: options.socketTimeoutSeconds ?? options.messageTimeoutSeconds,
+    claimTimeout: options.claimTimeoutSeconds
+  }).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError).on("message", onMessage);
 }
 async function setupCollections(options, logger2) {
   if (options.collectionsUrl) {
@@ -6352,8 +6360,6 @@ var yargs_default = Yargs;
 // src/util/cli.ts
 var DEFAULT_PORT2 = 2222;
 var DEFAULT_WORKER_CAPACITY = 5;
-var DEFAULT_SOCKET_TIMEOUT_SECONDS = 10;
-var DEFAULT_MESSAGE_TIMEOUT_SECONDS = 30;
 function setArg(argValue, envValue, defaultValue) {
   if (Array.isArray(defaultValue) && !argValue && typeof envValue === "string") {
     return envValue.split(",");
@@ -6368,6 +6374,7 @@ function parseArgs(argv) {
     OPENFN_ADAPTORS_REPO,
     WORKER_BACKOFF,
     WORKER_CAPACITY,
+    WORKER_CLAIM_TIMEOUT_SECONDS,
     WORKER_COLLECTIONS_URL,
     WORKER_COLLECTIONS_VERSION,
     WORKER_LIGHTNING_PUBLIC_KEY,
@@ -6410,9 +6417,12 @@ function parseArgs(argv) {
   }).option("sentry-env", {
     description: "Sentry environment. Defaults to 'dev'. Env: WORKER_SENTRY_ENV"
   }).option("socket-timeout", {
-    description: `Timeout for websockets to Lightning, in seconds. Defaults to 10.Env: WORKER_SOCKET_TIMEOUT_SECONDS`
+    description: `[deprecated] Timeout for websockets to Lightning, in seconds. Defaults to 10.Env: WORKER_SOCKET_TIMEOUT_SECONDS`,
+    hidden: true
   }).option("message-timeout", {
-    description: `Timeout for messages in the run channel in seconds. Defaults to 1. Env: WORKER_MESSAGE_TIMEOUT_SECONDS`
+    description: `Timeout for all messages send to lightning via websocket. Defaults to 30. Env: WORKER_MESSAGE_TIMEOUT_SECONDS`
+  }).option("claim-timeout", {
+    description: `Timeout for claim requests for new Runs. This should be set to a high value or else runs may be lost. Defaults to 3600 (1 hour). Env: WORKER_CLAIM_TIMEOUT_SECONDS`
   }).option("lightning-public-key", {
     description: "Base64-encoded public key. Used to verify run tokens. Env: WORKER_LIGHTNING_PUBLIC_KEY"
   }).option("log", {
@@ -6483,10 +6493,14 @@ function parseArgs(argv) {
       WORKER_MAX_RUN_DURATION_SECONDS,
       300
     ),
+    claimTimeoutSeconds: setArg(
+      args2.claimTimeoutSeconds,
+      WORKER_CLAIM_TIMEOUT_SECONDS,
+      DEFAULT_CLAIM_TIMEOUT_SECONDS
+    ),
     socketTimeoutSeconds: setArg(
       args2.socketTimeoutSeconds,
-      WORKER_SOCKET_TIMEOUT_SECONDS,
-      DEFAULT_SOCKET_TIMEOUT_SECONDS
+      WORKER_SOCKET_TIMEOUT_SECONDS
     ),
     messageTimeoutSeconds: setArg(
       args2.messageTimeoutSeconds,
@@ -6535,8 +6549,15 @@ function engineReady(engine) {
     collectionsUrl: args.collectionsUrl,
     monorepoDir: args.monorepoDir,
     messageTimeoutSeconds: args.messageTimeoutSeconds,
+    claimTimeoutSeconds: args.claimTimeoutSeconds,
+    // deprecated!
     socketTimeoutSeconds: args.socketTimeoutSeconds
   };
+  if ("socketTimeoutSeconds" in args) {
+    logger.warn(
+      "WARNING: deprecated socketTimeoutSeconds value passed.\n\nThis will be respected as the default socket timeout value, but will be removed from future versions of the worker."
+    );
+  }
   if (args.lightningPublicKey) {
     logger.info(
       "Lightning public key found: run tokens from Lightning will be verified by this worker"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "1.14.2",
+  "version": "1.14.3",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -24,9 +24,9 @@
     "phoenix": "1.7.10",
     "ws": "^8.18.0",
     "@openfn/engine-multi": "1.6.8",
-    "@openfn/lexicon": "^1.2.2",
     "@openfn/logger": "1.0.5",
-    "@openfn/runtime": "1.7.1"
+    "@openfn/runtime": "1.7.1",
+    "@openfn/lexicon": "^1.2.2"
   },
   "devDependencies": {
     "@types/koa": "^2.13.5",