@workflow/world-testing 4.0.1-beta.2 → 4.0.1-beta.21

package/dist/workflows/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../workflows/hooks.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,IAAI;;;;;;;;EAMf,CAAC;AAEH,wBAAsB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;;;;;;GActE"}

package/dist/workflows/hooks.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hook = void 0;
+exports.collectWithHook = collectWithHook;
+const workflow_1 = require("workflow");
+const z = __importStar(require("zod"));
+exports.Hook = (0, workflow_1.defineHook)({
+    schema: z.object({
+        data: z.string(),
+        done: z.boolean().optional(),
+        metadata: z.unknown(),
+    }),
+});
+async function collectWithHook(token, customData) {
+    'use workflow';
+    const hook = exports.Hook.create({ token, metadata: { customData } });
+    const collected = [];
+    const wf = (0, workflow_1.getWritable)();
+    await writeEvent(wf, 'hookCreated');
+    for await (const event of hook) {
+        await writeEvent(wf, 'hookResumed', event);
+        collected.push(event);
+        if (event.done)
+            break;
+    }
+    return { collected };
+}
+async function writeEvent(writable, event, payload) {
+    'use step';
+    console.log('writing event', event, payload);
+    const writer = writable.getWriter();
+    await writer.write(new TextEncoder().encode(`${JSON.stringify({
+        event,
+        payload,
+    })}\r\n`));
+}
+//# sourceMappingURL=hooks.js.map

package/dist/workflows/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../workflows/hooks.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWA,0CAcC;AAzBD,uCAAmD;AACnD,uCAAyB;AAEZ,QAAA,IAAI,GAAG,IAAA,qBAAU,EAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC5B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;KACtB,CAAC;CACH,CAAC,CAAC;AAEI,KAAK,UAAU,eAAe,CAAC,KAAa,EAAE,UAAkB;IACrE,cAAc,CAAC;IAEf,MAAM,IAAI,GAAG,YAAI,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAC9D,MAAM,SAAS,GAA6C,EAAE,CAAC;IAC/D,MAAM,EAAE,GAAG,IAAA,sBAAW,GAAE,CAAC;IACzB,MAAM,UAAU,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IACpC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,UAAU,CAAC,EAAE,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;QAC3C,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,IAAI,KAAK,CAAC,IAAI;YAAE,MAAM;IACxB,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,QAAwB,EACxB,KAAa,EACb,OAAiB;IAEjB,UAAU,CAAC;IAEX,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;IACpC,MAAM,MAAM,CAAC,KAAK,CAChB,IAAI,WAAW,EAAE,CAAC,MAAM,CACtB,GAAG,IAAI,CAAC,SAAS,CAAC;QAChB,KAAK;QACL,OAAO;KACR,CAAC,MAAM,CACT,CACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,30 +1,33 @@
 {
   "name": "@workflow/world-testing",
-  "version": "4.0.1-beta.2",
+  "version": "4.0.1-beta.21",
   "description": "Testing utilities and World implementation for Workflow DevKit",
   "main": "dist/src/index.mjs",
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
-  "license": "MIT",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/vercel/workflow.git",
     "directory": "packages/world-testing"
   },
   "dependencies": {
-    "@hono/node-server": "^1.19.5",
-    "chalk": "^5.6.2",
-    "hono": "^4.9.10",
-    "jsonlines": "^0.1.1",
+    "@hono/node-server": "1.19.5",
+    "chalk": "5.6.2",
+    "hono": "4.9.10",
+    "jsonlines": "0.1.1",
     "zod": "4.1.11",
-    "@workflow/cli": "4.0.1-beta.2",
-    "workflow": "4.0.1-beta.2",
-    "@workflow/world": "4.0.1-beta.1"
+    "@workflow/world": "4.0.1-beta.6",
+    "@workflow/cli": "4.0.1-beta.20",
+    "workflow": "4.0.1-beta.20"
   },
   "devDependencies": {
-    "@types/node": "24.6.2",
-    "@types/jsonlines": "^0.1.5",
+    "@types/node": "22.19.0",
+    "@types/jsonlines": "0.1.5",
     "vitest": "^3.2.4",
     "@workflow/tsconfig": "4.0.1-beta.0"
   },
