@openfn/ws-worker 1.22.3 → 1.23.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ws-worker
 
+## 1.23.1
+
+### Patch Changes
+
+- Even when sending final_dataclip_id, send finalState because it may be used by other consumers
+
+## 1.23.0
+
+### Minor Changes
+
+- 01a05ff: on send complete, only send final_state for multi-leaf output state. For single-leaf runs, reutrn final_dataclip_id
+
 ## 1.22.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -42,8 +42,8 @@ type RunState = {
   withheldDataclips: Record<string, true>;
   reasons: Record<string, ExitReason>;
 
-  // final dataclip id
-  lastDataclipId?: string;
+  // dataclip ids for leaf nodes (steps with no downstream)
+  leafDataclipIds: string[];
 };
 
 type ReceiveHook = {

package/dist/index.js

@@ -379,7 +379,7 @@ var convert_lightning_plan_default = (run, options = {}) => {
 // src/util/create-run-state.ts
 var create_run_state_default = (plan, input) => {
   const state = {
-    lastDataclipId: "",
+    leafDataclipIds: [],
     dataclips: {},
     inputDataclips: {},
     withheldDataclips: {},
@@ -730,7 +730,9 @@ async function onStepComplete(context, event, error) {
   state.dataclips[dataclipId] = event.state;
   delete state.activeStep;
   delete state.activeJob;
-  state.lastDataclipId = dataclipId;
+  if (!event.next?.length) {
+    state.leafDataclipIds.push(dataclipId);
+  }
   event.next?.forEach((nextJobId) => {
     state.inputDataclips[nextJobId] = dataclipId;
   });
@@ -819,12 +821,17 @@ async function onWorkflowComplete(context, event) {
   const result = event.state;
   const reason = calculateRunExitReason(state);
   await log_final_reason_default(context, reason);
+  const isSingleLeaf = state.leafDataclipIds.length === 1 && !state.withheldDataclips[state.leafDataclipIds[0]];
+  const payload = {
+    timestamp: timeInMicroseconds(event.time),
+    final_state: result,
+    ...reason
+  };
+  if (isSingleLeaf) {
+    payload.final_dataclip_id = state.leafDataclipIds[0];
+  }
   try {
-    await sendEvent(context, RUN_COMPLETE, {
-      final_state: result,
-      timestamp: timeInMicroseconds(event.time),
-      ...reason
-    });
+    await sendEvent(context, RUN_COMPLETE, payload);
   } catch (e) {
     logger.error(
       `${state.plan.id} failed to send ${RUN_COMPLETE} event. This run will be lost!`

package/dist/start.js

@@ -527,7 +527,7 @@ var convert_lightning_plan_default = (run2, options = {}) => {
 // src/util/create-run-state.ts
 var create_run_state_default = (plan, input) => {
   const state = {
-    lastDataclipId: "",
+    leafDataclipIds: [],
     dataclips: {},
     inputDataclips: {},
     withheldDataclips: {},
@@ -878,7 +878,9 @@ async function onStepComplete(context, event, error) {
   state.dataclips[dataclipId] = event.state;
   delete state.activeStep;
   delete state.activeJob;
-  state.lastDataclipId = dataclipId;
+  if (!event.next?.length) {
+    state.leafDataclipIds.push(dataclipId);
+  }
   event.next?.forEach((nextJobId) => {
     state.inputDataclips[nextJobId] = dataclipId;
   });
@@ -967,12 +969,17 @@ async function onWorkflowComplete(context, event) {
   const result = event.state;
   const reason = calculateRunExitReason(state);
   await log_final_reason_default(context, reason);
+  const isSingleLeaf = state.leafDataclipIds.length === 1 && !state.withheldDataclips[state.leafDataclipIds[0]];
+  const payload = {
+    timestamp: timeInMicroseconds(event.time),
+    final_state: result,
+    ...reason
+  };
+  if (isSingleLeaf) {
+    payload.final_dataclip_id = state.leafDataclipIds[0];
+  }
   try {
-    await sendEvent(context, RUN_COMPLETE, {
-      final_state: result,
-      timestamp: timeInMicroseconds(event.time),
-      ...reason
-    });
+    await sendEvent(context, RUN_COMPLETE, payload);
   } catch (e) {
     logger2.error(
       `${state.plan.id} failed to send ${RUN_COMPLETE} event. This run will be lost!`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/ws-worker",
-  "version": "1.22.3",
+  "version": "1.23.1",
   "description": "A Websocket Worker to connect Lightning to a Runtime Engine",
   "main": "dist/index.js",
   "type": "module",
@@ -23,8 +23,8 @@
     "koa-logger": "^3.2.1",
     "phoenix": "1.7.10",
     "ws": "^8.19.0",
-    "@openfn/engine-multi": "1.10.7",
     "@openfn/lexicon": "^1.4.2",
+    "@openfn/engine-multi": "1.10.7",
     "@openfn/logger": "1.1.2",
     "@openfn/runtime": "1.8.6"
   },