refactor(core): Move ExecutionLifecycleHooks to core #13042
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
n8n-assistant
bot
added
core
Codecov ReportAttention: Patch coverage is 📢 Thoughts on this report? Let us know! |
tomi
reviewed
Feb 4, 2025
packages/core/src/execution-engine/execution-lifecycle-hooks.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Tomi Turtiainen <10324676+tomi@users.noreply.github.com>
ivov
reviewed
Feb 4, 2025
| @@ -61,7 +61,7 @@ export class WorkflowRunner { | |||
| startedAt: Date, | |||
| executionMode: WorkflowExecuteMode, | |||
| executionId: string, | |||
| hooks?: WorkflowHooks, | |||
| hooks?: ExecutionLifecycleHooks, | |||
There was a problem hiding this comment.
Every call to processError passes hooks, can we make them required and remove the optional access below?
There was a problem hiding this comment.
I'll try to make hooks required wherever I can, but we'll still have some places where it'll be optional, until we rewrite credentials testing to stop using the execution engine.
packages/core/src/execution-engine/__tests__/workflow-execute.test.ts
Outdated
Show resolved
Hide resolved
packages/core/src/execution-engine/execution-lifecycle-hooks.ts
Outdated
Show resolved
Hide resolved
packages/core/src/execution-engine/execution-lifecycle-hooks.ts
Outdated
Show resolved
Hide resolved
packages/core/src/execution-engine/__tests__/execution-lifecycle-hooks.test.ts
Outdated
Show resolved
Hide resolved
packages/core/src/execution-engine/__tests__/execution-lifecycle-hooks.test.ts
Outdated
Show resolved
Hide resolved
| await expect(hooks.runHook('nodeExecuteBefore', ['testNode'])).rejects.toThrow('Hook failed'); | ||
| }); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
More ideas :)
- if a handler fails, should continue executing remaining handlers
- if a hook has no handlers, running the hook should not throw
- if two handlers are added for a hook, both should be called (not overridden)
Comment on lines
+47
to
+49
| mock<{ | ||
| [K in keyof ExecutionLifecyleHookHandlers]: ExecutionLifecyleHookHandlers[K][number]; | ||
| }>(); |
There was a problem hiding this comment.
Or mock<ExecutionLifecyleHookHandlers>()?
Comment on lines
+102
to
+107
| const typedHookFunction = hookFunction as unknown as ( | ||
| this: ExecutionLifecycleHooks, | ||
| ...args: Params | ||
| ) => Promise<void>; | ||
| await typedHookFunction.apply(this, parameters); | ||
| } |
There was a problem hiding this comment.
this file needs another round of cleanup. same with the TODO on line 90
n8n
|
||||||||||||||||||||||||||||
| Project |
n8n
|
| Branch Review |
master
|
| Run status |
|
| Run duration | 04m 37s |
| Commit |
|
| Committer | कारतोफ्फेलस्क्रिप्ट™ |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
5
|
Skipped
|
0
|
Passing
|
434
|
| View all changes introduced in this branch ↗︎ | |
|
✅ All Cypress E2E specs passed |
tomi
approved these changes
Feb 7, 2025
|
|
|
✅ All Cypress E2E specs passed |
# 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
This is a continuation of the execution-lifecycle hooks refactor. extracted out of #12364.
Review / Merge checklist
release/backport(if the PR is an urgent fix that needs to be backported)