@redflow/client 0.0.2 → 0.0.3

package/README.md

@@ -105,6 +105,16 @@ const analyticsRunId = await step.emitWorkflow(
 );
 ```
 
+You can also pass a workflow name string:
+
+```ts
+const analyticsRunId = await step.emitWorkflow(
+  { name: "emit-analytics" },
+  "analytics-consumer",
+  { orderId: input.orderId, totalCents: input.totalCents },
+);
+```
+
 ## Run workflows
 
 The object returned by `defineWorkflow(...)` has `.run(...)`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redflow/client",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "main": "src/index.ts",
   "module": "src/index.ts",

package/src/types.ts

@@ -113,7 +113,7 @@ export type StepApi = {
     workflow: WorkflowLike<TInput, TOutput>,
     input: TInput,
   ): Promise<TOutput>;
-  emitWorkflow(options: StepEmitWorkflowOptions, workflow: WorkflowLike, input: unknown): Promise<string>;
+  emitWorkflow(options: StepEmitWorkflowOptions, workflow: WorkflowLike | string, input: unknown): Promise<string>;
 };
 
 export type RunState = {

package/src/worker.ts

@@ -694,18 +694,27 @@ async function processRun(args: {
       };
 
       const emitWorkflowStep: StepApi["emitWorkflow"] = async (options, workflow, workflowInput) => {
+        const workflowName = typeof workflow === "string" ? workflow : workflow.name;
         const idempotencyKey =
-          options.idempotencyKey ?? defaultStepWorkflowIdempotencyKey(runId, options.name, workflow.name);
+          options.idempotencyKey ?? defaultStepWorkflowIdempotencyKey(runId, options.name, workflowName);
 
         return await runStep(
           { name: options.name, timeoutMs: options.timeoutMs },
           async () => {
-            const handle = await workflow.run(workflowInput, {
-              runAt: options.runAt,
-              queueOverride: options.queueOverride,
-              idempotencyTtl: options.idempotencyTtl,
-              idempotencyKey,
-            });
+            const handle =
+              typeof workflow === "string"
+                ? await client.runByName(workflow, workflowInput, {
+                    runAt: options.runAt,
+                    queueOverride: options.queueOverride,
+                    idempotencyTtl: options.idempotencyTtl,
+                    idempotencyKey,
+                  })
+                : await workflow.run(workflowInput, {
+                    runAt: options.runAt,
+                    queueOverride: options.queueOverride,
+                    idempotencyTtl: options.idempotencyTtl,
+                    idempotencyKey,
+                  });
             return handle.id;
           },
         );

package/tests/redflow.e2e.test.ts

@@ -532,6 +532,47 @@ test("step.runWorkflow: same queue avoids self-deadlock with concurrency 1", asy
   redis.close();
 }, { timeout: 20_000 });
 
+test("step.emitWorkflow: supports workflow name strings", async () => {
+  const prefix = testPrefix();
+  const redis = new RedisClient(redisServer.url);
+  const client = createClient({ redis, prefix });
+  setDefaultClient(client);
+
+  defineWorkflow("child-emit-by-name", { queue: "q_emit_name_child" }, async ({ input }) => {
+    return { ok: true, input };
+  });
+
+  const parent = defineWorkflow("parent-emit-by-name", { queue: "q_emit_name_parent" }, async ({ step }) => {
+    const childRunId = await step.emitWorkflow(
+      { name: "emit-child-by-name" },
+      "child-emit-by-name",
+      { value: 1 },
+    );
+
+    return { childRunId };
+  });
+
+  const worker = await startWorker({
+    redis,
+    prefix,
+    queues: ["q_emit_name_parent", "q_emit_name_child"],
+    concurrency: 2,
+    runtime: { leaseMs: 500 },
+  });
+
+  try {
+    const parentHandle = await parent.run({});
+    const parentOut = await parentHandle.result({ timeoutMs: 8000 });
+    expect(typeof parentOut.childRunId).toBe("string");
+
+    const childOut = await client.makeRunHandle(parentOut.childRunId).result({ timeoutMs: 8000 });
+    expect(childOut).toEqual({ ok: true, input: { value: 1 } });
+  } finally {
+    await worker.stop();
+    redis.close();
+  }
+}, { timeout: 20_000 });
+
 
 
 test("retries: step results are cached across attempts", async () => {