✨ User Notifications (⚠️ devops) 🚨

api/specs/webserver/openapi-user.yaml

@@ -101,7 +101,154 @@ paths:
         "204":
           description: token has been successfully deleted
 
+  /me/notifications:
+    get:
+      tags:
+        - user
+      summary: List of Notifications for the specific user
+      operationId: get_user_notifications
+      responses:
+        "200":
+          description: List of Notifications
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NotificationsOutListEnveloped"
+        default:
+          $ref: "#/components/responses/DefaultErrorResponse"
+    post:
+      tags:
+        - user
+      summary: Submit a new Notification
+      operationId: post_user_notification
+      requestBody:
+        required: true
+        description: the group to create
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NotificationIn"
+      responses:
+        "204":
+          description: Notification registered
+        default:
+          $ref: "#/components/responses/DefaultErrorResponse"
+
+  /me/notifications/{nid}:
+    parameters:
+      - name: nid
+        in: path
+        required: true
+        schema:
+          type: integer
+    patch:
+      tags:
+        - user
+      summary: Update a Notification
+      operationId: update_user_notification
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NotificationUpdate'
+      responses:
+        "200":
+          description: Returns modified service
+        default:
+          $ref: "./openapi.yaml#/components/responses/DefaultErrorResponse"
+
 components:
+  schemas:
+    NotificationIn:
+      type: object
+      required:
+        - user_id
+        - category
+        - actionable_path
+        - title
+        - text
+        - date
+      properties:
+        user_id:
+          type: string
+          description: >-
+            the user that will receive the notification
+          example: "123"
+        category:
+          type: string
+          enum:
+            - new_organization
+            - study_shared
+            - template_shared
+          description: >-
+            notification type, the frontend will use this to decorate the notification
+          example: new_organization
+        actionable_path:
+          type: string
+          description: >-
+            the frontend will use this information to trigger an action when the user click on it
+          example:
+            organization/123
+        title:
+          type: string
+          description: >-
+            the notification title to show in the frontend
+          example:
+            New Organization
+        text:
+          type: string
+          description: >-
+            the notification text to show in the frontend
+          example:
+            You are now part of Dummy Organization!
+        date:
+          type: string
+          format: date-time
+          description: >-
+            when it was created
+
+    NotificationOut:
+      # extend NotificationIn
+      allOf:
+        - $ref: "#/components/schemas/NotificationIn"
+        - type: "object"
+        - required:
+          - id
+          - read
+          properties:
+            id:
+              type: string
+              description: >-
+                notification id
+              example: "123456789"
+            read:
+              type: boolean
+              description: >-
+                wether the notification has been read
+
+    NotificationsOutListEnveloped:
+      type: object
+      required:
+        - data
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/NotificationOut"
+        error:
+          nullable: true
+          default: null
+
+    NotificationUpdate:
+      type: object
+      required:
+        - read
+      properties:
+        read:
+          type: boolean
+          description: >-
+            notification has been read
+
   responses:
     DefaultErrorResponse:
       $ref: "./openapi.yaml#/components/responses/DefaultErrorResponse"

api/specs/webserver/openapi.yaml

@@ -128,6 +128,12 @@ paths:
   /me/tokens/{service}:
     $ref: "./openapi-user.yaml#/paths/~1me~1tokens~1{service}"
 
+  /me/notifications:
+    $ref: "./openapi-user.yaml#/paths/~1me~1notifications"
+
+  /me/notifications/{nid}:
+    $ref: "./openapi-user.yaml#/paths/~1me~1notifications~1{nid}"
+
   # GROUP SETTINGS ------------------------------------------------------------------
 
   /groups:

packages/settings-library/src/settings_library/redis.py

@@ -32,6 +32,9 @@ class RedisSettings(BaseCustomSettings):
     REDIS_SCHEDULED_MAINTENANCE_DB: int = Field(
         default=3, description="This redis table is used for handling scheduled maintenance"
     )
+    REDIS_USER_NOTIFICATIONS_DB: int = Field(
+        default=4, description="This redis table is used for handling the notifications that have to be sent to the user"
+    )
 
     def _build_redis_dsn(self, db_index: int):
         return RedisDsn.build(
@@ -60,3 +63,7 @@ def dsn_validation_codes(self) -> str:
     @cached_property
     def dsn_scheduled_maintenance(self) -> str:
         return self._build_redis_dsn(self.REDIS_SCHEDULED_MAINTENANCE_DB)
+
+    @cached_property
+    def dsn_user_notifications(self) -> str:
+        return self._build_redis_dsn(self.REDIS_USER_NOTIFICATIONS_DB)

services/docker-compose-ops.yml

@@ -86,7 +86,7 @@ services:
     image: rediscommander/redis-commander:latest
     init: true
     environment:
-      - REDIS_HOSTS=resources:${REDIS_HOST}:${REDIS_PORT}:0,locks:${REDIS_HOST}:${REDIS_PORT}:1,validation_codes:${REDIS_HOST}:${REDIS_PORT}:2,scheduled_maintenance:${REDIS_HOST}:${REDIS_PORT}:3
+      - REDIS_HOSTS=resources:${REDIS_HOST}:${REDIS_PORT}:0,locks:${REDIS_HOST}:${REDIS_PORT}:1,validation_codes:${REDIS_HOST}:${REDIS_PORT}:2,scheduled_maintenance:${REDIS_HOST}:${REDIS_PORT}:3,user_notifications:${REDIS_HOST}:${REDIS_PORT}:4
       # If you add/remove a db, do not forget to update the --databases entry in the docker-compose.yml
     ports:
       - "18081:8081"

services/docker-compose.yml

@@ -500,7 +500,7 @@ services:
         "--loglevel",
         "verbose",
         "--databases",
-        "4",
+        "5",
         "--appendonly",
         "yes"
       ]

