@openfn/ws-worker 0.1.8 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # ws-worker
 
+## 0.2.0
+
+### Minor Changes
+
+- 0e8e20c: BREAKING: Updated exit reasons to `{ reason: "success", error_type, error_message }`
+  Add exit reasons to job and attempt complete
+
+### Patch Changes
+
+- Updated dependencies [a540888]
+- Updated dependencies [0e8e20c]
+  - @openfn/runtime@0.1.0
+  - @openfn/engine-multi@0.1.6
+
 ## 0.1.8
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,6 +4,20 @@ import { RuntimeEngine } from '@openfn/engine-multi';
 import { Channel as Channel$1 } from 'phoenix';
 import { ExecutionPlan } from '@openfn/runtime';
 
+type ExitReasonStrings =
+  | 'success'
+  | 'fail'
+  | 'crash'
+  | 'kill'
+  | 'cancel'
+  | 'exception';
+
+type ExitReason = {
+  reason: ExitReasonStrings;
+  error_message: string | null;
+  error_type: string | null;
+};
+
 type AttemptOptions = {
   timeout?: number;
   sanitize?: SanitizePolicies;
@@ -37,6 +51,7 @@ declare type AttemptState = {
     plan: ExecutionPlan;
     options: AttemptOptions;
     dataclips: Record<string, any>;
+    reasons: Record<string, ExitReason>;
     lastDataclipId?: string;
 };
 declare type Context = {

package/dist/index.js

@@ -210,6 +210,30 @@ var stringify_default = (obj) => stringify(obj, (_key, value) => {
   return value;
 });
 
+// src/api/reasons.ts
+var calculateJobExitReason = (jobId, state, error) => {
+  let reason = "success";
+  let error_type = null;
+  let error_message = null;
+  if (error) {
+    reason = error.severity ?? "crash";
+    error_message = error.message;
+    error_type = error.subtype || error.type || error.name;
+  } else if (state.errors?.[jobId]) {
+    reason = "fail";
+    ({ message: error_message, type: error_type } = state.errors[jobId]);
+  }
+  return { reason, error_type, error_message };
+};
+var calculateAttemptExitReason = (state) => {
+  if (state.reasons) {
+    const fail = Object.values(state.reasons).find(
+      ({ reason }) => reason === "fail"
+    );
+    return fail || { reason: "success", error_type: null, error_message: null };
+  }
+};
+
 // src/api/execute.ts
 var enc = new TextDecoder("utf-8");
 var eventMap = {
@@ -219,15 +243,17 @@ var eventMap = {
   "workflow-log": ATTEMPT_LOG,
   "workflow-complete": ATTEMPT_COMPLETE
 };
+var createAttemptState = (plan, options = {}) => ({
+  plan,
+  lastDataclipId: plan.initialState,
+  dataclips: {},
+  reasons: {},
+  options
+});
 function execute(channel, engine, logger, plan, options = {}, onComplete = (_result) => {
 }) {
   logger.info("execute...");
-  const state = {
-    plan,
-    lastDataclipId: plan.initialState,
-    dataclips: {},
-    options
-  };
+  const state = createAttemptState(plan, options);
   const context = { channel, state, logger, onComplete };
   const addEvent = (eventName, handler) => {
     const wrappedFn = async (event) => {
@@ -251,6 +277,7 @@ function execute(channel, engine, logger, plan, options = {}, onComplete = (_res
     addEvent("workflow-start", onWorkflowStart),
     addEvent("job-start", onJobStart),
     addEvent("job-complete", onJobComplete),
+    addEvent("job-error", onJobError),
     addEvent("workflow-log", onJobLog),
     addEvent("workflow-complete", onWorkflowComplete),
     addEvent("workflow-error", onWorkflowError)
@@ -288,7 +315,15 @@ function onJobStart({ channel, state }, event) {
     input_dataclip_id: state.lastDataclipId
   });
 }
-function onJobComplete({ channel, state }, event) {
+function onJobError(context, event) {
+  const { state, error, jobId } = event;
+  if (state.errors?.[jobId]?.message === error.message) {
+    onJobComplete(context, event);
+  } else {
+    onJobComplete(context, event, event.error);
+  }
+}
+function onJobComplete({ channel, state }, event, error) {
   const dataclipId = crypto2.randomUUID();
   const run_id = state.activeRun;
   const job_id = state.activeJob;
@@ -299,12 +334,20 @@ function onJobComplete({ channel, state }, event) {
   state.lastDataclipId = dataclipId;
   delete state.activeRun;
   delete state.activeJob;
+  const { reason, error_message, error_type } = calculateJobExitReason(
+    job_id,
+    event.state,
+    error
+  );
+  state.reasons[job_id] = { reason, error_message, error_type };
   return sendEvent(channel, RUN_COMPLETE, {
     run_id,
     job_id,
     output_dataclip_id: dataclipId,
     output_dataclip: stringify_default(event.state),
-    reason: "success"
+    reason,
+    error_message,
+    error_type
   });
 }
 function onWorkflowStart({ channel }, _event) {
@@ -312,20 +355,20 @@ function onWorkflowStart({ channel }, _event) {
 }
 async function onWorkflowComplete({ state, channel, onComplete }, _event) {
   const result = state.dataclips[state.lastDataclipId];
+  const reason = calculateAttemptExitReason(state);
   await sendEvent(channel, ATTEMPT_COMPLETE, {
     final_dataclip_id: state.lastDataclipId,
-    status: "success",
-    reason: "ok"
+    ...reason
   });
-  onComplete(result);
+  onComplete({ reason, state: result });
 }
 async function onWorkflowError({ state, channel, onComplete }, event) {
+  const reason = calculateJobExitReason("", { data: {} }, event);
   await sendEvent(channel, ATTEMPT_COMPLETE, {
-    reason: "fail",
     final_dataclip_id: state.lastDataclipId,
-    message: event.message
+    ...reason
   });
-  onComplete({});
+  onComplete({ reason });
 }
 function onJobLog({ channel, state }, event) {
   const timeInMicroseconds = BigInt(event.time) / BigInt(1e3);

package/dist/start.js

@@ -5192,6 +5192,30 @@ var stringify_default = (obj) => stringify(obj, (_key, value) => {
   return value;
 });
 
+// src/api/reasons.ts
+var calculateJobExitReason = (jobId, state, error) => {
+  let reason = "success";
+  let error_type = null;
+  let error_message = null;
+  if (error) {
+    reason = error.severity ?? "crash";
+    error_message = error.message;
+    error_type = error.subtype || error.type || error.name;
+  } else if (state.errors?.[jobId]) {
+    reason = "fail";
+    ({ message: error_message, type: error_type } = state.errors[jobId]);
+  }
+  return { reason, error_type, error_message };
+};
+var calculateAttemptExitReason = (state) => {
+  if (state.reasons) {
+    const fail = Object.values(state.reasons).find(
+      ({ reason }) => reason === "fail"
+    );
+    return fail || { reason: "success", error_type: null, error_message: null };
+  }
+};
+
 // src/api/execute.ts
 var enc = new TextDecoder("utf-8");
 var eventMap = {
@@ -5201,15 +5225,17 @@ var eventMap = {
   "workflow-log": ATTEMPT_LOG,
   "workflow-complete": ATTEMPT_COMPLETE
 };
+var createAttemptState = (plan, options = {}) => ({
+  plan,
+  lastDataclipId: plan.initialState,
+  dataclips: {},
+  reasons: {},
+  options
+});
 function execute(channel, engine, logger2, plan, options = {}, onComplete = (_result) => {
 }) {
   logger2.info("execute...");
-  const state = {
-    plan,
-    lastDataclipId: plan.initialState,
-    dataclips: {},
-    options
-  };
+  const state = createAttemptState(plan, options);
   const context = { channel, state, logger: logger2, onComplete };
   const addEvent = (eventName, handler) => {
     const wrappedFn = async (event) => {
@@ -5233,6 +5259,7 @@ function execute(channel, engine, logger2, plan, options = {}, onComplete = (_re
     addEvent("workflow-start", onWorkflowStart),
     addEvent("job-start", onJobStart),
     addEvent("job-complete", onJobComplete),
+    addEvent("job-error", onJobError),
     addEvent("workflow-log", onJobLog),
     addEvent("workflow-complete", onWorkflowComplete),
     addEvent("workflow-error", onWorkflowError)
@@ -5270,7 +5297,15 @@ function onJobStart({ channel, state }, event) {
     input_dataclip_id: state.lastDataclipId
   });
 }
-function onJobComplete({ channel, state }, event) {
+function onJobError(context, event) {
+  const { state, error, jobId } = event;
+  if (state.errors?.[jobId]?.message === error.message) {
+    onJobComplete(context, event);
+  } else {
+    onJobComplete(context, event, event.error);
+  }
+}
+function onJobComplete({ channel, state }, event, error) {
   const dataclipId = crypto3.randomUUID();
   const run_id = state.activeRun;
   const job_id = state.activeJob;
@@ -5281,12 +5316,20 @@ function onJobComplete({ channel, state }, event) {
   state.lastDataclipId = dataclipId;
   delete state.activeRun;
   delete state.activeJob;
+  const { reason, error_message, error_type } = calculateJobExitReason(
+    job_id,
+    event.state,
+    error
+  );
+  state.reasons[job_id] = { reason, error_message, error_type };
   return sendEvent(channel, RUN_COMPLETE, {
     run_id,
     job_id,
     output_dataclip_id: dataclipId,
     output_dataclip: stringify_default(event.state),
-    reason: "success"
+    reason,
+    error_message,
+    error_type
   });
 }
 function onWorkflowStart({ channel }, _event) {
@@ -5294,20 +5337,20 @@ function onWorkflowStart({ channel }, _event) {
 }
 async function onWorkflowComplete({ state, channel, onComplete }, _event) {
   const result = state.dataclips[state.lastDataclipId];
+  const reason = calculateAttemptExitReason(state);
   await sendEvent(channel, ATTEMPT_COMPLETE, {
     final_dataclip_id: state.lastDataclipId,
-    status: "success",
-    reason: "ok"
+    ...reason
   });
-  onComplete(result);
+  onComplete({ reason, state: result });
 }
 async function onWorkflowError({ state, channel, onComplete }, event) {
+  const reason = calculateJobExitReason("", { data: {} }, event);
   await sendEvent(channel, ATTEMPT_COMPLETE, {
-    reason: "fail",
     final_dataclip_id: state.lastDataclipId,
-    message: event.message
+    ...reason
   });
-  onComplete({});
+  onComplete({ reason });
 }
 function onJobLog({ channel, state }, event) {
   const timeInMicroseconds = BigInt(event.time) / BigInt(1e3);

package/package.json

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