@@ -35,6 +38,7 @@
   "author": "",
   "scripts": {
     "build": "wf build && tsc",
+    "clean": "tsc --build --clean && rm -rf dist .well-known* .workflow-data",
     "start": "node --watch src/server.mts",
     "test": "vitest"
   }

package/CHANGELOG.md

@@ -1,35 +0,0 @@
-# @workflow/world-testing
-
-## 4.0.1-beta.2
-
-### Patch Changes
-
-- Updated dependencies [f5f171f]
-  - @workflow/cli@4.0.1-beta.2
-  - workflow@4.0.1-beta.2
-
-## 4.0.1-beta.1
-
-### Patch Changes
-
-- 1408293: Add "description" field to `package.json` file
-- e46294f: Add "license" and "repository" fields to `package.json` file
-- Updated dependencies [57ebfcb]
-- Updated dependencies [1408293]
-- Updated dependencies [cea8530]
-- Updated dependencies [8196cd9]
-- Updated dependencies [8422a32]
-- Updated dependencies [e46294f]
-  - @workflow/cli@4.0.1-beta.1
-  - workflow@4.0.1-beta.1
-  - @workflow/world@4.0.1-beta.1
-
-## 4.0.1-beta.0
-
-### Patch Changes
-
-- fcf63d0: Initial publish
-- Updated dependencies [fcf63d0]
-  - workflow@4.0.1-beta.0
-  - @workflow/world@4.0.1-beta.0
-  - @workflow/cli@4.0.1-beta.0

package/src/addition.mts

@@ -1,27 +0,0 @@
-import { expect, test, vi } from 'vitest';
-import { createFetcher, startServer } from './util.mjs';
-
-export function addition(world: string) {
-  test('runs an addition', { timeout: 12_000 }, async () => {
-    const server = await startServer({ world }).then(createFetcher);
-    const result = await server.invoke(
-      'workflows/addition.ts',
-      'addition',
-      [1, 2]
-    );
-    expect(result.runId).toMatch(/^wrun_.+/);
-    await vi.waitFor(
-      async () => {
-        const run = await server.getRun(result.runId);
-        expect(run).toMatchObject<Partial<typeof run>>({
-          status: 'completed',
-          output: [3],
-        });
-      },
-      {
-        interval: 200,
-        timeout: 10_000,
-      }
-    );
-  });
-}

package/src/idempotency.mts

@@ -1,30 +0,0 @@
-import { expect, test, vi } from 'vitest';
-import { hydrateWorkflowReturnValue } from 'workflow/internal/serialization';
-import { createFetcher, startServer } from './util.mjs';
-
-export function idempotency(world: string) {
-  test('idempotency', { timeout: 60_000 }, async () => {
-    const server = await startServer({ world }).then(createFetcher);
-    const result = await server.invoke('workflows/noop.ts', 'brokenWf', [1, 2]);
-    expect(result.runId).toMatch(/^wrun_.+/);
-    const run = await vi.waitFor(
-      async () => {
-        const run = await server.getRun(result.runId);
-        expect(run).toMatchObject<Partial<typeof run>>({
-          status: 'completed',
-        });
-        return run;
-      },
-      {
-        interval: 200,
-        timeout: 59_000,
-      }
-    );
-
-    const output = await hydrateWorkflowReturnValue(run.output, [], globalThis);
-
-    expect(output).toEqual({
-      numbers: Array.from({ length: 110 }, () => expect.any(Number)),
-    });
-  });
-}

package/src/index.mts

@@ -1,7 +0,0 @@
-import { addition } from './addition.mjs';
-import { idempotency } from './idempotency.mjs';
-
-export function createTestSuite(pkgName: string) {
-  addition(pkgName);
-  idempotency(pkgName);
-}

package/src/server.mts

