mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
9bd78823a3
Our events handling and implementation has a couple pain points: - Adding or removing data from event payloads requires changes wherever the events are dispatched from. - We have no type safety for events and need to rely on string matching and dict access when interacting with events. - Frontend types for socket events must be manually typed. This has caused several bugs. `fastapi-events` has a neat feature where you can create a pydantic model as an event payload, give it an `__event_name__` attr, and then dispatch the model directly. This allows us to eliminate a layer of indirection and some unpleasant complexity: - Event handler callbacks get type hints for their event payloads, and can use `isinstance` on them if needed. - Event payload construction is now the responsibility of the event itself (a pydantic model), not the service. Every event model has a `build` class method, encapsulating this logic. The build methods are provided as few args as possible. For example, `InvocationStartedEvent.build()` gets the invocation instance and queue item, and can choose the data it wants to include in the event payload. - Frontend event types may be autogenerated from the OpenAPI schema. We use the payload registry feature of `fastapi-events` to collect all payload models into one place, making it trivial to keep our schema and frontend types in sync. This commit moves the backend over to this improved event handling setup.
47 lines
1.4 KiB
Python
47 lines
1.4 KiB
Python
# Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654)
|
|
|
|
import asyncio
|
|
import threading
|
|
from queue import Empty, Queue
|
|
|
|
from fastapi_events.dispatcher import dispatch
|
|
|
|
from invokeai.app.services.events.events_common import (
|
|
BaseEvent,
|
|
)
|
|
|
|
from .events_base import EventServiceBase
|
|
|
|
|
|
class FastAPIEventService(EventServiceBase):
|
|
def __init__(self, event_handler_id: int) -> None:
|
|
self.event_handler_id = event_handler_id
|
|
self._queue = Queue[BaseEvent | None]()
|
|
self._stop_event = threading.Event()
|
|
asyncio.create_task(self._dispatch_from_queue(stop_event=self._stop_event))
|
|
|
|
super().__init__()
|
|
|
|
def stop(self, *args, **kwargs):
|
|
self._stop_event.set()
|
|
self._queue.put(None)
|
|
|
|
def dispatch(self, event: BaseEvent) -> None:
|
|
self._queue.put(event)
|
|
|
|
async def _dispatch_from_queue(self, stop_event: threading.Event):
|
|
"""Get events on from the queue and dispatch them, from the correct thread"""
|
|
while not stop_event.is_set():
|
|
try:
|
|
event = self._queue.get(block=False)
|
|
if not event: # Probably stopping
|
|
continue
|
|
dispatch(event, middleware_id=self.event_handler_id, payload_schema_dump=False)
|
|
|
|
except Empty:
|
|
await asyncio.sleep(0.1)
|
|
pass
|
|
|
|
except asyncio.CancelledError as e:
|
|
raise e # Raise a proper error
|