@openfn/ws-worker 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ws-worker
 
+## 0.7.0
+
+### Minor Changes
+
+- 39af8e1: Ensure that we refer to the child of a 'run' (aka attempt) as a 'step'
+
 ## 0.6.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -73,7 +73,7 @@ type AttemptOptions = {
 
 // Internal server state for each attempt
 type AttemptState = {
-  activeRun?: string;
+  activeStep?: string;
   activeJob?: string;
   plan: ExecutionPlan;
   options: AttemptOptions;
@@ -142,27 +142,27 @@ declare type AttemptLogPayload = {
     level?: string;
     source?: string;
     job_id?: string;
-    run_id?: string;
+    step_id?: string;
 };
 declare type AttemptLogReply = void;
-declare const RUN_START = "run:start";
-declare type RunStartPayload = {
+declare const STEP_START = "step:start";
+declare type StepStartPayload = {
     job_id: string;
-    run_id: string;
+    step_id: string;
     attempt_id?: string;
     input_dataclip_id?: string;
     versions: Record<string, string>;
 };
-declare type RunStartReply = void;
-declare const RUN_COMPLETE = "run:complete";
-declare type RunCompletePayload = ExitReason & {
+declare type StepStartReply = void;
+declare const STEP_COMPLETE = "step:complete";
+declare type StepCompletePayload = ExitReason & {
     attempt_id?: string;
     job_id: string;
-    run_id: string;
+    step_id: string;
     output_dataclip?: string;
     output_dataclip_id?: string;
 };
-declare type RunCompleteReply = void;
+declare type StepCompleteReply = void;
 declare const INTERNAL_ATTEMPT_COMPLETE = "server:attempt-complete";
 
 declare type Context = {
@@ -200,4 +200,4 @@ interface ServerApp extends Koa {
 }
 declare function createServer(engine: RuntimeEngine, options?: ServerOptions): ServerApp;
 
-export { ATTEMPT_COMPLETE, ATTEMPT_LOG, ATTEMPT_START, AttemptCompletePayload, AttemptCompleteReply, AttemptLogPayload, AttemptLogReply, AttemptStartPayload, AttemptStartReply, CLAIM, ClaimAttempt, ClaimPayload, ClaimReply, GET_ATTEMPT, GET_CREDENTIAL, GET_DATACLIP, GetAttemptPayload, GetAttemptReply, GetCredentialPayload, GetCredentialReply, GetDataClipReply, GetDataclipPayload, INTERNAL_ATTEMPT_COMPLETE, RUN_COMPLETE, RUN_START, RunCompletePayload, RunCompleteReply, RunStartPayload, RunStartReply, createServer as default };
+export { ATTEMPT_COMPLETE, ATTEMPT_LOG, ATTEMPT_START, AttemptCompletePayload, AttemptCompleteReply, AttemptLogPayload, AttemptLogReply, AttemptStartPayload, AttemptStartReply, CLAIM, ClaimAttempt, ClaimPayload, ClaimReply, GET_ATTEMPT, GET_CREDENTIAL, GET_DATACLIP, GetAttemptPayload, GetAttemptReply, GetCredentialPayload, GetCredentialReply, GetDataClipReply, GetDataclipPayload, INTERNAL_ATTEMPT_COMPLETE, STEP_COMPLETE, STEP_START, StepCompletePayload, StepCompleteReply, StepStartPayload, StepStartReply, createServer as default };

package/dist/index.js

@@ -15,8 +15,8 @@ var GET_DATACLIP = "fetch:dataclip";
 var ATTEMPT_START = "attempt:start";
 var ATTEMPT_COMPLETE = "attempt:complete";
 var ATTEMPT_LOG = "attempt:log";
-var RUN_START = "run:start";
-var RUN_COMPLETE = "run:complete";
+var STEP_START = "step:start";
+var STEP_COMPLETE = "step:complete";
 var INTERNAL_ATTEMPT_COMPLETE = "server:attempt-complete";
 
 // src/api/destroy.ts
@@ -306,7 +306,7 @@ var create_attempt_state_default = (plan, options = {}) => {
   return state;
 };
 
-// src/events/run-complete.ts
+// src/events/step-complete.ts
 import crypto2 from "node:crypto";
 
 // src/api/reasons.ts
@@ -342,17 +342,17 @@ var calculateAttemptExitReason = (state) => {
   return { reason: "success", error_type: null, error_message: null };
 };
 
-// src/events/run-complete.ts
-function onRunComplete({ channel, state }, event, error) {
+// src/events/step-complete.ts
+function onStepComplete({ channel, state }, event, error) {
   const dataclipId = crypto2.randomUUID();
-  const run_id = state.activeRun;
+  const step_id = state.activeStep;
   const job_id = state.activeJob;
   if (!state.dataclips) {
     state.dataclips = {};
   }
   const outputState = event.state || {};
   state.dataclips[dataclipId] = event.state;
-  delete state.activeRun;
+  delete state.activeStep;
   delete state.activeJob;
   state.lastDataclipId = dataclipId;
   event.next?.forEach((nextJobId) => {
@@ -365,7 +365,7 @@ function onRunComplete({ channel, state }, event, error) {
   );
   state.reasons[job_id] = { reason, error_message, error_type };
   const evt = {
-    run_id,
+    step_id,
     job_id,
     output_dataclip_id: dataclipId,
     output_dataclip: stringify_default(outputState),
@@ -376,17 +376,17 @@ function onRunComplete({ channel, state }, event, error) {
     duration: event.duration,
     thread_id: event.threadId
   };
-  return sendEvent(channel, RUN_COMPLETE, evt);
+  return sendEvent(channel, STEP_COMPLETE, evt);
 }
 
-// src/events/run-start.ts
+// src/events/step-start.ts
 import crypto3 from "node:crypto";
 import { timestamp } from "@openfn/logger";
 
 // package.json
 var package_default = {
   name: "@openfn/ws-worker",
-  version: "0.6.0",
+  version: "0.7.0",
   description: "A Websocket Worker to connect Lightning to a Runtime Engine",
   main: "dist/index.js",
   type: "module",
@@ -449,14 +449,14 @@ var package_default = {
 // src/util/versions.ts
 import { mainSymbols } from "figures";
 var { triangleRightSmall: t } = mainSymbols;
-var versions_default = (runId, versions, adaptor) => {
+var versions_default = (stepId, versions, adaptor) => {
   let longest = "compiler".length;
   for (const v in versions) {
     longest = Math.max(v.length, longest);
   }
   const { node, compiler, engine, worker, runtime, ...adaptors } = versions;
   const prefix = (str2) => `    ${t} ${str2.padEnd(longest + 4, " ")}`;
-  let str = `Versions for run ${runId}:
+  let str = `Versions for step ${stepId}:
 ${prefix("node.js")}${versions.node || "unknown"}
 ${prefix("worker")}${versions.worker || "unknown"}
 ${prefix("engine")}${versions.engine || "unknown"}`;
@@ -470,11 +470,11 @@ ${prefix("engine")}${versions.engine || "unknown"}`;
   return str;
 };
 
-// src/events/run-start.ts
-async function onRunStart(context, event) {
+// src/events/step-start.ts
+async function onStepStart(context, event) {
   const time = (timestamp() - BigInt(1e7)).toString();
   const { channel, state } = context;
-  state.activeRun = crypto3.randomUUID();
+  state.activeStep = crypto3.randomUUID();
   state.activeJob = event.jobId;
   const job = state.plan.jobs.find(({ id }) => id === event.jobId);
   const input_dataclip_id = state.inputDataclips[event.jobId];
@@ -486,17 +486,17 @@ async function onRunStart(context, event) {
     ...context,
     state: {
       ...state,
-      activeRun: state.activeRun
+      activeStep: state.activeStep
     }
   };
-  await sendEvent(channel, RUN_START, {
-    run_id: state.activeRun,
+  await sendEvent(channel, STEP_START, {
+    step_id: state.activeStep,
     job_id: state.activeJob,
     input_dataclip_id,
     versions
   });
   const versionMessage = versions_default(
-    versionLogContext.state.activeRun,
+    versionLogContext.state.activeStep,
     versions,
     job?.adaptor
   );
@@ -591,8 +591,8 @@ var throttle_default = createThrottler;
 var enc = new TextDecoder("utf-8");
 var eventMap = {
   "workflow-start": ATTEMPT_START,
-  "job-start": RUN_START,
-  "job-complete": RUN_COMPLETE,
+  "job-start": STEP_START,
+  "job-complete": STEP_COMPLETE,
   "workflow-log": ATTEMPT_LOG,
   "workflow-complete": ATTEMPT_COMPLETE
 };
@@ -622,8 +622,8 @@ function execute(channel, engine, logger, plan, options = {}, onFinish = (_resul
   const listeners = Object.assign(
     {},
     addEvent("workflow-start", throttle(onWorkflowStart)),
-    addEvent("job-start", throttle(onRunStart)),
-    addEvent("job-complete", throttle(onRunComplete)),
+    addEvent("job-start", throttle(onStepStart)),
+    addEvent("job-complete", throttle(onStepComplete)),
     addEvent("job-error", throttle(onJobError)),
     addEvent("workflow-log", throttle(onJobLog)),
     addEvent("workflow-complete", throttle(onWorkflowComplete)),
@@ -663,9 +663,9 @@ var sendEvent = (channel, event, payload) => new Promise((resolve, reject) => {
 function onJobError(context, event) {
   const { state, error, jobId } = event;
   if (state?.errors?.[jobId]?.message === error.message) {
-    return onRunComplete(context, event);
+    return onStepComplete(context, event);
   } else {
-    return onRunComplete(context, event, event.error);
+    return onStepComplete(context, event, event.error);
   }
 }
 function onWorkflowStart({ channel }, _event) {
@@ -680,8 +680,8 @@ function onJobLog({ channel, state }, event) {
     level: event.level,
     timestamp: timeInMicroseconds.toString()
   };
-  if (state.activeRun) {
-    log.run_id = state.activeRun;
+  if (state.activeStep) {
+    log.step_id = state.activeStep;
   }
   return sendEvent(channel, ATTEMPT_LOG, log);
 }
@@ -935,7 +935,7 @@ export {
   GET_CREDENTIAL,
   GET_DATACLIP,
   INTERNAL_ATTEMPT_COMPLETE,
-  RUN_COMPLETE,
-  RUN_START,
+  STEP_COMPLETE,
+  STEP_START,
   src_default as default
 };

package/dist/start.js

@@ -5004,8 +5004,8 @@ var GET_DATACLIP = "fetch:dataclip";
 var ATTEMPT_START = "attempt:start";
 var ATTEMPT_COMPLETE = "attempt:complete";
 var ATTEMPT_LOG = "attempt:log";
-var RUN_START = "run:start";
-var RUN_COMPLETE = "run:complete";
+var STEP_START = "step:start";
+var STEP_COMPLETE = "step:complete";
 var INTERNAL_ATTEMPT_COMPLETE = "server:attempt-complete";
 
 // src/api/destroy.ts
@@ -5295,7 +5295,7 @@ var create_attempt_state_default = (plan, options = {}) => {
   return state;
 };
 
-// src/events/run-complete.ts
+// src/events/step-complete.ts
 import crypto3 from "node:crypto";
 
 // src/api/reasons.ts
@@ -5331,17 +5331,17 @@ var calculateAttemptExitReason = (state) => {
   return { reason: "success", error_type: null, error_message: null };
 };
 
-// src/events/run-complete.ts
-function onRunComplete({ channel, state }, event, error) {
+// src/events/step-complete.ts
+function onStepComplete({ channel, state }, event, error) {
   const dataclipId = crypto3.randomUUID();
-  const run_id = state.activeRun;
+  const step_id = state.activeStep;
   const job_id = state.activeJob;
   if (!state.dataclips) {
     state.dataclips = {};
   }
   const outputState = event.state || {};
   state.dataclips[dataclipId] = event.state;
-  delete state.activeRun;
+  delete state.activeStep;
   delete state.activeJob;
   state.lastDataclipId = dataclipId;
   event.next?.forEach((nextJobId) => {
@@ -5354,7 +5354,7 @@ function onRunComplete({ channel, state }, event, error) {
   );
   state.reasons[job_id] = { reason, error_message, error_type };
   const evt = {
-    run_id,
+    step_id,
     job_id,
     output_dataclip_id: dataclipId,
     output_dataclip: stringify_default(outputState),
@@ -5365,17 +5365,17 @@ function onRunComplete({ channel, state }, event, error) {
     duration: event.duration,
     thread_id: event.threadId
   };
-  return sendEvent(channel, RUN_COMPLETE, evt);
+  return sendEvent(channel, STEP_COMPLETE, evt);
 }
 
-// src/events/run-start.ts
+// src/events/step-start.ts
 import crypto4 from "node:crypto";
 import { timestamp } from "@openfn/logger";
 
 // package.json
 var package_default = {
   name: "@openfn/ws-worker",
-  version: "0.6.0",
+  version: "0.7.0",
   description: "A Websocket Worker to connect Lightning to a Runtime Engine",
   main: "dist/index.js",
   type: "module",
@@ -5438,14 +5438,14 @@ var package_default = {
 // src/util/versions.ts
 import { mainSymbols } from "figures";
 var { triangleRightSmall: t } = mainSymbols;
-var versions_default = (runId, versions, adaptor) => {
+var versions_default = (stepId, versions, adaptor) => {
   let longest = "compiler".length;
   for (const v in versions) {
     longest = Math.max(v.length, longest);
   }
   const { node, compiler, engine, worker, runtime, ...adaptors } = versions;
   const prefix = (str2) => `    ${t} ${str2.padEnd(longest + 4, " ")}`;
-  let str = `Versions for run ${runId}:
+  let str = `Versions for step ${stepId}:
 ${prefix("node.js")}${versions.node || "unknown"}
 ${prefix("worker")}${versions.worker || "unknown"}
 ${prefix("engine")}${versions.engine || "unknown"}`;
@@ -5459,11 +5459,11 @@ ${prefix("engine")}${versions.engine || "unknown"}`;
   return str;
 };
 
-// src/events/run-start.ts
-async function onRunStart(context, event) {
+// src/events/step-start.ts
+async function onStepStart(context, event) {
   const time = (timestamp() - BigInt(1e7)).toString();
   const { channel, state } = context;
-  state.activeRun = crypto4.randomUUID();
+  state.activeStep = crypto4.randomUUID();
   state.activeJob = event.jobId;
   const job = state.plan.jobs.find(({ id }) => id === event.jobId);
   const input_dataclip_id = state.inputDataclips[event.jobId];
@@ -5475,17 +5475,17 @@ async function onRunStart(context, event) {
     ...context,
     state: {
       ...state,
-      activeRun: state.activeRun
+      activeStep: state.activeStep
     }
   };
-  await sendEvent(channel, RUN_START, {
-    run_id: state.activeRun,
+  await sendEvent(channel, STEP_START, {
+    step_id: state.activeStep,
     job_id: state.activeJob,
     input_dataclip_id,
     versions
   });
   const versionMessage = versions_default(
-    versionLogContext.state.activeRun,
+    versionLogContext.state.activeStep,
     versions,
     job?.adaptor
   );
@@ -5580,8 +5580,8 @@ var throttle_default = createThrottler;
 var enc = new TextDecoder("utf-8");
 var eventMap = {
   "workflow-start": ATTEMPT_START,
-  "job-start": RUN_START,
-  "job-complete": RUN_COMPLETE,
+  "job-start": STEP_START,
+  "job-complete": STEP_COMPLETE,
   "workflow-log": ATTEMPT_LOG,
   "workflow-complete": ATTEMPT_COMPLETE
 };
@@ -5611,8 +5611,8 @@ function execute(channel, engine, logger2, plan, options = {}, onFinish = (_resu
   const listeners = Object.assign(
     {},
     addEvent("workflow-start", throttle(onWorkflowStart)),
-    addEvent("job-start", throttle(onRunStart)),
-    addEvent("job-complete", throttle(onRunComplete)),
+    addEvent("job-start", throttle(onStepStart)),
+    addEvent("job-complete", throttle(onStepComplete)),
     addEvent("job-error", throttle(onJobError)),
     addEvent("workflow-log", throttle(onJobLog)),
     addEvent("workflow-complete", throttle(onWorkflowComplete)),
@@ -5652,9 +5652,9 @@ var sendEvent = (channel, event, payload) => new Promise((resolve5, reject) => {
 function onJobError(context, event) {
   const { state, error, jobId } = event;
   if (state?.errors?.[jobId]?.message === error.message) {
-    return onRunComplete(context, event);
+    return onStepComplete(context, event);
   } else {
-    return onRunComplete(context, event, event.error);
+    return onStepComplete(context, event, event.error);
   }
 }
 function onWorkflowStart({ channel }, _event) {
@@ -5669,8 +5669,8 @@ function onJobLog({ channel, state }, event) {
     level: event.level,
     timestamp: timeInMicroseconds.toString()
   };
-  if (state.activeRun) {
-    log.run_id = state.activeRun;
+  if (state.activeStep) {
+    log.step_id = state.activeStep;
   }
   return sendEvent(channel, ATTEMPT_LOG, log);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -41,7 +41,7 @@
     "tsup": "^6.2.3",
     "typescript": "^4.6.4",
     "yargs": "^17.6.2",
-    "@openfn/lightning-mock": "1.1.10"
+    "@openfn/lightning-mock": "1.1.11"
   },
   "files": [
     "dist",