@openfn/ws-worker 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # ws-worker
 
+## 0.2.1
+
+### Patch Changes
+
+- ad8f6e9: Improve robustness of server connectivity
+- Updated dependencies [704e7b6]
+  - @openfn/engine-multi@0.1.7
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import Koa from 'koa';
 import { SanitizePolicies, Logger } from '@openfn/logger';
-import { RuntimeEngine } from '@openfn/engine-multi';
 import { Channel as Channel$1 } from 'phoenix';
 import { ExecutionPlan } from '@openfn/runtime';
+import { RuntimeEngine } from '@openfn/engine-multi';
 
 type ExitReasonStrings =
   | 'success'
@@ -85,7 +85,7 @@ interface ServerApp extends Koa {
     workflows: Record<string, true | Context>;
     execute: ({ id, token }: CLAIM_ATTEMPT) => Promise<void>;
     destroy: () => void;
-    killWorkloop: () => void;
+    killWorkloop?: () => void;
 }
 declare function createServer(engine: RuntimeEngine, options?: ServerOptions): ServerApp;
 

package/dist/index.js

@@ -80,6 +80,11 @@ var claim = (app, logger = mockLogger, maxWorkers = 5) => {
         app.execute(attempt);
         resolve();
       });
+    }).receive("error", () => {
+      logger.debug("pull err");
+    }).receive("timeout", () => {
+      logger.debug("pull timeout");
+      reject(new Error("timeout"));
     });
   });
 };
@@ -423,6 +428,7 @@ async function loadAttempt(channel) {
 }
 
 // src/channels/worker-queue.ts
+import EventEmitter from "node:events";
 import { Socket as PhxSocket } from "phoenix";
 import { WebSocket } from "ws";
 
