@openfn/ws-worker 1.15.1 → 1.15.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ws-worker
 
+## 1.15.3
+
+### Patch Changes
+
+- 5688813: Allow the worker to shutdown gracefully while claims are still in-flight. Runs will be completed before the server closes
+
+## 1.15.2
+
+### Patch Changes
+
+- Updated dependencies [362d6bf]
+  - @openfn/engine-multi@1.6.12
+
 ## 1.15.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -99,6 +99,7 @@ interface ServerApp extends Koa {
     execute: ({ id, token }: ClaimRun) => Promise<void>;
     destroy: () => void;
     resumeWorkloop: () => void;
+    claim: () => Promise<any>;
 }
 declare function createServer(engine: RuntimeEngine, options?: ServerOptions): ServerApp;
 
@@ -113,6 +114,9 @@ declare const RUN_LOG = "run:log";
 declare const STEP_START = "step:start";
 declare const STEP_COMPLETE = "step:complete";
 declare const INTERNAL_RUN_COMPLETE = "server:run-complete";
+declare const INTERNAL_CLAIM_START = "server:claim-start";
+declare const INTERNAL_CLAIM_COMPLETE = "server:claim-complete";
+declare const INTERNAL_SOCKET_READY = "server:socket-ready";
 type QueueEvents = {
     [CLAIM]: l.ClaimPayload;
 };
@@ -140,4 +144,4 @@ type RunReplies = {
     [STEP_COMPLETE]: l.StepCompleteReply;
 };
 
-export { CLAIM, GET_CREDENTIAL, GET_DATACLIP, GET_PLAN, INTERNAL_RUN_COMPLETE, QueueEventReplies, QueueEvents, RUN_COMPLETE, RUN_LOG, RUN_START, RunEvents, RunReplies, STEP_COMPLETE, STEP_START, WORK_AVAILABLE, createServer as default };
+export { CLAIM, GET_CREDENTIAL, GET_DATACLIP, GET_PLAN, INTERNAL_CLAIM_COMPLETE, INTERNAL_CLAIM_START, INTERNAL_RUN_COMPLETE, INTERNAL_SOCKET_READY, QueueEventReplies, QueueEvents, RUN_COMPLETE, RUN_LOG, RUN_START, RunEvents, RunReplies, STEP_COMPLETE, STEP_START, WORK_AVAILABLE, createServer as default };

package/dist/index.js

@@ -22,6 +22,9 @@ var RUN_LOG = "run:log";
 var STEP_START = "step:start";
 var STEP_COMPLETE = "step:complete";
 var INTERNAL_RUN_COMPLETE = "server:run-complete";
