JSON-RPC: retrieve events via long polling #4341
Conversation
link2xt
force-pushed
the
link2xt/jsonrpc-event-long-polling
branch
2 times, most recently
from
d2703c8
to
67ee039
Compare
|
With this PR merged we are retrieving events one-by-one, but this can further be improved by introducing a batched |
link2xt
force-pushed
the
link2xt/jsonrpc-event-long-polling
branch
2 times, most recently
from
fcde9ed
to
9aeccb9
Compare
|
This is mostly ready except for the TypeScript part. @Simon-Laux Maybe you have some suggestions on how the TypeScript part of it should work, otherwise I will try to do the minimum to get the tests pass but it may be far from idiomatic Asynchronous JavaScript. |
| @@ -165,6 +166,16 @@ impl CommandApi { | |||
| get_info() | |||
| } | |||
|
|
|||
| /// Get the next event. | |||
| async fn get_next_event(&self) -> Result<Event> { | |||
| let event_emitter = self.accounts.read().await.get_event_emitter(); | |||
There was a problem hiding this comment.
"Event emitter" is just a channel receiver inside. This line basically clones a receiver so we don't hold any locks on the self.accounts while waiting for events, otherwise it would be impossible to get a write lock to e.g. add an account because event loop is running.
link2xt
force-pushed
the
link2xt/jsonrpc-event-long-polling
branch
2 times, most recently
from
1cf259f
to
457d149
Compare
|
Websocket example is still not fixed, but everything else is ready for review. |
| main_cancel.cancelled().await; | ||
| accounts.read().await.stop_io().await; | ||
| drop(accounts); | ||
| drop(state); | ||
| let (r0, r1, r2, r3) = tokio::join!(events_task, send_task, sigterm_task, recv_task); |
There was a problem hiding this comment.
I removed join!, it is not necessary since we already use spawn. Just waiting for each task in a sequence.
| async def wait_for_event(self, account_id: int) -> Optional[dict]: | ||
| """Waits for the next event from the given account and returns it.""" | ||
| if account_id in self.event_queues: | ||
| return await self.event_queues[account_id].get() | ||
| return None |
There was a problem hiding this comment.
This was a bug I think, now creating a queue for an account if it did not have any events before.
This way is more compatible to JSON-RPC libraries that do not support receiving notifications from the server and allows describing event types in the OpenRPC specification. Event thread converting events to notifications in the FFI is removed, so it is now possible to construct a dc_jsonrpc_instance_t while still retrieving events via dc_event_emitter_t.
link2xt
force-pushed
the
link2xt/jsonrpc-event-long-polling
branch
from
7a1ea11
to
2cd82d7
Compare
link2xt
force-pushed
the
link2xt/jsonrpc-event-long-polling
branch
from
07cde3c
to
4a0817d
Compare
it was added to JSON-RPC server in: deltachat/deltachat-core-rust#4341
This way is more compatible to JSON-RPC libraries
that do not support receiving notifications from the server and allows describing event types in the OpenRPC specification.
Event thread converting events to notifications in the FFI is removed, so it is now possible to construct a dc_jsonrpc_instance_t while still retrieving events via dc_event_emitter_t.