feat: expose internal helper functions

Author: LouisHaftmann

src/workflow.ts

@@ -47,16 +47,19 @@ export type WorkflowWorkerOptions<Input> = Except<
 }
 
 export class Workflow<RunInput, Input, Output> {
-  id
-  private opts
-  private queue?: WorkflowQueueInternal<Input>
+  'id'
+  private 'opts'
+  private 'queue'?: WorkflowQueueInternal<Input>
+  '~internal' = {
+    getOrCreateQueue: this.getOrCreateQueue.bind(this),
+  }
 
-  constructor(opts: WorkflowOptions<RunInput, Input, Output>) {
+  'constructor'(opts: WorkflowOptions<RunInput, Input, Output>) {
     this.id = opts.id
     this.opts = opts
   }
 
-  async work(opts?: WorkflowWorkerOptions<Input>) {
+  async 'work'(opts?: WorkflowWorkerOptions<Input>) {
     const queue = await this.getOrCreateQueue()
 
     const worker = new Worker<WorkflowJobPayloadInternal<Input>>({
@@ -127,10 +130,10 @@ export class Workflow<RunInput, Input, Output> {
       { wait: 10_000 },
     )
 
-    return this
+    return worker
   }
 
-  async run(input: RunInput, opts?: WorkflowJobRunOptions<Input>) {
+  async 'run'(input: RunInput, opts?: WorkflowJobRunOptions<Input>) {
     const parsedInput = this.opts.schema && (await this.opts.schema['~standard'].validate(input))
     if (parsedInput?.issues) throw new Error('Invalid workflow input')
 
@@ -175,21 +178,21 @@ export class Workflow<RunInput, Input, Output> {
     )
   }
 
-  async runIn(input: RunInput, delayMs: number, opts?: WorkflowJobRunOptions<Input>) {
+  async 'runIn'(input: RunInput, delayMs: number, opts?: WorkflowJobRunOptions<Input>) {
     return this.run(input, {
       delay: delayMs,
       ...opts,
     })
   }
 
-  async runAt(input: RunInput, date: Date, opts?: WorkflowJobRunOptions<Input>) {
+  async 'runAt'(input: RunInput, date: Date, opts?: WorkflowJobRunOptions<Input>) {
     return this.run(input, {
       runAt: date,
       ...opts,
     })
   }
 
-  async runCron(
+  async 'runCron'(
     scheduleId: string,
     cron: string,
     input: RunInput,
@@ -204,7 +207,7 @@ export class Workflow<RunInput, Input, Output> {
     })
   }
 
-  async runEvery(
+  async 'runEvery'(
     scheduleId: string,
     everyMs: number,
     input: RunInput,
@@ -219,7 +222,7 @@ export class Workflow<RunInput, Input, Output> {
     })
   }
 
-  private async getOrCreateQueue() {
+  private async 'getOrCreateQueue'() {
     if (!this.queue) {
       this.queue = new Queue({
         namespace: this.opts.id,
@@ -232,7 +235,7 @@ export class Workflow<RunInput, Input, Output> {
     return this.queue
   }
 
-  private async setupMetrics({ meter, prefix }: { meter: Meter; prefix: string }) {
+  private async 'setupMetrics'({ meter, prefix }: { meter: Meter; prefix: string }) {
     const attributes = {
       workflow_id: this.opts.id,
     }

tests/workflow.test.ts

@@ -14,13 +14,14 @@ beforeAll(() => {
 describe('input', () => {
   test('primitive', async () => {
     const handler = vi.fn()
-    const workflow = await new Workflow({
+    const workflow = new Workflow({
       id: randomUUID(),
       schema: type({
         name: 'string',
       }),
       run: handler,
-    }).work()
+    })
+    await workflow.work()
     await workflow.run({ name: 'A' })
 
     await vi.waitFor(() =>
@@ -33,13 +34,14 @@ describe('input', () => {
   })
   test('non-pojos', async () => {
     const handler = vi.fn()
-    const workflow = await new Workflow({
+    const workflow = new Workflow({
       id: randomUUID(),
       schema: type({
         date: 'Date',
       }),
       run: handler,
-    }).work()
+    })
+    await workflow.work()
     await workflow.run({ date: new Date('2024-01-01T00:00:00.000Z') })
 
     await vi.waitFor(() =>
@@ -57,14 +59,15 @@ describe('step', () => {
   test('only runs once', async () => {
     const stepHandler = vi.fn()
     const handler = vi.fn()
-    const workflow = await new Workflow({
+    const workflow = new Workflow({
       id: randomUUID(),
       run: async ({ step }) => {
         await step.do('test-step', stepHandler)
         await handler()
         throw new Error('error')
       },
-    }).work({
+    })
+    await workflow.work({
       backoff: () => 0,
     })
 
@@ -81,14 +84,15 @@ describe('step', () => {
       date: new Date(),
     }))
     const handler = vi.fn()
-    const workflow = await new Workflow({
+    const workflow = new Workflow({
       id: randomUUID(),
       run: async ({ step }) => {
         const result = await step.do('test-step', stepHandler)
         await handler(result)
         throw new Error('error')
       },
-    }).work({
+    })
+    await workflow.work({
       backoff: () => 0,
     })
 
@@ -108,20 +112,21 @@ describe('step', () => {
 
 describe('groups', () => {
   test('random id if not specified', async () => {
-    const workflow = await new Workflow({
+    const workflow = new Workflow({
       id: randomUUID(),
       schema: type({
         name: 'string',
       }),
       run: async () => {},
-    }).work()
+    })
+    await workflow.work()
     const job = await workflow.run({ name: 'A' })
 
     expect(job.groupId).toMatch(/^[0-9a-f-]{36}$/i)
   })
 
   test('uses specified groupId getter', async () => {
-    const workflow = await new Workflow({
+    const workflow = new Workflow({
       id: randomUUID(),
       schema: type({
         name: 'string',
@@ -130,7 +135,8 @@ describe('groups', () => {
         return `group-for-${input.name}`
       },
       run: async () => {},
-    }).work()
+    })
+    await workflow.work()
     const job = await workflow.run({ name: 'A' })
 
     expect(job.groupId).toBe('group-for-A')