+var INTERNAL_CLAIM_START = "server:claim-start";
+var INTERNAL_CLAIM_COMPLETE = "server:claim-complete";
+var INTERNAL_SOCKET_READY = "server:socket-ready";
 
 // src/api/destroy.ts
 var destroy = async (app, logger) => {
@@ -30,13 +33,13 @@ var destroy = async (app, logger) => {
     new Promise((resolve) => {
       app.destroyed = true;
       app.workloop?.stop("server closed");
-      app.queueChannel?.leave();
       app.server.close(async () => {
         resolve();
       });
     }),
     new Promise(async (resolve) => {
-      await waitForRuns(app, logger);
+      await waitForRunsAndClaims(app, logger);
+      app.queueChannel?.leave();
       await app.engine.destroy();
       app.socket?.disconnect();
       resolve();
@@ -44,24 +47,26 @@ var destroy = async (app, logger) => {
   ]);
   logger.success("Server closed");
 };
-var waitForRuns = (app, logger) => new Promise((resolve) => {
+var waitForRunsAndClaims = (app, logger) => new Promise((resolve) => {
   const log = () => {
     logger.debug(
-      `Waiting for ${Object.keys(app.workflows).length} runs to complete...`
+      `Waiting for ${Object.keys(app.workflows).length} runs and ${Object.keys(app.openClaims).length} claims to complete...`
     );
   };
-  const onRunComplete = () => {
-    if (Object.keys(app.workflows).length === 0) {
+  const checkAllClear = () => {
+    if (Object.keys(app.workflows).length + Object.keys(app.openClaims).length === 0) {
       logger.debug("All runs completed!");
-      app.events.off(INTERNAL_RUN_COMPLETE, onRunComplete);
+      app.events.off(INTERNAL_RUN_COMPLETE, checkAllClear);
+      app.events.off(INTERNAL_CLAIM_COMPLETE, checkAllClear);
       resolve();
     } else {
       log();
     }
   };
-  if (Object.keys(app.workflows).length) {
+  if (Object.keys(app.workflows).length || Object.keys(app.openClaims).length) {
     log();
-    app.events.on(INTERNAL_RUN_COMPLETE, onRunComplete);
+    app.events.on(INTERNAL_RUN_COMPLETE, checkAllClear);
+    app.events.on(INTERNAL_CLAIM_COMPLETE, checkAllClear);
   } else {
     logger.debug("No active runs detected, closing immediately");
     resolve();
@@ -173,6 +178,7 @@ var claim = (app, logger = mockLogger, options = {}) => {
     const claimId = ++claimIdGen;
     app.openClaims[claimId] = demand;
     logger.debug(`requesting run (capacity ${activeWorkers}/${maxWorkers})`);
+    app.events.emit(INTERNAL_CLAIM_START);
     const start = Date.now();
     app.queueChannel.push(CLAIM, {
       demand,
@@ -184,6 +190,7 @@ var claim = (app, logger = mockLogger, options = {}) => {
         `${podName}claimed ${runs.length} runs in ${duration}ms (${runs.length ? runs.map((r) => r.id).join(",") : "-"})`
       );
       if (!runs?.length) {
+        app.events.emit(INTERNAL_CLAIM_COMPLETE, { runs });
         return reject(new Error("No runs returned"));
       }
       runs.forEach(async (run) => {
@@ -203,8 +210,9 @@ var claim = (app, logger = mockLogger, options = {}) => {
         }
         logger.debug(`${podName} starting run ${run.id}`);
         app.execute(run);
-        resolve();
       });
+      resolve();
+      app.events.emit(INTERNAL_CLAIM_COMPLETE, { runs });
     }).receive("error", (e) => {
       delete app.openClaims[claimId];
       logger.error("Error on claim", e);
@@ -1180,6 +1188,7 @@ function connect(app, logger, options = {}) {
       logger.info(`  curl -X POST http://localhost:${port}/claim`);
       logger.break();
     }
+    app.events.emit(INTERNAL_SOCKET_READY);
     app.resumeWorkloop();
   };
   const onDisconnect = () => {
@@ -1205,8 +1214,10 @@ function connect(app, logger, options = {}) {
   };
   const onMessage = (event) => {
     if (event === WORK_AVAILABLE) {
-      claim_default(app, logger, { maxWorkers: options.maxWorkflows }).catch(() => {
-      });
+      if (!app.destroyed) {
+        claim_default(app, logger, { maxWorkers: options.maxWorkflows }).catch(() => {
+        });
+      }
     }
   };
   worker_queue_default(options.lightning, app.id, options.secret, logger, {
@@ -1355,6 +1366,11 @@ function createServer(engine, options = {}) {
       ctx.status = 204;
     });
   });
+  app.claim = () => {
+    return claim_default(app, logger, {
+      maxWorkers: options.maxWorkflows
+    });
+  };
   app.destroy = () => destroy_default(app, logger);
   app.use(router.routes());
   if (options.lightning) {
@@ -1390,7 +1406,10 @@ export {
   GET_CREDENTIAL,
   GET_DATACLIP,
   GET_PLAN,
+  INTERNAL_CLAIM_COMPLETE,
+  INTERNAL_CLAIM_START,
   INTERNAL_RUN_COMPLETE,
+  INTERNAL_SOCKET_READY,
   RUN_COMPLETE,
   RUN_LOG,
   RUN_START,

package/dist/start.js

@@ -162,6 +162,9 @@ var RUN_LOG = "run:log";
 var STEP_START = "step:start";
 var STEP_COMPLETE = "step:complete";
 var INTERNAL_RUN_COMPLETE = "server:run-complete";
+var INTERNAL_CLAIM_START = "server:claim-start";
+var INTERNAL_CLAIM_COMPLETE = "server:claim-complete";
+var INTERNAL_SOCKET_READY = "server:socket-ready";
 
 // src/api/destroy.ts
 var destroy = async (app, logger2) => {
@@ -170,13 +173,13 @@ var destroy = async (app, logger2) => {
     new Promise((resolve5) => {
       app.destroyed = true;
       app.workloop?.stop("server closed");
-      app.queueChannel?.leave();
       app.server.close(async () => {
         resolve5();
       });
     }),
     new Promise(async (resolve5) => {
-      await waitForRuns(app, logger2);
+      await waitForRunsAndClaims(app, logger2);
+      app.queueChannel?.leave();
       await app.engine.destroy();
       app.socket?.disconnect();
       resolve5();
@@ -184,24 +187,26 @@ var destroy = async (app, logger2) => {
   ]);
   logger2.success("Server closed");
 };
-var waitForRuns = (app, logger2) => new Promise((resolve5) => {
+var waitForRunsAndClaims = (app, logger2) => new Promise((resolve5) => {
   const log = () => {
     logger2.debug(
-      `Waiting for ${Object.keys(app.workflows).length} runs to complete...`
+      `Waiting for ${Object.keys(app.workflows).length} runs and ${Object.keys(app.openClaims).length} claims to complete...`
     );
   };
-  const onRunComplete = () => {
-    if (Object.keys(app.workflows).length === 0) {
+  const checkAllClear = () => {
+    if (Object.keys(app.workflows).length + Object.keys(app.openClaims).length === 0) {
       logger2.debug("All runs completed!");
-      app.events.off(INTERNAL_RUN_COMPLETE, onRunComplete);
+      app.events.off(INTERNAL_RUN_COMPLETE, checkAllClear);
+      app.events.off(INTERNAL_CLAIM_COMPLETE, checkAllClear);
       resolve5();
     } else {
       log();
     }
   };
-  if (Object.keys(app.workflows).length) {
+  if (Object.keys(app.workflows).length || Object.keys(app.openClaims).length) {
     log();
-    app.events.on(INTERNAL_RUN_COMPLETE, onRunComplete);
+    app.events.on(INTERNAL_RUN_COMPLETE, checkAllClear);
+    app.events.on(INTERNAL_CLAIM_COMPLETE, checkAllClear);
   } else {
     logger2.debug("No active runs detected, closing immediately");
     resolve5();
@@ -313,6 +318,7 @@ var claim = (app, logger2 = mockLogger, options = {}) => {
     const claimId = ++claimIdGen;
     app.openClaims[claimId] = demand;
     logger2.debug(`requesting run (capacity ${activeWorkers}/${maxWorkers})`);
+    app.events.emit(INTERNAL_CLAIM_START);
     const start = Date.now();
     app.queueChannel.push(CLAIM, {
       demand,
@@ -324,6 +330,7 @@ var claim = (app, logger2 = mockLogger, options = {}) => {
         `${podName}claimed ${runs.length} runs in ${duration}ms (${runs.length ? runs.map((r) => r.id).join(",") : "-"})`
       );
       if (!runs?.length) {
+        app.events.emit(INTERNAL_CLAIM_COMPLETE, { runs });
         return reject(new Error("No runs returned"));
       }
       runs.forEach(async (run2) => {
@@ -343,8 +350,9 @@ var claim = (app, logger2 = mockLogger, options = {}) => {
         }
         logger2.debug(`${podName} starting run ${run2.id}`);
         app.execute(run2);
-        resolve5();
       });
+      resolve5();
+      app.events.emit(INTERNAL_CLAIM_COMPLETE, { runs });
     }).receive("error", (e) => {
       delete app.openClaims[claimId];
       logger2.error("Error on claim", e);
@@ -1320,6 +1328,7 @@ function connect(app, logger2, options = {}) {
       logger2.info(`  curl -X POST http://localhost:${port}/claim`);
       logger2.break();
     }
+    app.events.emit(INTERNAL_SOCKET_READY);
     app.resumeWorkloop();
   };
   const onDisconnect = () => {
@@ -1345,8 +1354,10 @@ function connect(app, logger2, options = {}) {
   };
   const onMessage = (event) => {
     if (event === WORK_AVAILABLE) {
-      claim_default(app, logger2, { maxWorkers: options.maxWorkflows }).catch(() => {
-      });
+      if (!app.destroyed) {
+        claim_default(app, logger2, { maxWorkers: options.maxWorkflows }).catch(() => {
+        });
+      }
     }
   };
   worker_queue_default(options.lightning, app.id, options.secret, logger2, {
@@ -1495,6 +1506,11 @@ function createServer(engine, options = {}) {
       ctx.status = 204;
     });
   });
+  app.claim = () => {
+    return claim_default(app, logger2, {
+      maxWorkers: options.maxWorkflows
+    });
+  };
   app.destroy = () => destroy_default(app, logger2);
   app.use(router.routes());
   if (options.lightning) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "1.15.1",
+  "version": "1.15.3",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -23,9 +23,9 @@
     "koa-logger": "^3.2.1",
     "phoenix": "1.7.10",
     "ws": "^8.18.3",
-    "@openfn/engine-multi": "1.6.11",
-    "@openfn/logger": "1.0.6",
+    "@openfn/engine-multi": "1.6.12",
     "@openfn/lexicon": "^1.2.3",
+    "@openfn/logger": "1.0.6",
     "@openfn/runtime": "1.7.2"
   },
   "devDependencies": {
@@ -43,7 +43,7 @@
     "tsup": "^6.7.0",
     "typescript": "^4.9.5",
     "yargs": "^17.7.2",
-    "@openfn/lightning-mock": "2.2.6"
+    "@openfn/lightning-mock": "2.2.7"
   },
   "files": [
     "dist",