Add output to workflow run #7276
Merged
Conversation
This file contains 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
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This pull request implements output functionality for workflow runs, enhancing tracking and analysis capabilities for workflow executions.
- Added 'output' field to WorkflowRunWorkspaceEntity in
workflow-run.workspace-entity.tsto store execution results - Modified WorkflowExecutorWorkspaceService in
workflow-executor.workspace-service.tsto track step-by-step execution output - Updated RunWorkflowJob in
run-workflow.job.tsto handle and store execution output for both successful and failed runs - Enhanced WorkflowRunWorkspaceService in
workflow-run.workspace-service.tsto persist detailed execution output when ending a workflow run - Added 'output' field ID to WORKFLOW_RUN_STANDARD_FIELD_IDS in
standard-field-ids.tsfor consistent field identification
5 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings
.../twenty-server/src/modules/workflow/common/standard-objects/workflow-run.workspace-entity.ts
Show resolved
Hide resolved
...modules/workflow/workflow-executor/workspace-services/workflow-executor.workspace-service.ts
Outdated
Show resolved
Hide resolved
...modules/workflow/workflow-executor/workspace-services/workflow-executor.workspace-service.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/modules/workflow/workflow-runner/jobs/run-workflow.job.ts
Outdated
Show resolved
Hide resolved
thomtrp
force-pushed
the
tt-add-output-to-workflows
branch
from
81a80a0
to
91a0001
Compare
martmull
reviewed
Sep 30, 2024
...modules/workflow/workflow-executor/workspace-services/workflow-executor.workspace-service.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/modules/workflow/workflow-runner/jobs/run-workflow.job.ts
Show resolved
Hide resolved
martmull
approved these changes
Sep 30, 2024
Devessier
reviewed
Sep 30, 2024
Comment on lines
12
to
19
| export type WorkflowExecutorOutput = { | ||
| steps: { | ||
| type: WorkflowActionType; | ||
| result: object | undefined; | ||
| error: object | undefined; | ||
| }[]; | ||
| status: WorkflowRunStatus; | ||
| }; |
There was a problem hiding this comment.
I think it would be great to store two more things per step:
- The step id; it will be easier to connect the output with the step node on the front-end
- The attemptCount; it would make it possible to store the output of all the attempts. Two attempts can fail for different reasons, and I think storing all of them would be worth it.
| @@ -75,13 +102,11 @@ export class WorkflowExecutorWorkspaceService { | |||
| currentStepIndex, | |||
| steps, | |||
| payload, | |||
| output, | |||
There was a problem hiding this comment.
I think it would be interesting to also store the output of the failed attempts. See my comment where I suggest adding two more fields to WorkflowExecutorOutput.
| const stepOutput = { | ||
| type: step.type, | ||
| result: result.result, | ||
| error: result.error, |
There was a problem hiding this comment.
I think we should be careful when storing the raw error. Indeed, here, we store the error with the stack trace, showing the internal file system of the worker running the jobs. These errors will be displayed to the user, and it's usually considered unsafe to expose stack traces publicly.
harshit078
pushed a commit
to harshit078/twenty
that referenced
this pull request
Oct 14, 2024
Example of output stored for following workflow: <img width="244" alt="Capture d’écran 2024-09-27 à 11 18 06" src="https://github.com/user-attachments/assets/722bfa96-2dd1-41f7-ab87-d39584ac9efc"> Output: ``` {"steps": [ {"type": "CODE", "result": {"email": "[email protected]"}}, {"type": "SEND_EMAIL", "result": {"success": true}} ]} ```
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.
Example of output stored for following workflow:
Output: