Broker - Real-time Zero-Code API Server

crates.io broker

Purpose

The purpose of this library is to be your real-time zero-code API server.

Broker is a SSE message broker that requires you write no backend code to have a full real-time API.

Broker is born from the need that rather than building a complex REST API with web-sockets and a SQL database to provide reactive web forms (like for React) there must be a simpler way.

Broker follows an insert-only/publish/subscribe paradigm rather than a REST CRUD paradigm.

Features

How it works

In Broker you create a user, login, then insert an event with its data, a collectionid, and a timestamp. Broker publishes the event when the timestamp is reached to the event stream via SSE. Broker keeps all events its database that can be viewed in collections (by collectionid). Broker can also cancel future events.

When the client first subscribes to the SSE connection all the latest events and data is sent to the client. Combined with sending the latest event via SSE when subscribed negates the necessity to do any GET API requests in the lifecycle of an event.

The side-effect of this system is that the latest event is the schema. Old events are saved in the database and are not changed but the latest event is the schema for the front-end. This is pure NoSQL as the backend is agnostic to the event data.

Recommeded Services/Libraries to use with Broker

API

Step 1 - create a user

html POST /users - public endpoint - POST JSON to create a user json {"username":{...}, "password":{...}, "collection_id":{...}} - where {...} is for username and string, password a string, and collection_id is the uuid of the event collection for user info

will return json {"id":{...}} - where {...} is the uuid (string) of the user

Step 2 - login with the user

html POST /login - public endpoint - POST JSON to login json {"username":{...}, "password":{...}} - where {...} is for username a string and password a string

will return json {"jwt":{...}} - where {...} is a JWT (string)

Step 3 - connect to SSE

html GET /events - authenticated endpoint (Authorization: Bearer {jwt}) - connect your sse-client to this endpoint using broker-client - note: broker-client uses fetch as eventsource doesn't support headers

Step 4 - insert an event

html POST /insert - authenticated endpoint (Authorization: Bearer {jwt}) - POST JSON to insert an event json {"event":{...}, "collection_id":{...}, "timestamp":{...}, "data":{...}} - where {...} is for the event a string, collection_id is an assigned uuid v4 for the event collection, timestamp is the epoch unix timestamp when you want the event to become the current event, and data is any JSON you want

will return json {"event":{...}} - where {...} is the event

Optional Endpoints

html GET /collections/{collection_id} - authenticated endpoint (Authorization: Bearer {jwt}) - do a GET request where {collection_id} is the uuid of the collection you want (sorted by ascending timestamp)

will return json {"events":{...}} - where {...} is the array of events

html GET /user_events - authenticated endpoint (Authorization: Bearer {jwt}) - do a GET request to get the user event collections (sorted by ascending timestamp)

will return json {"info": {...}, "events":{...}} - where (...) is for info a list of events for user info and events a list of all events that the user inserted

html GET /cancel/{id} - authenticated endpoint (Authorization: Bearer {jwt}) - do a GET request where id is the uuid of the event to cancel a future event

will return json {"event":{...}} - where {...} is the event

Use

```rust use broker::broker;

[tokio::main]

pub async fn main() { broker().await } ``` - the origin needs to be passed in as a flag - wildcard is not supported - the port needs to be passed in as a flag - the expiry (for jwts) needs to be passed in as a flag - the secret (for jwts) needs to be passed in as a flag - the savepath where the embedded database will save needs to be passed in as an environment variable - example: SAVEPATH=./tmp/broker_data broker -port 8080 -origin http://localhost:3000 -expiry 3600 -secret secret

Install Crate

cargo install broker - the origin needs to be passed in as a flag - wildcard is not supported - the port needs to be passed in as a flag - the expiry (for jwts) needs to be passed in as a flag - the secret (for jwts) needs to be passed in as a flag - the savepath where the embedded database will save needs to be passed in as an environment variable - example: SAVEPATH=./tmp/broker_data broker -port 8080 -origin http://localhost:3000 -expiry 3600 -secret secret

Install Linux Snap

sudo snap install broker - note: does not run as a daemon as requires flags - the origin needs to be passed in as a flag - wildcard is not supported - the snap saves the database in $SNAPDATA/brokerdata - which is /var/snap/broker/{rev#}/broker_data - where rev# is the revision number - the port needs to be passed in as a flag - the expiry (for jwts) needs to be passed in as a flag - the secret (for jwts) needs to be passed in as a flag - example: sudo broker -port 8080 -origin http://localhost:3000 -expiry 3600 -secret secret

Run Example

Run Integration Tests

Under the Hood

Inspiration

Migrations