Skip to content

Commit

Permalink
feat(core): Cache test webhook registrations (#8176)
Browse files Browse the repository at this point in the history
In a multi-main setup, we have the following issue. The user's client
connects to main A and runs a test webhook, so main A starts listening
for a webhook call. A third-party service sends a request to the test
webhook URL. The request is forwarded by the load balancer to main B,
who is not listening for this webhook call. Therefore, the webhook call
is unhandled.

To start addressing this, cache test webhook registrations, using Redis
for queue mode and in-memory for regular mode. When the third-party
service sends a request to the test webhook URL, the request is
forwarded by the load balancer to main B, who fetches test webhooks from
the cache and, if it finds a match, executes the test webhook. This
should be transparent - test webhook behavior should remain the same as
so far.

Notes:
- Test webhook timeouts are not cached. A timeout is only relevant to
the process it was created in, so another process retrieving from Redis
a "foreign" timeout will be unable to act on it. A timeout also has
circular references, so `cache-manager-ioredis-yet` is unable to
serialize it.
- In a single-main scenario, the timeout remains in the single process
and is cleared on test webhook expiration, successful execution, and
manual cancellation - all as usual.
- In a multi-main scenario, we will need to have the process who
received the webhook call send a message to the process who created the
webhook directing this originating process to clear the timeout. This
will likely be implemented via execution lifecycle hooks and Redis
channel messages checking session ID. This implementation is out of
scope for this PR and will come next.
- Additional data in test webhooks is not cached. From what I can tell,
additional data is not needed for test webhooks to be executed.
Additional data also has circular references, so
`cache-manager-ioredis-yet` is unable to serialize it.

Follow-up to: #8155
  • Loading branch information
ivov committed Jan 3, 2024
1 parent 0535035 commit 22a5f52
Show file tree
Hide file tree
Showing 8 changed files with 354 additions and 191 deletions.
10 changes: 0 additions & 10 deletions packages/cli/src/Interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import type {
INodeProperties,
IUserSettings,
IHttpRequestMethods,
IWebhookData,
} from 'n8n-workflow';

import type { ActiveWorkflowRunner } from '@/ActiveWorkflowRunner';
Expand Down Expand Up @@ -743,12 +742,3 @@ export abstract class SecretsProvider {
}

export type N8nInstanceType = 'main' | 'webhook' | 'worker';

export type WebhookRegistration = {
sessionId?: string;
timeout: NodeJS.Timeout;
workflowEntity: IWorkflowDb;
workflow: Workflow;
destinationNode?: string;
webhook: IWebhookData;
};
Loading

0 comments on commit 22a5f52

Please sign in to comment.