feat: notification metadata

migrations/20240417170201_notification_metadata.sql

@@ -0,0 +1,2 @@
+ALTER TABLE notification ADD COLUMN data VARCHAR(255) NULL DEFAULT NULL;
+ALTER TABLE welcome_notification ADD COLUMN data VARCHAR(255) NULL DEFAULT NULL;

src/model/helpers.rs

@@ -874,6 +874,7 @@ pub struct Notification {
     pub body: String,
     pub icon: Option<String>,
     pub url: Option<String>,
+    pub data: Option<String>,
     pub is_read: bool,
 }
 
@@ -970,6 +971,7 @@ pub async fn get_notifications_for_subscriber(
             notification.title,
             notification.body,
             notification.url,
+            notification.data,
             notification.icon
         FROM notification
         JOIN subscriber_notification ON subscriber_notification.notification=notification.id
@@ -1046,6 +1048,8 @@ pub struct WelcomeNotification {
     pub body: String,
     #[validate(length(min = 1, max = 255))]
     pub url: Option<String>,
+    #[validate(length(min = 1, max = 255))]
+    pub data: Option<String>,
 }
 
 #[instrument(skip(postgres, metrics))]
@@ -1055,7 +1059,7 @@ pub async fn get_welcome_notification(
     metrics: Option<&Metrics>,
 ) -> Result<Option<WelcomeNotification>, sqlx::Error> {
     let query = "
-        SELECT enabled, type, title, body, url
+        SELECT enabled, type, title, body, url, data
         FROM welcome_notification
         WHERE project=$1
     ";
@@ -1078,14 +1082,15 @@ pub async fn set_welcome_notification(
     metrics: Option<&Metrics>,
 ) -> Result<(), sqlx::Error> {
     let query = "
-        INSERT INTO welcome_notification (project, enabled, type, title, body, url)
-        VALUES ($1, $2, $3, $4, $5, $6)
+        INSERT INTO welcome_notification (project, enabled, type, title, body, url, data)
+        VALUES ($1, $2, $3, $4, $5, $6, $7)
         ON CONFLICT (project) DO UPDATE SET
             enabled=EXCLUDED.enabled,
             type=EXCLUDED.type,
             title=EXCLUDED.title,
             body=EXCLUDED.body,
-            url=EXCLUDED.url
+            url=EXCLUDED.url,
+            data=EXCLUDED.data
     ";
     let start = Instant::now();
     sqlx::query(query)
@@ -1095,6 +1100,7 @@ pub async fn set_welcome_notification(
         .bind(welcome_notification.title)
         .bind(welcome_notification.body)
         .bind(welcome_notification.url)
+        .bind(welcome_notification.data)
         .execute(postgres)
         .await?;
     if let Some(metrics) = metrics {

src/notify_message.rs

@@ -63,5 +63,6 @@ pub struct JwtNotification {
     pub body: String,
     pub icon: String,
     pub url: String,
+    pub data: Option<String>,
     pub is_read: bool,
 }

src/services/public_http_server/handlers/relay_webhook/handlers/notify_subscribe.rs

@@ -218,6 +218,7 @@ pub async fn handle(msg: RelayIncomingMessage, state: &AppState) -> Result<(), R
                             title: welcome_notification.title,
                             body: welcome_notification.body,
                             url: welcome_notification.url,
+                            data: welcome_notification.data,
                             icon: None,
                         },
                         &state.postgres,

src/services/publisher_service/helpers.rs

@@ -31,13 +31,14 @@ pub async fn upsert_notification(
         pub body: String,
         pub icon: Option<String>,
         pub url: Option<String>,
+        pub data: Option<String>,
     }
     let query = "
-        INSERT INTO notification (project, notification_id, type, title, body, icon, url)
-        VALUES ($1, $2, $3, $4, $5, $6, $7)
+        INSERT INTO notification (project, notification_id, type, title, body, icon, url, data)
+        VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
         ON CONFLICT (project, notification_id) DO UPDATE SET
             notification_id=EXCLUDED.notification_id
-        RETURNING id, type, title, body, icon, url
+        RETURNING id, type, title, body, icon, url, data
     ";
     let start = Instant::now();
     let result = sqlx::query_as::<Postgres, Result>(query)
@@ -48,6 +49,7 @@ pub async fn upsert_notification(
         .bind(notification.body)
         .bind(notification.icon)
         .bind(notification.url)
+        .bind(notification.data)
         .fetch_one(postgres)
         .await?;
     if let Some(metrics) = metrics {
@@ -61,6 +63,7 @@ pub async fn upsert_notification(
             body: result.body,
             icon: result.icon,
             url: result.url,
+            data: result.data,
         },
     })
 }
@@ -98,6 +101,7 @@ pub struct NotificationToProcess {
     pub notification_body: String,
     pub notification_icon: Option<String>,
     pub notification_url: Option<String>,
+    pub notification_data: Option<String>,
     pub subscriber: Uuid,
     #[sqlx(try_from = "String")]
     pub subscriber_account: AccountId,
@@ -159,6 +163,7 @@ pub async fn pick_subscriber_notification_for_processing(
                 notification.body AS notification_body,
                 notification.icon AS notification_icon,
                 notification.url AS notification_url,
+                notification.data AS notification_data,
                 subscriber.id AS subscriber,
                 subscriber.account AS subscriber_account,
                 subscriber.sym_key AS subscriber_sym_key,

src/services/publisher_service/mod.rs

@@ -326,6 +326,7 @@ async fn process_notification(
                                 .to_string()
                         })
                         .unwrap_or_default(),
+                    data: notification.notification_data.clone(),
                     is_read: notification.subscriber_notification_is_read,
                 }),
                 notification.subscriber_account.clone(),

src/types/notification.rs

@@ -16,6 +16,8 @@ pub struct Notification {
     pub icon: Option<String>,
     #[validate(length(min = 1, max = 255))]
     pub url: Option<String>,
+    #[validate(length(min = 1, max = 255))]
+    pub data: Option<String>,
 }
 
 impl Notification {
@@ -37,6 +39,7 @@ mod test {
             body: "body".to_owned(),
             icon: None,
             url: None,
+            data: None,
         }
         .validate()
         .is_ok());
@@ -47,6 +50,7 @@ mod test {
             body: "body".to_owned(),
             icon: Some("icon".to_owned()),
             url: Some("url".to_owned()),
+            data: None,
         }
         .validate()
         .is_ok());
@@ -60,6 +64,7 @@ mod test {
             body: "body".to_owned(),
             icon: None,
             url: None,
+            data: None,
         }
         .validate()
         .is_err());
@@ -70,6 +75,7 @@ mod test {
             body: "".to_owned(),
             icon: Some("icon".to_owned()),
             url: Some("url".to_owned()),
+            data: None,
         }
         .validate()
         .is_err());
@@ -80,6 +86,7 @@ mod test {
             body: "body".to_owned(),
             icon: Some("".to_owned()),
             url: Some("url".to_owned()),
+            data: None,
         }
         .validate()
         .is_err());
@@ -90,6 +97,7 @@ mod test {
             body: "body".to_owned(),
             icon: Some("icon".to_owned()),
             url: Some("".to_owned()),
+            data: None,
         }
         .validate()
         .is_err());

tests/deployment.rs

@@ -218,6 +218,7 @@ async fn deployment_integration() {
         body: "body".to_owned(),
         icon: None,
         url: None,
+        data: None,
     };
 
     let notify_body = NotifyBody {
@@ -257,6 +258,7 @@ async fn deployment_integration() {
     assert_eq!(claims.msg.body, "body");
     assert_eq!(claims.msg.icon, "");
     assert_eq!(claims.msg.url, "");
+    assert_eq!(claims.msg.data, None);
 
     unregister_identity_key(
         identity_key_details.keys_server_url,