pg-workflows 0.10.0 → 0.12.0

package/dist/index.js

@@ -1,7 +1,6 @@
 import {
   DEFAULT_PGBOSS_SCHEMA,
   PAUSE_EVENT_NAME,
-  StepType,
   WORKFLOW_RUN_DLQ_QUEUE_NAME,
   WORKFLOW_RUN_QUEUE_NAME,
   WorkflowClient,
@@ -21,32 +20,7 @@ import {
   waitForTimelineKey,
   withPostgresTransaction,
   workflow
-} from "./shared/chunk-nygamc7b.js";
-// src/duration.ts
-import parse from "parse-duration";
-var MS_PER_SECOND = 1000;
-var MS_PER_MINUTE = 60 * MS_PER_SECOND;
-var MS_PER_HOUR = 60 * MS_PER_MINUTE;
-var MS_PER_DAY = 24 * MS_PER_HOUR;
-var MS_PER_WEEK = 7 * MS_PER_DAY;
-function parseDuration(duration) {
-  if (typeof duration === "string") {
-    if (duration.trim() === "") {
-      throw new WorkflowEngineError("Invalid duration: empty string");
-    }
-    const ms2 = parse(duration);
-    if (ms2 == null || ms2 <= 0) {
-      throw new WorkflowEngineError(`Invalid duration: "${duration}"`);
-    }
-    return ms2;
-  }
-  const { weeks = 0, days = 0, hours = 0, minutes = 0, seconds = 0 } = duration;
-  const ms = weeks * MS_PER_WEEK + days * MS_PER_DAY + hours * MS_PER_HOUR + minutes * MS_PER_MINUTE + seconds * MS_PER_SECOND;
-  if (ms <= 0) {
-    throw new WorkflowEngineError("Invalid duration: must be a positive value");
-  }
-  return ms;
-}
+} from "./shared/chunk-ahxqsytt.js";
 // src/engine.ts
 import { merge } from "es-toolkit";
 import pg from "pg";
@@ -122,6 +96,32 @@ function parseWorkflowHandler(handler) {
   return { steps: Array.from(steps.values()) };
 }
 
