Merge pull request #20 from zjuasmn/dev

add seen notification server support

Author: gondzo

docs/swagger_api.yaml

@@ -70,6 +70,9 @@ paths:
                     read:
                       type: boolean
                       description: read flag
+                    seen:
+                      type: boolean
+                      description: seen flag
                     contents:
                       type: object
                       description: the event message in JSON format
@@ -152,6 +155,42 @@ paths:
           description: "Internal server error."
           schema:
             $ref: "#/definitions/Error"
+  /notifications/{id}/seen:
+    put:
+      description:
+        mark notification(s) as seen, id can be single id or '-' separated ids
+      security:
+        - jwt: []
+      parameters:
+        - in: path
+          name: id
+          description: notification id
+          required: true
+          type: integer
+          format: int64
+      responses:
+        200:
+          description: OK, the notification(s) are marked as seen
+        400:
+          description: "Invalid input"
+          schema:
+            $ref: "#/definitions/Error"
+        401:
+          description: "authentication failed"
+          schema:
+            $ref: "#/definitions/Error"
+        403:
+          description: "Action not allowed."
+          schema:
+            $ref: "#/definitions/Error"
+        404:
+          description: "Notification is not found"
+          schema:
+            $ref: "#/definitions/Error"
+        500:
+          description: "Internal server error."
+          schema:
+            $ref: "#/definitions/Error"
   /notificationsettings:
     get:
       description:

migrations/v1.2.sql

@@ -0,0 +1,2 @@
+ALTER TABLE public."Notifications"
+    ADD COLUMN seen boolean;

src/app.js

@@ -56,6 +56,7 @@ function startKafkaConsumer(handlers) {
         version: notification.version || null,
         contents: _.extend({}, messageJSON, notification.contents),
         read: false,
+        seen: false,
       }))))
       // commit offset
       .then(() => consumer.commitOffset({ topic, partition, offset: m.offset }))

src/controllers/NotificationController.js

@@ -34,6 +34,16 @@ function* markAllRead(req, res) {
   res.end();
 }
 
+/**
+ * Mark a notification as seen.
+ * @param req the request
+ * @param res the response
+ */
+function* markAsSeen(req, res) {
+  yield NotificationService.markAsSeen(req.params.id, req.user.userId);
+  res.end();
+}
+
 /**
  * Get notification settings.
  * @param req the request
@@ -58,6 +68,7 @@ module.exports = {
   listNotifications,
   markAsRead,
   markAllRead,
+  markAsSeen,
   getSettings,
   updateSettings,
 };

src/models/Notification.js

@@ -16,6 +16,7 @@ module.exports = (sequelize, DataTypes) => sequelize.define('Notification', {
   type: { type: DataTypes.STRING, allowNull: false },
   contents: { type: DataTypes.JSONB, allowNull: false },
   read: { type: DataTypes.BOOLEAN, allowNull: false },
+  seen: { type: DataTypes.BOOLEAN, allowNull: true },
   version: { type: DataTypes.SMALLINT, allowNull: true },
 }, {});
 

src/routes.js

@@ -19,6 +19,12 @@ module.exports = {
       method: 'markAllRead',
     },
   },
+  '/notifications/:id/seen': {
+    put: {
+      controller: 'NotificationController',
+      method: 'markAsSeen',
+    },
+  },
   '/notificationsettings': {
     get: {
       controller: 'NotificationController',

src/services/NotificationService.js

@@ -174,6 +174,36 @@ markAllRead.schema = {
   userId: Joi.number().required(),
 };
 
+/**
+ * Mark notification(s) as seen.
+ * @param {Number} id the notification id or '-' separated ids
+ * @param {Number} userId the user id
+ */
+function* markAsSeen(id, userId) {
+  const ids = _.map(id.split('-'), (str) => {
+    const idInt = Number(str);
+    if (!_.isInteger(idInt)) {
+      throw new errors.BadRequestError(`Notification id should be integer: ${str}`);
+    }
+    return idInt;
+  });
+  const entities = yield models.Notification.findAll({ where: { id: { $in: ids }, seen: { $not: true } } });
+  if (!entities || entities.length === 0) {
+    throw new errors.NotFoundError(`Cannot find un-seen Notification where id = ${id}`);
+  }
+  _.each(entities, (entity) => {
+    if (Number(entity.userId) !== userId) {
+      throw new errors.ForbiddenError(`Cannot access Notification where id = ${entity.id}`);
+    }
+  });
+  yield models.Notification.update({ seen: true }, { where: { id: { $in: ids }, seen: { $not: true } } });
+}
+
+markAsSeen.schema = {
+  id: Joi.string().required(),
+  userId: Joi.number().required(),
+};
+
 updateSettings.schema = {
   data: Joi.array().min(1).items(Joi.object().keys({
     topic: Joi.string().required(),
@@ -188,6 +218,7 @@ module.exports = {
   listNotifications,
   markAsRead,
   markAllRead,
+  markAsSeen,
   getSettings,
   updateSettings,
 };