Individual Recipients

We can now send and receive notifications anytime a paekli is sent. However, our users probably only want to be notified if there is a paekli for a specific recipient, i.e. themselves.

Let's broadcast information about the recipient of the paekli in our send_paekli handler. We'll need to change the type of our channel from Sender<()> to Sender<String>. Then we just... sender.send(recipient) in the body. You should already have access to this recipient if you implemented the additional feature of individual recipients for the HTTP server component. We receive the notifications in the subscribe_to_notifications handler function, so we'll need to update the Sender type there as well to fix any compilation errors.

Now we could just pass along the name of the recipient from the internal channel to the websocket. That would be simple and serve the purpose. But it's a little nicer if the user can specify a recipient up front and only receive those notifications.

The recipient as path parameter

In terms of our API, we'll allow users to subscribe to notifications on different URL paths. For example, Alice can subscribe to her notifications at /notifications/alice and Bob can subscribe at /notifications/bob.

But we don't want to write a new handler function for ever possible recipient... that would be a lot. Axum allows us to turn some segments of the path into parameters to the handler function. To do that, we need to first declare the route with the new path:

#![allow(unused)]
fn main() {
.route("/notifications/:recipient", get(subscribe_to_notifications))
}

Notice the colon before recipient, it means this is a parameter instead of a literal part of the path. Next, we can accept the parameter in our handler:

#![allow(unused)]
fn main() {
async fn subscribe_to_notifications(
    Path(recipient): Path<String>,
    // ...
) -> Response {
}

Path is imported from axum::extract::Path. This type tells the axum library to extract the value of recipient from the URL of the request. That only works because we declared the parameter previously in the route declaration with "/notifications/:recipient".

#![allow(unused)]
fn main() {
async fn subscribe_to_notifications(
    Path((recipient, sender)): Path<(String, String)>,
    // ...
) -> Response {
}

Inside the body of subscribe_to_notifications, we can now send a notification on the websocket only if the recipient matches the one of our URL parameter. The code you'll need might look a little something like this:

#![allow(unused)]
fn main() {
let Ok(channel_recipient) = receiver.recv().await
if url_path_recipient == channel_recipient {
    socket.send(/**/)
}
}

Trying it out

With all these connections, it's becoming more tricky to test that everything works. Here are a couple commands to get you started. You might have to adjust some details, especially if you designed your HTTP API a little differently.

# Terminal 1: run HTTP & WebSocket server
cd paekli-rs/paekli-http
cargo run

# Terminal 2: listen to notifications for Alice
websocat ws://127.0.0.1:4200/notifications/alice

# Terminal 3: listen to notifications for Bob
websocat ws://127.0.0.1:4200/notifications/bob

# Terminal 4: send paekli

# send paekli to Alice
curl --header 'Content-Type: application/json' --data '{ "content": "shoes", "recipient": "alice" }' localhost:4200/paekli

# send paekli to Bob
curl --header 'Content-Type: application/json' --data '{ "content": "shoes", "recipient": "alice" }' localhost:4200/paekli

Instead of using curl to send paekli, you can obviously also use any of you client components if you have already integrated them with the HTTP client storage backend.

Obviously we don't want to handle websocket connections as manually as we did just now. The real fun starts when we integrate that with our GUI clients! I recommend you do that next, otherwise all that work was for nothing.