Add tags to rooms (#156)

docs/src/api/room.md

@@ -10,3 +10,4 @@ time       | [int, int] | _required_ | Opening and closing timestamps in seconds
 created_at |        int | _required_ | Room creation timestamp in seconds.
 backend    |     string | _required_ | Room backend, either `janus` or `none`.
 reserve    |        int | _optional_ | The number of slots for agents reserved on the backend.
+tags       |       json | {}         | Arbitrary tags object associated with the room.

docs/src/api/room/create.md

@@ -21,6 +21,7 @@ time     | [i64, i64) | _required_ | A [lt, rt) range of unix time (seconds) or
 audience | String     | _required_ | The room audience.
 backend  | String     | none       | The room backend. Available values: janus, none.
 reserve  | i32        | _optional_ | The number of slots for subscribers to reserve on the server.
+tags     | json       | {}         | Arbitrary tags object associated with the room.
 
 
 ## Unicast response

docs/src/api/room/update.md

@@ -21,6 +21,7 @@ time     | [i64, i64) | _optional_ | A [lt, rt) range of unix time (seconds) or
 audience | String     | _optional_ | The room audience.
 backend  | String     | _optional_ | The room backend. Available values: janus, none.
 reserve  | i32        | _optional_ | The number of slots for subscribers to reserve on the server.
+tags     | json       | {}         | Arbitrary tags object associated with the room.
 
 
 ## Unicast response

migrations/2020-09-24-104539_add_tags_to_room/down.sql

@@ -0,0 +1 @@
+ALTER TABLE room DROP COLUMN tags;

migrations/2020-09-24-104539_add_tags_to_room/up.sql

@@ -0,0 +1 @@
+ALTER TABLE room ADD COLUMN tags JSON NOT NULL DEFAULT '{}'::JSON;

src/app/endpoint/room.rs

@@ -1,8 +1,10 @@
+use std::ops::Bound;
+
 use async_std::stream;
 use async_trait::async_trait;
 use chrono::{DateTime, Utc};
 use serde_derive::{Deserialize, Serialize};
-use std::ops::Bound;
+use serde_json::Value as JsonValue;
 use svc_agent::mqtt::{
     IncomingRequestProperties, IntoPublishableMessage, OutgoingRequest, ResponseStatus,
     ShortTermTimingProperties,
@@ -43,6 +45,7 @@ pub(crate) struct CreateRequest {
     #[serde(default = "CreateRequest::default_backend")]
     backend: db::room::RoomBackend,
     reserve: Option<i32>,
+    tags: Option<JsonValue>,
 }
 
 impl CreateRequest {
@@ -79,6 +82,10 @@ impl RequestHandler for CreateHandler {
                 q = q.reserve(reserve);
             }
 
+            if let Some(ref tags) = payload.tags {
+                q = q.tags(tags);
+            }
+
             let conn = context.db().get()?;
             q.execute(&conn)?
         };
@@ -442,6 +449,7 @@ mod test {
         use std::ops::Bound;
 
         use chrono::{SubsecRound, Utc};
+        use serde_json::json;
 
         use crate::db::room::Object as Room;
         use crate::test_helpers::prelude::*;
@@ -466,6 +474,7 @@ mod test {
                     audience: USR_AUDIENCE.to_owned(),
                     backend: db::room::RoomBackend::Janus,
                     reserve: Some(123),
+                    tags: Some(json!({ "foo": "bar" })),
                 };
 
                 let messages = handle_request::<CreateHandler>(&context, &agent, payload)
@@ -479,6 +488,7 @@ mod test {
                 assert_eq!(room.time(), &time);
                 assert_eq!(room.backend(), db::room::RoomBackend::Janus);
                 assert_eq!(room.reserve(), Some(123));
+                assert_eq!(room.tags(), &json!({ "foo": "bar" }));
 
                 // Assert notification.
                 let (room, evp, topic) = find_event::<Room>(messages.as_slice());
@@ -488,6 +498,7 @@ mod test {
                 assert_eq!(room.time(), &time);
                 assert_eq!(room.backend(), db::room::RoomBackend::Janus);
                 assert_eq!(room.reserve(), Some(123));
+                assert_eq!(room.tags(), &json!({ "foo": "bar" }));
             });
         }
 
@@ -503,6 +514,7 @@ mod test {
                     audience: USR_AUDIENCE.to_owned(),
                     backend: db::room::RoomBackend::Janus,
                     reserve: None,
+                    tags: None,
                 };
 
                 let err = handle_request::<CreateHandler>(&context, &agent, payload)
@@ -604,6 +616,7 @@ mod test {
         use std::ops::Bound;
 
         use chrono::{Duration, SubsecRound, Utc};
+        use serde_json::json;
 
         use crate::db::room::Object as Room;
         use crate::test_helpers::prelude::*;
@@ -647,7 +660,10 @@ mod test {
                     Bound::Excluded(now + Duration::hours(3)),
                 );
 
-                let payload = UpdateRequest::new(room.id()).time(time).reserve(Some(123));
+                let payload = UpdateRequest::new(room.id())
+                    .time(time)
+                    .reserve(Some(123))
+                    .tags(json!({"foo": "bar"}));
 
                 let messages = handle_request::<UpdateHandler>(&context, &agent, payload)
                     .await
@@ -661,6 +677,7 @@ mod test {
                 assert_eq!(resp_room.time(), &time);
                 assert_eq!(resp_room.backend(), db::room::RoomBackend::Janus);
                 assert_eq!(resp_room.reserve(), Some(123));
+                assert_eq!(resp_room.tags(), &json!({"foo": "bar"}));
             });
         }
 

src/db/room.rs

@@ -6,6 +6,7 @@ use chrono::{DateTime, Utc};
 use diesel::pg::PgConnection;
 use diesel::result::Error;
 use serde_derive::{Deserialize, Serialize};
+use serde_json::Value as JsonValue;
 use uuid::Uuid;
 
 use crate::db::janus_backend::Object as JanusBackend;
@@ -46,6 +47,7 @@ type AllColumns = (
     room::created_at,
     room::backend,
     room::reserve,
+    room::tags,
 );
 
 const ALL_COLUMNS: AllColumns = (
@@ -55,6 +57,7 @@ const ALL_COLUMNS: AllColumns = (
     room::created_at,
     room::backend,
     room::reserve,
+    room::tags,
 );
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -89,6 +92,7 @@ pub(crate) struct Object {
     backend: RoomBackend,
     #[serde(skip_serializing_if = "Option::is_none")]
     reserve: Option<i32>,
+    tags: JsonValue,
 }
 
 impl Object {
@@ -113,6 +117,11 @@ impl Object {
     pub(crate) fn reserve(&self) -> Option<i32> {
         self.reserve
     }
+
+    #[cfg(test)]
+    pub(crate) fn tags(&self) -> &JsonValue {
+        &self.tags
+    }
 }
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -221,6 +230,7 @@ pub(crate) struct InsertQuery<'a> {
     audience: &'a str,
     backend: RoomBackend,
     reserve: Option<i32>,
+    tags: Option<&'a JsonValue>,
 }
 
 impl<'a> InsertQuery<'a> {
@@ -230,6 +240,7 @@ impl<'a> InsertQuery<'a> {
             audience,
             backend,
             reserve: None,
+            tags: None,
         }
     }
 
@@ -240,6 +251,13 @@ impl<'a> InsertQuery<'a> {
         }
     }
 
+    pub(crate) fn tags(self, value: &'a JsonValue) -> Self {
+        Self {
+            tags: Some(value),
+            ..self
+        }
+    }
+
     pub(crate) fn execute(&self, conn: &PgConnection) -> Result<Object, Error> {
         use crate::schema::room::dsl::room;
         use diesel::RunQueryDsl;
@@ -278,6 +296,7 @@ pub(crate) struct UpdateQuery {
     audience: Option<String>,
     backend: Option<RoomBackend>,
     reserve: Option<Option<i32>>,
+    tags: Option<JsonValue>,
 }
 
 impl UpdateQuery {
@@ -289,6 +308,7 @@ impl UpdateQuery {
             audience: None,
             backend: None,
             reserve: None,
+            tags: None,
         }
     }
 
@@ -312,6 +332,14 @@ impl UpdateQuery {
         }
     }
 
+    #[cfg(test)]
+    pub(crate) fn tags(self, value: JsonValue) -> Self {
+        Self {
+            tags: Some(value),
+            ..self
+        }
+    }
+
     pub(crate) fn execute(&self, conn: &PgConnection) -> Result<Object, Error> {
         use diesel::prelude::*;
 

src/schema.rs

@@ -76,6 +76,7 @@ table! {
         created_at -> Timestamptz,
         backend -> Room_backend,
         reserve -> Nullable<Int4>,
+        tags -> Json,
     }
 }