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

Author: pranaygp

.changeset/fix-sveltekit-vite-e2e-tests.md

@@ -0,0 +1,7 @@
+---
+"@workflow/example-sveltekit": patch
+---
+
+Fix Sveltekit workbench workflows directory location
+
+Move workflows from root to src/workflows for proper Sveltekit bundling and deployment

packages/core/e2e/dev.test.ts

@@ -10,6 +10,8 @@ export interface DevTestConfig {
   apiFileImportPath: string;
   /** The workflow file to modify for testing HMR. Defaults to '3_streams.ts' */
   testWorkflowFile?: string;
+  /** The workflows directory relative to appPath. Defaults to 'workflows' */
+  workflowsDir?: string;
 }
 
 function getConfigFromEnv(): DevTestConfig | null {
@@ -39,6 +41,7 @@ export function createDevTests(config?: DevTestConfig) {
       finalConfig.generatedWorkflowPath
     );
     const testWorkflowFile = finalConfig.testWorkflowFile ?? '3_streams.ts';
+    const workflowsDir = finalConfig.workflowsDir ?? 'workflows';
     const restoreFiles: Array<{ path: string; content: string }> = [];
 
     afterEach(async () => {
@@ -55,7 +58,7 @@ export function createDevTests(config?: DevTestConfig) {
     });
 
     test('should rebuild on workflow change', { timeout: 10_000 }, async () => {
-      const workflowFile = path.join(appPath, 'workflows', testWorkflowFile);
+      const workflowFile = path.join(appPath, workflowsDir, testWorkflowFile);
 
       const content = await fs.readFile(workflowFile, 'utf8');
 
@@ -83,7 +86,7 @@ export async function myNewWorkflow() {
     });
 
     test('should rebuild on step change', { timeout: 10_000 }, async () => {
-      const stepFile = path.join(appPath, 'workflows', testWorkflowFile);
+      const stepFile = path.join(appPath, workflowsDir, testWorkflowFile);
 
       const content = await fs.readFile(stepFile, 'utf8');
 
@@ -114,7 +117,11 @@ export async function myNewStep() {
       'should rebuild on adding workflow file',
       { timeout: 10_000 },
       async () => {
-        const workflowFile = path.join(appPath, 'workflows', 'new-workflow.ts');
+        const workflowFile = path.join(
+          appPath,
+          workflowsDir,
+          'new-workflow.ts'
+        );
 
         await fs.writeFile(
           workflowFile,
@@ -132,7 +139,7 @@ export async function myNewStep() {
 
         await fs.writeFile(
           apiFile,
-          `import '${finalConfig.apiFileImportPath}/workflows/new-workflow';
+          `import '${finalConfig.apiFileImportPath}/${workflowsDir}/new-workflow';
 ${apiFileContent}`
         );
 

packages/core/e2e/e2e.test.ts

@@ -90,10 +90,11 @@ describe('e2e', () => {
       output: 133,
     });
     // In local vs. vercel backends, the workflow name is different, so we check for either,
-    // since this test runs against both.
+    // since this test runs against both. Also different workbenches have different directory structures.
     expect(json.workflowName).toBeOneOf([
       `workflow//example/${workflow.workflowFile}//${workflow.workflowFn}`,
       `workflow//${workflow.workflowFile}//${workflow.workflowFn}`,
+      `workflow//src/${workflow.workflowFile}//${workflow.workflowFn}`,
     ]);
   });
 

packages/core/e2e/local-build.test.ts

@@ -12,6 +12,7 @@ describe.each([
   'vite',
   'sveltekit',
   'nuxt',
+  'hono',
 ])('e2e', (project) => {
   test('builds without errors', { timeout: 180_000 }, async () => {
     // skip if we're targeting specific app to test

packages/sveltekit/src/builder.ts

@@ -19,14 +19,17 @@ async function convertSvelteKitRequest(request) {
 
 export class SvelteKitBuilder extends BaseBuilder {
   constructor(config?: Partial<SvelteKitConfig>) {
+    const workingDir = config?.workingDir || process.cwd();
+    const dirs = getWorkflowDirs({ dirs: config?.dirs });
+
     super({
       ...config,
-      dirs: ['workflows'],
+      dirs,
       buildTarget: 'sveltekit' as const,
       stepsBundlePath: '', // unused in base
       workflowsBundlePath: '', // unused in base
       webhookBundlePath: '', // unused in base
-      workingDir: config?.workingDir || process.cwd(),
+      workingDir,
     });
   }
 
@@ -229,3 +232,24 @@ export const OPTIONS = createSvelteKitHandler('OPTIONS');`
     }
   }
 }
+
+/**
+ * Gets the list of directories to scan for workflow files.
+ */
+export function getWorkflowDirs(options?: { dirs?: string[] }): string[] {
+  return unique([
+    // User-provided directories take precedence
+    ...(options?.dirs ?? []),
+    // Scan routes directories (like Next.js does with app/pages directories)
+    // This allows workflows to be placed anywhere in the routes tree
+    'routes',
+    'src/routes',
+    // Also scan dedicated workflow directories for organization
+    'workflows',
+    'src/workflows',
+  ]).sort();
+}
+
+function unique<T>(array: T[]): T[] {
+  return Array.from(new Set(array));
+}

packages/sveltekit/src/plugin.ts

@@ -4,7 +4,15 @@ import { resolveModulePath } from 'exsolve';
 import type { HotUpdateOptions, Plugin } from 'vite';
 import { SvelteKitBuilder } from './builder.js';
 
-export function workflowPlugin(): Plugin {
+export interface WorkflowPluginOptions {
+  /**
+   * Directories to scan for workflow files.
+   * If not specified, defaults to ['workflows', 'src/workflows', 'routes', 'src/routes']
+   */
+  dirs?: string[];
+}
+
+export function workflowPlugin(options?: WorkflowPluginOptions): Plugin {
   let builder: SvelteKitBuilder;
 
   return {
@@ -89,7 +97,9 @@ export function workflowPlugin(): Plugin {
     },
 
     configResolved() {
-      builder = new SvelteKitBuilder();
+      builder = new SvelteKitBuilder({
+        dirs: options?.dirs,
+      });
     },
 
     // TODO: Move this to @workflow/vite or something since this is vite specific

scripts/create-test-matrix.mjs

@@ -29,12 +29,19 @@ const DEV_TEST_CONFIGS = {
     generatedWorkflowPath: 'src/routes/.well-known/workflow/v1/flow/+server.js',
     apiFilePath: 'src/routes/api/chat/+server.ts',
     apiFileImportPath: '../../../..',
+    workflowsDir: 'src/workflows',
   },
   vite: {
-    generatedStepPath: 'dist/workflow/steps.mjs',
-    generatedWorkflowPath: 'dist/workflow/workflows.mjs',
-    apiFilePath: 'src/main.ts',
-    apiFileImportPath: '..',
+    generatedStepPath: '.nitro/workflow/steps.mjs',
+    generatedWorkflowPath: '.nitro/workflow/workflows.mjs',
+    apiFilePath: 'routes/api/trigger.post.ts',
+    apiFileImportPath: '../..',
+  },
+  hono: {
+    generatedStepPath: '.nitro/workflow/steps.mjs',
+    generatedWorkflowPath: '.nitro/workflow/workflows.mjs',
+    apiFilePath: 'server.ts',
+    apiFileImportPath: '.',
   },
 };
 
@@ -81,4 +88,16 @@ matrix.app.push({
   ...DEV_TEST_CONFIGS.nuxt,
 });
 
+matrix.app.push({
+  name: 'hono',
+  project: 'workbench-hono-workflow',
+  ...DEV_TEST_CONFIGS.hono,
+});
+
+matrix.app.push({
+  name: 'vite',
+  project: 'workbench-vite-workflow',
+  ...DEV_TEST_CONFIGS.vite,
+});
+
 console.log(JSON.stringify(matrix));

workbench/example/workflows/7_full.ts

@@ -0,0 +1 @@
+// TODO: implement this

workbench/hono/.gitignore

@@ -4,3 +4,4 @@ manifest.js
 .output
 .data
 .vercel
+_workflows.ts