fix(core): Don't fail task runner task if logging fails #12401
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
netroy
reviewed
Dec 30, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
netroy
previously approved these changes
Dec 30, 2024
netroy
approved these changes
Dec 30, 2024
|
|
n8n
|
||||||||||||||||||||||||||||
| Project |
n8n
|
| Branch Review |
cat-447-console-logging-the-context-object-throws
|
| Run status |
|
| Run duration | 04m 47s |
| Commit |
|
| Committer | Tomi Turtiainen |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
3
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
484
|
| View all changes introduced in this branch ↗︎ | |
|
|
ivov
reviewed
Dec 30, 2024
Comment on lines
+472
to
+484
| const context: Context = { | ||
| [inspect.custom]: () => '[[ExecutionContext]]', | ||
| require: this.requireResolver, | ||
| module: {}, | ||
| console: this.buildCustomConsole(taskId), | ||
| $getWorkflowStaticData: (type: 'global' | 'node') => workflow.getStaticData(type, node), | ||
| ...this.getNativeVariables(), | ||
| ...dataProxy, | ||
| ...this.buildRpcCallObject(taskId), | ||
| ...additionalProperties, | ||
| }; | ||
|
|
||
| return context; |
There was a problem hiding this comment.
Suggested change
| const context: Context = { | |
| [inspect.custom]: () => '[[ExecutionContext]]', | |
| require: this.requireResolver, | |
| module: {}, | |
| console: this.buildCustomConsole(taskId), | |
| $getWorkflowStaticData: (type: 'global' | 'node') => workflow.getStaticData(type, node), | |
| ...this.getNativeVariables(), | |
| ...dataProxy, | |
| ...this.buildRpcCallObject(taskId), | |
| ...additionalProperties, | |
| }; | |
| return context; | |
| return { | |
| [inspect.custom]: () => '[[ExecutionContext]]', | |
| require: this.requireResolver, | |
| module: {}, | |
| console: this.buildCustomConsole(taskId), | |
| $getWorkflowStaticData: (type: 'global' | 'node') => workflow.getStaticData(type, node), | |
| ...this.getNativeVariables(), | |
| ...dataProxy, | |
| ...this.buildRpcCallObject(taskId), | |
| ...additionalProperties, | |
| }; |
Comment on lines
+456
to
+463
| this.send({ | ||
| type: 'runner:rpc', | ||
| callId, | ||
| taskId, | ||
| name, | ||
| params, | ||
| }); | ||
|
|
There was a problem hiding this comment.
There's no catch block here? Shouldn't we error the task if RPC fails?
There was a problem hiding this comment.
The RPC calls are initiated by user code. Hence it's up to the user code to handle or ignore them. If the user code throws, we of course error the task.
|
✅ All Cypress E2E specs passed |
Merged
|
Got released with |
1 similar comment
|
Got released with |
|
Got released with |
1 similar comment
|
Got released with |
riascho
pushed a commit
that referenced
this pull request
Jan 14, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Summary
To conform to old Code Node behaviour, make sure JS task execution doesn't fail if logging fails. The issue mainly comes when trying to
console.logthe context object (e.g.this), because most of the built-ins are not serializable.Related Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/CAT-447/console-logging-the-context-object-throws
Review / Merge checklist
release/backport(if the PR is an urgent fix that needs to be backported)