-
Notifications
You must be signed in to change notification settings - Fork 7.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(core): Simplify webhook pubsub message handler #11048
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
142 changes: 142 additions & 0 deletions
142
packages/cli/src/scaling/__tests__/pubsub-handler.test.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
import { mock } from 'jest-mock-extended'; | ||
import type { InstanceSettings } from 'n8n-core'; | ||
|
||
import type { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus'; | ||
import { EventService } from '@/events/event.service'; | ||
import type { ExternalSecretsManager } from '@/external-secrets/external-secrets-manager.ee'; | ||
import type { License } from '@/license'; | ||
import type { CommunityPackagesService } from '@/services/community-packages.service'; | ||
|
||
import { PubSubHandler } from '../pubsub/pubsub-handler'; | ||
|
||
describe('PubSubHandler', () => { | ||
const eventService = new EventService(); | ||
const license = mock<License>(); | ||
const eventbus = mock<MessageEventBus>(); | ||
const externalSecretsManager = mock<ExternalSecretsManager>(); | ||
const communityPackagesService = mock<CommunityPackagesService>(); | ||
|
||
describe('in webhook process', () => { | ||
const instanceSettings = mock<InstanceSettings>({ instanceType: 'webhook' }); | ||
|
||
it('should set up handlers in webhook process', () => { | ||
// @ts-expect-error Spying on private method | ||
const setupWebhookHandlersSpy = jest.spyOn(PubSubHandler.prototype, 'setupWebhookHandlers'); | ||
|
||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
expect(setupWebhookHandlersSpy).toHaveBeenCalled(); | ||
}); | ||
|
||
it('should reload license on `reload-license` event', () => { | ||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
eventService.emit('reload-license'); | ||
|
||
expect(license.reload).toHaveBeenCalled(); | ||
}); | ||
|
||
it('should restart event bus on `restart-event-bus` event', () => { | ||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
eventService.emit('restart-event-bus'); | ||
|
||
expect(eventbus.restart).toHaveBeenCalled(); | ||
}); | ||
|
||
it('should reload providers on `reload-external-secrets-providers` event', () => { | ||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
eventService.emit('reload-external-secrets-providers'); | ||
|
||
expect(externalSecretsManager.reloadAllProviders).toHaveBeenCalled(); | ||
}); | ||
|
||
it('should install community package on `community-package-install` event', () => { | ||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
eventService.emit('community-package-install', { | ||
packageName: 'test-package', | ||
packageVersion: '1.0.0', | ||
}); | ||
|
||
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith( | ||
'test-package', | ||
'1.0.0', | ||
); | ||
}); | ||
|
||
it('should update community package on `community-package-update` event', () => { | ||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
eventService.emit('community-package-update', { | ||
packageName: 'test-package', | ||
packageVersion: '1.0.0', | ||
}); | ||
|
||
expect(communityPackagesService.installOrUpdateNpmPackage).toHaveBeenCalledWith( | ||
'test-package', | ||
'1.0.0', | ||
); | ||
}); | ||
|
||
it('should uninstall community package on `community-package-uninstall` event', () => { | ||
new PubSubHandler( | ||
eventService, | ||
instanceSettings, | ||
license, | ||
eventbus, | ||
externalSecretsManager, | ||
communityPackagesService, | ||
).init(); | ||
|
||
eventService.emit('community-package-uninstall', { | ||
packageName: 'test-package', | ||
}); | ||
|
||
expect(communityPackagesService.removeNpmPackage).toHaveBeenCalledWith('test-package'); | ||
}); | ||
}); | ||
}); |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
import { InstanceSettings } from 'n8n-core'; | ||
import { Service } from 'typedi'; | ||
|
||
import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus'; | ||
import { EventService } from '@/events/event.service'; | ||
import type { PubSubEventMap } from '@/events/maps/pub-sub.event-map'; | ||
import { ExternalSecretsManager } from '@/external-secrets/external-secrets-manager.ee'; | ||
import { License } from '@/license'; | ||
import { CommunityPackagesService } from '@/services/community-packages.service'; | ||
|
||
/** | ||
* Responsible for handling events emitted from messages received via a pubsub channel. | ||
*/ | ||
@Service() | ||
export class PubSubHandler { | ||
constructor( | ||
private readonly eventService: EventService, | ||
private readonly instanceSettings: InstanceSettings, | ||
private readonly license: License, | ||
private readonly eventbus: MessageEventBus, | ||
private readonly externalSecretsManager: ExternalSecretsManager, | ||
private readonly communityPackagesService: CommunityPackagesService, | ||
) {} | ||
|
||
init() { | ||
if (this.instanceSettings.instanceType === 'webhook') this.setupWebhookHandlers(); | ||
} | ||
|
||
private setupHandlers<EventNames extends keyof PubSubEventMap>( | ||
map: { | ||
[EventName in EventNames]?: (event: PubSubEventMap[EventName]) => void | Promise<void>; | ||
}, | ||
) { | ||
for (const [eventName, handlerFn] of Object.entries(map) as Array< | ||
[EventNames, (event: PubSubEventMap[EventNames]) => void | Promise<void>] | ||
>) { | ||
this.eventService.on(eventName, async (event) => { | ||
await handlerFn(event); | ||
}); | ||
} | ||
} | ||
|
||
// #region Webhook process | ||
|
||
private setupWebhookHandlers() { | ||
this.setupHandlers({ | ||
'reload-license': async () => await this.license.reload(), | ||
ivov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
'restart-event-bus': async () => await this.eventbus.restart(), | ||
'reload-external-secrets-providers': async () => | ||
await this.externalSecretsManager.reloadAllProviders(), | ||
'community-package-install': async ({ packageName, packageVersion }) => | ||
await this.communityPackagesService.installOrUpdateNpmPackage(packageName, packageVersion), | ||
'community-package-update': async ({ packageName, packageVersion }) => | ||
await this.communityPackagesService.installOrUpdateNpmPackage(packageName, packageVersion), | ||
'community-package-uninstall': async ({ packageName }) => | ||
await this.communityPackagesService.removeNpmPackage(packageName), | ||
}); | ||
} | ||
|
||
// #endregion | ||
} |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would this order also work and prevent use form missing messages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! It's a tiny window - I'll address in the next PR 👍🏻