atomicdata-dev / atomic-server

An open source headless CMS / real-time database. Powerful table editor, full-text search, and SDKs for JS / React / Svelte.
https://atomicserver.eu
MIT License
954 stars 44 forks source link

Request for Comments: Machine to Machine API for atomic data #425

Open AlexMikhalev opened 2 years ago

AlexMikhalev commented 2 years ago

As a user, I would like to synchronize multiple atomic data servers - personal ones, one can be on the phone, another on raspberry pi and a third on a laptop.
I propose a single API endpoint: RPC sync (similar to couchd/couchbase), but data served in binary format, we can leverage serde to message pack serialisation or cap&proto + zstd compression to optimize the size of serialized binary going through the network.

For security we can work on: We can perform syncthing like adding devices to set mutual trust and certificates for device authorization and encryption.

Later this machine to machine sync can be the foundation of distributed/decentralized network.

joepio commented 2 years ago

Thoughts:

Use cases:

Implementation ideas:

Use the /commits collection

It already contains all Commits. Replaying these, page for page, should give you all you need to rebuild the store.

Create a /sync Endpoint

Not sure how this should work, but we could always add custom query params and behavior on a new endpoint.

We could even have a fully custom implementation in Actix that uses websockets and sends binary blobs over the line. Not sure what it should contain, though.

Maybe:

Adding a SUBSCRIBE_ALL action in WebSockets

We already have websocket support, including a bunch of commands. One of these is SUBSCRIBE ${subject} which is instructing the server to send alll Commits about a subject to a different machine.

We could add a SUBSCRIBE_ALL action, that sends all incoming commits.

If we combine this with quering the /commits collection, we could sync all things. But that process might be a bit error-prone.

Inspiration