Popup log fixed

backend/index.js

@@ -14,7 +14,7 @@ const authRoutes = require('./src/routes/auth.routes');
 const userRoutes = require('./src/routes/user.routes');
 const mocks = require('./src/routes/mocks.routes');
 const popup = require('./src/routes/popup.routes');
-const popup_log = require('./src/routes/popuplog.routes');
+const guide_log = require('./src/routes/guidelog.routes');
 const banner = require('./src/routes/banner.routes');
 const teamRoutes = require('./src/routes/team.routes');
 const hint = require('./src/routes/hint.routes');
@@ -47,7 +47,7 @@ app.use('/api/auth', authRoutes);
 app.use('/api/users', userRoutes);
 app.use('/api/mock/', mocks);
 app.use('/api/popup', popup);
-app.use('/api/popup_log', popup_log);
+app.use('/api/guide_log', guide_log);
 app.use('/api/banner', banner);
 app.use('/api/team', teamRoutes);
 // app.use('/api/tours', tourRoutes);

backend/migrations/20240916052017-create_teams_table.js

@@ -21,7 +21,8 @@ module.exports = {
     });
 
     await queryInterface.bulkInsert("teams", [{
-      name: config.defaultTeamName
+      name: config.defaultTeamName,
+      createdAt: new Date()
     }]);
   },
 

backend/migrations/20241203005208-change-popup-log-to-guide-log.js

@@ -0,0 +1,70 @@
+'use strict';
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  up: async (queryInterface, Sequelize) => {
+    await queryInterface.renameTable('popup_logs', 'guide_logs');
+    await queryInterface.sequelize.query(`
+      ALTER TABLE "guide_logs" 
+      ALTER COLUMN "popupType" TYPE INTEGER 
+      USING 
+        CASE 
+          WHEN "popupType" = 'guide' THEN 1
+          WHEN "popupType" = 'tooltip' THEN 2
+          WHEN "popupType" = 'hotspot' THEN 3
+          WHEN "popupType" = 'checklist' THEN 4
+          ELSE NULL
+        END
+    `);
+
+    await queryInterface.changeColumn('guide_logs', 'popupType', {
+      type: Sequelize.INTEGER,
+      allowNull: false,
+    });
+
+    await queryInterface.addColumn('guide_logs', 'guideId', {
+      type: Sequelize.INTEGER,
+      allowNull: false,
+    });
+
+    await queryInterface.addIndex('guide_logs', ['userId'], {
+      name: 'idx_userId',
+    });
+    await queryInterface.addIndex('guide_logs', ['guideId'], {
+      name: 'idx_guideId',
+    });
+    await queryInterface.addIndex('guide_logs', ['popupType'], {
+      name: 'idx_popupType',
+    });
+    await queryInterface.addIndex('guide_logs', ['userId', 'guideId', 'popupType'], {
+      name: 'idx_userId_guideId_popupType',
+      unique: false,
+    });
+  },
+
+  down: async (queryInterface, Sequelize) => {
+    await queryInterface.renameTable('guide_logs', 'popup_logs');
+    await queryInterface.sequelize.query(`
+    ALTER TABLE "popup_logs" 
+    ALTER COLUMN "popupType" TYPE ENUM('guide', 'tooltip', 'hotspot', 'checklist') 
+    USING 
+      CASE 
+        WHEN "popupType" = 1 THEN 'guide'
+        WHEN "popupType" = 2 THEN 'tooltip'
+        WHEN "popupType" = 3 THEN 'hotspot'
+        WHEN "popupType" = 4 THEN 'checklist'
+        ELSE NULL
+      END
+  `);
+    await queryInterface.changeColumn('popup_logs', 'popupType', {
+      type: Sequelize.ENUM('guide', 'tooltip', 'hotspot', 'checklist'),
+      allowNull: false,
+    });
+
+    await queryInterface.removeColumn('popup_logs', 'guideId');
+
+    await queryInterface.removeIndex('popup_logs', 'idx_userId');
+    await queryInterface.removeIndex('popup_logs', 'idx_guideId');
+    await queryInterface.removeIndex('popup_logs', 'idx_popupType');
+    await queryInterface.removeIndex('popup_logs', 'idx_userId_guideId_popupType');
+  },
+};

backend/src/controllers/guidelog.controller.js

