mirror of
https://github.com/ankitects/anki.git
synced 2025-09-18 14:02:21 -04:00

This PR replaces the existing Python-driven sync server with a new one in Rust. The new server supports both collection and media syncing, and is compatible with both the new protocol mentioned below, and older clients. A setting has been added to the preferences screen to point Anki to a local server, and a similar setting is likely to come to AnkiMobile soon. Documentation is available here: <https://docs.ankiweb.net/sync-server.html> In addition to the new server and refactoring, this PR also makes changes to the sync protocol. The existing sync protocol places payloads and metadata inside a multipart POST body, which causes a few headaches: - Legacy clients build the request in a non-deterministic order, meaning the entire request needs to be scanned to extract the metadata. - Reqwest's multipart API directly writes the multipart body, without exposing the resulting stream to us, making it harder to track the progress of the transfer. We've been relying on a patched version of reqwest for timeouts, which is a pain to keep up to date. To address these issues, the metadata is now sent in a HTTP header, with the data payload sent directly in the body. Instead of the slower gzip, we now use zstd. The old timeout handling code has been replaced with a new implementation that wraps the request and response body streams to track progress, allowing us to drop the git dependencies for reqwest, hyper-timeout and tokio-io-timeout. The main other change to the protocol is that one-way syncs no longer need to downgrade the collection to schema 11 prior to sending.
9 lines
326 B
Python
9 lines
326 B
Python
def buildhash() -> str: ...
|
|
def open_backend(data: bytes) -> Backend: ...
|
|
def initialize_logging(log_file: str | None) -> Backend: ...
|
|
def syncserver() -> None: ...
|
|
|
|
class Backend:
|
|
@classmethod
|
|
def command(self, service: int, method: int, data: bytes) -> bytes: ...
|
|
def db_command(self, data: bytes) -> bytes: ...
|