feat(inApp-notification): Implement in-app notification feature for new

travel request

- [x] Install socket.io and sockect.io-client
- [x] Create in-app client
- [x] Create sockect io server
- [x] Modify new trip request method

[Finishes #167891584]

Author: Pomile

package.json

@@ -13,6 +13,7 @@
     "exclude": [
       "src/database/",
       "src/config/",
+      "src/helpers/template/",
       "src/models/",
       "src/helpers/PassportHelper.js",
       "src/index.js"
@@ -62,6 +63,8 @@
     "sequelize": "^5.15.0",
     "sequelize-cli": "^5.5.0",
     "sequelize-replace-enum-postgres": "1.5.0",
+    "socket.io": "^2.2.0",
+    "socket.io-client": "^2.2.0",
     "swagger-ui-express": "^4.0.7",
     "underscore": "^1.9.1",
     "uuid-validate": "0.0.3"

src/controllers/NotificationOpt.js

@@ -0,0 +1,53 @@
+import jwt from 'jsonwebtoken';
+import db from '../database/models';
+import Response from '../helpers/Response';
+import modifyUserNotificationOpt from '../helpers/modifyUserNotificationOpt';
+
+const { User } = db;
+class NotificationOpt {
+  static async modifyEmailNotificationOption(req, res) {
+    const { emailOpt } = req.body;
+    const { payload } = req.payload;
+    const { email } = payload;
+    const [rowRetured, updatedUser] = await modifyUserNotificationOpt({ emailOpt }, email);
+    const opt = emailOpt ? 'on' : 'off';
+    
+    const response = new Response(
+      true,
+      200,
+      `email notification turned ${opt}successfully`,
+      {
+        id: updatedUser.id,
+        email: updatedUser.email,
+        emailOpt: updatedUser.emailOpt,
+      });
+
+    return res.status(response.code).send(response);
+  }
+  static async modifyInAppNotificationOption(req, res) {
+    const { inAppOpt } = req.body;
+    const { payload } = req.payload;
+    const { email } = payload;
+    const [rowRetured, updatedUser] = await modifyUserNotificationOpt(
+      { inAppOpt },
+      email
+    );
+    const opt = inAppOpt ? "on" : "off";
+  
+    const response = new Response(
+      true,
+      200,
+      `In-app notification turned ${opt}successfully`,
+      {
+        id: updatedUser.id,
+        email: updatedUser.email,
+        inAppOpt: updatedUser.inAppOpt
+      }
+    );
+
+    return res.status(response.code).send(response);
+
+  }
+}
+
+export default NotificationOpt;

src/controllers/Trip.js

@@ -1,5 +1,9 @@
 import db from '../database/models';
 import Response from '../helpers/Response';
+import SearchDatabase from '../helpers/SearchDatabase';
+import EmailNotifications from '../helpers/EmailNotifications';
+import addNotification from '../helpers/addNotification';
+import inAppBot from '../helpers/inAppBot';
 
 const {
   Trip, Branch, User, Stop, Accomodation
@@ -76,13 +80,34 @@ class TripController {
           ]
         }
       );
-      const response = new Response(
-        true,
-        201,
-        'Travel request successfully created',
-        { trip }
-      );
-      return res.status(response.code).json(response);
+      if (trip.id) {
+        const admins = await SearchDatabase.findAdminUsersWithNotificationOpt(
+          ['travel admin', 'manager', 'super admin'], { emailOpt: true }
+        );
+        const emails = admins.map(admin => admin.email);
+        if (emails) {
+          const data = await SearchDatabase.findTrip(trip.id);
+          const tripData = {
+            type,
+            reason,
+            departureDate,
+            returnDate
+          };
+          const message = `${data.user.firstName} ${data.user.lastName} requested for a ${type} trip`;
+          data.trips = { ...data.trips, ...tripData };
+          EmailNotifications.sendNewTrip(emails, 'New Trip', data);
+          inAppBot.send({ tripId: trip.id, message });
+          await addNotification(trip.id, message);
+          const response = new Response(
+          true,
+          201,
+          'Travel request successfully created',
+          { trip }
+        );
+        return res.status(response.code).json(response);
+        }
+        
+      }
     } catch (error) {
       const response = new Response(
         false,

src/database/migrations/20190904042655-add-columns-user.js

@@ -0,0 +1,33 @@
+'use strict';
+
+module.exports = {
+  up: (queryInterface, Sequelize) => {
+    return Promise.all([
+      queryInterface.addColumn('Users', 'emailOpt', {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+        defaultValue: false
+      }),
+      queryInterface.addColumn('Users', 'inAppOpt', {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+        defaultValue: false
+      })
+    ]);
+  },
+
+  down: (queryInterface, Sequelize) => {
+    return Promise.all([
+      queryInterface.removeColumn('Users', 'emailOpt', {
+        type: Sequelize.BOOLEAN,
+        allowNull: true,
+        defaultValue: false
+      }),
+      queryInterface.removeColumn('Users', 'inAppOpt', {
+        type: Sequelize.BOOLEAN,
+        allowNull: true,
+        defaultValue: false
+      })
+    ]);
+  }
+};

src/database/migrations/20190905031234-create-notifications.js

@@ -0,0 +1,32 @@
+'use strict';
+module.exports = {
+  up: (queryInterface, Sequelize) => {
+    return queryInterface.createTable('Notifications', {
+      id: {
+        allowNull: false,
+        primaryKey: true,
+        type: Sequelize.DataTypes.UUID,
+        defaultValue: Sequelize.literal('uuid_generate_v4()'),
+      },
+      tripId: {
+        allowNull: false,
+        type: Sequelize.UUID,
+      },
+      message: {
+        allowNull: false,
+        type: Sequelize.STRING
+      },
+      createdAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      },
+      updatedAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      }
+    });
+  },
+  down: (queryInterface, Sequelize) => {
+    return queryInterface.dropTable('Notifications');
+  }
+};

