fix: normalize workbench tests (#292)

* Proper stacktrace propogation in world

Proper stacktrace propogation in world

* Standardize the error type in the world spec

* Normalize Workbenches

Normalize trigger scripts across workbenches
fix: include hono in local build test

test: include src dir for test

test: add workflow dir config in test to fix sveltekit dev tests

add temp 7_full in example wokrflow

format

fix(sveltekit): detecting workflow folders and customizable dir

Remove 7_full and 1_simple error
replace API symlink in webpack workbench
Fix sveltekit and vite tests
Fix sveltekit symlinks
Test fixes
Fix sveltekit workflows path
Dont symlink routes in vite
Include e2e tests for hono and vite

* fix error tests post normalization

* fix(sveltekit): reading file on hmr delete

* changeset

* fix(vite): add resolve symlink script

* fix(vite): missing building on hmr

* test local builder in vite

* test: increase timeout on hookWorkflow

* test: ignore vite based apps in crossFileWorkflow

* test: fix nitro based apps status codes

* fix: intercept default vite spa handler on 404 workflow routes

* fix: vite hook route returning 422

* test: use 422 for hookWorkflow expected

* test: fix hono returning 404

* chore: add comment to middleware to clarify

* make api route for duplicate case

* revert

* revert: nitro builder

* add back nitro unhandled rejection logic

* test: add hono

* changeset

* fix: unused method

* fix: remove duplicate import

* remove

* chore: add comments to clarify

* test remove vite symlink script

---------

Co-authored-by: Pranay Prakash <[email protected]>

Author: adriandlam

.changeset/eager-lands-rhyme.md

@@ -0,0 +1,5 @@
+---
+"@workflow/nitro": patch
+---
+
+Add Vite middleware to handle 404s in workflow routes from Nitro and silence undefined unhandled rejections

.changeset/five-planets-push.md

@@ -0,0 +1,5 @@
+---
+"@workflow/sveltekit": patch
+---
+
+Fix SvelteKit plugin reading deleted files on HMR

.github/workflows/tests.yml

@@ -71,6 +71,8 @@ jobs:
             project-id: "prj_oTgiz3SGX2fpZuM6E0P38Ts8de6d"
           - name: "sveltekit"
             project-id: "prj_MqnBLm71ceXGSnm3Fs8i8gBnI23G"
+          - name: "hono"
+            project-id: "prj_p0GIEsfl53L7IwVbosPvi9rPSOYW"
     env:
       TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
       TURBO_TEAM: ${{ vars.TURBO_TEAM }}

packages/core/e2e/e2e.test.ts

@@ -155,7 +155,10 @@ describe('e2e', () => {
       method: 'POST',
       body: JSON.stringify({ token: 'invalid' }),
     });
-    expect(res.status).toBe(404);
+    // NOTE: For Nitro apps (Vite, Hono, etc.) in dev mode, status 404 does some
+    // unexpected stuff and could return a Vite SPA fallback or can cause a Hono route to hang.
+    // This is because Nitro passes the 404 requests to the dev server to handle.
+    expect(res.status).toBeOneOf([404, 422]);
     body = await res.json();
     expect(body).toBeNull();
 
@@ -579,14 +582,16 @@ describe('e2e', () => {
       expect(returnValue.cause).toHaveProperty('stack');
       expect(typeof returnValue.cause.stack).toBe('string');
 
-      // Known issue: SvelteKit dev mode has incorrect source map mappings for bundled imports.
+      // Known issue: vite-based frameworks dev mode has incorrect source map mappings for bundled imports.
       // esbuild with bundle:true inlines helpers.ts but source maps incorrectly map to 99_e2e.ts
       // This works correctly in production and other frameworks.
       // TODO: Investigate esbuild source map generation for bundled modules
-      const isSvelteKitDevMode =
-        process.env.APP_NAME === 'sveltekit' && isLocalDeployment();
+      const isViteBasedFrameworkDevMode =
+        (process.env.APP_NAME === 'sveltekit' ||
+          process.env.APP_NAME === 'vite') &&
+        isLocalDeployment();
 
-      if (!isSvelteKitDevMode) {
+      if (!isViteBasedFrameworkDevMode) {
         // Stack trace should include frames from the helper module (helpers.ts)
         expect(returnValue.cause.stack).toContain('helpers.ts');
       }

packages/nitro/src/builders.ts

@@ -63,10 +63,21 @@ export class LocalBuilder extends BaseBuilder {
       inputFiles,
     });
 
+    const webhookRouteFile = join(this.#outDir, 'webhook.mjs');
+
     await this.createWebhookBundle({
-      outfile: join(this.#outDir, 'webhook.mjs'),
+      outfile: webhookRouteFile,
       bundle: false,
     });
+
+    // Post-process the generated file to wrap with SvelteKit request converter
+    let webhookRouteContent = await readFile(webhookRouteFile, 'utf-8');
+
+    // NOTE: This is a workaround to avoid crashing in local dev when context isn't set for waitUntil()
+    webhookRouteContent = `process.on('unhandledRejection', (reason) => { if (reason !== undefined) console.error('Unhandled rejection detected', reason); });
+${webhookRouteContent}`;
+
+    await writeFile(webhookRouteFile, webhookRouteContent);
   }
 }
 

packages/nitro/src/vite.ts

@@ -1,10 +1,13 @@
 import type { Nitro } from 'nitro/types';
-import type { Plugin } from 'vite';
+import type { HotUpdateOptions, Plugin } from 'vite';
+import { LocalBuilder } from './builders.js';
 import type { ModuleOptions } from './index.js';
 import nitroModule from './index.js';
 import { workflowRollupPlugin } from './rollup.js';
 
 export function workflow(options?: ModuleOptions): Plugin[] {
+  let builder: LocalBuilder | undefined;
+
   return [
     workflowRollupPlugin(),
     {
@@ -18,9 +21,96 @@ export function workflow(options?: ModuleOptions): Plugin[] {
             ...options,
             _vite: true,
           };
+          if (nitro.options.dev) {
+            builder = new LocalBuilder(nitro);
+          }
           return nitroModule.setup(nitro);
         },
       },
+      // NOTE: This is a workaround because Nitro passes the 404 requests to the dev server to handle.
+      //       For workflow routes, we override to send an empty body to prevent Hono/Vite's SPA fallback.
+      configureServer(server) {
+        // Add middleware to intercept 404s on workflow routes before Vite's SPA fallback
+        return () => {
+          server.middlewares.use((req, res, next) => {
+            // Only handle workflow webhook routes
+            if (!req.url?.startsWith('/.well-known/workflow/v1/')) {
+              return next();
+            }
+
+            // Wrap writeHead to ensure we send empty body for 404s
+            const originalWriteHead = res.writeHead;
+            res.writeHead = function (this: typeof res, ...args: any[]) {
+              const statusCode = typeof args[0] === 'number' ? args[0] : 200;
+
+              // NOTE: Workaround because Nitro passes 404 requests to the vite to handle.
+              //       Causes `webhook route with invalid token` test to fail.
+              // For 404s on workflow routes, ensure we're sending the right headers
+              if (statusCode === 404) {
+                // Set content-length to 0 to prevent Vite from overriding
+                res.setHeader('Content-Length', '0');
+              }
+
+              // @ts-expect-error - Complex overload signature
+              return originalWriteHead.apply(this, args);
+            } as any;
+
+            next();
+          });
+        };
+      },
+      // TODO: Move this to @workflow/vite or something since this is vite specific
+      async hotUpdate(options: HotUpdateOptions) {
+        const { file, server, read } = options;
+
+        // Check if this is a TS/JS file that might contain workflow directives
+        const jsTsRegex = /\.(ts|tsx|js|jsx|mjs|cjs)$/;
+        if (!jsTsRegex.test(file)) {
+          return;
+        }
+
+        // Read the file to check for workflow/step directives
+        let content: string;
+        try {
+          content = await read();
+        } catch {
+          // File might have been deleted - trigger rebuild to update generated routes
+          console.log('Workflow file deleted, rebuilding...');
+          if (builder) {
+            await builder.build();
+          }
+          // NOTE: Might be too aggressive
+          server.ws.send({
+            type: 'full-reload',
+            path: '*',
+          });
+          return;
+        }
+
+        const useWorkflowPattern = /^\s*(['"])use workflow\1;?\s*$/m;
+        const useStepPattern = /^\s*(['"])use step\1;?\s*$/m;
+
+        if (
+          !useWorkflowPattern.test(content) &&
+          !useStepPattern.test(content)
+        ) {
+          return;
+        }
+
+        // Trigger full reload - this will cause Nitro's dev:reload hook to fire,
+        // which will rebuild workflows and update routes
+        console.log('Workflow file changed, rebuilding...');
+        if (builder) {
+          await builder.build();
+        }
+        server.ws.send({
+          type: 'full-reload',
+          path: '*',
+        });
+
+        // Let Vite handle the normal HMR for the changed file
+        return;
+      },
     },
   ];
 }

packages/sveltekit/src/plugin.ts

@@ -113,7 +113,22 @@ export function workflowPlugin(options?: WorkflowPluginOptions): Plugin {
       }
 
       // Read the file to check for workflow/step directives
-      const content = await read();
+      let content: string;
+      try {
+        content = await read();
+      } catch {
+        // File might have been deleted - trigger rebuild to update generated routes
+        console.log('Workflow file deleted, regenerating routes...');
+        try {
+          await builder.build();
+        } catch (buildError) {
+          // Build might fail if files are being deleted during test cleanup
+          // Log but don't crash - the next successful change will trigger a rebuild
+          console.error('Build failed during file deletion:', buildError);
+        }
+        return;
+      }
+
       const useWorkflowPattern = /^\s*(['"])use workflow\1;?\s*$/m;
       const useStepPattern = /^\s*(['"])use step\1;?\s*$/m;
 
@@ -123,7 +138,14 @@ export function workflowPlugin(options?: WorkflowPluginOptions): Plugin {
 
       // Rebuild everything - simpler and more reliable than tracking individual files
       console.log('Workflow file changed, regenerating routes...');
-      await builder.build();
+      try {
+        await builder.build();
+      } catch (buildError) {
+        // Build might fail if files are being modified/deleted during test cleanup
+        // Log but don't crash - the next successful change will trigger a rebuild
+        console.error('Build failed during HMR:', buildError);
+        return;
+      }
 
       // Trigger full reload of workflow routes
       server.ws.send({

workbench/example/api/trigger.ts

@@ -1,10 +1,10 @@
 import { getRun, start } from 'workflow/api';
-import { hydrateWorkflowArguments } from 'workflow/internal/serialization';
-import workflowManifest from '../manifest.js';
 import {
   WorkflowRunFailedError,
   WorkflowRunNotCompletedError,
 } from 'workflow/internal/errors';
+import { hydrateWorkflowArguments } from 'workflow/internal/serialization';
+import workflowManifest from '../manifest.js';
 
 export async function POST(req: Request) {
   const url = new URL(req.url);

workbench/example/workflows/7_full.ts

@@ -1,4 +1,4 @@
-import { sleep, createWebhook } from 'workflow';
+import { createWebhook, sleep } from 'workflow';
 
 export async function handleUserSignup(email: string) {
   'use workflow';

workbench/hono/server.ts

@@ -1,11 +1,11 @@
 import { Hono } from 'hono';
 import { getHookByToken, getRun, resumeHook, start } from 'workflow/api';
-import { hydrateWorkflowArguments } from 'workflow/internal/serialization';
-import { allWorkflows } from './_workflows.js';
 import {
   WorkflowRunFailedError,
   WorkflowRunNotCompletedError,
 } from 'workflow/internal/errors';
+import { hydrateWorkflowArguments } from 'workflow/internal/serialization';
+import { allWorkflows } from './_workflows.js';
 
 const app = new Hono();
 
@@ -163,8 +163,9 @@ app.post('/api/hook', async ({ req }) => {
   } catch (error) {
     console.log('error during getHookByToken', error);
     // TODO: `WorkflowAPIError` is not exported, so for now
-    // we'll return 404 assuming it's the "invalid" token test case
-    return Response.json(null, { status: 404 });
+    // we'll return 422 assuming it's the "invalid" token test case
+    // NOTE: Need to return 422 because Nitro passes 404 requests to the dev server to handle.
+    return Response.json(null, { status: 422 });
   }
 
   await resumeHook(hook.token, {