perf(core): Batch workflow activation to speed up startup (#13191)

This commit is contained in:
Iván Ovejero 2025-02-11 15:12:55 +01:00 committed by GitHub
parent 6abb1f9374
commit 17acf70591
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 58 additions and 36 deletions

View file

@ -10,4 +10,8 @@ export class WorkflowsConfig {
@Env('N8N_WORKFLOW_CALLER_POLICY_DEFAULT_OPTION') @Env('N8N_WORKFLOW_CALLER_POLICY_DEFAULT_OPTION')
callerPolicyDefaultOption: 'any' | 'none' | 'workflowsFromAList' | 'workflowsFromSameOwner' = callerPolicyDefaultOption: 'any' | 'none' | 'workflowsFromAList' | 'workflowsFromSameOwner' =
'workflowsFromSameOwner'; 'workflowsFromSameOwner';
/** How many workflows to activate simultaneously during startup. */
@Env('N8N_WORKFLOW_ACTIVATION_BATCH_SIZE')
activationBatchSize: number = 1;
} }

View file

@ -35,6 +35,7 @@ export { FrontendBetaFeatures, FrontendConfig } from './configs/frontend.config'
export { S3Config } from './configs/external-storage.config'; export { S3Config } from './configs/external-storage.config';
export { LOG_SCOPES } from './configs/logging.config'; export { LOG_SCOPES } from './configs/logging.config';
export type { LogScope } from './configs/logging.config'; export type { LogScope } from './configs/logging.config';
export { WorkflowsConfig } from './configs/workflows.config';
@Config @Config
export class GlobalConfig { export class GlobalConfig {

View file

@ -156,6 +156,7 @@ describe('GlobalConfig', () => {
workflows: { workflows: {
defaultName: 'My workflow', defaultName: 'My workflow',
callerPolicyDefaultOption: 'workflowsFromSameOwner', callerPolicyDefaultOption: 'workflowsFromSameOwner',
activationBatchSize: 1,
}, },
endpoints: { endpoints: {
metrics: { metrics: {

View file

@ -36,6 +36,7 @@ describe('ActiveWorkflowManager', () => {
mock(), mock(),
instanceSettings, instanceSettings,
mock(), mock(),
mock(),
); );
}); });

View file

@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */ /* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { WorkflowsConfig } from '@n8n/config';
import { Service } from '@n8n/di'; import { Service } from '@n8n/di';
import { chunk } from 'lodash';
import { import {
ActiveWorkflows, ActiveWorkflows,
ErrorReporter, ErrorReporter,
@ -82,6 +84,7 @@ export class ActiveWorkflowManager {
private readonly workflowExecutionService: WorkflowExecutionService, private readonly workflowExecutionService: WorkflowExecutionService,
private readonly instanceSettings: InstanceSettings, private readonly instanceSettings: InstanceSettings,
private readonly publisher: Publisher, private readonly publisher: Publisher,
private readonly workflowsConfig: WorkflowsConfig,
) {} ) {}
async init() { async init() {
@ -419,48 +422,61 @@ export class ActiveWorkflowManager {
this.logger.info(' ================================'); this.logger.info(' ================================');
} }
for (const dbWorkflow of dbWorkflows) { const batches = chunk(dbWorkflows, this.workflowsConfig.activationBatchSize);
try {
const wasActivated = await this.add(dbWorkflow.id, activationMode, dbWorkflow, {
shouldPublish: false,
});
if (wasActivated) { for (const batch of batches) {
this.logger.debug(`Successfully started workflow ${dbWorkflow.display()}`, { const activationPromises = batch.map(async (dbWorkflow) => {
workflowName: dbWorkflow.name, await this.activateWorkflow(dbWorkflow, activationMode);
workflowId: dbWorkflow.id, });
});
this.logger.info(' => Started');
}
} catch (error) {
this.errorReporter.error(error);
this.logger.info(
' => ERROR: Workflow could not be activated on first try, keep on trying if not an auth issue',
);
this.logger.info(` ${error.message}`); await Promise.all(activationPromises);
this.logger.error(
`Issue on initial workflow activation try of ${dbWorkflow.display()} (startup)`,
{
workflowName: dbWorkflow.name,
workflowId: dbWorkflow.id,
},
);
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
this.executeErrorWorkflow(error, dbWorkflow, 'internal');
// do not keep trying to activate on authorization error
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
if (error.message.includes('Authorization')) continue;
this.addQueuedWorkflowActivation('init', dbWorkflow);
}
} }
this.logger.debug('Finished activating workflows (startup)'); this.logger.debug('Finished activating workflows (startup)');
} }
private async activateWorkflow(
dbWorkflow: WorkflowEntity,
activationMode: 'init' | 'leadershipChange',
) {
try {
const wasActivated = await this.add(dbWorkflow.id, activationMode, dbWorkflow, {
shouldPublish: false,
});
if (wasActivated) {
this.logger.info(` - ${dbWorkflow.display()})`);
this.logger.info(' => Started');
this.logger.debug(`Successfully started workflow ${dbWorkflow.display()}`, {
workflowName: dbWorkflow.name,
workflowId: dbWorkflow.id,
});
}
} catch (error) {
this.errorReporter.error(error);
this.logger.info(
` => ERROR: Workflow ${dbWorkflow.display()} could not be activated on first try, keep on trying if not an auth issue`,
);
this.logger.info(` ${error.message}`);
this.logger.error(
`Issue on initial workflow activation try of ${dbWorkflow.display()} (startup)`,
{
workflowName: dbWorkflow.name,
workflowId: dbWorkflow.id,
},
);
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
this.executeErrorWorkflow(error, dbWorkflow, 'internal');
// do not keep trying to activate on authorization error
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
if (error.message.includes('Authorization')) return;
this.addQueuedWorkflowActivation('init', dbWorkflow);
}
}
async clearAllActivationErrors() { async clearAllActivationErrors() {
this.logger.debug('Clearing all activation errors'); this.logger.debug('Clearing all activation errors');
@ -533,7 +549,6 @@ export class ActiveWorkflowManager {
} }
if (shouldDisplayActivationMessage) { if (shouldDisplayActivationMessage) {
this.logger.info(` - ${dbWorkflow.display()}`);
this.logger.debug(`Initializing active workflow ${dbWorkflow.display()} (startup)`, { this.logger.debug(`Initializing active workflow ${dbWorkflow.display()} (startup)`, {
workflowName: dbWorkflow.name, workflowName: dbWorkflow.name,
workflowId: dbWorkflow.id, workflowId: dbWorkflow.id,