@@ -0,0 +1,61 @@
+const guidelogService = require("../service/guidelog.service.js");
+const { internalServerError } = require("../utils/errors.helper.js");
+
+class GuideLogController {
+  async addGuideLog(req, res) {
+      try {
+          const { popupType, userId, completed, guideId } = req.body;
+          const isCompleted = completed !== undefined ? completed : false;
+
+          const guideLog = await guidelogService.addGuideLog({ popupType, guideId, userId, completed: isCompleted });
+
+          res.status(201).json(guideLog);
+        } catch (err) {
+          const { statusCode, payload } = internalServerError(
+            "Error adding Guide Logs:",
+            err.message,
+          );
+          res.status(statusCode).json(payload);
+        }
+      }
+  async getAllLogs(req, res) {
+    try {
+      const guideLogs = await guidelogService.getAllGuideLogs();
+      res.status(200).json(guideLogs);
+    } catch (err) {
+      const { statusCode, payload } = internalServerError(
+        "GET_ALL_GUIDE_LOGS_ERROR",
+        err.message,
+      );
+      res.status(statusCode).json(payload);
+    }
+  }
+  async getLogsByUser(req, res){
+    try {
+      const {userId} = req.body;
+      const guideLogs = await guidelogService.getLogsByUser(userId);
+      res.status(200).json(guideLogs);
+    } catch (err) {
+      const { statusCode, payload } = internalServerError(
+        "GET_ALL_LOGS_BY_USER_ERROR",
+        err.message,
+      );
+      res.status(statusCode).json(payload);
+    }
+  }
+  async getCompleteGuideLogs(req, res){
+    try {
+      const {userId} = req.body;
+      const guideLogs = await guidelogService.getCompleteGuideLogs(userId);
+      res.status(200).json(guideLogs);
+    } catch (err) {
+      const { statusCode, payload } = internalServerError(
+        "GET_ALL_COMPLETE_LOGS_BY_USER_ERROR",
+        err.message,
+      );
+      res.status(statusCode).json(payload);
+    }
+  }
+}
+
+module.exports = new GuideLogController();

backend/src/models/GuideLog.js

@@ -0,0 +1,58 @@
+const { GuideType } = require('../utils/guidelog.helper');
+
+module.exports = (sequelize, DataTypes) => {
+    const GuideLog = sequelize.define('GuideLog', {
+        popupType: {
+            type: DataTypes.INTEGER,
+            allowNull: false,
+            validate: {
+                isIn: {
+                    args: [
+                        Object.values(GuideType),
+                    ],
+                    msg: 'popupType must be a valid value.',
+                },
+            },
+        },
+        guideId: {
+            type: DataTypes.INTEGER,
+            allowNull: false,
+        },
+        userId: {
+            type: DataTypes.STRING,
+            allowNull: false,
+        },
+        showingTime: {
+            type: DataTypes.DATE,
+            defaultValue: DataTypes.NOW,
+        },
+        completed: {
+            type: DataTypes.BOOLEAN,
+            defaultValue: false,
+        },
+    }, {
+        timestamps: false,
+        tableName: 'guide_logs',
+        indexes: [
+            {
+                name: 'idx_userId', 
+                fields: ['userId'],
+            },
+            {
+                name: 'idx_guideId', 
+                fields: ['guideId'],
+            },
+            {
+                name: 'idx_popupType',
+                fields: ['popupType'],
+            },
+            {
+                name: 'idx_userId_guideId_popupType', 
+                fields: ['userId', 'guideId', 'popupType'],
+                unique: false,
+            },
+        ],
+    });
+
+    return GuideLog;
+};

backend/src/models/index.js

@@ -25,7 +25,7 @@ db.sequelize = sequelize;
 db.User = require("./User.js")(sequelize, Sequelize.DataTypes);
 db.Popup = require("./Popup.js")(sequelize, Sequelize.DataTypes);
 db.Token = require("./Token.js")(sequelize, Sequelize.DataTypes);
-db.PopupLog = require("./PopupLog.js")(sequelize, Sequelize.DataTypes);
+db.GuideLog = require("./GuideLog.js")(sequelize, Sequelize.DataTypes);
 db.Banner = require("./Banner.js")(sequelize, Sequelize.DataTypes);
 db.Team = require("./Team.js")(sequelize, Sequelize.DataTypes);
 db.Invite = require("./Invite.js")(sequelize, Sequelize.DataTypes);

backend/src/routes/guidelog.routes.js

@@ -0,0 +1,12 @@
+const express = require("express");
+const guidelogController = require("../controllers/guidelog.controller");
+const {addGuideLogValidation, getLogByUserValidation} = require('../utils/guidelog.helper')
+const {handleValidationErrors} = require('../middleware/validation.middleware')
+const router = express.Router();
+
+router.post("/add_guide_log", addGuideLogValidation, handleValidationErrors, guidelogController.addGuideLog);
+router.get("/all_guide_logs", guidelogController.getAllLogs);
+router.get("/guide_logs_by_user", getLogByUserValidation, handleValidationErrors, guidelogController.getLogsByUser);
+router.get("/complete_guide_logs", getLogByUserValidation, handleValidationErrors, guidelogController.getCompleteGuideLogs);
+
+module.exports = router;

backend/src/service/guidelog.service.js

@@ -0,0 +1,43 @@
+const db = require("../models");
+const GuideLog = db.GuideLog;
+
+class GuideLogService {
+  async addGuideLog({ popupType, userId, guideId, completed }) {
+    return await GuideLog.create({
+      popupType,
+      userId,
+      guideId,
+      showingTime: new Date(),
+      completed
+    });
+  }
+  async getAllGuideLogs() {
+    return await GuideLog.findAll();
+  }
+  async getCompleteGuideLogs(userId) {
+    try {
+      return await GuideLog.findAll({
+        where: {
+          userId: userId,
+          completed: true,
+        },
+      });
+    } catch (err) {
+      throw new Error("Error retrieving Guide Log by UserID");
+    }
+  }
+
+  async getLogsByUser(userId) {
+    try {
+      return await GuideLog.findAll({
+        where: {
+          userId: userId,
+        },
+      });
+    } catch (err) {
+      throw new Error("Error retrieving Guide Log by UserID");
+    }
+  }
+}
+
+module.exports = new GuideLogService();