mirror of
https://github.com/ankitects/anki.git
synced 2026-01-13 22:13:58 -05:00
3707e54ffa
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.
34 lines
1.1 KiB
Rust
34 lines
1.1 KiB
Rust
// Copyright: Ankitects Pty Ltd and contributors
|
|
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
use serde_derive::{Deserialize, Serialize};
|
|
|
|
use crate::prelude::*;
|
|
|
|
// The old Rust code sent the host key in a query string
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
pub struct SyncBeginQuery {
|
|
#[serde(rename = "k")]
|
|
pub host_key: String,
|
|
#[serde(rename = "v")]
|
|
pub client_version: String,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
pub struct SyncBeginRequest {
|
|
/// Older clients provide this in the multipart wrapper; our router will
|
|
/// inject the value in if necessary. The route handler should check that
|
|
/// a value has actually been provided.
|
|
#[serde(rename = "v", default)]
|
|
pub client_version: String,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
pub struct SyncBeginResponse {
|
|
pub usn: Usn,
|
|
/// The server used to send back a session key used for following requests,
|
|
/// but this is no longer required. To avoid breaking older clients, the host
|
|
/// key is returned in its place.
|
|
#[serde(rename = "sk")]
|
|
pub host_key: String,
|
|
}
|