fix(queue): Cancel button now works for pending jobs #7788
Conversation
The cancel button on queue job items was calling api.interrupt() for
all jobs, but interrupt only works for running/initializing jobs.
Pending jobs need to be deleted from the queue instead.
Changes:
- Check item.state before deciding which API to call
- Call api.interrupt() for running/initialization states
- Call api.deleteItem('queue', id) for pending state
- Refresh queue state after cancel action
This mirrors the existing correct behavior in useJobMenu.ts cancelJob().
Fixes Comfy-Org#7758
Move queueStore.update() inside conditional branches so it's only called when an actual action (interrupt or delete) is performed. Previously it was called unconditionally, even for states like 'completed' or 'failed' where no action is taken.
📝 WalkthroughWalkthroughThe PR fixes the queue item cancellation logic by adding state-based branching to the Changes
Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🎨 Storybook Build Status
⏰ Started at: 12/29/2025, 05:29:21 PM UTC 🚀 Building Storybook
⏱️ Please wait while the Storybook build is in progress... |
dosubot
bot
added
the
size:S
🎭 Playwright Test Results⏰ Completed at: 12/29/2025, 07:41:22 PM UTC 📈 Summary
📊 Test Reports by Browser
🎉 Click on the links above to view detailed test results for each browser configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
src/components/queue/QueueProgressOverlay.vue
🧰 Additional context used
📓 Path-based instructions (12)
src/**/*.vue
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
src/**/*.vue: Use the Vue 3 Composition API instead of the Options API when writing Vue components (exception: when overriding or extending PrimeVue components for compatibility)
Use setup() function for component logic
Utilize ref and reactive for reactive state
Implement computed properties with computed()
Use watch and watchEffect for side effects
Implement lifecycle hooks with onMounted, onUpdated, etc.
Utilize provide/inject for dependency injection
Use vue 3.5 style of default prop declaration
Use Tailwind CSS for styling
Implement proper props and emits definitions
Utilize Vue 3's Teleport component when needed
Use Suspense for async components
Follow Vue 3 style guide and naming conventions
Files:
src/components/queue/QueueProgressOverlay.vue
src/**/*.{vue,ts}
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
src/**/*.{vue,ts}: Leverage VueUse functions for performance-enhancing styles
Implement proper error handling
Use vue-i18n in composition API for any string literals. Place new translation entries in src/locales/en/main.json
Files:
src/components/queue/QueueProgressOverlay.vue
src/**/*.{ts,tsx,vue}
📄 CodeRabbit inference engine (src/CLAUDE.md)
src/**/*.{ts,tsx,vue}: Sanitize HTML with DOMPurify to prevent XSS attacks
Avoid using @ts-expect-error; use proper TypeScript types instead
Use es-toolkit for utility functions instead of other utility libraries
Implement proper TypeScript types throughout the codebase
Files:
src/components/queue/QueueProgressOverlay.vue
src/**/{composables,components}/**/*.{ts,tsx,vue}
📄 CodeRabbit inference engine (src/CLAUDE.md)
Clean up subscriptions in state management to prevent memory leaks
Files:
src/components/queue/QueueProgressOverlay.vue
src/**/*.{vue,ts,tsx}
📄 CodeRabbit inference engine (src/CLAUDE.md)
Follow Vue 3 composition API style guide
Files:
src/components/queue/QueueProgressOverlay.vue
src/**/{components,composables}/**/*.{ts,tsx,vue}
📄 CodeRabbit inference engine (src/CLAUDE.md)
Use vue-i18n for ALL user-facing strings by adding them to
src/locales/en/main.json
Files:
src/components/queue/QueueProgressOverlay.vue
src/components/**/*.vue
📄 CodeRabbit inference engine (src/components/CLAUDE.md)
src/components/**/*.vue: Use setup() function in Vue 3 Composition API
Destructure props using Vue 3.5 style in Vue components
Use ref/reactive for state management in Vue 3 Composition API
Implement computed() for derived state in Vue 3 Composition API
Use provide/inject for dependency injection in Vue components
Prefer emit/@event-name for state changes over other communication patterns
Use defineExpose only for imperative operations (such as form.validate(), modal.open())
Replace PrimeVue Dropdown component with Select
Replace PrimeVue OverlayPanel component with Popover
Replace PrimeVue Calendar component with DatePicker
Replace PrimeVue InputSwitch component with ToggleSwitch
Replace PrimeVue Sidebar component with Drawer
Replace PrimeVue Chips component with AutoComplete with multiple enabled
Replace PrimeVue TabMenu component with Tabs without panels
Replace PrimeVue Steps component with Stepper without panels
Replace PrimeVue InlineMessage component with Message
Extract complex conditionals to computed properties
Implement cleanup for async operations in Vue components
Use lifecycle hooks: onMounted, onUpdated in Vue 3 Composition API
Use Teleport/Suspense when needed for component rendering
Define proper props and emits definitions in Vue components
Files:
src/components/queue/QueueProgressOverlay.vue
src/components/**/*.{vue,css}
📄 CodeRabbit inference engine (src/components/CLAUDE.md)
src/components/**/*.{vue,css}: Use Tailwind CSS only for styling (no custom CSS)
Use the correct tokens from style.css in the design system package
Files:
src/components/queue/QueueProgressOverlay.vue
src/components/**/*.{vue,ts,js}
📄 CodeRabbit inference engine (src/components/CLAUDE.md)
src/components/**/*.{vue,ts,js}: Use existing VueUse composables (such as useElementHover) instead of manually managing event listeners
Use useIntersectionObserver for visibility detection instead of custom scroll handlers
Use vue-i18n for ALL UI strings
Files:
src/components/queue/QueueProgressOverlay.vue
**/*.vue
📄 CodeRabbit inference engine (AGENTS.md)
**/*.vue: Use Vue 3.5+ with TypeScript in.vuefiles, exclusively using Composition API with<script setup lang="ts">syntax
Use Tailwind 4 for styling in Vue components; avoid<style>blocks
Name Vue components using PascalCase (e.g.,MenuHamburger.vue)
Use Vue 3.5 TypeScript-style default prop declaration with reactive props destructuring; do not usewithDefaultsor runtime props declaration
Prefercomputed()overrefwithwatchwhen deriving values
PreferuseModelover separately defining prop and emit for two-way binding
Usevue-i18nin composition API for string literals; place new translation entries insrc/locales/en/main.json
Usecn()utility function from@/utils/tailwindUtilfor merging Tailwind class names; do not use:class="[]"syntax
Do not use thedark:Tailwind variant; use semantic values from thestyle.csstheme instead (e.g.,bg-node-component-surface)
Do not use!importantor the!important prefix for Tailwind classes; find and correct interfering!importantclasses instead
Avoid new usage of PrimeVue components; use VueUse, shadcn/vue, or Reka UI instead
Leverage VueUse functions for performance-enhancing styles in Vue components
Implement proper props and emits definitions in Vue components
Utilize Vue 3's Teleport component when needed
Use Suspense for async components
Follow Vue 3 style guide and naming conventions
Files:
src/components/queue/QueueProgressOverlay.vue
**/*.{ts,tsx,vue}
📄 CodeRabbit inference engine (AGENTS.md)
**/*.{ts,tsx,vue}: Use TypeScript exclusively; do not write new JavaScript code
Use sorted and grouped imports organized by plugin/source
Enforce ESLint rules including Vue + TypeScript rules, disallow floating promises, disallow unused imports, and restrict i18n raw text in templates
Do not useanytype oras anytype assertions; fix the underlying type issue instead
Write code that is expressive and self-documenting; avoid redundant comments and clean as you go
Keep functions short and functional; minimize nesting and follow the arrow anti-pattern
Avoid mutable state; prefer immutability and assignment at point of declaration
Use function declarations instead of function expressions when possible
Use es-toolkit for utility functions
Implement proper error handling in code
Files:
src/components/queue/QueueProgressOverlay.vue
**/*.{ts,tsx,vue,js,jsx,json,css}
📄 CodeRabbit inference engine (AGENTS.md)
Apply Prettier formatting with 2-space indentation, single quotes, no trailing semicolons, and 80-character line width
Files:
src/components/queue/QueueProgressOverlay.vue
🧠 Learnings (10)
📓 Common learnings
Learnt from: henrikvilhelmberglund
Repo: Comfy-Org/ComfyUI_frontend PR: 7617
File: src/components/actionbar/ComfyActionbar.vue:301-308
Timestamp: 2025-12-18T16:03:09.642Z
Learning: In the ComfyUI frontend queue system (src/stores/queueStore.ts), the `useQueuePendingTaskCountStore().count` includes the currently executing task. When count = 1, there is only the active/running task with no pending tasks. When count > 1, there is an active task plus pending tasks waiting in the queue. The "Clear Pending Tasks" button should only be enabled when count > 1 to avoid clearing the currently running task, which should be handled by the "Cancel current run" button instead.
📚 Learning: 2025-12-18T16:03:02.066Z
Learnt from: henrikvilhelmberglund
Repo: Comfy-Org/ComfyUI_frontend PR: 7617
File: src/components/actionbar/ComfyActionbar.vue:301-308
Timestamp: 2025-12-18T16:03:02.066Z
Learning: In the ComfyUI frontend queue system, useQueuePendingTaskCountStore().count indicates the number of tasks in the queue, where count = 1 means a single active/running task and count > 1 means there are pending tasks in addition to the active task. Therefore, in src/components/actionbar/ComfyActionbar.vue, enable the 'Clear Pending Tasks' button only when count > 1 to avoid clearing the currently running task. The active task should be canceled using the 'Cancel current run' button instead. This rule should be enforced via a conditional check on the queue count, with appropriate disabled/aria-disabled states for accessibility, and tests should verify behavior for count = 1 and count > 1.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-09T03:49:52.828Z
Learnt from: christian-byrne
Repo: Comfy-Org/ComfyUI_frontend PR: 6300
File: src/platform/updates/components/WhatsNewPopup.vue:5-13
Timestamp: 2025-12-09T03:49:52.828Z
Learning: In Vue files across the ComfyUI_frontend repo, when a button is needed, prefer the repo's common button components from src/components/button/ (IconButton.vue, TextButton.vue, IconTextButton.vue) over plain HTML <button> elements. These components wrap PrimeVue with the project’s design system styling. Use only the common button components for consistency and theming, and import them from src/components/button/ as needed.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-09T21:40:12.361Z
Learnt from: benceruleanlu
Repo: Comfy-Org/ComfyUI_frontend PR: 7297
File: src/components/actionbar/ComfyActionbar.vue:33-43
Timestamp: 2025-12-09T21:40:12.361Z
Learning: In Vue single-file components, allow inline Tailwind CSS class strings for static classes and avoid extracting them into computed properties solely for readability. Prefer keeping static class names inline for simplicity and performance. For dynamic or conditional classes, use Vue bindings (e.g., :class) to compose classes.
Applies to all Vue files in the repository (e.g., src/**/*.vue) where Tailwind utilities are used for static styling.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-16T22:26:49.463Z
Learnt from: DrJKL
Repo: Comfy-Org/ComfyUI_frontend PR: 7537
File: src/components/ui/button/Button.vue:17-17
Timestamp: 2025-12-16T22:26:49.463Z
Learning: In Vue 3.5+ with <script setup>, when using defineProps<Props>() with partial destructuring (e.g., const { as = 'button', class: customClass = '' } = defineProps<Props>() ), props that are not destructured (e.g., variant, size) stay accessible by name in the template scope. This pattern is valid: you can destructure only a subset of props for convenience while referencing the remaining props directly in template expressions. Apply this guideline to Vue components across the codebase (all .vue files).
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-22T21:36:08.369Z
Learnt from: DrJKL
Repo: Comfy-Org/ComfyUI_frontend PR: 7649
File: src/platform/cloud/subscription/components/PricingTable.vue:185-201
Timestamp: 2025-12-22T21:36:08.369Z
Learning: In Vue components, avoid creating single-use variants for common UI components (e.g., Button and other shared components). Aim for reusable variants that cover multiple use cases. It’s acceptable to temporarily mix variant props with inline Tailwind classes when a styling need is unique to one place, but plan and consolidate into shared, reusable variants as patterns emerge across the codebase.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-11T12:25:15.470Z
Learnt from: christian-byrne
Repo: Comfy-Org/ComfyUI_frontend PR: 7358
File: src/components/dialog/content/signin/SignUpForm.vue:45-54
Timestamp: 2025-12-11T12:25:15.470Z
Learning: This repository uses CI automation to format code (pnpm format). Do not include manual formatting suggestions in code reviews for Comfy-Org/ComfyUI_frontend. If formatting issues are detected, rely on the CI formatter or re-run pnpm format. Focus reviews on correctness, readability, performance, accessibility, and maintainability rather than style formatting.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-18T02:07:38.870Z
Learnt from: DrJKL
Repo: Comfy-Org/ComfyUI_frontend PR: 7598
File: src/components/sidebar/tabs/AssetsSidebarTab.vue:131-131
Timestamp: 2025-12-18T02:07:38.870Z
Learning: Tailwind CSS v4 safe utilities (e.g., items-center-safe, justify-*-safe, place-*-safe) are allowed in Vue components under src/ and in story files. Do not flag these specific safe variants as invalid when reviewing code in src/**/*.vue or related stories.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-18T21:15:46.862Z
Learnt from: DrJKL
Repo: Comfy-Org/ComfyUI_frontend PR: 7603
File: src/components/queue/QueueOverlayHeader.vue:49-59
Timestamp: 2025-12-18T21:15:46.862Z
Learning: In the ComfyUI_frontend repository, for Vue components, do not add aria-label to buttons that have visible text content (e.g., buttons containing <span> text). The visible text provides the accessible name. Use aria-label only for elements without visible labels (e.g., icon-only buttons). If a button has no visible label, provide a clear aria-label or associate with an aria-labelledby describing its action.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
📚 Learning: 2025-12-21T01:06:02.786Z
Learnt from: DrJKL
Repo: Comfy-Org/ComfyUI_frontend PR: 7649
File: src/components/graph/selectionToolbox/ColorPickerButton.vue:15-18
Timestamp: 2025-12-21T01:06:02.786Z
Learning: In Comfy-Org/ComfyUI_frontend, in Vue component files, when a filled icon is required (e.g., 'pi pi-circle-fill'), you may mix PrimeIcons with Lucide icons since Lucide lacks filled variants. This mixed usage is acceptable when one icon library does not provide an equivalent filled icon. Apply consistently across Vue components in the src directory where icons are used, and document the rationale when a mixed approach is chosen.
Applied to files:
src/components/queue/QueueProgressOverlay.vue
| const onCancelItem = wrapWithErrorHandlingAsync(async (item: JobListItem) => { | ||
| const promptId = item.taskRef?.promptId | ||
| if (!promptId) return | ||
| await api.interrupt(promptId) | ||
|
|
||
| if (item.state === 'running' || item.state === 'initialization') { | ||
| // Running/initializing jobs: interrupt execution | ||
| await api.interrupt(promptId) | ||
| await queueStore.update() | ||
| } else if (item.state === 'pending') { | ||
| // Pending jobs: remove from queue | ||
| await api.deleteItem('queue', promptId) | ||
| await queueStore.update() | ||
| } | ||
| }) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Find JobListItem type definition
fd -e ts -e tsx | xargs grep -l "JobListItem" | head -5Repository: Comfy-Org/ComfyUI_frontend
Length of output: 328
🏁 Script executed:
# Search for JobListItem type definition
rg -A 10 "type JobListItem\s*=|interface JobListItem" --type tsRepository: Comfy-Org/ComfyUI_frontend
Length of output: 911
🏁 Script executed:
# Examine the QueueProgressOverlay.vue file around the onCancelItem function
wc -l src/components/queue/QueueProgressOverlay.vueRepository: Comfy-Org/ComfyUI_frontend
Length of output: 119
🏁 Script executed:
# Find JobState type definition
rg -A 5 "type JobState|enum JobState" --type tsRepository: Comfy-Org/ComfyUI_frontend
Length of output: 284
🏁 Script executed:
# Read the actual implementation in QueueProgressOverlay.vue around lines 197-210
sed -n '190,215p' src/components/queue/QueueProgressOverlay.vueRepository: Comfy-Org/ComfyUI_frontend
Length of output: 852
🏁 Script executed:
# Check if there are other state values handled elsewhere in the codebase
rg "item\.state\s*===" src/components/queue/ --type vue -B 2 -A 2Repository: Comfy-Org/ComfyUI_frontend
Length of output: 97
🏁 Script executed:
# Check state handling in queue components
rg "item\.state" src/components/queue/ -A 2 -B 2Repository: Comfy-Org/ComfyUI_frontend
Length of output: 819
🏁 Script executed:
# Check the useJobMenu.ts file mentioned in the review comment to see if there's a similar pattern
rg -A 15 "onCancelItem|const onCancel" src/composables/queue/useJobMenu.tsRepository: Comfy-Org/ComfyUI_frontend
Length of output: 52
🏁 Script executed:
# Check imports in QueueProgressOverlay.vue to understand the context
head -50 src/components/queue/QueueProgressOverlay.vueRepository: Comfy-Org/ComfyUI_frontend
Length of output: 1996
🏁 Script executed:
# Check the context around onDeleteItem and how non-actionable states are handled elsewhere
sed -n '210,220p' src/components/queue/QueueProgressOverlay.vueRepository: Comfy-Org/ComfyUI_frontend
Length of output: 302
🏁 Script executed:
# Verify if there are any other references to state handling that might indicate a pattern
rg "state.*===.*pending|state.*===.*running|state.*===.*completed|state.*===.*failed" src/components/queue/Repository: Comfy-Org/ComfyUI_frontend
Length of output: 840
🏁 Script executed:
# Check if there's a useJobMenu.ts file that might show a similar pattern
find src -name "*useJobMenu*" -type fRepository: Comfy-Org/ComfyUI_frontend
Length of output: 105
🏁 Script executed:
# Look at the broader context to see how cancel operations are typically handled
rg "api\.interrupt|api\.deleteItem" src/ --type ts -B 2 -A 2 | head -40Repository: Comfy-Org/ComfyUI_frontend
Length of output: 2259
🏁 Script executed:
# Get the full context of useJobMenu.ts to see the exact pattern
rg -B 5 -A 10 "if.*item\.state.*===.*running" src/composables/queue/useJobMenu.tsRepository: Comfy-Org/ComfyUI_frontend
Length of output: 498
🏁 Script executed:
# Compare the exact structure: check if queueStore.update() placement differs between the two
echo "=== useJobMenu.ts ===" && rg -A 12 "const cancelJob = async" src/composables/queue/useJobMenu.ts && echo "" && echo "=== QueueProgressOverlay.vue ===" && sed -n '197,211p' src/components/queue/QueueProgressOverlay.vueRepository: Comfy-Org/ComfyUI_frontend
Length of output: 1022
🏁 Script executed:
# Check the git history or comments about why the structure differs
rg "queueStore.update|commit 2" src/components/queue/QueueProgressOverlay.vue -B 5 -A 5Repository: Comfy-Org/ComfyUI_frontend
Length of output: 550
🏁 Script executed:
# Look at when this change was made and any associated comments
git log --oneline src/components/queue/QueueProgressOverlay.vue | head -5Repository: Comfy-Org/ComfyUI_frontend
Length of output: 130
🏁 Script executed:
# Get the commit details to understand the rationale
git show 1d814cb5 --statRepository: Comfy-Org/ComfyUI_frontend
Length of output: 50383
🏁 Script executed:
# Check if there are any PR comments or messages about this structure
git show 1d814cb5 | head -50Repository: Comfy-Org/ComfyUI_frontend
Length of output: 2210
LGTM! Fix correctly implements state-based cancellation with conditional updates.
The updated logic properly handles different job states:
- Running/initializing jobs are interrupted via
api.interrupt() - Pending jobs are removed via
api.deleteItem() - Queue state is refreshed only after each action (not for non-actionable states like completed/failed)
This resolves the reported issue where pending jobs couldn't be canceled from the overlay. The state type safety is confirmed: all literals used (running, initialization, pending) match the JobState union type definition.
🤖 Prompt for AI Agents
In src/components/queue/QueueProgressOverlay.vue around lines 197 to 210, the
cancellation handler logic is correct and type-safe as-is: it checks for
promptId, interrupts running/initialization jobs via api.interrupt(promptId) and
deletes pending jobs via api.deleteItem('queue', promptId), calling
queueStore.update() after each action; no code changes required.
DrJKL
left a comment
DrJKL
left a comment
There was a problem hiding this comment.
Looks good, but I'll wait for @benceruleanlu to approve 👍🏻
Bundle Size ReportSummary
Category Glance Per-category breakdownApp Entry Points — 3.19 MB (baseline 3.19 MB) • 🟢 -22 BMain entry bundles and manifests
Status: 3 added / 3 removed Graph Workspace — 996 kB (baseline 996 kB) • 🟢 -810 BGraph editor runtime, canvas, workflow orchestration
Status: 1 added / 1 removed Views & Navigation — 6.54 kB (baseline 6.54 kB) • ⚪ 0 BTop-level views, pages, and routed surfaces
Status: 1 added / 1 removed Panels & Settings — 296 kB (baseline 296 kB) • ⚪ 0 BConfiguration panels, inspectors, and settings screens
Status: 6 added / 6 removed UI Components — 196 kB (baseline 196 kB) • ⚪ 0 BReusable component library chunks
Status: 8 added / 8 removed Data & Services — 12.5 kB (baseline 12.5 kB) • ⚪ 0 BStores, services, APIs, and repositories
Status: 2 added / 2 removed Utilities & Hooks — 1.41 kB (baseline 1.41 kB) • ⚪ 0 BHelpers, composables, and utility bundles
Status: 1 added / 1 removed Vendor & Third-Party — 9.1 MB (baseline 9.1 MB) • ⚪ 0 BExternal libraries and shared vendor chunks
Other — 3.46 MB (baseline 3.46 MB) • ⚪ 0 BBundles that do not match a named category
Status: 20 added / 20 removed |
|
Taking a look now |
benceruleanlu
left a comment
benceruleanlu
left a comment
There was a problem hiding this comment.
LGTM, a regression test for this would be helpful as well
christian-byrne
added
needs-backport
|
@godwiniheuwa Commit |
|
@godwiniheuwa Commit |
|
@godwiniheuwa Commit |
|
@godwiniheuwa Commit |
5 participants
Summary
Fixes the cancel button on queue job items to properly handle pending (queued) jobs.
Problem
The cancel button was calling
api.interrupt()for all jobs, but interrupt only affects running/initializing jobs. For pending jobs, it silently fails with log message:"Prompt ... is not currently running, skipping interrupt".The "Cancel job" option in the context menu worked correctly because it checks the job state first.
Reported in #7758.
Changes
Update
onCancelIteminQueueProgressOverlay.vueto mirror the behavior ofcancelJob()inuseJobMenu.ts:item.statebefore deciding which API to callapi.interrupt(promptId)forrunningorinitializationstatesapi.deleteItem('queue', promptId)forpendingstatequeueStore.update()Testing
Steps to Reproduce (before fix)
After this fix, clicking Cancel on a pending job will remove it from the queue.
Fixes #7758
┆Issue is synchronized with this Notion page by Unito