Add scriptName option to Workflow

alchemy-web/docs/providers/cloudflare/workflow.md

@@ -20,6 +20,20 @@ const workflow = await Workflow("my-workflow", {
 });
 ```
 
+## Use a Workflow Defined in Another Script
+
+Reference a workflow implemented in a different worker script using `scriptName`.
+
+```ts
+import { Workflow } from "alchemy/cloudflare";
+
+const workflow = await Workflow("shared-workflow", {
+  workflowName: "my-workflow",
+  className: "MyWorkflow",
+  scriptName: "shared-worker"
+});
+```
+
 ## Bind to a Worker
 
 Bind a workflow to a Worker to use its functionality.

alchemy/src/cloudflare/worker-metadata.ts

@@ -403,8 +403,7 @@ export async function prepareWorkerMetadata<B extends Bindings>(
         name: bindingName,
         workflow_name: binding.workflowName,
         class_name: binding.className,
-        // this should be set if the Workflow is in another script ...
-        // script_name: ??,
+        script_name: binding.scriptName,
       });
       // it's unclear whether this is needed, but it works both ways
       // configureClassMigration(binding, binding.id, binding.className);

alchemy/src/cloudflare/worker.ts

@@ -805,7 +805,7 @@ export const _Worker = Resource(
         await upsertWorkflow(api, {
           workflowName: workflow.workflowName,
           className: workflow.className,
-          scriptName: workerName,
+          scriptName: workflow.scriptName ?? workerName,
         });
       }
 

alchemy/src/cloudflare/workflow.ts

@@ -19,6 +19,13 @@ export interface WorkflowProps {
    * @default - workflowName if provided, otherwise id
    */
   className?: string;
+
+  /**
+   * Name of the script containing the workflow implementation
+   *
+   * @default - bound worker script
+   */
+  scriptName?: string;
 }
 
 export function isWorkflow(binding: Binding): binding is Workflow {
@@ -36,13 +43,15 @@ export class Workflow<PARAMS = unknown> {
 
   public readonly workflowName: string;
   public readonly className: string;
+  public readonly scriptName?: string;
 
   constructor(
     public readonly id: string,
     props: WorkflowProps = {},
   ) {
     this.workflowName = props.workflowName ?? props.className ?? id;
     this.className = props.className ?? this.workflowName;
+    this.scriptName = props.scriptName;
   }
 }
 

alchemy/src/cloudflare/wrangler.json.ts

@@ -261,6 +261,7 @@ export interface WranglerJsonSpec {
     name: string;
     binding: string;
     class_name: string;
+    script_name?: string;
   }[];
 
   /**
@@ -366,7 +367,12 @@ function processBindings(
   const services: { binding: string; service: string; environment?: string }[] =
     [];
   const secrets: string[] = [];
-  const workflows: { name: string; binding: string; class_name: string }[] = [];
+  const workflows: {
+    name: string;
+    binding: string;
+    class_name: string;
+    script_name?: string;
+  }[] = [];
   const d1Databases: {
     binding: string;
     database_id: string;
@@ -481,6 +487,7 @@ function processBindings(
         name: binding.workflowName,
         binding: bindingName,
         class_name: binding.className,
+        script_name: binding.scriptName,
       });
     } else if (binding.type === "d1") {
       d1Databases.push({

alchemy/test/cloudflare/wrangler-json.test.ts

@@ -325,6 +325,7 @@ describe("WranglerJson Resource", () => {
         const workflow = new Workflow("test-workflow", {
           className: "TestWorkflow",
           workflowName: "test-workflow",
+          scriptName: "other-script",
         });
 
         const worker = await Worker(name, {
@@ -345,6 +346,7 @@ describe("WranglerJson Resource", () => {
         expect(spec.workflows?.[0].name).toEqual("test-workflow");
         expect(spec.workflows?.[0].binding).toEqual("WF");
         expect(spec.workflows?.[0].class_name).toEqual("TestWorkflow");
+        expect(spec.workflows?.[0].script_name).toEqual("other-script");
       } finally {
         await fs.rm(tempDir, { recursive: true, force: true });
         await destroy(scope);