@falcondev-oss/workflow 0.7.3 → 0.8.1

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { Meter, Span } from "@opentelemetry/api";
 import { SuperJSONResult } from "superjson";
 import { Options } from "p-retry";
 import { StandardSchemaV1 } from "@standard-schema/spec";
-import { AddOptions, Job, Queue, QueueOptions, WorkerOptions } from "groupmq";
+import { AddOptions, Job, Queue, QueueOptions, Worker, WorkerOptions } from "groupmq";
 import { Except, IsUnknown, SetOptional, Tagged } from "type-fest";
 
 //#region src/settings.d.ts
@@ -103,18 +103,21 @@ type WorkflowWorkerOptions<Input> = Except<WorkerOptions<WorkflowJobPayloadInter
   };
 };
 declare class Workflow<RunInput, Input, Output> {
-  id: string;
-  private opts;
-  private queue?;
+  'id': string;
+  private 'opts';
+  private 'queue'?;
+  '~internal': {
+    getOrCreateQueue: () => Promise<WorkflowQueueInternal<Input>>;
+  };
   constructor(opts: WorkflowOptions<RunInput, Input, Output>);
-  work(opts?: WorkflowWorkerOptions<Input>): Promise<this>;
-  run(input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runIn(input: RunInput, delayMs: number, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runAt(input: RunInput, date: Date, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runCron(scheduleId: string, cron: string, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  runEvery(scheduleId: string, everyMs: number, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
-  private getOrCreateQueue;
-  private setupMetrics;
+  'work'(opts?: WorkflowWorkerOptions<Input>): Promise<Worker<WorkflowJobPayloadInternal<Input>>>;
+  'run'(input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runIn'(input: RunInput, delayMs: number, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runAt'(input: RunInput, date: Date, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runCron'(scheduleId: string, cron: string, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  'runEvery'(scheduleId: string, everyMs: number, input: RunInput, opts?: WorkflowJobRunOptions<Input>): Promise<WorkflowJob<Output>>;
+  private 'getOrCreateQueue';
+  private 'setupMetrics';
 }
 interface WorkflowRunContext<Input> {
   input: IsUnknown<Input> extends true ? undefined : Input;

package/dist/index.mjs

@@ -9706,18 +9706,19 @@ var WorkflowStep = class WorkflowStep {
 //#endregion
 //#region src/workflow.ts
 var Workflow = class {
-	id;
-	opts;
-	queue;
-	constructor(opts) {
+	"id";
+	"opts";
+	"queue";
+	"~internal" = { getOrCreateQueue: this.getOrCreateQueue.bind(this) };
+	"constructor"(opts) {
 		this.id = opts.id;
 		this.opts = opts;
 	}
-	async work(opts) {
+	async "work"(opts) {
 		const queue = await this.getOrCreateQueue();
 		const worker = new Worker({
 			handler: async (job) => {
-				Settings.logger?.info?.(`Processing workflow job ${job.id} of workflow ${this.opts.id}`);
+				Settings.logger?.info?.(`[${this.opts.id}] Processing job ${job.id} `);
 				const jobId = job.id;
 				if (!jobId) throw new Error("Job ID is missing");
 				const deserializedData = deserialize$1(job.data);
@@ -9741,7 +9742,7 @@ var Workflow = class {
 						span
 					});
 					const end = performance.now();
-					Settings.logger?.success?.(`Completed workflow job ${job.id} of workflow ${this.opts.id} in ${(end - start).toFixed(2)} ms`);
+					Settings.logger?.success?.(`[${this.opts.id}] Completed job ${job.id} in ${(end - start).toFixed(2)} ms`);
 					return serialize$1(result);
 				}, propagation.extract(ROOT_CONTEXT, deserializedData.tracingHeaders));
 			},
@@ -9749,24 +9750,22 @@ var Workflow = class {
 			...this.opts.workerOptions,
 			...opts
 		});
-		worker.on("ready", () => {
-			Settings.logger?.info?.(`Worker started for workflow ${this.opts.id}`);
-		});
 		worker.on("failed", (job) => {
-			Settings.logger?.info?.(`Workflow job ${job.id} of workflow ${this.opts.id} failed`);
+			Settings.logger?.info?.(`[${this.opts.id}] Job ${job.id} failed`);
 		});
 		worker.on("error", (error) => {
-			Settings.logger?.error?.(`Error during worker startup for workflow ${this.opts.id}:`, error);
+			Settings.logger?.error?.(`[${this.opts.id}] Error during worker startup:`, error);
 		});
+		Settings.logger?.info?.(`[${this.opts.id}] Worker started`);
 		const metricsOpts = opts?.metrics ?? this.opts.workerOptions?.metrics ?? Settings.metrics;
 		if (metricsOpts) await this.setupMetrics(metricsOpts);
 		asyncExitHook(async (signal) => {
-			Settings.logger?.info?.(`Received ${signal}, shutting down worker for workflow ${this.opts.id}...`);
+			Settings.logger?.info?.(`[${this.opts.id}] Received ${signal}, shutting down worker...`);
 			await worker.close();
 		}, { wait: 1e4 });
-		return this;
+		return worker;
 	}
-	async run(input, opts) {
+	async "run"(input, opts) {
 		const parsedInput = this.opts.schema && await this.opts.schema["~standard"].validate(input);
 		if (parsedInput?.issues) throw new Error("Invalid workflow input");
 		const queue = await this.getOrCreateQueue();
@@ -9790,33 +9789,33 @@ var Workflow = class {
 			}) });
 		});
 	}
-	async runIn(input, delayMs, opts) {
+	async "runIn"(input, delayMs, opts) {
 		return this.run(input, {
 			delay: delayMs,
 			...opts
 		});
 	}
-	async runAt(input, date, opts) {
+	async "runAt"(input, date, opts) {
 		return this.run(input, {
 			runAt: date,
 			...opts
 		});
 	}
-	async runCron(scheduleId, cron, input, opts) {
+	async "runCron"(scheduleId, cron, input, opts) {
 		return this.run(input, {
 			groupId: scheduleId,
 			repeat: { pattern: cron },
 			...opts
 		});
 	}
-	async runEvery(scheduleId, everyMs, input, opts) {
+	async "runEvery"(scheduleId, everyMs, input, opts) {
 		return this.run(input, {
 			groupId: scheduleId,
 			repeat: { every: everyMs },
 			...opts
 		});
 	}
-	async getOrCreateQueue() {
+	async "getOrCreateQueue"() {
 		if (!this.queue) this.queue = new Queue({
 			namespace: this.opts.id,
 			redis: this.opts.redis ?? await defaultRedisConnection(),
@@ -9825,7 +9824,7 @@ var Workflow = class {
 		});
 		return this.queue;
 	}
-	async setupMetrics({ meter, prefix }) {
+	async "setupMetrics"({ meter, prefix }) {
 		const attributes = { workflow_id: this.opts.id };
 		const queue = await this.getOrCreateQueue();
 		const completedJobsGauge = meter.createObservableGauge(`${prefix}_workflow_completed_jobs`, { description: "Number of completed workflow jobs" });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@falcondev-oss/workflow",
   "type": "module",
-  "version": "0.7.3",
+  "version": "0.8.1",
   "description": "Simple type-safe queue worker with durable execution using Redis.",
   "license": "MIT",
   "repository": "github:falcondev-oss/workflow",