src/database/migrations/20190905031542-create-reads.js

@@ -0,0 +1,48 @@
+'use strict';
+module.exports = {
+  up: (queryInterface, Sequelize) => {
+    return queryInterface.createTable('Reads', {
+      id: {
+        allowNull: false,
+        autoIncrement: true,
+        primaryKey: true,
+        type: Sequelize.INTEGER
+      },
+      notificationId: {
+        type: Sequelize.UUID,
+        allowNull: false,
+        onDelete: 'RESTRICT',
+        onUpdate: 'RESTRICT',
+        references: {
+          model: 'Notifications',
+          key: 'id',
+        }
+      },
+      userId: {
+        type: Sequelize.UUID,
+        allowNull: false,
+        onDelete: 'RESTRICT',
+        onUpdate: 'RESTRICT',
+        references: {
+          model: 'Users',
+          key: 'id',
+        }
+      },
+      read: {
+        type: Sequelize.BOOLEAN,
+        allowNull: false,
+      },
+      createdAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      },
+      updatedAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      }
+    });
+  },
+  down: (queryInterface, Sequelize) => {
+    return queryInterface.dropTable('Reads');
+  }
+};

src/database/models/branch.js

@@ -12,13 +12,13 @@ module.exports = (sequelize, DataTypes) => {
     });
     Branch.hasMany(models.Trip, {
       foreignKey: 'startBranchId',
-      as: 'trip',
+      as: 'trips',
       onDelete: 'CASCADE',
       onUpdate: 'CASCADE'
     });
     Branch.hasMany(models.Accomodation, {
       foreignKey: 'branchId',
-      as: 'accomodation',
+      as: 'accomodations',
       onDelete: 'CASCADE',
       onUpdate: 'CASCADE'
     });

src/database/models/notification.js

@@ -0,0 +1,11 @@
+'use strict';
+module.exports = (sequelize, DataTypes) => {
+  const Notification = sequelize.define('Notification', {
+    message: DataTypes.STRING,
+    tripId: DataTypes.UUID
+  }, {});
+  Notification.associate = function(models) {
+    // associations can be defined here
+  };
+  return Notification;
+};

src/database/models/read.js

@@ -0,0 +1,24 @@
+'use strict';
+module.exports = (sequelize, DataTypes) => {
+  const Read = sequelize.define('Read', {
+    notificationId: DataTypes.UUID,
+    userId: DataTypes.UUID,
+    read: DataTypes.BOOLEAN
+  }, {});
+  Read.associate = function(models) {
+    // associations can be defined here
+    Read.belongsTo(models.Notification, {
+      foreignKey: 'notificationId',
+      as: 'notifications',
+      onDelete: 'CASCADE',
+      onUpdate: 'CASCADE'
+    });
+    Read.belongsTo(models.Notification, {
+      foreignKey: 'userId',
+      as: 'users',
+      onDelete: 'CASCADE',
+      onUpdate: 'CASCADE'
+    });
+  };
+  return Read;
+};

src/database/models/user.js

@@ -11,7 +11,9 @@ module.exports = (sequelize, DataTypes) => {
       role: DataTypes.ENUM('super admin', 'travel admin', 'travel team member', 'manager', 'requester', 'staff'),
       status: DataTypes.ENUM('active', 'inactive', 'unverified'),
       companyId: DataTypes.UUID,
-      favorites: DataTypes.BOOLEAN
+      favorites: DataTypes.BOOLEAN,
+      emailOpt: DataTypes.BOOLEAN,
+      inAppOpt: DataTypes.BOOLEAN
     },
     {}
   );