feat(app): add cancel all except current queue item functionality

Author: rikublock

invokeai/app/api/routers/session_queue.py

@@ -10,6 +10,7 @@
     QUEUE_ITEM_STATUS,
     Batch,
     BatchStatus,
+    CancelAllExceptCurrentResult,
     CancelByBatchIDsResult,
     CancelByDestinationResult,
     ClearResult,
@@ -94,6 +95,18 @@ async def Pause(
     return ApiDependencies.invoker.services.session_processor.pause()
 
 
+@session_queue_router.put(
+    "/{queue_id}/cancel_all_except_current",
+    operation_id="cancel_all_except_current",
+    responses={200: {"model": CancelAllExceptCurrentResult}},
+)
+async def cancel_all_except_current(
+    queue_id: str = Path(description="The queue id to perform this operation on"),
+) -> CancelAllExceptCurrentResult:
+    """Immediately cancels all queue items except in-processing items"""
+    return ApiDependencies.invoker.services.session_queue.cancel_all_except_current(queue_id=queue_id)
+
+
 @session_queue_router.put(
     "/{queue_id}/cancel_by_batch_ids",
     operation_id="cancel_by_batch_ids",

invokeai/app/services/session_queue/session_queue_base.py

@@ -5,6 +5,7 @@
     QUEUE_ITEM_STATUS,
     Batch,
     BatchStatus,
+    CancelAllExceptCurrentResult,
     CancelByBatchIDsResult,
     CancelByDestinationResult,
     CancelByQueueIDResult,
@@ -112,6 +113,11 @@ def cancel_by_queue_id(self, queue_id: str) -> CancelByQueueIDResult:
         """Cancels all queue items with matching queue ID"""
         pass
 
+    @abstractmethod
+    def cancel_all_except_current(self, queue_id: str) -> CancelAllExceptCurrentResult:
+        """Cancels all queue items except in-progress items"""
+        pass
+
     @abstractmethod
     def list_queue_items(
         self,

invokeai/app/services/session_queue/session_queue_common.py

@@ -374,6 +374,12 @@ class CancelByQueueIDResult(CancelByBatchIDsResult):
     pass
 
 
+class CancelAllExceptCurrentResult(CancelByBatchIDsResult):
+    """Result of canceling all except current"""
+
+    pass
+
+
 class IsEmptyResult(BaseModel):
     """Result of checking if the session queue is empty"""
 

invokeai/app/services/session_queue/session_queue_sqlite.py

@@ -9,6 +9,7 @@
     QUEUE_ITEM_STATUS,
     Batch,
     BatchStatus,
+    CancelAllExceptCurrentResult,
     CancelByBatchIDsResult,
     CancelByDestinationResult,
     CancelByQueueIDResult,
@@ -510,6 +511,39 @@ def cancel_by_queue_id(self, queue_id: str) -> CancelByQueueIDResult:
             self.__lock.release()
         return CancelByQueueIDResult(canceled=count)
 
+    def cancel_all_except_current(self, queue_id: str) -> CancelAllExceptCurrentResult:
+        try:
+            where = """--sql
+                WHERE
+                  queue_id == ?
+                  AND status == 'pending'
+                """
+            self.__lock.acquire()
+            self.__cursor.execute(
+                f"""--sql
+                SELECT COUNT(*)
+                FROM session_queue
+                {where};
+                """,
+                (queue_id,),
+            )
+            count = self.__cursor.fetchone()[0]
+            self.__cursor.execute(
+                f"""--sql
+                UPDATE session_queue
+                SET status = 'canceled'
+                {where};
+                """,
+                (queue_id,),
+            )
+            self.__conn.commit()
+        except Exception:
+            self.__conn.rollback()
+            raise
+        finally:
+            self.__lock.release()
+        return CancelAllExceptCurrentResult(canceled=count)
+
     def get_queue_item(self, item_id: int) -> SessionQueueItem:
         try:
             self.__lock.acquire()