Activity Contracts for Workflow Orchestrator#360
Merged
Conversation
PR Validation PassedPR description validation passed |
WalkthroughA new activity contracts Go package is introduced, defining shared types for the activity system including global output mappings, standardized activity inputs and outputs, and a common activity function signature. Module configuration is established for the new package. Changes
🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
core/activity-contracts/activity/activity.go (1)
22-27: Clarify precedence betweenActivityOutput.Errorand returnederror.Lines 22-27 currently expose two error channels. Please define one canonical behavior to avoid inconsistent handling across activities and orchestrator paths.
Proposed contract clarification
type ActivityOutput struct { Result map[string]interface{} `json:"result,omitempty"` - Error string `json:"error,omitempty"` + // Error is for domain/business failures that should be serialized in workflow state. + // Runtime/infrastructure failures should be returned from ActivityFunc as a non-nil error. + Error string `json:"error,omitempty"` } // ActivityFunc is the function signature that every registered activity must implement. +// Return non-nil error only for runtime/execution failures. type ActivityFunc func(ctx context.Context, globalOutputs GlobalActivityOutputs, input ActivityInput) (ActivityOutput, error)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@core/activity-contracts/activity/activity.go` around lines 22 - 27, Define a single canonical error precedence: treat the error value returned by ActivityFunc as authoritative for control flow and orchestration, and treat ActivityOutput.Error only as an optional, informational field for result payloads; update all callers (the orchestrator and any executor) to check the returned error from ActivityFunc first and only inspect ActivityOutput.Error if the returned error is nil, and update comments/docs on the ActivityOutput struct and the ActivityFunc type to state this precedence so implementers know to return an error for control/failure and only set ActivityOutput.Error for non-fatal, descriptive result information.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@core/activity-contracts/activity/activity.go`:
- Around line 22-27: Define a single canonical error precedence: treat the error
value returned by ActivityFunc as authoritative for control flow and
orchestration, and treat ActivityOutput.Error only as an optional, informational
field for result payloads; update all callers (the orchestrator and any
executor) to check the returned error from ActivityFunc first and only inspect
ActivityOutput.Error if the returned error is nil, and update comments/docs on
the ActivityOutput struct and the ActivityFunc type to state this precedence so
implementers know to return an error for control/failure and only set
ActivityOutput.Error for non-fatal, descriptive result information.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0ede72fd-5da4-4b1a-a91d-848215d0bebd
📒 Files selected for processing (2)
core/activity-contracts/activity/activity.gocore/activity-contracts/go.mod
a0d00kc
approved these changes
Mar 30, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What type of PR is this?
Description
PR Description
Adding a small Go Project which is used by workflow-orchestrator and activities.
Added tests
Key Requirement Doc
Why is KRD not required?
Just model changes, which needs to be released
Downstream Impact
Additional Information