@@ -1,104 +0,0 @@
-import fs from 'node:fs';
-import { serve } from '@hono/node-server';
-import { Hono } from 'hono';
-import { getRun, start } from 'workflow/api';
-import { getWorld } from 'workflow/runtime';
-import * as z from 'zod';
-import flow from '../.well-known/workflow/v1/flow.js';
-import manifest from '../.well-known/workflow/v1/manifest.debug.json' with {
-  type: 'json',
-};
-import step from '../.well-known/workflow/v1/step.js';
-
-if (!process.env.WORKFLOW_TARGET_WORLD) {
-  console.error(
-    'Error: WORKFLOW_TARGET_WORLD environment variable is not set.'
-  );
-  process.exit(1);
-}
-
-type Files = keyof typeof manifest.workflows;
-type Workflows<F extends Files> = keyof (typeof manifest.workflows)[F];
-
-const Invoke = z
-  .object({
-    file: z.literal(Object.keys(manifest.workflows) as Files[]),
-    workflow: z.string(),
-    args: z.unknown().array().default([]),
-  })
-  .transform((obj) => {
-    const file = obj.file as keyof typeof manifest.workflows;
-    const workflow = z
-      .literal(
-        Object.keys(manifest.workflows[file]) as Workflows<typeof file>[]
-      )
-      .parse(obj.workflow);
-    return {
-      args: obj.args,
-      workflow: manifest.workflows[file][workflow],
-    };
-  });
-
-const app = new Hono()
-  .post('/.well-known/workflow/v1/flow', (ctx) => {
-    return flow.POST(ctx.req.raw);
-  })
-  .post('/.well-known/workflow/v1/step', (ctx) => {
-    return step.POST(ctx.req.raw);
-  })
-  .get('/_manifest', (ctx) => ctx.json(manifest))
-  .post('/invoke', async (ctx) => {
-    const json = await ctx.req.json().then(Invoke.parse);
-    const handler = await start(json.workflow, json.args);
-
-    return ctx.json({ runId: handler.runId });
-  })
-  .get('/runs/:runId', async (ctx) => {
-    return ctx.json(await getWorld().runs.get(ctx.req.param('runId')));
-  })
-  .get('/runs/:runId/readable', async (ctx) => {
-    const runId = ctx.req.param('runId');
-    const run = getRun(runId);
-    return new Response(run.getReadable());
-  });
-
-serve(
-  {
-    fetch: app.fetch,
-    port: Number(process.env.PORT) || 0,
-  },
-  async (info) => {
-    console.log(`👂 listening on http://${info.address}:${info.port}`);
-    console.log('');
-
-    process.env.PORT = info.port.toString();
-
-    for (const [filename, workflows] of Object.entries(manifest.workflows)) {
-      for (const workflowName of Object.keys(workflows)) {
-        console.log(
-          `$ curl -X POST http://localhost:${info.port}/invoke -d '${JSON.stringify(
-            {
-              file: filename,
-              workflow: workflowName,
-            }
-          )}'`
-        );
-      }
-    }
-
-    const world = getWorld();
-    if (world.start) {
-      console.log(`starting background tasks...`);
-      await world.start().then(
-        () => console.log('background tasks started.'),
-        (err) => console.error('❗ error starting background tasks:', err)
-      );
-    }
-
-    if (process.env.CONTROL_FD === '3') {
-      const control = fs.createWriteStream('', { fd: 3 });
-      control.write(`${JSON.stringify({ state: 'listening', info })}\n`);
-      control.end();
-    }
-  }
-);

package/src/util.mts

