Add prompt ID to interrupt API call

[deepanjanroy]

The Comfy UI backend currently ignores the post body.

┆Issue is synchronized with this Notion page by Unito

[deepanjanroy]

prompt[1] is not the most readable, but this bit of code is only used by the legacy UI and it's somewhat complicated to have nicer types here, so I did a low-effort thing.

[christian-byrne]

Hi @deepanjanroy, will this change be later supported by a change to the /interrupt endpoint on the HTTP server? Or will the change be dependent on the backend type?

Currently, the /queue and /history endpoint allow cancelling or deleting items by id when passing delete key:

• cancel queue item by id: https://github.com/comfyanonymous/ComfyUI/blob/181a9bf26d4445e160645f6c81dc2ee29e7b6a08/server.py#L677-L681
• delete history item by id: https://github.com/comfyanonymous/ComfyUI/blob/181a9bf26d4445e160645f6c81dc2ee29e7b6a08/server.py#L707-L710

On the frontend, we create abstracted deleteItem method on our public api module:

ComfyUI_frontend/src/scripts/api.ts

Lines 755 to 762 in f5b03f3

	/**
	* Deletes an item from the specified list
	* @param {string} type The type of item to delete, queue or history
	* @param {number} id The id of the item to delete
	*/
	async deleteItem(type: string, id: string) {
	await this.#postItem(type, { delete: [id] })
	}

Is there a known limitation for these approaches? Or is this something specific for cloud?

[deepanjanroy]

Hi @christian-byrne! We needed it for cloud yes, don't think we need to support it right now on regular Comfy backend. The regular comfy backend only supports running one task at a time so it doesn't need to know the prompt id. (cc @robinjhuang if I got anything wrong)

Re: why not use cancel queue / delete history: I think none of those cancel a currently executing task. That's exclusively handled by interrupt.

[robinjhuang]

Yeah echoing what Deep said. Interrupt is meant to cancel currently running jobs, so the intention is different from cancel (cancel items in the queue). Is this a harmless change on FE (even if ComfyUI backend doesn't use it for now)? Or are there potential side effects? @christian-byrne

Edit: FYI this is not urgent at all so it can wait.

[robinjhuang]

Looks like there's a PR to implement this in core too. https://github.com/comfyanonymous/ComfyUI/pull/8308/files

[christian-byrne]

Okay makes sense, thanks for explanation.

I don't forsee side effects. This could be merged currently if necessary.

[deepanjanroy]

@christian-byrne / any other code owners: would you mind approving the PR and merging it if there are no other blockers?