-
Notifications
You must be signed in to change notification settings - Fork 127
Support passing step function references across serialization boundaries #307
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: bc59732 The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…ze-step-function-reference
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds support for serializing step function references when they are passed as arguments between steps within a workflow context. Step functions can now be passed to other step functions and properly serialized/deserialized through the workflow runtime.
Problem
Previously, when a step function reference was passed as an argument to another step function (e.g.,
await stepWithStepFunctionArg(doubleNumber)), the serialization layer would fail because functions are not serializable by default. This prevented workflows from accepting and invoking step functions as parameters.Solution
This implementation introduces a custom serialization mechanism for step function references:
1. Symbol-based Function Marking (Compiler Level)
STEP_FUNCTION_NAME_SYMBOLconstant to mark step functions with their unique identifierexport async function step() {}✅export const stepArrow = async () => {}✅2. Custom Reducer for Serialization
STEP_FUNCTION_NAME_SYMBOLand returns the step name string instead of trying to serialize the function itselfdevalue3. Custom Reviver for Deserialization
getStepFunction()to retrieve the registered function reference4. Enhanced devalue Library
Changes
Core Serialization (
packages/core/src/)symbols.ts: AddedSTEP_FUNCTION_NAME_SYMBOLexportserialization.ts:StepFunctionreducer and reviver for handling step function serializationgetWorkflowReducersandgetWorkflowReviversschemas.ts: UpdatedSerializabletype to include step function typeserialization.test.ts: Added comprehensive unit tests for step function serializationSWC Plugin (
packages/swc-plugin-workflow/transform/)lib.rs: Enhanced to mark both regular and arrow function step declarationsDecl::Varcases (arrow functions and function expressions)Object.defineProperty()calls for all step functions withSTEP_FUNCTION_NAME_SYMBOLE2E Tests (
packages/core/e2e/)stepFunctionPassingWorkflowtest caseExample Workflows (
workbench/example/)stepWithStepFunctionArg,doubleNumber,stepFunctionPassingWorkflowTesting
✅ All SWC Plugin Tests Pass (36 tests)
✅ Unit Tests Added
✅ E2E Tests
Usage Example
Technical Details
Architecture
Symbol.for('WORKFLOW_STEP_FUNCTION_NAME')Benefits
Breaking Changes
None. This is a purely additive feature.
Notes
devaluelibrary that allows custom reducers for functions