Skip to content

Commit

Permalink
fix(core): Add safeguard for command publishing (#11337)
Browse files Browse the repository at this point in the history
  • Loading branch information
ivov authored Oct 24, 2024
1 parent f4ea943 commit 656439e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
10 changes: 10 additions & 0 deletions packages/cli/src/scaling/__tests__/publisher.service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ describe('Publisher', () => {
});

describe('publishCommand', () => {
it('should do nothing if not in scaling mode', async () => {
config.set('executions.mode', 'regular');
const publisher = new Publisher(logger, redisClientService, instanceSettings);
const msg = mock<PubSub.Command>({ command: 'reload-license' });

await publisher.publishCommand(msg);

expect(client.publish).not.toHaveBeenCalled();
});

it('should publish command into `n8n.commands` pubsub channel', async () => {
const publisher = new Publisher(logger, redisClientService, instanceSettings);
const msg = mock<PubSub.Command>({ command: 'reload-license' });
Expand Down
5 changes: 4 additions & 1 deletion packages/cli/src/scaling/pubsub/publisher.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class Publisher {
private readonly redisClientService: RedisClientService,
private readonly instanceSettings: InstanceSettings,
) {
// @TODO: Once this class is only ever initialized in scaling mode, throw in the next line instead.
// @TODO: Once this class is only ever initialized in scaling mode, assert in the next line.
if (config.getEnv('executions.mode') !== 'queue') return;

this.logger = this.logger.scoped(['scaling', 'pubsub']);
Expand All @@ -46,6 +46,9 @@ export class Publisher {

/** Publish a command into the `n8n.commands` channel. */
async publishCommand(msg: Omit<PubSub.Command, 'senderId'>) {
// @TODO: Once this class is only ever used in scaling mode, remove next line.
if (config.getEnv('executions.mode') !== 'queue') return;

await this.client.publish(
'n8n.commands',
JSON.stringify({
Expand Down

0 comments on commit 656439e

Please sign in to comment.