@openfn/ws-worker 0.8.1 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # ws-worker
 
+## 1.0.0
+
+### Major Changes
+
+- 86dd668: The 1.0 release updates the language and input of the Worker to match the nomenclature of Lightning.
+
+### Minor Changes
+
+- 29bff41: Validate the run token
+
+### Patch Changes
+
+- a97eb26: Better error handling for invalid dataclips
+- 823b471: Update handling of logs to accept stringified messages
+- Updated dependencies
+  - @openfn/engine-multi@1.0.0
+  - @openfn/logger@1.0.0
+  - @openfn/runtime@1.0.0
+  - @openfn/lexicon@1.0.0
+
 ## 0.8.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,72 +1,19 @@
 import { EventEmitter } from 'node:events';
 import Koa from 'koa';
-import { SanitizePolicies, Logger } from '@openfn/logger';
+import { Logger } from '@openfn/logger';
+import * as l from '@openfn/lexicon/lightning';
+import { ClaimRun } from '@openfn/lexicon/lightning';
+import { ExecuteOptions, RuntimeEngine } from '@openfn/engine-multi';
+import { ExecutionPlan, Lazy, State } from '@openfn/lexicon';
 import { Channel as Channel$1 } from 'phoenix';
-import { ExecutionPlan } from '@openfn/runtime';
-import { RuntimeEngine } from '@openfn/engine-multi';
 import { Server } from 'http';
 
