return both sse and ws urls for client to connect

Author: fa-sharp

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "tinistream"
-version = "0.1.4"
+version = "0.1.5"
 edition = "2021"
 publish = false
 

api/Cargo.toml

@@ -2,7 +2,7 @@ use rocket::{get, post, serde::json::Json, Route, State};
 use rocket_okapi::{okapi::openapi3::OpenApi, openapi, openapi_get_routes_spec};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
-use time::{ext::NumericalDuration, format_description::well_known, UtcDateTime};
+use time::{format_description::well_known, UtcDateTime};
 
 use crate::{
     auth::{create_client_token, ApiKeyAuth, Crypto},
@@ -107,11 +107,14 @@ async fn create_stream(
     }
     redis.start_stream(&input.key, config.ttl).await?;
 
-    let url = stream_sse_url(&input.key, &config.server_address);
-    let plaintext_token = create_client_token(&input.key, 10.minutes());
+    let plaintext_token = create_client_token(&input.key, config.ttl);
     let token = crypto.encrypt_base64(&plaintext_token)?;
 
-    Ok(Json(StreamAccessResponse { url, token }))
+    Ok(Json(StreamAccessResponse {
+        sse_url: stream_sse_url(&input.key, &config.server_address),
+        ws_url: stream_ws_url(&input.key, &config.server_address),
+        token,
+    }))
 }
 
 /// # Create stream token
@@ -124,11 +127,14 @@ async fn create_token(
     crypto: &State<Crypto>,
     config: &State<AppConfig>,
 ) -> Result<Json<StreamAccessResponse>, ApiError> {
-    let url = stream_sse_url(&input.key, &config.server_address);
-    let plaintext_token = create_client_token(&input.key, 10.minutes());
+    let plaintext_token = create_client_token(&input.key, config.ttl);
     let token = crypto.encrypt_base64(&plaintext_token)?;
 
-    Ok(Json(StreamAccessResponse { url, token }))
+    Ok(Json(StreamAccessResponse {
+        sse_url: stream_sse_url(&input.key, &config.server_address),
+        ws_url: stream_ws_url(&input.key, &config.server_address),
+        token,
+    }))
 }
 
 /// # Cancel stream
@@ -198,9 +204,12 @@ struct StreamRequest {
 
 #[derive(JsonSchema, Serialize, Deserialize)]
 struct StreamAccessResponse {
-    /// URL to connect to the stream
-    url: String,
-    /// Bearer token to access the stream
+    /// URL for the client to connect to the stream via SSE
+    sse_url: String,
+    /// URL for the client to connect to the stream via WebSocket
+    ws_url: String,
+    /// Client token to access the stream. Can be used as a Bearer token
+    /// in the Authorization header (recommended) or as the `token` query parameter.
     token: String,
 }
 

api/src/api/stream.rs

@@ -54,8 +54,9 @@ impl<'r> FromRequest<'r> for ClientTokenAuth {
 
 /// Create a plaintext client token that gives access to the given stream key
 /// and is valid for the given length of time
-pub fn create_client_token(key: &str, ttl: Duration) -> String {
-    let unix_expires = (UtcDateTime::now() + ttl).unix_timestamp();
+pub fn create_client_token(key: &str, ttl: u32) -> String {
+    let ttl_duration = Duration::seconds(ttl.into());
+    let unix_expires = (UtcDateTime::now() + ttl_duration).unix_timestamp();
     format!("{unix_expires}:{key}")
 }
 

api/src/auth/client_token.rs

@@ -20,6 +20,11 @@ pub fn stream_sse_url(key: &str, base_url: &str) -> String {
     format!("{base_url}/api/client/sse?key={}", urlencoding::encode(key))
 }
 
+/// Get the URL for streaming WebSocket events from the given Redis stream
+pub fn stream_ws_url(key: &str, base_url: &str) -> String {
+    format!("{base_url}/api/client/ws?key={}", urlencoding::encode(key))
+}
+
 /// Convert a Redis stream event into a Rocket SSE event. Expects the event data to contain
 /// an "event" and "data" field.
 pub fn stream_event_to_sse((id, fields): RedisEntry) -> rocket::response::stream::Event {

api/src/redis/util.rs

@@ -2,7 +2,7 @@
   "openapi": "3.0.0",
   "info": {
     "title": "tinistream",
-    "version": "0.1.4"
+    "version": "0.1.5"
   },
   "paths": {
     "/api/health": {
@@ -1050,16 +1050,21 @@
       "StreamAccessResponse": {
         "type": "object",
         "required": [
+          "sse_url",
           "token",
-          "url"
+          "ws_url"
         ],
         "properties": {
-          "url": {
-            "description": "URL to connect to the stream",
+          "sse_url": {
+            "description": "URL for the client to connect to the stream via SSE",
+            "type": "string"
+          },
+          "ws_url": {
+            "description": "URL for the client to connect to the stream via WebSocket",
             "type": "string"
           },
           "token": {
-            "description": "Bearer token to access the stream",
+            "description": "Client token to access the stream. Can be used as a Bearer token in the Authorization header (recommended) or as the `token` query parameter.",
             "type": "string"
           }
         }