@@ -1,99 +0,0 @@
-import cp from 'node:child_process';
-import { existsSync } from 'node:fs';
-import { WorkflowRunSchema } from '@workflow/world';
-import chalk, { type ChalkInstance } from 'chalk';
-import jsonlines from 'jsonlines';
-import { assert, onTestFailed, onTestFinished } from 'vitest';
-import * as z from 'zod';
-import type manifest from '../.well-known/workflow/v1/manifest.debug.json';
-
-export const Control = z.object({
-  state: z.literal('listening'),
-  info: z.object({
-    port: z.number(),
-  }),
-});
-type Control = z.infer<typeof Control>;
-
-type Files = keyof typeof manifest.workflows;
-type Workflows<F extends Files> = keyof (typeof manifest.workflows)[F];
-
-export const Worlds = {
-  embedded: 'embedded',
-  postgres: '@workflow/world-postgres',
-};
-
-export async function startServer(opts: { world: string }) {
-  let serverPath = new URL('./server.mts', import.meta.url).pathname;
-
-  if (!existsSync(serverPath)) {
-    serverPath = new URL('./server.mjs', import.meta.url).pathname;
-  }
-
-  const proc = cp.spawn('node', [serverPath], {
-    stdio: ['ignore', 'pipe', 'pipe', 'pipe'],
-    env: {
-      ...process.env,
-      WORKFLOW_TARGET_WORLD: opts.world,
-      CONTROL_FD: '3',
-    },
-  });
-  onTestFinished(() => {
-    proc.kill();
-  });
-
-  const stdio = [] as { stream: ChalkInstance; chunk: string }[];
-  proc.stdout?.on('data', (chunk) => {
-    stdio.push({ stream: chalk.white, chunk: chunk.toString() });
-  });
-  proc.stderr?.on('data', (chunk) => {
-    stdio.push({ stream: chalk.red, chunk: chunk.toString() });
-  });
-
-  onTestFailed(() => {
-    console.log('=== SERVER STDIO ===');
-    let buffer = '';
-    for (const { stream, chunk } of stdio) {
-      buffer += stream.inverse(chunk);
-    }
-    console.log(buffer);
-  });
-
-  const fd3 = proc.stdio[3];
-  assert(fd3, 'fd3 should be defined');
-
-  for await (const chunk of fd3.pipe(jsonlines.parse())) {
-    return Control.parse(chunk);
-  }
-
-  throw new Error('Server did not start correctly');
-}
-
-const Invoke = z.object({ runId: z.coerce.string() });
-
-export function createFetcher(control: Control) {
-  return {
-    async invoke<F extends Files, W extends Workflows<F>>(
-      file: F,
-      workflow: W,
-      args: unknown[]
-    ) {
-      const x = await fetch(`http://localhost:${control.info.port}/invoke`, {
-        method: 'POST',
-        headers: {
-          'content-type': 'application/json',
-        },
-        body: JSON.stringify({ file, workflow, args }),
-      });
-      const data = await x.json().then(Invoke.parse);
-      return data;
-    },
-    async getRun(id: string) {
-      const x = await fetch(
-        `http://localhost:${control.info.port}/runs/${encodeURIComponent(id)}`
-      );
-      const data = await x.json();
-      return WorkflowRunSchema.parseAsync(data);
-    },
-  };
-}

package/test/embedded.test.ts

@@ -1,3 +0,0 @@
-import { createTestSuite } from '../src/index.mjs';
-
-createTestSuite('embedded');

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "@workflow/tsconfig/base.json",
-  "compilerOptions": {
-    "moduleResolution": "NodeNext",
-    "allowJs": true,
-    "module": "NodeNext",
-    "outDir": "dist"
-  },
-  "include": ["src", ".well-known"],
-  "exclude": ["node_modules", "**/*.test.ts"]
-}

package/turbo.json

@@ -1,13 +0,0 @@
-{
-  "extends": ["//"],
-  "tasks": {
-    "build": {
-      "dependsOn": ["^build"],
-      "inputs": ["src", "workflows"],
-      "outputs": [".well-known", "dist"]
-    },
-    "test": {
-      "dependsOn": ["build"]
-    }
-  }
-}

package/workflows/addition.ts

@@ -1,16 +0,0 @@
-import { RetryableError } from 'workflow';
-
-async function add(num: number, num2: number): Promise<number> {
-  'use step';
-  if (Math.random() < 0.2) {
-    throw new RetryableError('Random failure, please retry');
-  }
-  return num + num2;
-}
-
-export async function addition(num: number, num2: number): Promise<number> {
-  'use workflow';
-  const result = await add(num, num2);
-  console.log({ result });
-  return result;
-}

package/workflows/noop.ts

@@ -1,37 +0,0 @@
-let count = 0;
-export async function noop(_i: number) {
-  'use step';
-
-  count++;
-  return count;
-}
-
-export async function brokenWf() {
-  'use workflow';
-
-  const numbers = [] as number[];
-
-  {
-    const promises: Promise<number>[] = [];
-    for (let i = 0; i < 10; i++) {
-      promises.push(noop(i));
-    }
-
-    console.log('await 10');
-    numbers.push(...(await Promise.all(promises)));
-  }
-
-  {
-    const promises: Promise<number>[] = [];
-    for (let i = 0; i < 100; i++) {
-      promises.push(noop(1000 + i));
-    }
-
-    console.log('await 100');
-    numbers.push(...(await Promise.all(promises)));
-  }
-
-  console.log('done.');
-
-  return { numbers };
-}