services/static-webserver/client/source/class/osparc/Application.js

@@ -247,11 +247,11 @@ qx.Class.define("osparc.Application", {
       if (!osparc.CookiePolicy.areCookiesAccepted()) {
         const cookiePolicy = new osparc.CookiePolicy();
         let title = this.tr("Privacy Policy");
-        let height = 155;
+        let height = 160;
         if (osparc.product.Utils.showLicenseExtra()) {
           // "tis" and "s4llite" include the license terms
           title = this.tr("Privacy Policy and License Terms");
-          height = 200;
+          height = 210;
         }
         const win = osparc.ui.window.Window.popUpInWindow(cookiePolicy, title, 400, height).set({
           clickAwayClose: false,

services/static-webserver/client/source/class/osparc/MaintenanceTracker.js

@@ -47,7 +47,6 @@ qx.Class.define("osparc.MaintenanceTracker", {
 
   members: {
     __checkInternval: null,
-    __lastNotification: null,
     __lastRibbonMessage: null,
     __logoutTimer: null,
 
@@ -119,32 +118,14 @@ qx.Class.define("osparc.MaintenanceTracker", {
 
     __scheduleStart: function() {
       if (this.getStart() === null) {
-        this.__removeNotification();
         this.__removeRibbonMessage();
         this.__removeScheduledLogout();
       } else {
-        this.__addNotification();
         this.__scheduleRibbonMessage();
         this.__scheduleLogout();
       }
     },
 
-    __addNotification: function() {
-      this.__removeNotification();
-
-      const text = this.__getText();
-      const notification = new osparc.component.notification.Notification(text);
-      const notificationUI = this.__lastNotification = new osparc.component.notification.NotificationUI(notification.getFullText(true));
-      osparc.component.notification.Notifications.getInstance().addNotification(notificationUI);
-    },
-
-    __removeNotification: function() {
-      if (this.__lastNotification) {
-        osparc.component.notification.Notifications.getInstance().removeNotification(this.__lastNotification);
-        this.__lastNotification = null;
-      }
-    },
-
     __scheduleRibbonMessage: function() {
       this.__removeRibbonMessage();
 
@@ -155,8 +136,8 @@ qx.Class.define("osparc.MaintenanceTracker", {
       const messageToRibbon = closable => {
         this.__removeRibbonMessage();
         const text = this.__getText();
-        const notification = new osparc.component.notification.Notification(text, "maintenance", closable);
-        osparc.component.notification.NotificationsRibbon.getInstance().addNotification(notification);
+        const notification = new osparc.component.notification.RibbonNotification(text, "maintenance", closable);
+        osparc.component.notification.RibbonNotifications.getInstance().addNotification(notification);
         this.__lastRibbonMessage = notification;
       };
       if (diffClosable < 0) {
@@ -173,7 +154,7 @@ qx.Class.define("osparc.MaintenanceTracker", {
 
     __removeRibbonMessage: function() {
       if (this.__lastRibbonMessage) {
-        osparc.component.notification.NotificationsRibbon.getInstance().removeNotification(this.__lastRibbonMessage);
+        osparc.component.notification.RibbonNotifications.getInstance().removeNotification(this.__lastRibbonMessage);
         this.__lastRibbonMessage = null;
       }
     },

services/static-webserver/client/source/class/osparc/WindowSizeTracker.js

@@ -90,12 +90,12 @@ qx.Class.define("osparc.WindowSizeTracker", {
 
       let notification = null;
       if (tooSmall === "shortText") {
-        notification = new osparc.component.notification.Notification(null, "smallWindow", true);
+        notification = new osparc.component.notification.RibbonNotification(null, "smallWindow", true);
       } else if (tooSmall === "longText") {
         const text = this.__getLongText(true);
-        notification = new osparc.component.notification.Notification(text, "smallWindow", true);
+        notification = new osparc.component.notification.RibbonNotification(text, "smallWindow", true);
       }
-      osparc.component.notification.NotificationsRibbon.getInstance().addNotification(notification);
+      osparc.component.notification.RibbonNotifications.getInstance().addNotification(notification);
       this.__lastRibbonMessage = notification;
     },
 
@@ -108,7 +108,7 @@ qx.Class.define("osparc.WindowSizeTracker", {
 
     __removeRibbonMessage: function() {
       if (this.__lastRibbonMessage) {
-        osparc.component.notification.NotificationsRibbon.getInstance().removeNotification(this.__lastRibbonMessage);
+        osparc.component.notification.RibbonNotifications.getInstance().removeNotification(this.__lastRibbonMessage);
         this.__lastRibbonMessage = null;
       }
     }