+// src/duration.ts
+import parse from "parse-duration";
+var MS_PER_SECOND = 1000;
+var MS_PER_MINUTE = 60 * MS_PER_SECOND;
+var MS_PER_HOUR = 60 * MS_PER_MINUTE;
+var MS_PER_DAY = 24 * MS_PER_HOUR;
+var MS_PER_WEEK = 7 * MS_PER_DAY;
+function parseDuration(duration) {
+  if (typeof duration === "string") {
+    if (duration.trim() === "") {
+      throw new WorkflowEngineError("Invalid duration: empty string");
+    }
+    const ms2 = parse(duration);
+    if (ms2 == null || ms2 <= 0) {
+      throw new WorkflowEngineError(`Invalid duration: "${duration}"`);
+    }
+    return ms2;
+  }
+  const { weeks = 0, days = 0, hours = 0, minutes = 0, seconds = 0 } = duration;
+  const ms = weeks * MS_PER_WEEK + days * MS_PER_DAY + hours * MS_PER_HOUR + minutes * MS_PER_MINUTE + seconds * MS_PER_SECOND;
+  if (ms <= 0) {
+    throw new WorkflowEngineError("Invalid duration: must be a positive value");
+  }
+  return ms;
+}
+
 // src/engine.ts
 var LOG_PREFIX = "[WorkflowEngine]";
 var StepTypeToIcon = {
@@ -271,7 +271,7 @@ class WorkflowEngine {
   async startWorkflow(refOrParams, inputArg, optionsArg) {
     const { workflowId, input, resourceId, idempotencyKey, options } = this.resolveWorkflowRunParameters(refOrParams, inputArg, optionsArg);
     if (!this._started) {
-      await this.start(false, { batchSize: options?.batchSize ?? 1 });
+      await this.start(false);
     }
     const { run } = await this.createWorkflowRun({
       workflowId,
@@ -732,19 +732,32 @@ class WorkflowEngine {
       };
       let step = { ...baseStep };
       const plugins = workflow2.plugins ?? [];
-      for (const plugin of plugins) {
-        const extra = plugin.methods(step);
-        step = { ...step, ...extra };
-      }
       const context = {
         input: run.input,
         workflowId: run.workflowId,
         runId: run.id,
-        timeline: run.timeline,
+        resourceId: run.resourceId ?? undefined,
+        attempt: run.retryCount,
+        get timeline() {
+          return run?.timeline ?? {};
+        },
         logger: this.logger,
         step
       };
-      const result = await workflow2.handler(context);
+      for (const plugin of plugins) {
+        const extra = plugin.methods(step, context);
+        step = { ...step, ...extra };
+        context.step = step;
+      }
+      let next = () => workflow2.handler(context);
+      for (const plugin of [...plugins].reverse()) {
+        if (plugin.wrap) {
+          const inner = next;
+          const wrap = plugin.wrap;
+          next = () => wrap(context, inner);
+        }
+      }
+      const result = await next();
       run = await this.getRun({ runId, resourceId: scopedResourceId });
       const isLastParsedStep = run.currentStepId === workflow2.steps[workflow2.steps.length - 1]?.id;
       const hasPluginSteps = (workflow2.plugins?.length ?? 0) > 0;
@@ -1037,7 +1050,7 @@ class WorkflowEngine {
         if (output === undefined) {
           output = {};
         }
-        run = await this.updateRun({
+        const updated = await this.updateRun({
           runId: run.id,
           resourceId: run.resourceId ?? undefined,
           data: {
@@ -1049,6 +1062,7 @@ class WorkflowEngine {
             })
           }
         }, { db });
+        Object.assign(run, updated);
         return output;
       } catch (error) {
         this.logger.error(`Step ${stepId} failed:`, error, {
@@ -1276,19 +1290,190 @@ ${error.stack}` : String(error)
     }, this.db);
   }
 }
+// src/plugins/otel.ts
+import {
+  context as otelContext,
+  SpanStatusCode,
+  trace
+} from "@opentelemetry/api";
+var DEFAULT_PREFIX = "pg_workflows";
+function isCachedHit(timeline, stepId, kind) {
+  const entry = timeline[stepId];
+  if (entry && typeof entry === "object" && "output" in entry && entry.output !== undefined) {
+    return true;
+  }
+  if (kind === "invokeChildWorkflow" && timeline[invokeChildWorkflowTimelineKey(stepId)]) {
+    return true;
+  }
+  return false;
+}
+function otelPlugin(options = {}) {
+  const tracer = options.tracer ?? trace.getTracer("pg-workflows");
+  const prefix = options.spanNamePrefix ?? DEFAULT_PREFIX;
+  const extraAttrs = options.attributes;
+  return {
+    name: "opentelemetry",
+    methods: (step, context) => {
+      const wrapVoidish = (kind, base) => {
+        return async (stepId, ...args) => {
+          if (isCachedHit(context.timeline, stepId, kind)) {
+            return base(stepId, ...args);
+          }
+          const capturedCtx = otelContext.active();
+          const startTime = new Date;
+          let result;
+          let originalErr;
+          let thrownError;
+          try {
+            result = await base(stepId, ...args);
+          } catch (err) {
+            originalErr = err;
+            thrownError = err instanceof Error ? err : new Error(String(err));
+          }
+          const span = tracer.startSpan(`${prefix}.step.${kind}`, {
+            startTime,
+            attributes: { "step.id": stepId, "step.type": kind }
+          }, capturedCtx);
+          if (thrownError) {
+            span.recordException(thrownError);
+            span.setStatus({ code: SpanStatusCode.ERROR, message: thrownError.message });
+            span.end();
+            throw originalErr;
+          }
+          span.setStatus({ code: SpanStatusCode.OK });
+          span.end();
+          return result;
+        };
+      };
+      return {
+        run: async (stepId, handler) => {
+          if (isCachedHit(context.timeline, stepId, "run")) {
+            return step.run(stepId, handler);
+          }
+          const capturedCtx = otelContext.active();
+          const startTime = new Date;
+          let result;
+          let originalErr;
+          let thrownError;
+          try {
+            result = await step.run(stepId, handler);
+          } catch (err) {
+            originalErr = err;
+            thrownError = err instanceof Error ? err : new Error(String(err));
+          }
+          if (result === undefined && !thrownError) {
+            return;
+          }
+          const span = tracer.startSpan(`${prefix}.step.run`, {
+            startTime,
+            attributes: { "step.id": stepId, "step.type": "run" }
+          }, capturedCtx);
+          if (thrownError) {
+            span.recordException(thrownError);
+            span.setStatus({ code: SpanStatusCode.ERROR, message: thrownError.message });
+            span.end();
+            throw originalErr;
+          }
+          span.setStatus({ code: SpanStatusCode.OK });
+          span.end();
+          return result;
+        },
+        waitFor: wrapVoidish("waitFor", step.waitFor),
+        delay: wrapVoidish("delay", step.delay),
+        sleep: wrapVoidish("delay", step.delay),
+        waitUntil: wrapVoidish("waitUntil", step.waitUntil),
+        pause: wrapVoidish("pause", step.pause),
+        poll: async (stepId, conditionFn, pollOptions) => {
+          const capturedCtx = otelContext.active();
+          const startTime = new Date;
+          let result;
+          let originalErr;
+          let thrownError;
+          try {
+            result = await step.poll(stepId, conditionFn, pollOptions);
+          } catch (err) {
+            originalErr = err;
+            thrownError = err instanceof Error ? err : new Error(String(err));
+          }
+          const span = tracer.startSpan(`${prefix}.step.poll`, {
+            startTime,
+            attributes: { "step.id": stepId, "step.type": "poll" }
+          }, capturedCtx);
+          if (thrownError) {
+            span.recordException(thrownError);
+            span.setStatus({ code: SpanStatusCode.ERROR, message: thrownError.message });
+            span.end();
+            throw originalErr;
+          }
+          span.setStatus({ code: SpanStatusCode.OK });
+          span.end();
+          return result;
+        },
+        invokeChildWorkflow: async (stepId, refOrParams, inputArg, optionsArg) => {
+          if (isCachedHit(context.timeline, stepId, "invokeChildWorkflow")) {
+            return step.invokeChildWorkflow(stepId, refOrParams, inputArg, optionsArg);
+          }
+          const capturedCtx = otelContext.active();
+          const startTime = new Date;
+          let result;
+          let originalErr;
+          let thrownError;
+          try {
+            result = await step.invokeChildWorkflow(stepId, refOrParams, inputArg, optionsArg);
+          } catch (err) {
+            originalErr = err;
+            thrownError = err instanceof Error ? err : new Error(String(err));
+          }
+          const span = tracer.startSpan(`${prefix}.step.invokeChildWorkflow`, {
+            startTime,
+            attributes: { "step.id": stepId, "step.type": "invokeChildWorkflow" }
+          }, capturedCtx);
+          if (thrownError) {
+            span.recordException(thrownError);
+            span.setStatus({ code: SpanStatusCode.ERROR, message: thrownError.message });
+            span.end();
+            throw originalErr;
+          }
+          span.setStatus({ code: SpanStatusCode.OK });
+          span.end();
+          return result;
+        }
+      };
+    },
+    wrap: (context, next) => tracer.startActiveSpan(`${prefix}.workflow.run`, {
+      attributes: {
+        "workflow.id": context.workflowId,
+        "workflow.run_id": context.runId,
+        "workflow.attempt": context.attempt,
+        ...context.resourceId ? { "workflow.resource_id": context.resourceId } : {},
+        ...extraAttrs ? extraAttrs(context) : {}
+      }
+    }, async (span) => {
+      try {
+        const result = await next();
+        span.setStatus({ code: SpanStatusCode.OK });
+        return result;
+      } catch (err) {
+        const error = err instanceof Error ? err : new Error(String(err));
+        span.recordException(error);
+        span.setStatus({ code: SpanStatusCode.ERROR, message: error.message });
+        throw err;
+      } finally {
+        span.end();
+      }
+    })
+  };
+}
 export {
   workflow,
-  validateWorkflowId,
-  validateResourceId,
-  parseDuration,
+  otelPlugin,
   createWorkflowRef,
   WorkflowStatus,
   WorkflowRunNotFoundError,
   WorkflowEngineError,
   WorkflowEngine,
-  WorkflowClient,
-  StepType
+  WorkflowClient
 };
 
-//# debugId=F3273B34BE68C60E64756E2164756E21
+//# debugId=3131CBB2B482181264756E2164756E21
 //# sourceMappingURL=index.js.map