@openfn/ws-worker 0.1.3 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ws-worker
 
+## 0.1.4
+
+### Patch Changes
+
+- Accept backoff as startup command
+
 ## 0.1.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -8,14 +8,16 @@ declare type CLAIM_ATTEMPT = {
 };
 
 declare type ServerOptions = {
-    backoff?: number;
-    maxBackoff?: number;
     maxWorkflows?: number;
     port?: number;
     lightning?: string;
     logger?: Logger;
     noLoop?: boolean;
     secret?: string;
+    backoff?: {
+        min?: number;
+        max?: number;
+    };
 };
 interface ServerApp extends Koa {
     id: string;

package/dist/index.js

@@ -7,20 +7,9 @@ import { humanId } from "human-id";
 import { createMockLogger as createMockLogger2 } from "@openfn/logger";
 
 // src/util/try-with-backoff.ts
-var MAX_BACKOFF = 1e3 * 30;
+var BACKOFF_MULTIPLIER = 1.15;
 var tryWithBackoff = (fn, opts = {}) => {
-  if (!opts.timeout) {
-    opts.timeout = 100;
-  }
-  if (!opts.attempts) {
-    opts.attempts = 1;
-  }
-  if (!opts.maxBackoff) {
-    opts.maxBackoff = MAX_BACKOFF;
-  }
-  let { timeout, attempts, maxAttempts } = opts;
-  timeout = timeout;
-  attempts = attempts;
+  const { min = 1e3, max = 1e4, maxAttempts, attempts = 1 } = opts;
   let cancelled = false;
   if (!opts.isCancelled) {
     opts.isCancelled = () => cancelled;
@@ -43,11 +32,12 @@ var tryWithBackoff = (fn, opts = {}) => {
         const nextOpts = {
           maxAttempts,
           attempts: attempts + 1,
-          timeout: Math.min(opts.maxBackoff, timeout * 1.2),
+          min: Math.min(max, min * BACKOFF_MULTIPLIER),
+          max,
           isCancelled: opts.isCancelled
         };
         tryWithBackoff(fn, nextOpts).then(resolve).catch(reject);
-      }, timeout);
+      }, min);
     }
   });
   promise.cancel = () => {
@@ -92,14 +82,14 @@ var claim = (channel, execute2, logger = mockLogger) => {
 var claim_default = claim;
 
 // src/api/workloop.ts
-var startWorkloop = (channel, execute2, logger, options = {}) => {
+var startWorkloop = (channel, execute2, logger, minBackoff, maxBackoff) => {
   let promise;
   let cancelled = false;
   const workLoop = () => {
     if (!cancelled) {
       promise = try_with_backoff_default(() => claim_default(channel, execute2, logger), {
-        timeout: options.timeout,
-        maxBackoff: options.maxBackoff
+        min: minBackoff,
+        max: maxBackoff
       });
       promise.then(() => {
         if (!cancelled) {
@@ -438,6 +428,8 @@ var worker_queue_default = connectToWorkerQueue;
 
 // src/server.ts
 var DEFAULT_PORT = 1234;
+var MIN_BACKOFF = 1e3;
+var MAX_BACKOFF = 1e3 * 30;
 function connect(app, engine, logger, options = {}) {
   logger.debug("Connecting to Lightning at", options.lightning);
   worker_queue_default(options.lightning, app.id, options.secret).then(({ socket, channel }) => {
@@ -445,10 +437,18 @@ function connect(app, engine, logger, options = {}) {
     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(channel, app.execute, logger, {
-        maxBackoff: options.maxBackoff
-      });
+      app.killWorkloop = workloop_default(
+        channel,
+        app.execute,
+        logger,
+        options.backoff?.min || MIN_BACKOFF,
+        options.backoff?.max || MAX_BACKOFF
+      );
     } else {
       logger.break();
       logger.warn("Workloop not starting");

package/dist/start.js

@@ -4981,20 +4981,9 @@ import { humanId } from "human-id";
 import { createMockLogger as createMockLogger2 } from "@openfn/logger";
 
 // src/util/try-with-backoff.ts
-var MAX_BACKOFF = 1e3 * 30;
+var BACKOFF_MULTIPLIER = 1.15;
 var tryWithBackoff = (fn, opts = {}) => {
-  if (!opts.timeout) {
-    opts.timeout = 100;
-  }
-  if (!opts.attempts) {
-    opts.attempts = 1;
-  }
-  if (!opts.maxBackoff) {
-    opts.maxBackoff = MAX_BACKOFF;
-  }
-  let { timeout, attempts, maxAttempts } = opts;
-  timeout = timeout;
-  attempts = attempts;
+  const { min = 1e3, max = 1e4, maxAttempts, attempts = 1 } = opts;
   let cancelled = false;
   if (!opts.isCancelled) {
     opts.isCancelled = () => cancelled;
@@ -5017,11 +5006,12 @@ var tryWithBackoff = (fn, opts = {}) => {
         const nextOpts = {
           maxAttempts,
           attempts: attempts + 1,
-          timeout: Math.min(opts.maxBackoff, timeout * 1.2),
+          min: Math.min(max, min * BACKOFF_MULTIPLIER),
+          max,
           isCancelled: opts.isCancelled
         };
         tryWithBackoff(fn, nextOpts).then(resolve5).catch(reject);
-      }, timeout);
+      }, min);
     }
   });
   promise.cancel = () => {
@@ -5066,14 +5056,14 @@ var claim = (channel, execute2, logger2 = mockLogger) => {
 var claim_default = claim;
 
 // src/api/workloop.ts
-var startWorkloop = (channel, execute2, logger2, options = {}) => {
+var startWorkloop = (channel, execute2, logger2, minBackoff2, maxBackoff2) => {
   let promise;
   let cancelled = false;
   const workLoop = () => {
     if (!cancelled) {
       promise = try_with_backoff_default(() => claim_default(channel, execute2, logger2), {
-        timeout: options.timeout,
-        maxBackoff: options.maxBackoff
+        min: minBackoff2,
+        max: maxBackoff2
       });
       promise.then(() => {
         if (!cancelled) {
@@ -5412,6 +5402,8 @@ var worker_queue_default = connectToWorkerQueue;
 
 // src/server.ts
 var DEFAULT_PORT = 1234;
+var MIN_BACKOFF = 1e3;
+var MAX_BACKOFF = 1e3 * 30;
 function connect(app, engine, logger2, options = {}) {
   logger2.debug("Connecting to Lightning at", options.lightning);
   worker_queue_default(options.lightning, app.id, options.secret).then(({ socket, channel }) => {
@@ -5419,10 +5411,18 @@ function connect(app, engine, logger2, options = {}) {
     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(channel, app.execute, logger2, {
-        maxBackoff: options.maxBackoff
-      });
+      app.killWorkloop = workloop_default(
+        channel,
+        app.execute,
+        logger2,
+        options.backoff?.min || MIN_BACKOFF,
+        options.backoff?.max || MAX_BACKOFF
+      );
     } else {
       logger2.break();
       logger2.warn("Workloop not starting");
@@ -5532,6 +5532,9 @@ var args = yargs_default(hideBin(process.argv)).command("server", "Start a ws-wo
   description: "Use a mock runtime engine",
   default: false,
   type: "boolean"
+}).option("backoff", {
+  description: "Claim backoff rules: min/max (s)",
+  default: "1/10"
 }).parse();
 var logger = createLogger("SRV", { level: args.log });
 if (args.lightning === "mock") {
@@ -5547,13 +5550,19 @@ if (args.lightning === "mock") {
   }
   args.secret = WORKER_SECRET;
 }
+var [minBackoff, maxBackoff] = args.backoff.split("/").map((n) => parseInt(n, 10) * 1e3);
+console.log(minBackoff, maxBackoff);
 function engineReady(engine) {
   server_default(engine, {
     port: args.port,
     lightning: args.lightning,
     logger,
     secret: args.secret,
-    noLoop: !args.loop
+    noLoop: !args.loop,
+    backoff: {
+      min: minBackoff,
+      max: maxBackoff
+    }
   });
 }
 if (args.mock) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",