refactor(core): Decouple post workflow execute event from internal hooks (no-changelog) #10232
Conversation
…oks (no-changelog) Follow-up to: #10221
n8n-assistant
bot
added
core
| executionId, | ||
| success: runData.status === 'success', | ||
| isManual: runData.mode === 'manual', | ||
| audit: { |
There was a problem hiding this comment.
why not emit two separate events?
There was a problem hiding this comment.
Other option would be to keep the event payload generic enough so both telemetry-event-relay and audit-event-relay can then derive whatever data they need from that. Tho that makes it then implicit what happens based on the sent event. Then again that's usually the point of using event buses: to decouple consumers from producers. Now the coupling is there, as we explicitly define the data separately for each consumer.
| success: data.status === 'success', | ||
| isManual: data.mode === 'manual', | ||
| userId: additionalData.userId, | ||
| audit: { |
I thought of prefixing event names but ruled this out, because there is only a small minority of events that are sent to both relays with different payloads, because this adds coupling to all events and relays, and because I expect that sending multiple events with different payloads at all callsites will be noisy. For these edge cases I'd like to aim for unifying both payloads as they're usually similar enough, but that would require a breaking change. Sending a big payload from which relays pick what they need is error prone (we have no tests) and causes the payload type to be unclear. Payloads with nesting in edge cases like this (although adding a bit of coupling) are meant as a workaround until we can unify. |
| // audit and telemetry | ||
| userId?: string; | ||
|
|
||
| // audit only | ||
| executionId: string; | ||
| success: boolean; | ||
| workflowId: string; | ||
| isManual: boolean; | ||
| workflowName: string; | ||
| metadata?: Record<string, string>; | ||
|
|
||
| // telemetry only | ||
| workflow: IWorkflowBase; | ||
| runData?: IRun; |
There was a problem hiding this comment.
This could be simplified to
| // audit and telemetry | |
| userId?: string; | |
| // audit only | |
| executionId: string; | |
| success: boolean; | |
| workflowId: string; | |
| isManual: boolean; | |
| workflowName: string; | |
| metadata?: Record<string, string>; | |
| // telemetry only | |
| workflow: IWorkflowBase; | |
| runData?: IRun; | |
| userId?: string; | |
| executionId: string; | |
| workflow: IWorkflowBase; | |
| runData?: IRun; |
as metadata doesn't seem to be passed in any emit and all the other fields can be derived from workflow and runData. That way there's no need to duplicate the logic for deriving those fields
|
Too many conflicts to safely resolve, I'll reopen from master soon enough. |
Follow-up to: #10221