-type ExitReasonStrings =
-  | 'success'
-  | 'fail'
-  | 'crash'
-  | 'kill'
-  | 'cancel'
-  | 'exception';
-
-type ExitReason = {
-  reason: ExitReasonStrings;
-  error_message: string | null;
-  error_type: string | null;
-};
-
-type Node = {
-  id: string;
-  body?: string;
-  adaptor?: string;
-  credential?: object;
-  credential_id?: string;
-  type?: 'webhook' | 'cron'; // trigger only
-  state?: any; // Initial state / defaults
-};
-
-interface Edge {
-  id: string;
-  source_job_id?: string;
-  source_trigger_id?: string;
-  target_job_id: string;
-  name?: string;
-  condition?: string;
-  error_path?: boolean;
-  errors?: any;
-  enabled?: boolean;
-}
-
-// An run object returned by Lightning
-type Run = {
-  id: string;
-  dataclip_id: string;
-  starting_node_id: string;
-
-  triggers: Node[];
-  jobs: Node[];
-  edges: Edge[];
-
-  options?: RunOptions;
-};
-
-type RunOptions = {
-  runTimeoutMs?: number;
-
-  sanitize?: SanitizePolicies;
-};
-
 // Internal server state for each run
 type RunState = {
   activeStep?: string;
   activeJob?: string;
   plan: ExecutionPlan;
-  options: RunOptions;
+  input: Lazy<State>;
   dataclips: Record<string, any>;
   // For each run, map the input ids
   // TODO better name maybe?
@@ -92,74 +39,16 @@ interface Channel extends Channel$1 {
   // join: () => ReceiveHook;
 }
 
-declare const CLAIM = "claim";
-declare type ClaimPayload = {
-    demand?: number;
-};
-declare type ClaimReply = {
-    runs: Array<ClaimRun>;
-};
-declare type ClaimRun = {
-    id: string;
-    token: string;
+declare type WorkerRunOptions = ExecuteOptions & {
+    outputDataclips?: boolean;
 };
-declare const GET_PLAN = "fetch:plan";
-declare type GetPlanPayload = void;
-declare type GetPlanReply = Run;
-declare const GET_CREDENTIAL = "fetch:credential";
-declare type GetCredentialPayload = {
-    id: string;
-};
-declare type GetCredentialReply = {};
-declare const GET_DATACLIP = "fetch:dataclip";
-declare type GetDataclipPayload = {
-    id: string;
-};
-declare type GetDataClipReply = Uint8Array;
-declare const RUN_START = "run:start";
-declare type RunStartPayload = void;
-declare type RunStartReply = {};
-declare const RUN_COMPLETE = "run:complete";
-declare type RunCompletePayload = ExitReason & {
-    final_dataclip_id?: string;
-};
-declare type RunCompleteReply = undefined;
-declare const RUN_LOG = "run:log";
-declare type RunLogPayload = {
-    message: Array<string | object>;
-    timestamp: string;
-    run_id: string;
-    level?: string;
-    source?: string;
-    job_id?: string;
-    step_id?: string;
-};
-declare type RunLogReply = void;
-declare const STEP_START = "step:start";
-declare type StepStartPayload = {
-    job_id: string;
-    step_id: string;
-    run_id?: string;
-    input_dataclip_id?: string;
-    versions: Record<string, string>;
-};
-declare type StepStartReply = void;
-declare const STEP_COMPLETE = "step:complete";
-declare type StepCompletePayload = ExitReason & {
-    run_id?: string;
-    job_id: string;
-    step_id: string;
-    output_dataclip?: string;
-    output_dataclip_id?: string;
-};
-declare type StepCompleteReply = void;
-declare const INTERNAL_RUN_COMPLETE = "server:run-complete";
 
 declare type Context = {
     channel: Channel;
     state: RunState;
     logger: Logger;
     engine: RuntimeEngine;
+    options: WorkerRunOptions;
     onFinish: (result: any) => void;
 };
 
@@ -170,6 +59,7 @@ declare type ServerOptions = {
     logger?: Logger;
     noLoop?: boolean;
     secret?: string;
+    runPublicKey?: string;
     backoff?: {
         min?: number;
         max?: number;
@@ -184,10 +74,48 @@ interface ServerApp extends Koa {
     events: EventEmitter;
     server: Server;
     engine: RuntimeEngine;
+    options: ServerOptions;
     execute: ({ id, token }: ClaimRun) => Promise<void>;
     destroy: () => void;
     killWorkloop?: () => void;
 }
 declare function createServer(engine: RuntimeEngine, options?: ServerOptions): ServerApp;
 
-export { CLAIM, ClaimPayload, ClaimReply, ClaimRun, GET_CREDENTIAL, GET_DATACLIP, GET_PLAN, GetCredentialPayload, GetCredentialReply, GetDataClipReply, GetDataclipPayload, GetPlanPayload, GetPlanReply, INTERNAL_RUN_COMPLETE, RUN_COMPLETE, RUN_LOG, RUN_START, RunCompletePayload, RunCompleteReply, RunLogPayload, RunLogReply, RunStartPayload, RunStartReply, STEP_COMPLETE, STEP_START, StepCompletePayload, StepCompleteReply, StepStartPayload, StepStartReply, createServer as default };
+declare const CLAIM = "claim";
+declare const GET_PLAN = "fetch:plan";
+declare const GET_DATACLIP = "fetch:dataclip";
+declare const GET_CREDENTIAL = "fetch:credential";
+declare const RUN_START = "run:start";
+declare const RUN_COMPLETE = "run:complete";
+declare const RUN_LOG = "run:log";
+declare const STEP_START = "step:start";
+declare const STEP_COMPLETE = "step:complete";
+declare const INTERNAL_RUN_COMPLETE = "server:run-complete";
+declare type QueueEvents = {
+    [CLAIM]: l.ClaimPayload;
+};
+declare type QueueEventReplies = {
+    [CLAIM]: l.ClaimReply;
+};
+declare type RunEvents = {
+    [GET_PLAN]: l.GetPlanPayload;
+    [GET_CREDENTIAL]: l.GetCredentialPayload;
+    [GET_DATACLIP]: l.GetDataclipPayload;
+    [RUN_START]: l.RunStartPayload;
+    [RUN_COMPLETE]: l.RunCompletePayload;
+    [RUN_LOG]: l.RunLogPayload;
+    [STEP_START]: l.StepStartPayload;
+    [STEP_COMPLETE]: l.StepCompletePayload;
+};
+declare type RunReplies = {
+    [GET_PLAN]: l.GetPlanReply;
+    [GET_CREDENTIAL]: l.GetCredentialReply;
+    [GET_DATACLIP]: l.GetDataClipReply;
+    [RUN_START]: l.RunStartReply;
+    [RUN_COMPLETE]: l.RunCompleteReply;
+    [RUN_LOG]: l.RunLogReply;
+    [STEP_START]: l.StepStartReply;
+    [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 };