feat(queue): add workflow execution priority (high/medium/low) #19057
Conversation
…p to Bull job priority; add UI + i18n; tests
feat(queue): add workflow execution priority (high/medium/low)
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
| @@ -381,7 +381,20 @@ export class WorkflowRunner { | |||
| let job: Job; | |||
| let lifecycleHooks: ExecutionLifecycleHooks; | |||
| try { | |||
| job = await this.scalingService.addJob(jobData, { priority: realtime ? 50 : 100 }); | |||
| // Determine numeric Bull priority. Lower numbers are higher priority. | |||
| const qp = data.workflowData?.settings?.queuePriority as | |||
There was a problem hiding this comment.
Rule violated: Prefer Typeguards over Type casting
Avoid as for type narrowing; use a variable type annotation or a type guard for queuePriority.
(Based on your team's feedback about avoiding as casts and aligning local variable types with existing API types, prefer type guards or type annotations over assertions.)
Prompt for AI agents
Address the following comment on packages/cli/src/workflow-runner.ts at line 385:
<comment>Avoid `as` for type narrowing; use a variable type annotation or a type guard for `queuePriority`.
(Based on your team's feedback about avoiding `as` casts and aligning local variable types with existing API types, prefer type guards or type annotations over assertions.)</comment>
<file context>
@@ -381,7 +381,20 @@ export class WorkflowRunner {
try {
- job = await this.scalingService.addJob(jobData, { priority: realtime ? 50 : 100 });
+ // Determine numeric Bull priority. Lower numbers are higher priority.
+ const qp = data.workflowData?.settings?.queuePriority as
+ | 'low'
+ | 'medium'
</file context>
| @@ -568,6 +568,8 @@ export interface IWorkflowSettings extends IWorkflowSettingsWorkflow { | |||
| callerIds?: string; | |||
| callerPolicy?: WorkflowSettings.CallerPolicy; | |||
| executionOrder: NonNullable<IWorkflowSettingsWorkflow['executionOrder']>; | |||
| /** Optional queue execution priority for queued workflow runs */ | |||
| queuePriority?: 'low' | 'medium' | 'high'; | |||
There was a problem hiding this comment.
queuePriority is already defined on IWorkflowSettingsWorkflow (from n8n-workflow); redeclaring it here is redundant and risks divergence if the base changes. Remove the redeclaration and rely on the inherited property.
(Based on your team's feedback about aligning local types with existing API/library types to avoid redundant declarations.)
Prompt for AI agents
Address the following comment on packages/frontend/editor-ui/src/Interface.ts at line 572:
<comment>queuePriority is already defined on IWorkflowSettingsWorkflow (from n8n-workflow); redeclaring it here is redundant and risks divergence if the base changes. Remove the redeclaration and rely on the inherited property.
(Based on your team's feedback about aligning local types with existing API/library types to avoid redundant declarations.)</comment>
<file context>
@@ -568,6 +568,8 @@ export interface IWorkflowSettings extends IWorkflowSettingsWorkflow {
callerPolicy?: WorkflowSettings.CallerPolicy;
executionOrder: NonNullable<IWorkflowSettingsWorkflow['executionOrder']>;
+ /** Optional queue execution priority for queued workflow runs */
+ queuePriority?: 'low' | 'medium' | 'high';
}
</file context>
| medium: 50, | ||
| low: 100, | ||
| }; | ||
| const computedPriority = qp ? priorityMap[qp] : realtime ? 50 : 100; |
There was a problem hiding this comment.
computedPriority may become undefined when queuePriority is an unexpected string, causing addJob() to assert on invalid priority; validate qp against priorityMap before indexing to preserve the realtime fallback.
(Based on previous feedback about avoiding 'as' assertions and using type guards to validate values before narrowing.)
Prompt for AI agents
Address the following comment on packages/cli/src/workflow-runner.ts at line 395:
<comment>computedPriority may become undefined when queuePriority is an unexpected string, causing addJob() to assert on invalid priority; validate qp against priorityMap before indexing to preserve the realtime fallback.
(Based on previous feedback about avoiding 'as' assertions and using type guards to validate values before narrowing.)</comment>
<file context>
@@ -381,7 +381,20 @@ export class WorkflowRunner {
+ medium: 50,
+ low: 100,
+ };
+ const computedPriority = qp ? priorityMap[qp] : realtime ? 50 : 100;
+
+ job = await this.scalingService.addJob(jobData, { priority: computedPriority });
</file context>
| @@ -464,6 +478,9 @@ onMounted(async () => { | |||
| if (workflowSettingsData.executionOrder === undefined) { | |||
| workflowSettingsData.executionOrder = 'v0'; | |||
| } | |||
| if (workflowSettingsData.queuePriority === undefined) { | |||
| workflowSettingsData.queuePriority = 'medium'; | |||
There was a problem hiding this comment.
Defaulting queuePriority to 'medium' in the UI overrides backend fallback behavior on save (e.g., workflows with realtime=false would shift from 100/low to 50/medium). Leave it undefined until users choose a value.
Prompt for AI agents
Address the following comment on packages/frontend/editor-ui/src/components/WorkflowSettings.vue at line 482:
<comment>Defaulting queuePriority to 'medium' in the UI overrides backend fallback behavior on save (e.g., workflows with realtime=false would shift from 100/low to 50/medium). Leave it undefined until users choose a value.</comment>
<file context>
@@ -464,6 +478,9 @@ onMounted(async () => {
workflowSettingsData.executionOrder = 'v0';
}
+ if (workflowSettingsData.queuePriority === undefined) {
+ workflowSettingsData.queuePriority = 'medium';
+ }
</file context>
n8n-assistant
bot
added
community
|
Hey @robversluis, Thank you for your contribution. We appreciate the time and effort you’ve taken to submit this pull request. Before we can proceed, please ensure the following: Regarding new nodes: If your node integrates with an AI service that you own or represent, please email nodes@n8n.io and we will be happy to discuss the best approach. About review timelines: Thank you again for contributing to n8n. |
##Summary
Adds a workflow "Execution priority" setting (high/medium/low) that maps to Bull job priority so urgent executions run first under load.
##Changes
Backend (packages/cli/src/workflow-runner.ts): Map workflow.settings.queuePriority to Bull job option priority when enqueuing via scalingService.addJob(). Mapping: high=1, medium=50, low=100. If unset, fallback to previous behavior using realtime (50 when true, else 100). Uses a type guard (no assertions) and robust fallback to avoid passing undefined to Bull.
Frontend (packages/frontend/editor-ui/src/components/WorkflowSettings.vue): Add "Execution priority" select bound to workflowSettings.queuePriority. Disabled in read-only env or without update permissions.
Types: Add optional queuePriority to IWorkflowSettings in backend (packages/workflow/src/interfaces.ts) and frontend (packages/frontend/editor-ui/src/Interface.ts).
i18n: Add English keys in packages/frontend/@n8n/i18n/src/locales/en.json for label, placeholder, and options (low/medium/high).
Tests (packages/cli/src/tests/workflow-runner.test.ts): Verify mapping and fallback behavior.
Behavior
Lower numeric Bull priority runs sooner (1 is highest). Ordering is per-queue; concurrency/delays/retries still apply. Default remains effectively "Medium" when unset via realtime fallback.
##Notes
Minimal, non-disruptive change reusing existing queue infrastructure and settings patterns. Future follow-ups: docs entry for the setting; translations for other locales; optional e2e test under load.