@openfn/ws-worker 1.9.2 → 1.11.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # ws-worker
 
+## 1.11.0
+
+### Minor Changes
+
+- 87f10f7: Respond to `work:available` events.
+
+  When the worker receives `work:available` in the worker queue, it'll instantly trigger a claim event.
+
+  This claim is independent of the workloop and does not affect backoff in any way.
+
+## 1.10.0
+
+### Minor Changes
+
+- 1857b46: Allow configuration of job log level
+
+### Patch Changes
+
+- Updated dependencies [1857b46]
+  - @openfn/engine-multi@1.5.0
+  - @openfn/lexicon@1.2.0
+  - @openfn/runtime@1.6.2
+
 ## 1.9.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
 import Koa from 'koa';
-import { Logger } from '@openfn/logger';
+import { LogLevel, Logger } from '@openfn/logger';
 import * as l from '@openfn/lexicon/lightning';
 import { ClaimRun } from '@openfn/lexicon/lightning';
 import { ExecuteOptions, RuntimeEngine } from '@openfn/engine-multi';
@@ -49,6 +49,7 @@ interface Channel extends Channel$1 {
 type WorkerRunOptions = ExecuteOptions & {
     outputDataclips?: boolean;
     payloadLimitMb?: number;
+    jobLogLevel?: LogLevel;
 };
 
 type Context = {
@@ -95,6 +96,7 @@ interface ServerApp extends Koa {
 }
 declare function createServer(engine: RuntimeEngine, options?: ServerOptions): ServerApp;
 
+declare const WORK_AVAILABLE = "work-available";
 declare const CLAIM = "claim";
 declare const GET_PLAN = "fetch:plan";
 declare const GET_DATACLIP = "fetch:dataclip";
@@ -132,4 +134,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, createServer as default };
+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 };

package/dist/index.js

@@ -10,6 +10,7 @@ import { humanId } from "human-id";
 import { createMockLogger as createMockLogger2 } from "@openfn/logger";
 
 // src/events.ts
+var WORK_AVAILABLE = "work-available";
 var CLAIM = "claim";
 var GET_PLAN = "fetch:plan";
 var GET_DATACLIP = "fetch:dataclip";
@@ -287,6 +288,9 @@ var convert_lightning_plan_default = (run, options = {}) => {
     if ("output_dataclips" in run.options) {
       engineOpts.outputDataclips = run.options.output_dataclips;
     }
+    if ("job_log_level" in run.options) {
+      engineOpts.jobLogLevel = run.options.job_log_level;
+    }
   }
   const plan = {
     id: run.id,
@@ -957,6 +961,10 @@ var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger, So
     socket.onOpen(() => {
       didOpen = true;
       const channel = socket.channel("worker:queue");
+      channel.onMessage = (ev, load) => {
+        events.emit("message", ev, load);
+        return load;
+      };
       channel.join().receive("ok", () => {
         logger.debug("Connected to worker queue socket");
         events.emit("connect", { socket, channel });
@@ -1028,13 +1036,19 @@ function connect(app, logger, options = {}) {
     );
     logger.debug(e);
   };
+  const onMessage = (event) => {
+    if (event === WORK_AVAILABLE) {
+      claim_default(app, logger, { maxWorkers: options.maxWorkflows }).catch(() => {
+      });
+    }
+  };
   worker_queue_default(
     options.lightning,
     app.id,
     options.secret,
     options.socketTimeoutSeconds,
     logger
-  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
+  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError).on("message", onMessage);
 }
 async function setupCollections(options, logger) {
   if (options.collectionsUrl) {
@@ -1206,5 +1220,6 @@ export {
   RUN_START,
   STEP_COMPLETE,
   STEP_START,
+  WORK_AVAILABLE,
   src_default as default
 };

package/dist/start.js

@@ -150,6 +150,7 @@ import { humanId } from "human-id";
 import { createMockLogger as createMockLogger2 } from "@openfn/logger";
 
 // src/events.ts
+var WORK_AVAILABLE = "work-available";
 var CLAIM = "claim";
 var GET_PLAN = "fetch:plan";
 var GET_DATACLIP = "fetch:dataclip";
@@ -427,6 +428,9 @@ var convert_lightning_plan_default = (run2, options = {}) => {
     if ("output_dataclips" in run2.options) {
       engineOpts.outputDataclips = run2.options.output_dataclips;
     }
+    if ("job_log_level" in run2.options) {
+      engineOpts.jobLogLevel = run2.options.job_log_level;
+    }
   }
   const plan = {
     id: run2.id,
@@ -1097,6 +1101,10 @@ var connectToWorkerQueue = (endpoint, serverId, secret, timeout = 10, logger2, S
     socket.onOpen(() => {
       didOpen = true;
       const channel = socket.channel("worker:queue");
+      channel.onMessage = (ev, load) => {
+        events.emit("message", ev, load);
+        return load;
+      };
       channel.join().receive("ok", () => {
         logger2.debug("Connected to worker queue socket");
         events.emit("connect", { socket, channel });
@@ -1168,13 +1176,19 @@ function connect(app, logger2, options = {}) {
     );
     logger2.debug(e);
   };
+  const onMessage = (event) => {
+    if (event === WORK_AVAILABLE) {
+      claim_default(app, logger2, { maxWorkers: options.maxWorkflows }).catch(() => {
+      });
+    }
+  };
   worker_queue_default(
     options.lightning,
     app.id,
     options.secret,
     options.socketTimeoutSeconds,
     logger2
-  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError);
+  ).on("connect", onConnect).on("disconnect", onDisconnect).on("error", onError).on("message", onMessage);
 }
 async function setupCollections(options, logger2) {
   if (options.collectionsUrl) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "1.9.2",
+  "version": "1.11.0",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -22,9 +22,9 @@
     "koa-logger": "^3.2.1",
     "phoenix": "1.7.10",
     "ws": "^8.18.0",
-    "@openfn/engine-multi": "1.4.9",
-    "@openfn/lexicon": "^1.1.0",
+    "@openfn/lexicon": "^1.2.0",
     "@openfn/logger": "1.0.4",
+    "@openfn/engine-multi": "1.5.0",
     "@openfn/runtime": "1.6.2"
   },
   "devDependencies": {
@@ -41,7 +41,7 @@
     "tsup": "^6.2.3",
     "typescript": "^4.6.4",
     "yargs": "^17.6.2",
-    "@openfn/lightning-mock": "2.0.30"
+    "@openfn/lightning-mock": "2.1.0"
   },
   "files": [
     "dist",