From 992bf099fa0d66d7731c76b1b73c10df1fa300b0 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Thu, 26 Sep 2024 13:41:50 +0800 Subject: [PATCH 1/9] Add app settings model, routes, db ops, service, use settings for issueToken --- Server/configs/db.js | 2 +- Server/controllers/authController.js | 24 ++++--- Server/controllers/checkController.js | 8 +-- Server/controllers/settingsController.js | 20 ++++++ Server/db/mongo/MongoDB.js | 21 ++++++- Server/db/mongo/modules/settingsModule.js | 17 +++++ Server/db/mongo/modules/userModule.js | 1 + Server/index.js | 16 +++-- Server/models/AppSettings.js | 76 +++++++++++++++++++++++ Server/routes/settingsRoute.js | 8 +++ Server/service/settingsService.js | 33 ++++++++++ Server/utils/messages.js | 3 + 12 files changed, 210 insertions(+), 19 deletions(-) create mode 100644 Server/controllers/settingsController.js create mode 100644 Server/db/mongo/modules/settingsModule.js create mode 100644 Server/models/AppSettings.js create mode 100644 Server/routes/settingsRoute.js create mode 100644 Server/service/settingsService.js diff --git a/Server/configs/db.js b/Server/configs/db.js index ba3c8b660..9dd768da3 100644 --- a/Server/configs/db.js +++ b/Server/configs/db.js @@ -1,4 +1,4 @@ -const PORT = process.env.PORT || 5000; +const PORT = 5000; const connectDbAndRunServer = async (app, db) => { try { diff --git a/Server/controllers/authController.js b/Server/controllers/authController.js index a58d5e7a9..5f3d3e4bd 100644 --- a/Server/controllers/authController.js +++ b/Server/controllers/authController.js @@ -25,10 +25,15 @@ const { getTokenFromHeaders } = require("../utils/utils"); * @param {Object} payload * @returns {String} */ -const issueToken = (payload) => { - //TODO Add proper expiration date - const tokenTTL = process.env.TOKEN_TTL ? process.env.TOKEN_TTL : "2h"; - return jwt.sign(payload, process.env.JWT_SECRET, { expiresIn: tokenTTL }); +const issueToken = async (payload, appSettings) => { + try { + const tokenTTL = appSettings.jwtTTL ? appSettings.jwtTTL : "2h"; + return jwt.sign(payload, appSettings.jwtSecret, { expiresIn: tokenTTL }); + } catch (error) { + error.service === undefined ? (error.service = SERVICE_NAME) : null; + error.method === undefined ? (error.method = "issueToken") : null; + next(error); + } }; /** @@ -67,7 +72,8 @@ const registerController = async (req, res, next) => { delete userForToken.profileImage; delete userForToken.avatarImage; - const token = issueToken(userForToken); + const appSettings = await req.settingsService.getSettings(); + const token = issueToken(userForToken, appSettings); req.emailService .buildAndSendEmail( @@ -130,8 +136,8 @@ const loginController = async (req, res, next) => { delete userWithoutPassword.avatarImage; // Happy path, return token - const token = issueToken(userWithoutPassword); - + const appSettings = req.settingsService.getSettings(); + const token = await issueToken(userWithoutPassword, appSettings); // reset avatar image userWithoutPassword.avatarImage = user.avatarImage; @@ -425,7 +431,9 @@ const resetPasswordController = async (req, res, next) => { } try { const user = await req.db.resetPassword(req, res); - const token = issueToken(user._doc); + + const appSettings = await req.settingsService.getSettings(); + const token = issueToken(user._doc, appSettings); res.status(200).json({ success: true, msg: successMessages.AUTH_RESET_PASSWORD, diff --git a/Server/controllers/checkController.js b/Server/controllers/checkController.js index 591703f57..bf30d9017 100644 --- a/Server/controllers/checkController.js +++ b/Server/controllers/checkController.js @@ -34,7 +34,7 @@ const createCheck = async (req, res, next) => { .status(200) .json({ success: true, msg: successMessages.CHECK_CREATE, data: check }); } catch (error) { - error.service === undefined ? (error.serivce = SERVICE_NAME) : null; + error.service === undefined ? (error.service = SERVICE_NAME) : null; error.method === undefined ? (error.method = "createCheck") : null; next(error); } @@ -62,7 +62,7 @@ const getChecks = async (req, res, next) => { data: { checksCount, checks }, }); } catch (error) { - error.service === undefined ? (error.serivce = SERVICE_NAME) : null; + error.service === undefined ? (error.service = SERVICE_NAME) : null; error.method === undefined ? (error.method = "getChecks") : null; next(error); } @@ -88,7 +88,7 @@ const getTeamChecks = async (req, res, next) => { data: checkData, }); } catch (error) { - error.service === undefined ? (error.serivce = SERVICE_NAME) : null; + error.service === undefined ? (error.service = SERVICE_NAME) : null; error.method === undefined ? (error.method = "getTeamChecks") : null; next(error); } @@ -114,7 +114,7 @@ const deleteChecks = async (req, res, next) => { data: { deletedCount }, }); } catch (error) { - error.service === undefined ? (error.serivce = SERVICE_NAME) : null; + error.service === undefined ? (error.service = SERVICE_NAME) : null; error.method === undefined ? (error.method = "deleteChecks") : null; next(error); } diff --git a/Server/controllers/settingsController.js b/Server/controllers/settingsController.js new file mode 100644 index 000000000..f4b5ae0f3 --- /dev/null +++ b/Server/controllers/settingsController.js @@ -0,0 +1,20 @@ +const { successMessages } = require("../utils/messages"); +const SERVICE_NAME = "SettingsController"; + +const getAppSettings = async (req, res, next) => { + try { + const settings = await req.db.getAppSettings(); + return res.status(200).json({ + success: true, + msg: successMessages.GET_APP_SETTINGS, + data: settings, + }); + } catch (error) { + error.service === undefined ? (error.service = SERVICE_NAME) : null; + error.method === undefined ? (error.method = "getAppSettings") : null; + } +}; + +module.exports = { + getAppSettings, +}; diff --git a/Server/db/mongo/MongoDB.js b/Server/db/mongo/MongoDB.js index 8bb51b898..a8f527391 100644 --- a/Server/db/mongo/MongoDB.js +++ b/Server/db/mongo/MongoDB.js @@ -1,5 +1,6 @@ const mongoose = require("mongoose"); const UserModel = require("../../models/User"); +const AppSettings = require("../../models/AppSettings"); //**************************************** // DB Connection @@ -7,7 +8,16 @@ const UserModel = require("../../models/User"); const connect = async () => { try { - await mongoose.connect(process.env.DB_CONNECTION_STRING); + const connectionString = + process.env.DB_CONNECTION_STRING || "mongodb://localhost:27017/uptime_db"; + await mongoose.connect(connectionString); + // If there are no AppSettings, create one + let appSettings = await AppSettings.find(); + if (appSettings.length === 0) { + appSettings = new AppSettings({}); + await appSettings.save(); + } + console.log("Connected to MongoDB"); } catch (error) { console.error("Failed to connect to MongoDB"); @@ -115,12 +125,20 @@ const { deleteMaintenanceWindowByUserId, } = require("./modules/maintenaceWindowModule"); +//**************************************** +// Notifications +//**************************************** const { createNotification, getNotificationsByMonitorId, deleteNotificationsByMonitorId, } = require("./modules/notificationModule"); +//**************************************** +// AppSettings +//**************************************** +const { getAppSettings } = require("./modules/settingsModule"); + module.exports = { connect, insertUser, @@ -168,4 +186,5 @@ module.exports = { createNotification, getNotificationsByMonitorId, deleteNotificationsByMonitorId, + getAppSettings, }; diff --git a/Server/db/mongo/modules/settingsModule.js b/Server/db/mongo/modules/settingsModule.js new file mode 100644 index 000000000..defc3e870 --- /dev/null +++ b/Server/db/mongo/modules/settingsModule.js @@ -0,0 +1,17 @@ +const AppSettings = require("../../../models/AppSettings"); +const SERVICE_NAME = "SettingsModule"; + +const getAppSettings = async () => { + try { + const settings = AppSettings.findOne(); + return settings; + } catch (error) { + error.service = SERVICE_NAME; + error.method = "getSettings"; + throw error; + } +}; + +module.exports = { + getAppSettings, +}; diff --git a/Server/db/mongo/modules/userModule.js b/Server/db/mongo/modules/userModule.js index 436ff1be5..bfdd54a4c 100644 --- a/Server/db/mongo/modules/userModule.js +++ b/Server/db/mongo/modules/userModule.js @@ -35,6 +35,7 @@ const insertUser = async (userData, imageFile) => { email: userData.email, }); userData.teamId = team._id; + userData.checkTTL = 60 * 60 * 24 * 30; await team.save(); } diff --git a/Server/index.js b/Server/index.js index 05c9d3059..c7974bb60 100644 --- a/Server/index.js +++ b/Server/index.js @@ -5,7 +5,6 @@ const swaggerUi = require("swagger-ui-express"); const express = require("express"); const helmet = require("helmet"); const cors = require("cors"); -require("dotenv").config(); const logger = require("./utils/logger"); const { verifyJWT } = require("./middleware/verifyJWT"); const { handleErrors } = require("./middleware/handleErrors"); @@ -15,6 +14,7 @@ const inviteRouter = require("./routes/inviteRoute"); const monitorRouter = require("./routes/monitorRoute"); const checkRouter = require("./routes/checkRoute"); const maintenanceWindowRouter = require("./routes/maintenanceWindowRoute"); +const settingsRouter = require("./routes/settingsRoute"); const { connectDbAndRunServer } = require("./configs/db"); const queueRouter = require("./routes/queueRoute"); @@ -22,6 +22,7 @@ const JobQueue = require("./service/jobQueue"); const NetworkService = require("./service/networkService"); const EmailService = require("./service/emailService"); const PageSpeedService = require("./service/pageSpeedService"); +const SettingsService = require("./service/settingsService"); const SERVICE_NAME = "Server"; let cleaningUp = false; @@ -47,9 +48,11 @@ const startApp = async () => { FakedDB: () => require("./db/FakeDb"), }; - const db = DB_TYPE[process.env.DB_TYPE] - ? DB_TYPE[process.env.DB_TYPE]() - : require("./db/FakeDb"); + // const db = DB_TYPE[process.env.DB_TYPE] + // ? DB_TYPE[process.env.DB_TYPE]() + // : require("./db/FakeDb"); + + const db = DB_TYPE.MongoDB(); const app = express(); @@ -60,7 +63,6 @@ const startApp = async () => { ); app.use(express.json()); app.use(helmet()); - // ************************** // Make DB accessible anywhere we have a Request object // By adding the DB to the request object, we can access it in any route @@ -72,6 +74,7 @@ const startApp = async () => { req.jobQueue = jobQueue; req.emailService = emailService; req.pageSpeedService = pageSpeedService; + req.settingsService = settingsService; next(); }); @@ -80,6 +83,7 @@ const startApp = async () => { //routes app.use("/api/v1/auth", authRouter); + app.use("/api/v1/settings", verifyJWT, settingsRouter); app.use("/api/v1/invite", inviteRouter); app.use("/api/v1/monitors", verifyJWT, monitorRouter); app.use("/api/v1/checks", verifyJWT, checkRouter); @@ -126,6 +130,8 @@ const startApp = async () => { const networkService = new NetworkService(db, emailService); const jobQueue = await JobQueue.createJobQueue(db, networkService); const pageSpeedService = new PageSpeedService(); + const settingsService = new SettingsService(); + settingsService.loadSettings(); const cleanup = async () => { if (cleaningUp) { diff --git a/Server/models/AppSettings.js b/Server/models/AppSettings.js new file mode 100644 index 000000000..3a146e46f --- /dev/null +++ b/Server/models/AppSettings.js @@ -0,0 +1,76 @@ +const mongoose = require("mongoose"); + +const AppSettingsSchema = mongoose.Schema( + { + apiBaseUrl: { + type: String, + required: true, + default: "http://localhost:5000/api/v1", + }, + logLevel: { + type: String, + default: "debug", + enum: ["debug", "none", "error", "warn"], + }, + clientHost: { + type: String, + required: true, + default: "http://localhost:5173", + }, + jwtSecret: { + type: String, + required: true, + default: "my_secret", + }, + dbType: { + type: String, + required: true, + default: "MongoDB", + }, + dbConnectionString: { + type: String, + required: true, + default: "mongodb://localhost:27017/uptime_db", + }, + redisHost: { + type: String, + required: true, + default: "127.0.0.1", + }, + redisPort: { + type: Number, + default: "6379", + }, + jwtTTL: { + type: String, + required: true, + default: "99d", + }, + pagespeedApiKey: { + type: String, + }, + systemEmailHost: { + type: String, + }, + systemEmailPort: { + type: Number, + }, + systemEmailAddress: { + type: String, + }, + systemEmailAddress: { + type: String, + }, + singleton: { + type: Boolean, + required: true, + unique: true, + default: true, + }, + }, + { + timestamps: true, + } +); + +module.exports = mongoose.model("AppSettings", AppSettingsSchema); diff --git a/Server/routes/settingsRoute.js b/Server/routes/settingsRoute.js new file mode 100644 index 000000000..4c0acf1b8 --- /dev/null +++ b/Server/routes/settingsRoute.js @@ -0,0 +1,8 @@ +const router = require("express").Router(); +const settingsController = require("../controllers/settingsController"); +const { isAllowed } = require("../middleware/isAllowed"); +const Monitor = require("../models/Monitor"); + +router.get("/", isAllowed(["superadmin"]), settingsController.getAppSettings); + +module.exports = router; diff --git a/Server/service/settingsService.js b/Server/service/settingsService.js new file mode 100644 index 000000000..e8abe747f --- /dev/null +++ b/Server/service/settingsService.js @@ -0,0 +1,33 @@ +const AppSettings = require("../models/AppSettings"); +const SERVICE_NAME = "SettingsService"; + +class SettingsService { + constructor() { + this.settings = null; + } + + async loadSettings() { + if (!this.settings) { + try { + this.settings = await AppSettings.findOne(); + if (!this.settings) { + throw new Error("Settings not found"); + } + return this.settings; + } catch (error) { + error.service === undefined ? (error.service = SERVICE_NAME) : null; + error.method === undefined ? (error.method = "loadSettings") : null; + throw error; + } + } + } + + getSettings() { + if (!this.settings) { + throw new Error("Settings have not been loaded"); + } + return this.settings; + } +} + +module.exports = SettingsService; diff --git a/Server/utils/messages.js b/Server/utils/messages.js index 04da91491..14e1af6db 100644 --- a/Server/utils/messages.js +++ b/Server/utils/messages.js @@ -98,6 +98,9 @@ const successMessages = { //Ping Operations PING_SUCCESS: "Success", + + // App Settings + GET_APP_SETTINGS: "Got app settings successfully", }; module.exports = { From 11b97ab3b467d0ea1b3252f854b008b921b54fef Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Thu, 26 Sep 2024 14:37:11 +0800 Subject: [PATCH 2/9] add update settings method, remove all env var references possible --- Server/controllers/authController.js | 14 ++++++----- Server/controllers/checkController.js | 3 ++- Server/controllers/inviteController.js | 3 ++- Server/controllers/monitorController.js | 7 ++++-- Server/controllers/settingsController.js | 29 +++++++++++++++++++++++ Server/db/mongo/MongoDB.js | 6 ++++- Server/db/mongo/modules/settingsModule.js | 16 +++++++++++++ Server/index.js | 15 ++++++++---- Server/middleware/isAllowed.js | 3 ++- Server/middleware/verifyJWT.js | 4 +++- Server/middleware/verifySuperAdmin.js | 4 +++- Server/models/AppSettings.js | 6 ++++- Server/routes/settingsRoute.js | 5 ++++ Server/service/emailService.js | 28 +++++++++++++++------- Server/service/jobQueue.js | 20 +++++++++------- Server/utils/messages.js | 1 + Server/validation/joi.js | 21 ++++++++++++++++ 17 files changed, 149 insertions(+), 36 deletions(-) diff --git a/Server/controllers/authController.js b/Server/controllers/authController.js index 5f3d3e4bd..cd9284479 100644 --- a/Server/controllers/authController.js +++ b/Server/controllers/authController.js @@ -25,7 +25,7 @@ const { getTokenFromHeaders } = require("../utils/utils"); * @param {Object} payload * @returns {String} */ -const issueToken = async (payload, appSettings) => { +const issueToken = (payload, appSettings) => { try { const tokenTTL = appSettings.jwtTTL ? appSettings.jwtTTL : "2h"; return jwt.sign(payload, appSettings.jwtSecret, { expiresIn: tokenTTL }); @@ -74,7 +74,6 @@ const registerController = async (req, res, next) => { const appSettings = await req.settingsService.getSettings(); const token = issueToken(userForToken, appSettings); - req.emailService .buildAndSendEmail( "welcomeEmailTemplate", @@ -137,7 +136,7 @@ const loginController = async (req, res, next) => { // Happy path, return token const appSettings = req.settingsService.getSettings(); - const token = await issueToken(userWithoutPassword, appSettings); + const token = issueToken(userWithoutPassword, appSettings); // reset avatar image userWithoutPassword.avatarImage = user.avatarImage; @@ -186,7 +185,8 @@ const userEditController = async (req, res, next) => { // Get token from headers const token = getTokenFromHeaders(req.headers); // Get email from token - const { email } = jwt.verify(token, process.env.JWT_SECRET); + const { jwtSecret } = req.settingsService.getSettings(); + const { email } = jwt.verify(token, jwtSecret); // Add user email to body for DB operation req.body.email = email; // Get user @@ -236,12 +236,13 @@ const inviteController = async (req, res, next) => { } const inviteToken = await req.db.requestInviteToken(req, res); + const { clientHost } = req.settingsService.getSettings(); req.emailService .buildAndSendEmail( "employeeActivationTemplate", { name: firstname, - link: `${process.env.CLIENT_HOST}/register/${inviteToken.token}`, + link: `${clientHost}/register/${inviteToken.token}`, }, req.body.email, "Welcome to Uptime Monitor" @@ -345,7 +346,8 @@ const recoveryRequestController = async (req, res, next) => { const recoveryToken = await req.db.requestRecoveryToken(req, res); const name = user.firstName; const email = req.body.email; - const url = `${process.env.CLIENT_HOST}/set-new-password/${recoveryToken.token}`; + const { clientHost } = req.settingsService.getSettings(); + const url = `${clientHost}/set-new-password/${recoveryToken.token}`; const msgId = await req.emailService.buildAndSendEmail( "passwordResetTemplate", diff --git a/Server/controllers/checkController.js b/Server/controllers/checkController.js index bf30d9017..17507e0b2 100644 --- a/Server/controllers/checkController.js +++ b/Server/controllers/checkController.js @@ -163,7 +163,8 @@ const updateChecksTTL = async (req, res, next) => { try { // Get user's teamId const token = getTokenFromHeaders(req.headers); - const { teamId } = jwt.verify(token, process.env.JWT_SECRET); + const { jwtSecret } = req.settingsService.getSettings(); + const { teamId } = jwt.verify(token, jwtSecret); const ttl = parseInt(req.body.ttl, 10) * SECONDS_PER_DAY; await req.db.updateChecksTTL(teamId, ttl); return res.status(200).json({ diff --git a/Server/controllers/inviteController.js b/Server/controllers/inviteController.js index 1b8ab01f1..da9b2496a 100644 --- a/Server/controllers/inviteController.js +++ b/Server/controllers/inviteController.js @@ -39,12 +39,13 @@ const inviteController = async (req, res, next) => { } const inviteToken = await req.db.requestInviteToken({ ...req.body }); + const { clientHost } = req.settingsService.getSettings(); req.emailService .buildAndSendEmail( "employeeActivationTemplate", { name: firstname, - link: `${process.env.CLIENT_HOST}/register/${inviteToken.token}`, + link: `${clientHost}/register/${inviteToken.token}`, }, req.body.email, "Welcome to Uptime Monitor" diff --git a/Server/controllers/monitorController.js b/Server/controllers/monitorController.js index 2dc577f19..5cda56634 100644 --- a/Server/controllers/monitorController.js +++ b/Server/controllers/monitorController.js @@ -345,7 +345,8 @@ const deleteMonitor = async (req, res, next) => { const deleteAllMonitors = async (req, res) => { try { const token = getTokenFromHeaders(req.headers); - const { teamId } = jwt.verify(token, process.env.JWT_SECRET); + const { jwtSecret } = req.settingsService.getSettings(); + const { teamId } = jwt.verify(token, jwtSecret); const { monitors, deletedCount } = await req.db.deleteAllMonitors(teamId); await monitors.forEach(async (monitor) => { await req.jobQueue.deleteJob(monitor); @@ -460,7 +461,9 @@ const pauseMonitor = async (req, res, next) => { const addDemoMonitors = async (req, res, next) => { try { const token = getTokenFromHeaders(req.headers); - const { _id, teamId } = jwt.verify(token, process.env.JWT_SECRET); + const { jwtSecret } = req.settingsService.getSettings(); + + const { _id, teamId } = jwt.verify(token, jwtSecret); const demoMonitors = await req.db.addDemoMonitors(_id, teamId); await demoMonitors.forEach(async (monitor) => { await req.jobQueue.addJob(monitor._id, monitor); diff --git a/Server/controllers/settingsController.js b/Server/controllers/settingsController.js index f4b5ae0f3..87e4edfc1 100644 --- a/Server/controllers/settingsController.js +++ b/Server/controllers/settingsController.js @@ -1,5 +1,6 @@ const { successMessages } = require("../utils/messages"); const SERVICE_NAME = "SettingsController"; +const { updateAppSettingsBodyValidation } = require("../validation/joi"); const getAppSettings = async (req, res, next) => { try { @@ -12,9 +13,37 @@ const getAppSettings = async (req, res, next) => { } catch (error) { error.service === undefined ? (error.service = SERVICE_NAME) : null; error.method === undefined ? (error.method = "getAppSettings") : null; + next(error); + } +}; + +const updateAppSettings = async (req, res, next) => { + try { + await updateAppSettingsBodyValidation.validateAsync(req.body); + } catch (error) { + error.status = 422; + error.service = SERVICE_NAME; + error.message = + error.details?.[0]?.message || error.message || "Validation Error"; + next(error); + return; + } + + try { + const settings = await req.db.updateAppSettings(req.body); + return res.status(200).json({ + success: true, + msg: successMessages.UPDATE_APP_SETTINGS, + data: settings, + }); + } catch (error) { + error.service === undefined ? (error.service = SERVICE_NAME) : null; + error.method === undefined ? (error.method = "updateAppSettings") : null; + next(error); } }; module.exports = { getAppSettings, + updateAppSettings, }; diff --git a/Server/db/mongo/MongoDB.js b/Server/db/mongo/MongoDB.js index a8f527391..268e62798 100644 --- a/Server/db/mongo/MongoDB.js +++ b/Server/db/mongo/MongoDB.js @@ -137,7 +137,10 @@ const { //**************************************** // AppSettings //**************************************** -const { getAppSettings } = require("./modules/settingsModule"); +const { + getAppSettings, + updateAppSettings, +} = require("./modules/settingsModule"); module.exports = { connect, @@ -187,4 +190,5 @@ module.exports = { getNotificationsByMonitorId, deleteNotificationsByMonitorId, getAppSettings, + updateAppSettings, }; diff --git a/Server/db/mongo/modules/settingsModule.js b/Server/db/mongo/modules/settingsModule.js index defc3e870..b7e6b765d 100644 --- a/Server/db/mongo/modules/settingsModule.js +++ b/Server/db/mongo/modules/settingsModule.js @@ -12,6 +12,22 @@ const getAppSettings = async () => { } }; +const updateAppSettings = async (newSettings) => { + try { + const settings = await AppSettings.findOneAndUpdate( + {}, + { $set: newSettings }, + { new: true } + ); + return settings; + } catch (error) { + error.service = SERVICE_NAME; + error.method = "updateAppSettings"; + throw error; + } +}; + module.exports = { getAppSettings, + updateAppSettings, }; diff --git a/Server/index.js b/Server/index.js index c7974bb60..05eaeb617 100644 --- a/Server/index.js +++ b/Server/index.js @@ -126,12 +126,17 @@ const startApp = async () => { // Create services await connectDbAndRunServer(app, db); - const emailService = new EmailService(); - const networkService = new NetworkService(db, emailService); - const jobQueue = await JobQueue.createJobQueue(db, networkService); - const pageSpeedService = new PageSpeedService(); const settingsService = new SettingsService(); - settingsService.loadSettings(); + + await settingsService.loadSettings(); + const emailService = new EmailService(settingsService); + const networkService = new NetworkService(db, emailService); + const jobQueue = await JobQueue.createJobQueue( + db, + networkService, + settingsService + ); + const pageSpeedService = new PageSpeedService(); const cleanup = async () => { if (cleaningUp) { diff --git a/Server/middleware/isAllowed.js b/Server/middleware/isAllowed.js index c7d78785a..e141ad165 100644 --- a/Server/middleware/isAllowed.js +++ b/Server/middleware/isAllowed.js @@ -27,7 +27,8 @@ const isAllowed = (allowedRoles) => { // Parse the token try { const parsedToken = token.slice(TOKEN_PREFIX.length, token.length); - var decoded = jwt.verify(parsedToken, process.env.JWT_SECRET); + const { jwtSecret } = req.settingsService.getSettings(); + var decoded = jwt.verify(parsedToken, jwtSecret); const userRoles = decoded.role; // Check if the user has the required role diff --git a/Server/middleware/verifyJWT.js b/Server/middleware/verifyJWT.js index 9d50fe7ea..ffbcd55a5 100644 --- a/Server/middleware/verifyJWT.js +++ b/Server/middleware/verifyJWT.js @@ -35,7 +35,9 @@ const verifyJWT = (req, res, next) => { const parsedToken = token.slice(TOKEN_PREFIX.length, token.length); // Verify the token's authenticity - jwt.verify(parsedToken, process.env.JWT_SECRET, (err, decoded) => { + const { jwtSecret } = req.settingsService.getSettings(); + + jwt.verify(parsedToken, jwtSecret, (err, decoded) => { if (err) { return res .status(401) diff --git a/Server/middleware/verifySuperAdmin.js b/Server/middleware/verifySuperAdmin.js index e977a1591..cf8774c31 100644 --- a/Server/middleware/verifySuperAdmin.js +++ b/Server/middleware/verifySuperAdmin.js @@ -33,7 +33,9 @@ const verifySuperAdmin = (req, res, next) => { const parsedToken = token.slice(TOKEN_PREFIX.length, token.length); // verify admin role is present - jwt.verify(parsedToken, process.env.JWT_SECRET, (err, decoded) => { + const { jwtSecret } = req.settingsService.getSettings(); + + jwt.verify(parsedToken, jwtSecret, (err, decoded) => { if (err) { logger.error(errorMessages.INVALID_AUTH_TOKEN, { service: SERVICE_NAME, diff --git a/Server/models/AppSettings.js b/Server/models/AppSettings.js index 3a146e46f..79ede650a 100644 --- a/Server/models/AppSettings.js +++ b/Server/models/AppSettings.js @@ -51,15 +51,19 @@ const AppSettingsSchema = mongoose.Schema( }, systemEmailHost: { type: String, + default: "smtp.gmail.com", }, systemEmailPort: { type: Number, + default: 465, }, systemEmailAddress: { type: String, + default: "", }, - systemEmailAddress: { + systemEmailPassword: { type: String, + default: "", }, singleton: { type: Boolean, diff --git a/Server/routes/settingsRoute.js b/Server/routes/settingsRoute.js index 4c0acf1b8..834f68f26 100644 --- a/Server/routes/settingsRoute.js +++ b/Server/routes/settingsRoute.js @@ -4,5 +4,10 @@ const { isAllowed } = require("../middleware/isAllowed"); const Monitor = require("../models/Monitor"); router.get("/", isAllowed(["superadmin"]), settingsController.getAppSettings); +router.put( + "/", + isAllowed(["superadmin"]), + settingsController.updateAppSettings +); module.exports = router; diff --git a/Server/service/emailService.js b/Server/service/emailService.js index 27518484c..4295f33ab 100644 --- a/Server/service/emailService.js +++ b/Server/service/emailService.js @@ -13,7 +13,8 @@ class EmailService { /** * Constructs an instance of the EmailService, initializing template loaders and the email transporter. */ - constructor() { + constructor(settingsService) { + this.settingsService = settingsService; /** * Loads an email template from the filesystem. * @@ -54,15 +55,26 @@ class EmailService { * The email transporter used to send emails. * @type {Object} */ - this.transporter = nodemailer.createTransport({ - host: process.env.SYSTEM_EMAIL_HOST, - port: process.env.SYSTEM_EMAIL_PORT, - secure: true, // Use `true` for port 465, `false` for all other ports + + const { + systemEmailHost, + systemEmailPort, + systemEmailAddress, + systemEmailPassword, + } = this.settingsService.getSettings(); + + const emailConfig = { + host: systemEmailHost, + port: systemEmailPort, + secure: true, auth: { - user: process.env.SYSTEM_EMAIL_ADDRESS, - pass: process.env.SYSTEM_EMAIL_PASSWORD, + user: systemEmailAddress, + pass: systemEmailPassword, }, - }); + }; + console.log(emailConfig); + + this.transporter = nodemailer.createTransport(emailConfig); } /** diff --git a/Server/service/jobQueue.js b/Server/service/jobQueue.js index 5a6d3e8e0..7566debd8 100644 --- a/Server/service/jobQueue.js +++ b/Server/service/jobQueue.js @@ -1,9 +1,6 @@ const { Queue, Worker, Job } = require("bullmq"); const QUEUE_NAME = "monitors"; -const connection = { - host: process.env.REDIS_HOST || "127.0.0.1", - port: process.env.REDIS_PORT || 6379, -}; + const JOBS_PER_WORKER = 5; const logger = require("../utils/logger"); const { errorMessages, successMessages } = require("../utils/messages"); @@ -15,13 +12,20 @@ class JobQueue { * @constructor * @throws {Error} */ - constructor(networkService) { + constructor(settingsService) { + const { redisHost, redisPort } = settingsService.getSettings(); + const connection = { + host: redisHost || "127.0.0.1", + port: redisPort || 6379, + }; + this.connection = connection; this.queue = new Queue(QUEUE_NAME, { connection, }); this.workers = []; this.db = null; this.networkService = null; + this.settingsService = settingsService; } /** @@ -31,8 +35,8 @@ class JobQueue { * @returns {Promise} - Returns a new JobQueue * */ - static async createJobQueue(db, networkService) { - const queue = new JobQueue(); + static async createJobQueue(db, networkService, settingsService) { + const queue = new JobQueue(settingsService); try { queue.db = db; queue.networkService = networkService; @@ -99,7 +103,7 @@ class JobQueue { } }, { - connection, + connection: this.connection, } ); return worker; diff --git a/Server/utils/messages.js b/Server/utils/messages.js index 14e1af6db..59fa53f49 100644 --- a/Server/utils/messages.js +++ b/Server/utils/messages.js @@ -101,6 +101,7 @@ const successMessages = { // App Settings GET_APP_SETTINGS: "Got app settings successfully", + UPDATE_APP_SETTINGS: "Updated app settings successfully", }; module.exports = { diff --git a/Server/validation/joi.js b/Server/validation/joi.js index 0a83b6e74..7b26ea8e1 100644 --- a/Server/validation/joi.js +++ b/Server/validation/joi.js @@ -382,6 +382,26 @@ const getMaintenanceWindowsByMonitorIdParamValidation = joi.object({ monitorId: joi.string().required(), }); +//**************************************** +// SettingsValidation +//**************************************** +const updateAppSettingsBodyValidation = joi.object({ + apiBaseUrl: joi.string().allow(""), + logLevel: joi.string().valid("debug", "none", "error", "warn").allow(""), + clientHost: joi.string().allow(""), + jwtSecret: joi.string().allow(""), + dbType: joi.string().allow(""), + dbConnectionString: joi.string().allow(""), + redisHost: joi.string().allow(""), + redisPort: joi.number().allow(null, ""), + jwtTTL: joi.string().allow(""), + pagespeedApiKey: joi.string().allow(""), + systemEmailHost: joi.string().allow(""), + systemEmailPort: joi.number().allow(""), + systemEmailAddress: joi.string().allow(""), + systemEmailPassword: joi.string().allow(""), +}); + module.exports = { roleValidatior, loginValidation, @@ -432,4 +452,5 @@ module.exports = { createMaintenanceWindowBodyValidation, getMaintenanceWindowsByUserIdParamValidation, getMaintenanceWindowsByMonitorIdParamValidation, + updateAppSettingsBodyValidation, }; From 0832e8438af891cbdf3ade1c4d4fbf4b4685ec28 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Thu, 26 Sep 2024 15:38:02 +0800 Subject: [PATCH 3/9] remove console log --- Server/service/emailService.js | 1 - 1 file changed, 1 deletion(-) diff --git a/Server/service/emailService.js b/Server/service/emailService.js index 4295f33ab..edee0cc72 100644 --- a/Server/service/emailService.js +++ b/Server/service/emailService.js @@ -72,7 +72,6 @@ class EmailService { pass: systemEmailPassword, }, }; - console.log(emailConfig); this.transporter = nodemailer.createTransport(emailConfig); } From 97419b436c75aab273608423a534d67824a67115 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Thu, 26 Sep 2024 15:45:54 +0800 Subject: [PATCH 4/9] Add reload settings method, reload settings when DB updated --- Server/controllers/settingsController.js | 1 + Server/service/settingsService.js | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/Server/controllers/settingsController.js b/Server/controllers/settingsController.js index 87e4edfc1..c44363bfa 100644 --- a/Server/controllers/settingsController.js +++ b/Server/controllers/settingsController.js @@ -31,6 +31,7 @@ const updateAppSettings = async (req, res, next) => { try { const settings = await req.db.updateAppSettings(req.body); + await req.settingsService.reloadSettings(); return res.status(200).json({ success: true, msg: successMessages.UPDATE_APP_SETTINGS, diff --git a/Server/service/settingsService.js b/Server/service/settingsService.js index e8abe747f..a5e7b2734 100644 --- a/Server/service/settingsService.js +++ b/Server/service/settingsService.js @@ -22,6 +22,19 @@ class SettingsService { } } + async reloadSettings() { + try { + this.settings = await AppSettings.findOne(); + if (!this.settings) { + throw new Error("Settings not found"); + } + } catch (error) { + error.service === undefined ? (error.service = SERVICE_NAME) : null; + error.method === undefined ? (error.method = "reloadSettings") : null; + throw error; + } + } + getSettings() { if (!this.settings) { throw new Error("Settings have not been loaded"); From c3edbb779a690f09ab16c647a5998090cf12f8bd Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Fri, 27 Sep 2024 13:02:01 +0800 Subject: [PATCH 5/9] Modify settingsService to load from env by default --- Server/service/settingsService.js | 52 ++++++++++++++++++++++++------- 1 file changed, 40 insertions(+), 12 deletions(-) diff --git a/Server/service/settingsService.js b/Server/service/settingsService.js index a5e7b2734..ca2509fe0 100644 --- a/Server/service/settingsService.js +++ b/Server/service/settingsService.js @@ -1,24 +1,52 @@ const AppSettings = require("../models/AppSettings"); const SERVICE_NAME = "SettingsService"; +CLIENT_HOST = process.env.CLIENT_HOST; +JWT_SECRET = process.env.JWT_SECRET; +DB_TYPE = process.env.DB_TYPE; +DB_CONNECTION_STRING = process.env.DB_CONNECTION_STRING; +REDIS_HOST = process.env.REDIS_HOST; +REDIS_PORT = process.env.REDIS_PORT; +TOKEN_TTL = process.env.TOKEN_TTL; +PAGESPEED_API_KEY = process.env.PAGESPEED_API_KEY; +SYSTEM_EMAIL_HOST = process.env.SYSTEM_EMAIL_HOST; +SYSTEM_EMAIL_PORT = process.env.SYSTEM_EMAIL_PORT; +SYSTEM_EMAIL_ADDRESS = process.env.SYSTEM_EMAIL_ADDRESS; +SYSTEM_EMAIL_PASSWORD = process.env.SYSTEM_EMAIL_PASSWORD; class SettingsService { constructor() { - this.settings = null; + this.settings = { + clientHost: CLIENT_HOST, + jwtSecret: JWT_SECRET, + dbType: DB_TYPE, + dbConnectionString: DB_CONNECTION_STRING, + redisHost: REDIS_HOST, + redisPort: REDIS_PORT, + tokenTTL: TOKEN_TTL, + pagespeedApiKey: PAGESPEED_API_KEY, + systemEmailHost: SYSTEM_EMAIL_HOST, + systemEmailPort: SYSTEM_EMAIL_PORT, + systemEmailAddress: SYSTEM_EMAIL_ADDRESS, + systemEmailPassword: SYSTEM_EMAIL_PASSWORD, + }; } async loadSettings() { - if (!this.settings) { - try { - this.settings = await AppSettings.findOne(); - if (!this.settings) { - throw new Error("Settings not found"); - } - return this.settings; - } catch (error) { - error.service === undefined ? (error.service = SERVICE_NAME) : null; - error.method === undefined ? (error.method = "loadSettings") : null; - throw error; + try { + const dbSettings = await AppSettings.findOne(); + if (!this.settings) { + throw new Error("Settings not found"); } + for (const key in this.settings) { + if (this.settings[key] === undefined && dbSettings[key] !== undefined) { + this.settings[key] = dbSettings[key]; + } + } + return this.settings; + } catch (error) { + error.service === undefined ? (error.service = SERVICE_NAME) : null; + error.method === undefined ? (error.method = "loadSettings") : null; + throw error; } } From f4bbbc5fa9f299e7b6db172d1f67ee0609a7b25d Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Fri, 27 Sep 2024 13:10:29 +0800 Subject: [PATCH 6/9] fix conditional loadingof settings --- Server/service/settingsService.js | 55 ++++++++++++++----------------- 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/Server/service/settingsService.js b/Server/service/settingsService.js index ca2509fe0..b1027a17c 100644 --- a/Server/service/settingsService.js +++ b/Server/service/settingsService.js @@ -1,34 +1,23 @@ +const { env } = require("process"); const AppSettings = require("../models/AppSettings"); const SERVICE_NAME = "SettingsService"; - -CLIENT_HOST = process.env.CLIENT_HOST; -JWT_SECRET = process.env.JWT_SECRET; -DB_TYPE = process.env.DB_TYPE; -DB_CONNECTION_STRING = process.env.DB_CONNECTION_STRING; -REDIS_HOST = process.env.REDIS_HOST; -REDIS_PORT = process.env.REDIS_PORT; -TOKEN_TTL = process.env.TOKEN_TTL; -PAGESPEED_API_KEY = process.env.PAGESPEED_API_KEY; -SYSTEM_EMAIL_HOST = process.env.SYSTEM_EMAIL_HOST; -SYSTEM_EMAIL_PORT = process.env.SYSTEM_EMAIL_PORT; -SYSTEM_EMAIL_ADDRESS = process.env.SYSTEM_EMAIL_ADDRESS; -SYSTEM_EMAIL_PASSWORD = process.env.SYSTEM_EMAIL_PASSWORD; +const envConfig = { + clientHost: process.env.CLIENT_HOST, + jwtSecret: process.env.JWT_SECRET, + dbType: process.env.DB_TYPE, + dbConnectionString: process.env.DB_CONNECTION_STRING, + redisHost: process.env.REDIS_HOST, + redisPort: process.env.REDIS_PORT, + tokenTTL: process.env.TOKEN_TTL, + pagespeedApiKey: process.env.PAGESPEED_API_KEY, + systemEmailHost: process.env.SYSTEM_EMAIL_HOST, + systemEmailPort: process.env.SYSTEM_EMAIL_PORT, + systemEmailAddress: process.env.SYSTEM_EMAIL_ADDRESS, + systemEmailPassword: process.env.SYSTEM_EMAIL_PASSWORD, +}; class SettingsService { constructor() { - this.settings = { - clientHost: CLIENT_HOST, - jwtSecret: JWT_SECRET, - dbType: DB_TYPE, - dbConnectionString: DB_CONNECTION_STRING, - redisHost: REDIS_HOST, - redisPort: REDIS_PORT, - tokenTTL: TOKEN_TTL, - pagespeedApiKey: PAGESPEED_API_KEY, - systemEmailHost: SYSTEM_EMAIL_HOST, - systemEmailPort: SYSTEM_EMAIL_PORT, - systemEmailAddress: SYSTEM_EMAIL_ADDRESS, - systemEmailPassword: SYSTEM_EMAIL_PASSWORD, - }; + this.settings = envConfig; } async loadSettings() { @@ -37,8 +26,8 @@ class SettingsService { if (!this.settings) { throw new Error("Settings not found"); } - for (const key in this.settings) { - if (this.settings[key] === undefined && dbSettings[key] !== undefined) { + for (const key in envConfig) { + if (envConfig[key] === undefined && dbSettings[key] !== undefined) { this.settings[key] = dbSettings[key]; } } @@ -52,7 +41,13 @@ class SettingsService { async reloadSettings() { try { - this.settings = await AppSettings.findOne(); + const dbSettings = await AppSettings.findOne(); + + for (const key in envConfig) { + if (envConfig[key] === undefined && dbSettings[key] !== undefined) { + this.settings[key] = dbSettings[key]; + } + } if (!this.settings) { throw new Error("Settings not found"); } From 114f4ffb0514a6e14aa8a69ce93d243fec613299 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Mon, 30 Sep 2024 09:52:47 +0800 Subject: [PATCH 7/9] refactor reloadSettings --- Server/controllers/settingsController.js | 4 ++-- Server/service/settingsService.js | 25 +++++++++--------------- 2 files changed, 11 insertions(+), 18 deletions(-) diff --git a/Server/controllers/settingsController.js b/Server/controllers/settingsController.js index c44363bfa..77895caea 100644 --- a/Server/controllers/settingsController.js +++ b/Server/controllers/settingsController.js @@ -31,11 +31,11 @@ const updateAppSettings = async (req, res, next) => { try { const settings = await req.db.updateAppSettings(req.body); - await req.settingsService.reloadSettings(); + const updatedSettings = await req.settingsService.reloadSettings(); return res.status(200).json({ success: true, msg: successMessages.UPDATE_APP_SETTINGS, - data: settings, + data: updatedSettings, }); } catch (error) { error.service === undefined ? (error.service = SERVICE_NAME) : null; diff --git a/Server/service/settingsService.js b/Server/service/settingsService.js index b1027a17c..7cf76f7cc 100644 --- a/Server/service/settingsService.js +++ b/Server/service/settingsService.js @@ -15,6 +15,7 @@ const envConfig = { systemEmailAddress: process.env.SYSTEM_EMAIL_ADDRESS, systemEmailPassword: process.env.SYSTEM_EMAIL_PASSWORD, }; + class SettingsService { constructor() { this.settings = envConfig; @@ -26,11 +27,18 @@ class SettingsService { if (!this.settings) { throw new Error("Settings not found"); } + + // Try to load settings from env first, if not found, load from db for (const key in envConfig) { if (envConfig[key] === undefined && dbSettings[key] !== undefined) { this.settings[key] = dbSettings[key]; } } + + if (!this.settings) { + throw new Error("Settings not found"); + } + return this.settings; } catch (error) { error.service === undefined ? (error.service = SERVICE_NAME) : null; @@ -40,22 +48,7 @@ class SettingsService { } async reloadSettings() { - try { - const dbSettings = await AppSettings.findOne(); - - for (const key in envConfig) { - if (envConfig[key] === undefined && dbSettings[key] !== undefined) { - this.settings[key] = dbSettings[key]; - } - } - if (!this.settings) { - throw new Error("Settings not found"); - } - } catch (error) { - error.service === undefined ? (error.service = SERVICE_NAME) : null; - error.method === undefined ? (error.method = "reloadSettings") : null; - throw error; - } + return this.loadSettings(); } getSettings() { From b6a7cfa7cc87823c2fc1387072b3ca287fde333d Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Mon, 30 Sep 2024 09:56:39 +0800 Subject: [PATCH 8/9] refactor getAppSettings endpoint to user settingsService as source of truth --- Server/controllers/settingsController.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Server/controllers/settingsController.js b/Server/controllers/settingsController.js index 77895caea..e3444436b 100644 --- a/Server/controllers/settingsController.js +++ b/Server/controllers/settingsController.js @@ -4,7 +4,7 @@ const { updateAppSettingsBodyValidation } = require("../validation/joi"); const getAppSettings = async (req, res, next) => { try { - const settings = await req.db.getAppSettings(); + const settings = await req.settingsService.getSettings(); return res.status(200).json({ success: true, msg: successMessages.GET_APP_SETTINGS, @@ -30,7 +30,7 @@ const updateAppSettings = async (req, res, next) => { } try { - const settings = await req.db.updateAppSettings(req.body); + await req.db.updateAppSettings(req.body); const updatedSettings = await req.settingsService.reloadSettings(); return res.status(200).json({ success: true, From 73ac91c2014e7a960619c06972a6b9f11a5ea7d3 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Mon, 30 Sep 2024 10:08:37 +0800 Subject: [PATCH 9/9] Generate random JWT on first account signup if one is not supplied by env --- Server/controllers/authController.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Server/controllers/authController.js b/Server/controllers/authController.js index cd9284479..8d41f916b 100644 --- a/Server/controllers/authController.js +++ b/Server/controllers/authController.js @@ -18,6 +18,7 @@ const { errorMessages, successMessages } = require("../utils/messages"); var jwt = require("jsonwebtoken"); const SERVICE_NAME = "AuthController"; const { getTokenFromHeaders } = require("../utils/utils"); +const crypto = require("crypto"); /** * Creates and returns JWT token with an arbitrary payload @@ -61,7 +62,12 @@ const registerController = async (req, res, next) => { const superAdminExists = await req.db.checkSuperadmin(req, res); if (superAdminExists) { await req.db.getInviteTokenAndDelete(inviteToken); + } else { + // This is the first account, create JWT secret to use if one is not supplied by env + const jwtSecret = crypto.randomBytes(64).toString("hex"); + await req.db.updateAppSettings({ jwtSecret }); } + const newUser = await req.db.insertUser({ ...req.body }, req.file); logger.info(successMessages.AUTH_CREATE_USER, { service: SERVICE_NAME,