mirror of
https://github.com/chatmail/core.git
synced 2026-04-26 01:46:34 +03:00
8b58b16cb5
I used some AI to draft a first version of this, and then reworked it. This is one of multiple possibilities to fix https://github.com/chatmail/core/issues/8041: For bots, the IncomingMsg event is not emitted when the pre-message arrives, only when the post-message arrives. Also, post-messages are downloaded immediately, not after all the small messages are downloaded. The `get_next_msgs()` API is deprecated. Instead, bots need to listen to the IncomingMsg event in order to be notified about new events. Is this acceptable for bots? THE PROBLEM THAT WAS SOLVED BY THIS: With pre-messages, it's hard for bots to wait for the message to be fully downloaded and then process it. Up until now, bots used get_next_msgs() to query the unprocessed messages, then set last_msg_id after processing a message to that they won't process it again. But this will now also return messages that were not fully downloaded. ALTERNATIVES: In the following, I will explain the alternatives, and for why it's not so easy to just make the `get_next_msgs()` API work. If it's not understandable, I'm happy to elaborate more. Core can't just completely ignore the pre-message for two reasons: - If a post-message containing a Webxdc arrives later, and some webxdc updates arrive in the meantime, then these updates will be lost. - The post-message doesn't contain the text (reasoning was to avoid duplicate text for people who didn't upgrade yet during the 2.43.0 rollout) There are multiple solutions: - Add the message as hidden in the database when the pre-message arrives. - When the post-message arrives and we want to make it available for bots, we need to update the msg_id because of how the `get_next_msgs()` API works. This means that we need to update all webxdc updates that reference this msg_id. - Alternatively, we could make webxdc's reference the rfc724_mid instead of the msg_id, so that we don't need stable msg_ids anymore - Alternatively, we could deprecate `get_next_msgs()`, and ask bots to use plain events for message processing again. It's not that bad; worst case, the bot crashes and then forgets to react to some messages, but the user will just try again. And if some message makes the bot crash, then it might actually be good not to try and process it again. - Store the pre-message text and `PostMsgMetadata` (or alternatively, the whole mime) in a new database table. Wait with processing it until the post-message arrives. Additionally, the logic that small messages are downloaded before post-messages should be disabled for bots, in order to prevent reordering.
Delta Chat RPC python client
RPC client connects to standalone Delta Chat RPC server deltachat-rpc-server
and provides asynchronous interface to it.
rpc.start() performs a health-check RPC call to verify the server
started successfully and will raise an error if startup fails
(e.g. if the accounts directory could not be used).
Getting started
To use Delta Chat RPC client, first build a deltachat-rpc-server with cargo build -p deltachat-rpc-server
or download a prebuilt release.
Install it anywhere in your PATH.
Create a virtual environment if you don't have one already and activate it.
$ python -m venv env
$ . env/bin/activate
Install deltachat-rpc-client from source:
$ cd deltachat-rpc-client
$ pip install .
Testing
- Build
deltachat-rpc-serverwithcargo build -p deltachat-rpc-server. - Install tox
pip install -U tox - Run
CHATMAIL_DOMAIN=nine.testrun.org PATH="../target/debug:$PATH" tox.
Additional arguments to tox are passed to pytest, e.g. tox -- -s does not capture test output.
Activating current checkout of deltachat-rpc-client and -server for development
Go to root repository directory and run:
$ scripts/make-rpc-testenv.sh
$ source venv/bin/activate
Using in REPL
Setup a development environment:
$ tox --devenv env
$ . env/bin/activate
$ python
>>> from deltachat_rpc_client import *
>>> rpc = Rpc()
>>> rpc.start()
>>> dc = DeltaChat(rpc)
>>> system_info = dc.get_system_info()
>>> system_info["level"]
'awesome'
>>> rpc.close()