@yieldstar/core 0.4.6 → 0.6.0

package/src/lib/workflow-runner.ts

@@ -1,58 +1,80 @@
 import type { Logger } from "pino";
 import type {
   WorkflowGenerator,
-  HeapClient,
-  SchedulerClient,
-  EventProcessor,
   WorkflowEvent,
   EventParams,
+  ExecutionLease,
+  WorkflowRunOutcome,
 } from "..";
-import { StepDelay, WorkflowDelay, WorkflowResult } from "..";
+import {
+  InfrastructureError,
+  StepDelay,
+  StepEffectWait,
+  StepStoreWait,
+  WorkflowResult,
+} from "..";
+import type { Runtime } from "../base/runtime";
+import type { DeliveryOptions } from "../base/invoker";
 import { EventContext } from "../base/event";
 
 export class WorkflowRunner<
   Router extends Record<string, WorkflowGenerator<any, any, any>>
 > {
-  private heapClient: HeapClient;
-  private schedulerClient: SchedulerClient;
+  private runtime: Runtime;
   private router: Router;
+  private logger: Logger;
 
-  constructor(params: {
-    heapClient: HeapClient;
-    schedulerClient: SchedulerClient;
-    router: Router;
-    logger: Logger;
-  }) {
-    this.heapClient = params.heapClient;
-    this.schedulerClient = params.schedulerClient;
-    this.router = params.router;
+  constructor(runtime: Runtime, options: { router: Router; logger: Logger }) {
+    this.runtime = runtime;
+    this.router = options.router;
+    this.logger = options.logger;
   }
 
-  run: EventProcessor = async (event, logger) => {
+  /**
+   * Runs one delivery under `options.lease` and resolves with its outcome.
+   * Rejects only with an infrastructure error, which must not be acknowledged
+   * as an outcome; a lost lease is one, and so is an aborted `options.signal`.
+   */
+  run = async (
+    event: WorkflowEvent,
+    options: DeliveryOptions & { logger?: Logger }
+  ): Promise<WorkflowRunOutcome> => {
+    const { lease, signal, logger = this.logger } = options;
     const workflow = this.router[event.workflowId];
 
     if (!workflow) {
-      throw new Error(`No workflow registered for "${event.workflowId}"`);
+      return {
+        status: "failed",
+        error: new Error(`No workflow registered for "${event.workflowId}"`),
+      };
     }
 
+    let response:
+      | WorkflowResult<unknown>
+      | StepDelay
+      | StepEffectWait
+      | StepStoreWait;
     try {
-      const response = await this.runWorkflows({
+      response = await this.runWorkflows({
         workflow,
         logger,
         event,
+        lease,
+        signal,
       });
-
-      switch (response.type) {
-        case "workflow-result":
-          return response;
-
-        case "workflow-delay":
-          this.schedulerClient.requestWakeUp(event, response.resumeIn);
-          break;
-      }
     } catch (err) {
-      // todo: distinguish between a workflow error and a system error
-      throw err;
+      if (InfrastructureError.is(err)) throw err;
+      return { status: "failed", error: toError(err) };
+    }
+
+    switch (response.type) {
+      case "workflow-result":
+        return { status: "completed", result: response.result };
+      case "step-delay":
+      case "effect-wait":
+        return { status: "suspended", wakeAt: response.wakeAt };
+      case "store-wait":
+        return { status: "suspended" };
     }
   };
 
@@ -63,17 +85,26 @@ export class WorkflowRunner<
   >(params: {
     workflow: WorkflowGenerator<Params, Result, Context>;
     event: WorkflowEvent<Params, Context>;
+    lease: ExecutionLease;
+    signal: AbortSignal;
     logger: Logger;
-  }): Promise<WorkflowResult<Result> | WorkflowDelay> {
-    const { workflow, event, logger } = params;
+  }): Promise<
+    WorkflowResult<Result> | StepDelay | StepEffectWait | StepStoreWait
+  > {
+    const { workflow, event, lease, signal, logger } = params;
 
     const workflowIterator = workflow({
       event,
-      heapClient: this.heapClient,
+      lease,
+      signal,
+      heapClient: this.runtime.heap,
+      storeClient: this.runtime.stores,
+      executionClient: this.runtime.executions,
+      effectClient: this.runtime.effects,
+      clock: this.runtime.clock,
       logger,
     });
 
-
     const iteratorResult = await workflowIterator.next();
     const stageResponse = iteratorResult.value;
 
@@ -81,8 +112,17 @@ export class WorkflowRunner<
       return stageResponse as WorkflowResult<Result>;
     }
 
+    // A delay's `wakeAt` is the absolute time it elapses, which is exactly
+    // the `wakeAt` the suspended outcome reports.
     if (stageResponse instanceof StepDelay) {
-      return new WorkflowDelay(stageResponse.resumeIn - Date.now());
+      return stageResponse;
+    }
+
+    if (
+      stageResponse instanceof StepEffectWait ||
+      stageResponse instanceof StepStoreWait
+    ) {
+      return stageResponse;
     }
 
     throw new Error(
@@ -90,3 +130,7 @@ export class WorkflowRunner<
     );
   }
 }
+
+function toError(value: unknown): Error {
+  return value instanceof Error ? value : new Error(String(value));
+}

package/src/utils/map.test.ts

@@ -1,4 +1,4 @@
-import { expect, test } from "bun:test";
+import { expect, test } from "vitest";
 import { ReadOnlyMap, FreezableMap } from "./map";
 
 test("ReadOnlyMap", () => {

package/src/utils/map.ts

@@ -3,8 +3,14 @@ import { errorWithOriginalStack } from "./error";
 export class ReadOnlyMap<K, V> implements ReadonlyMap<K, V> {
   private sourceMap: Map<K, V>;
 
-  constructor(sourceMap: Map<K, V>) {
-    this.sourceMap = sourceMap;
+  constructor(sourceMap: Map<K, V> | Record<any, any> | undefined) {
+    if (sourceMap instanceof Map) {
+      this.sourceMap = sourceMap;
+    } else if (typeof sourceMap === "object" && sourceMap !== null) {
+      this.sourceMap = new Map(Object.entries(sourceMap)) as Map<K, V>;
+    } else {
+      this.sourceMap = new Map();
+    }
   }
 
   get(key: K): V | undefined {

package/dist/base/map.d.ts

@@ -1,21 +0,0 @@
-export declare class ReadOnlyMap<K, V> implements ReadonlyMap<K, V> {
-    private sourceMap;
-    constructor(sourceMap: Map<K, V>);
-    get(key: K): V | undefined;
-    has(key: K): boolean;
-    get size(): number;
-    entries(): ReturnType<Map<K, V>["entries"]>;
-    keys(): ReturnType<Map<K, V>["keys"]>;
-    values(): ReturnType<Map<K, V>["values"]>;
-    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
-    [Symbol.iterator](): ReturnType<Map<K, V>[typeof Symbol.iterator]>;
-}
-export declare class FreezableMap<K, V> extends Map<K, V> {
-    private frozen;
-    freeze(): void;
-    isFrozen(): boolean;
-    set(key: K, value: V): this;
-    delete(key: K): boolean;
-    clear(): void;
-}
-//# sourceMappingURL=map.d.ts.map

package/dist/base/map.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/base/map.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAW,CAAC,CAAC,EAAE,CAAC,CAAE,YAAW,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IACzD,OAAO,CAAC,SAAS,CAAY;gBAEjB,SAAS,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAIhC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAI1B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAIpB,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,OAAO,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAI3C,IAAI,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAIrC,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAIzC,OAAO,CACL,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,EACtD,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI;IAIP,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;CAGnE;AAED,qBAAa,YAAY,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/C,OAAO,CAAC,MAAM,CAAS;IAEvB,MAAM,IAAI,IAAI;IAId,QAAQ,IAAI,OAAO;IAInB,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAO3B,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO;IAOvB,KAAK,IAAI,IAAI;CAMd"}

package/dist/base/map.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=map.test.d.ts.map

package/dist/base/map.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"map.test.d.ts","sourceRoot":"","sources":["../../src/base/map.test.ts"],"names":[],"mappings":""}

package/dist/base/schedule.d.ts

@@ -1,71 +0,0 @@
-/**
- * Object-based schedule definition with specific time units
- */
-export interface ScheduleObject {
-    /** Execute every X seconds */
-    seconds?: number;
-    /** Execute every X minutes */
-    minutes?: number;
-    /** Execute every X hours */
-    hours?: number;
-    /** Execute every X days */
-    days?: number;
-    /** Execute every X weeks */
-    weeks?: number;
-    /** Execute every X months */
-    months?: number;
-    /** Specific days of the week to run (0 = Sunday, 6 = Saturday) */
-    daysOfWeek?: number[];
-    /** Specific days of the month to run (1-31) */
-    daysOfMonth?: number[];
-    /** Specific months to run (0 = January, 11 = December) */
-    monthsOfYear?: number[];
-}
-/**
- * Schedule definition for a workflow execution
- */
-export interface ScheduleDefinition<T = Record<string, any>> {
-    /** Unique identifier for this schedule */
-    id: string;
-    /** ID of the workflow to execute */
-    workflowId: string;
-    /** Parameters to pass to the workflow execution */
-    params?: T;
-    /**
-     * Schedule definition - can be:
-     * - Cron expression (e.g. "0 9 * * *")
-     * - Object-based schedule with specific time units
-     * - Array of specific dates for one-time executions
-     */
-    schedule: string | ScheduleObject | Date[];
-    /** Whether this schedule is currently active */
-    enabled?: boolean;
-    /** The date when this schedule should start (defaults to now) */
-    startDate?: Date;
-    /** The date when this schedule should stop being executed */
-    endDate?: Date;
-    /**
-     * Retry policy for failed executions
-     */
-    retryPolicy?: {
-        /** Maximum number of retry attempts */
-        maxAttempts: number;
-    };
-    /** Additional metadata for the schedule */
-    metadata?: Record<string, any>;
-}
-/**
- * Options for creating a new schedule
- */
-export interface ScheduleOptions<T = Record<string, any>> extends Omit<ScheduleDefinition<T>, "id"> {
-    /** Optional ID for the schedule (will be auto-generated if not provided) */
-    id?: string;
-}
-/**
- * Response from creating a new schedule
- */
-export interface ScheduleCreationResponse {
-    /** The ID of the created schedule */
-    scheduleId: string;
-}
-//# sourceMappingURL=schedule.d.ts.map

package/dist/base/schedule.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schedule.d.ts","sourceRoot":"","sources":["../../src/base/schedule.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACzD,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IAEnB,mDAAmD;IACnD,MAAM,CAAC,EAAE,CAAC,CAAC;IAEX;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI,EAAE,CAAC;IAE3C,gDAAgD;IAChD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,iEAAiE;IACjE,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,uCAAuC;QACvC,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IAEF,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACtD,SAAQ,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IACzC,4EAA4E;IAC5E,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/base/types.d.ts

@@ -1,24 +0,0 @@
-import type { WorkflowRouter } from "./workflow";
-import type { EventParamsOf } from "./workflow";
-/**
- * Helper type to simplify complex generic types
- * This helps TypeScript's inference by "flattening" nested types
- */
-export type Flatten<T> = {
-    [P in keyof T]: T[P];
-};
-/**
- * Simplified type to extract the key type from a WorkflowRouter
- */
-export type WorkflowKey<W extends WorkflowRouter> = keyof W & string;
-/**
- * Simplified type to extract the parameters type from a workflow
- */
-export type WorkflowParams<W extends WorkflowRouter, K extends WorkflowKey<W>> = EventParamsOf<W[K]>;
-/**
- * Standard response type for trigger operations
- */
-export type TriggerResponse = {
-    executionId: string;
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/base/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/base/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAA+B,MAAM,YAAY,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,cAAc,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,WAAW,CAAC,CAAC,CAAC,IACtB,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/src/base/scheduler.ts

@@ -1,8 +0,0 @@
-import type { WorkflowEvent, EventParams } from "./event";
-
-export interface SchedulerClient {
-  requestWakeUp<Params extends EventParams>(
-    event: WorkflowEvent<Params>,
-    resumeIn?: number
-  ): Promise<void>;
-}