Support nested "use step" declarations in non-workflow functions (#418)

Author: TooTallNate

.changeset/sixty-carpets-join.md

@@ -0,0 +1,5 @@
+---
+"@workflow/swc-plugin": patch
+---
+
+Support nested "use step" declarations in non-workflow functions

packages/swc-plugin-workflow/transform/src/lib.rs

@@ -9,13 +9,6 @@ export const syncWorkflow = ()=>{
     'use workflow';
     return 'test';
 };
-// Error: sync method with use step
-const obj = {
-    syncMethod () {
-        'use step';
-        return true;
-    }
-};
 // These are ok
 export async function validStep() {
     return 42;

packages/swc-plugin-workflow/transform/tests/errors/non-async-functions/output-client.js

@@ -9,13 +9,6 @@ export const syncWorkflow = ()=>{
     'use workflow';
     return 'test';
 };
-// Error: sync method with use step
-const obj = {
-    syncMethod () {
-        'use step';
-        return true;
-    }
-};
 // These are ok
 export var validStep = globalThis[Symbol.for("WORKFLOW_USE_STEP")]("step//input.js//validStep");
 export const validWorkflow = async ()=>{

packages/swc-plugin-workflow/transform/tests/errors/non-async-functions/output-workflow.js

@@ -0,0 +1,32 @@
+// Test case for functions used in default parameter values
+// The createDefaultDownloadFunction should NOT be removed by DCE
+
+const createDefaultDownloadFunction = (download = defaultDownload) => (requestedDownloads) =>
+  Promise.all(requestedDownloads.map(async (r) => r.isUrlSupportedByModel ? null : download(r)));
+
+async function defaultDownload(request) {
+  return fetch(request.url);
+}
+
+// This function uses createDefaultDownloadFunction in a default parameter value
+// DCE must NOT remove createDefaultDownloadFunction
+async function convertToLanguageModelPrompt({
+  prompt,
+  supportedUrls,
+  download = createDefaultDownloadFunction()
+}) {
+  return { prompt, supportedUrls, download };
+}
+
+export async function myWorkflow(input) {
+  'use workflow';
+
+  const result = await convertToLanguageModelPrompt({
+    prompt: input.prompt,
+    supportedUrls: {},
+    download: undefined
+  });
+
+  return result;
+}
+

packages/swc-plugin-workflow/transform/tests/fixture/default-parameter-usage/input.js

@@ -0,0 +1,7 @@
+// Test case for functions used in default parameter values
+// The createDefaultDownloadFunction should NOT be removed by DCE
+/**__internal_workflows{"workflows":{"input.js":{"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;
+export async function myWorkflow(input) {
+    throw new Error("You attempted to execute workflow myWorkflow function directly. To start a workflow, use start(myWorkflow) from workflow/api");
+}
+myWorkflow.workflowId = "workflow//input.js//myWorkflow";

packages/swc-plugin-workflow/transform/tests/fixture/default-parameter-usage/output-client.js

@@ -0,0 +1,25 @@
+// Test case for functions used in default parameter values
+// The createDefaultDownloadFunction should NOT be removed by DCE
+/**__internal_workflows{"workflows":{"input.js":{"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;
+const createDefaultDownloadFunction = (download = defaultDownload)=>(requestedDownloads)=>Promise.all(requestedDownloads.map(async (r)=>r.isUrlSupportedByModel ? null : download(r)));
+async function defaultDownload(request) {
+    return fetch(request.url);
+}
+// This function uses createDefaultDownloadFunction in a default parameter value
+// DCE must NOT remove createDefaultDownloadFunction
+async function convertToLanguageModelPrompt({ prompt, supportedUrls, download = createDefaultDownloadFunction() }) {
+    return {
+        prompt,
+        supportedUrls,
+        download
+    };
+}
+export async function myWorkflow(input) {
+    'use workflow';
+    const result = await convertToLanguageModelPrompt({
+        prompt: input.prompt,
+        supportedUrls: {},
+        download: undefined
+    });
+    return result;
+}

packages/swc-plugin-workflow/transform/tests/fixture/default-parameter-usage/output-step.js

@@ -0,0 +1,25 @@
+// Test case for functions used in default parameter values
+// The createDefaultDownloadFunction should NOT be removed by DCE
+/**__internal_workflows{"workflows":{"input.js":{"myWorkflow":{"workflowId":"workflow//input.js//myWorkflow"}}}}*/;
+const createDefaultDownloadFunction = (download = defaultDownload)=>(requestedDownloads)=>Promise.all(requestedDownloads.map(async (r)=>r.isUrlSupportedByModel ? null : download(r)));
+async function defaultDownload(request) {
+    return fetch(request.url);
+}
+// This function uses createDefaultDownloadFunction in a default parameter value
+// DCE must NOT remove createDefaultDownloadFunction
+async function convertToLanguageModelPrompt({ prompt, supportedUrls, download = createDefaultDownloadFunction() }) {
+    return {
+        prompt,
+        supportedUrls,
+        download
+    };
+}
+export async function myWorkflow(input) {
+    const result = await convertToLanguageModelPrompt({
+        prompt: input.prompt,
+        supportedUrls: {},
+        download: undefined
+    });
+    return result;
+}
+myWorkflow.workflowId = "workflow//input.js//myWorkflow";

packages/swc-plugin-workflow/transform/tests/fixture/default-parameter-usage/output-workflow.js

@@ -1,7 +1,4 @@
 /**__internal_workflows{"steps":{"input.js":{"step":{"stepId":"step//input.js//step"},"stepArrow":{"stepId":"step//input.js//stepArrow"}}}}*/;
-const localArrow = async (input)=>{
-    return input.bar;
-};
 export async function step(input) {
     return input.foo;
 }

packages/swc-plugin-workflow/transform/tests/fixture/module-level-step/output-client.js

@@ -1,7 +1,4 @@
 /**__internal_workflows{"steps":{"input.js":{"step":{"stepId":"step//input.js//step"},"stepArrow":{"stepId":"step//input.js//stepArrow"}}}}*/;
 'use step';
-const localArrow = async (input)=>{
-    return input.bar;
-};
 export var step = globalThis[Symbol.for("WORKFLOW_USE_STEP")]("step//input.js//step");
 export const stepArrow = globalThis[Symbol.for("WORKFLOW_USE_STEP")]("step//input.js//stepArrow");