@@ -448,9 +454,9 @@ var generateWorkerToken = async (secret, workerId) => {
 var worker_token_default = generateWorkerToken;
 
 // src/channels/worker-queue.ts
-var connectToWorkerQueue = (endpoint, serverId, secret, SocketConstructor = PhxSocket) => {
-  return new Promise(async (done, reject) => {
-    const token = await worker_token_default(secret, serverId);
+var connectToWorkerQueue = (endpoint, serverId, secret, logger, SocketConstructor = PhxSocket) => {
+  const events = new EventEmitter();
+  worker_token_default(secret, serverId).then((token) => {
     const socket = new SocketConstructor(endpoint, {
       params: { token },
       transport: WebSocket
@@ -460,20 +466,27 @@ var connectToWorkerQueue = (endpoint, serverId, secret, SocketConstructor = PhxS
       didOpen = true;
       const channel = socket.channel("worker:queue");
       channel.join().receive("ok", () => {
-        done({ socket, channel });
+        logger.debug("Connected to worker queue socket");
+        events.emit("connect", { socket, channel });
       }).receive("error", (e) => {
-        console.log("ERROR", e);
+        logger.error("ERROR", e);
       }).receive("timeout", (e) => {
-        console.log("TIMEOUT", e);
+        logger.error("TIMEOUT", e);
       });
     });
+    socket.onClose((_e) => {
+      logger.debug("queue socket closed");
+      events.emit("disconnect");
+    });
     socket.onError((e) => {
       if (!didOpen) {
-        reject(e);
+        events.emit("error", e.message);
+        didOpen = false;
       }
     });
     socket.connect();
   });
+  return events;
 };
 var worker_queue_default = connectToWorkerQueue;
 
@@ -481,17 +494,13 @@ var worker_queue_default = connectToWorkerQueue;
 var DEFAULT_PORT = 1234;
 var MIN_BACKOFF = 1e3;
 var MAX_BACKOFF = 1e3 * 30;
-function connect(app, engine, logger, options = {}) {
+function connect(app, logger, options = {}) {
   logger.debug("Connecting to Lightning at", options.lightning);
-  worker_queue_default(options.lightning, app.id, options.secret).then(({ socket, channel }) => {
+  const onConnect = ({ socket, channel }) => {
     logger.success("Connected to Lightning at", options.lightning);
     app.socket = socket;
     app.channel = channel;
     if (!options.noLoop) {
-      if (app.killWorkloop) {
-        logger.info("Terminating old workloop");
-        app.killWorkloop();
-      }
       logger.info("Starting workloop");
       app.killWorkloop = workloop_default(
         app,
@@ -510,17 +519,25 @@ function connect(app, engine, logger, options = {}) {
       );
       logger.break();
     }
-  }).catch((e) => {
+  };
+  const onDisconnect = () => {
+    if (app.killWorkloop) {
+      app.killWorkloop();
+      delete app.killWorkloop;
+      logger.info("Connection to lightning lost.");
+      logger.info(
+        "Worker will automatically reconnect when lightning is back online."
+      );
+    }
+  };
+  const onError = (e) => {
     logger.error(
       "CRITICAL ERROR: could not connect to lightning at",
       options.lightning
     );
     logger.debug(e);
-    app.killWorkloop?.();
-    setTimeout(() => {
-      connect(app, engine, logger, options);
-    }, 1e4);
-  });
+  };
+  worker_queue_default(options.lightning, app.id, options.secret, logger).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
 }
 function createServer(engine, options = {}) {
   const logger = options.logger || createMockLogger2();
@@ -583,7 +600,7 @@ function createServer(engine, options = {}) {
   };
   app.use(router.routes());
   if (options.lightning) {
-    connect(app, engine, logger, options);
+    connect(app, logger, options);
   } else {
     logger.warn("No lightning URL provided");
   }

package/dist/start.js

@@ -5062,6 +5062,11 @@ var claim = (app, logger2 = mockLogger, maxWorkers = 5) => {
         app.execute(attempt);
         resolve5();
       });
+    }).receive("error", () => {
+      logger2.debug("pull err");
+    }).receive("timeout", () => {
+      logger2.debug("pull timeout");
+      reject(new Error("timeout"));
     });
   });
 };
@@ -5405,6 +5410,7 @@ async function loadAttempt(channel) {
 }
 
 // src/channels/worker-queue.ts
+import EventEmitter2 from "node:events";
 import { Socket as PhxSocket } from "phoenix";
 import { WebSocket } from "ws";
 
@@ -5430,9 +5436,9 @@ var generateWorkerToken = async (secret, workerId) => {
 var worker_token_default = generateWorkerToken;
 
 // src/channels/worker-queue.ts
-var connectToWorkerQueue = (endpoint, serverId, secret, SocketConstructor = PhxSocket) => {
-  return new Promise(async (done, reject) => {
-    const token = await worker_token_default(secret, serverId);
+var connectToWorkerQueue = (endpoint, serverId, secret, logger2, SocketConstructor = PhxSocket) => {
+  const events = new EventEmitter2();
+  worker_token_default(secret, serverId).then((token) => {
     const socket = new SocketConstructor(endpoint, {
       params: { token },
       transport: WebSocket
@@ -5442,20 +5448,27 @@ var connectToWorkerQueue = (endpoint, serverId, secret, SocketConstructor = PhxS
       didOpen = true;
       const channel = socket.channel("worker:queue");
       channel.join().receive("ok", () => {
-        done({ socket, channel });
+        logger2.debug("Connected to worker queue socket");
+        events.emit("connect", { socket, channel });
       }).receive("error", (e) => {
-        console.log("ERROR", e);
+        logger2.error("ERROR", e);
       }).receive("timeout", (e) => {
-        console.log("TIMEOUT", e);
+        logger2.error("TIMEOUT", e);
       });
     });
+    socket.onClose((_e) => {
+      logger2.debug("queue socket closed");
+      events.emit("disconnect");
+    });
     socket.onError((e) => {
       if (!didOpen) {
-        reject(e);
+        events.emit("error", e.message);
+        didOpen = false;
       }
     });
     socket.connect();
   });
+  return events;
 };
 var worker_queue_default = connectToWorkerQueue;
 
@@ -5463,17 +5476,13 @@ var worker_queue_default = connectToWorkerQueue;
 var DEFAULT_PORT = 1234;
 var MIN_BACKOFF = 1e3;
 var MAX_BACKOFF = 1e3 * 30;
-function connect(app, engine, logger2, options = {}) {
+function connect(app, logger2, options = {}) {
   logger2.debug("Connecting to Lightning at", options.lightning);
-  worker_queue_default(options.lightning, app.id, options.secret).then(({ socket, channel }) => {
+  const onConnect = ({ socket, channel }) => {
     logger2.success("Connected to Lightning at", options.lightning);
     app.socket = socket;
     app.channel = channel;
     if (!options.noLoop) {
-      if (app.killWorkloop) {
-        logger2.info("Terminating old workloop");
-        app.killWorkloop();
-      }
       logger2.info("Starting workloop");
       app.killWorkloop = workloop_default(
         app,
@@ -5492,17 +5501,25 @@ function connect(app, engine, logger2, options = {}) {
       );
       logger2.break();
     }
-  }).catch((e) => {
+  };
+  const onDisconnect = () => {
+    if (app.killWorkloop) {
+      app.killWorkloop();
+      delete app.killWorkloop;
+      logger2.info("Connection to lightning lost.");
+      logger2.info(
+        "Worker will automatically reconnect when lightning is back online."
+      );
+    }
+  };
+  const onError = (e) => {
     logger2.error(
       "CRITICAL ERROR: could not connect to lightning at",
       options.lightning
     );
     logger2.debug(e);
-    app.killWorkloop?.();
-    setTimeout(() => {
-      connect(app, engine, logger2, options);
-    }, 1e4);
-  });
+  };
+  worker_queue_default(options.lightning, app.id, options.secret, logger2).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
 }
 function createServer(engine, options = {}) {
   const logger2 = options.logger || createMockLogger2();
@@ -5565,7 +5582,7 @@ function createServer(engine, options = {}) {
   };
   app.use(router.routes());
   if (options.lightning) {
-    connect(app, engine, logger2, options);
+    connect(app, logger2, options);
   } else {
     logger2.warn("No lightning URL provided");
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -21,7 +21,7 @@
     "koa-logger": "^3.2.1",
     "phoenix": "^1.7.7",
     "ws": "^8.14.1",
-    "@openfn/engine-multi": "0.1.6",
+    "@openfn/engine-multi": "0.1.7",
     "@openfn/logger": "0.0.19",
     "@openfn/runtime": "0.1.0"
   },
@@ -40,7 +40,7 @@
     "tsup": "^6.2.3",
     "typescript": "^4.6.4",
     "yargs": "^17.6.2",
-    "@openfn/lightning-mock": "1.0.7"
+    "@openfn/lightning-mock": "1.0.8"
   },
   "files": [
     "dist",