mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/@n8n/config/src/configs/workflows.config.ts
View file

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

1
packages/@n8n/config/src/index.ts
View file

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

1
packages/@n8n/config/test/config.test.ts
View file

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

1
packages/cli/src/__tests__/active-workflow-manager.test.ts
View file

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

87
packages/cli/src/active-workflow-manager.ts
View file

@ -1,5 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import { WorkflowsConfig } from '@n8n/config';
import { Service } from '@n8n/di';
import { chunk } from 'lodash';
import {
ActiveWorkflows,
ErrorReporter,
@ -82,6 +84,7 @@ export class ActiveWorkflowManager {
private readonly workflowExecutionService: WorkflowExecutionService,
private readonly instanceSettings: InstanceSettings,
private readonly publisher: Publisher,
private readonly workflowsConfig: WorkflowsConfig,
) {}
async init() {
@ -419,48 +422,61 @@ export class ActiveWorkflowManager {
this.logger.info(' ================================');
}
for (const dbWorkflow of dbWorkflows) {
try {
const wasActivated = await this.add(dbWorkflow.id, activationMode, dbWorkflow, {
shouldPublish: false,
});
const batches = chunk(dbWorkflows, this.workflowsConfig.activationBatchSize);
if (wasActivated) {
this.logger.debug(`Successfully started workflow ${dbWorkflow.display()}`, {
workflowName: dbWorkflow.name,
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',
);
for (const batch of batches) {
const activationPromises = batch.map(async (dbWorkflow) => {
await this.activateWorkflow(dbWorkflow, activationMode);
});
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')) continue;
this.addQueuedWorkflowActivation('init', dbWorkflow);
}
await Promise.all(activationPromises);
}
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() {
this.logger.debug('Clearing all activation errors');
@ -533,7 +549,6 @@ export class ActiveWorkflowManager {
}
if (shouldDisplayActivationMessage) {
this.logger.info(` - ${dbWorkflow.display()}`);
this.logger.debug(`Initializing active workflow ${dbWorkflow.display()} (startup)`, {
workflowName: dbWorkflow.name,
workflowId: dbWorkflow.id,