feat/be/status page implementation

Server/controllers/statusPageController.js

@@ -0,0 +1,51 @@
+import { handleError, handleValidationError } from "./controllerUtils.js";
+import {
+	createStatusPageBodyValidation,
+	getStatusPageParamValidation,
+} from "../validation/joi.js";
+import { successMessages } from "../utils/messages.js";
+
+const SERVICE_NAME = "statusPageController";
+
+const createStatusPage = async (req, res, next) => {
+	try {
+		await createStatusPageBodyValidation.validateAsync(req.body);
+	} catch (error) {
+		next(handleValidationError(error, SERVICE_NAME));
+		return;
+	}
+
+	try {
+		const statusPage = await req.db.createStatusPage(req.body);
+		return res.status(200).json({
+			success: true,
+			msg: successMessages.STATUS_PAGE_CREATE,
+			data: statusPage,
+		});
+	} catch (error) {
+		next(handleError(error, SERVICE_NAME, "createStatusPage"));
+	}
+};
+
+const getStatusPageByUrl = async (req, res, next) => {
+	try {
+		await getStatusPageParamValidation.validateAsync(req.params);
+	} catch (error) {
+		next(handleValidationError(error, SERVICE_NAME));
+		return;
+	}
+
+	try {
+		const { url } = req.params;
+		const statusPage = await req.db.getStatusPageByUrl(url);
+		return res.status(200).json({
+			success: true,
+			msg: successMessages.STATUS_PAGE_BY_URL,
+			data: statusPage,
+		});
+	} catch (error) {
+		next(handleError(error, SERVICE_NAME, "getStatusPage"));
+	}
+};
+
+export { createStatusPage, getStatusPageByUrl };

Server/db/models/StatusPage.js

@@ -0,0 +1,41 @@
+import mongoose from "mongoose";
+
+const StatusPageSchema = mongoose.Schema(
+	{
+		companyName: {
+			type: String,
+			required: true,
+			default: "",
+		},
+		url: {
+			type: String,
+			required: true,
+			default: "",
+		},
+		timezone: {
+			type: String,
+			required: true,
+			default: "America/Toronto",
+		},
+		color: {
+			type: String,
+			required: true,
+			default: "#4169E1",
+		},
+		theme: {
+			type: String,
+			required: true,
+			default: "light",
+		},
+		monitors: [
+			{
+				type: mongoose.Schema.Types.ObjectId,
+				ref: "Monitor",
+				required: true,
+			},
+		],
+	},
+	{ timestamps: true }
+);
+
+export default mongoose.model("StatusPage", StatusPageSchema);

Server/db/mongo/MongoDB.js

@@ -169,6 +169,11 @@ import {
 //****************************************
 import { getAppSettings, updateAppSettings } from "./modules/settingsModule.js";
 
+//****************************************
+// Status Page
+//****************************************
+import { createStatusPage, getStatusPageByUrl } from "./modules/statusPageModule.js";
+
 export default {
 	connect,
 	disconnect,
@@ -223,4 +228,6 @@ export default {
 	deleteNotificationsByMonitorId,
 	getAppSettings,
 	updateAppSettings,
+	createStatusPage,
+	getStatusPageByUrl,
 };

Server/db/mongo/modules/statusPageModule.js

@@ -0,0 +1,47 @@
+import StatusPage from "../../models/StatusPage.js";
+import { errorMessages } from "../../../utils/messages.js";
+
+const SERVICE_NAME = "statusPageModule";
+
+const createStatusPage = async (statusPageData) => {
+	try {
+		const isUnique = await urlIsUnique(statusPageData.url);
+		if (!isUnique) {
+			const error = new Error(errorMessages.STATUS_PAGE_URL_NOT_UNIQUE);
+			error.status = 400;
+			throw error;
+		}
+		const statusPage = new StatusPage({ ...statusPageData });
+		await statusPage.save();
+		return statusPage;
+	} catch (error) {
+		error.service = SERVICE_NAME;
+		error.method = "createStatusPage";
+		throw error;
+	}
+};
+
+const getStatusPageByUrl = async (url) => {
+	try {
+		const statusPage = await StatusPage.findOne({ url });
+		if (statusPage === null || statusPage === undefined) {
+			const error = new Error(errorMessages.STATUS_PAGE_NOT_FOUND);
+			error.status = 404;
+
+			throw error;
+		}
+		return statusPage;
+	} catch (error) {
+		error.service = SERVICE_NAME;
+		error.method = "getStatusPageByUrl";
+		throw error;
+	}
+};
+
+const urlIsUnique = async (url) => {
+	const statusPage = await StatusPage.find({ url });
+	if (statusPage.length > 0) return false;
+	return true;
+};
+
+export { createStatusPage, getStatusPageByUrl };

Server/index.js

@@ -14,6 +14,7 @@ import monitorRouter from "./routes/monitorRoute.js";
 import checkRouter from "./routes/checkRoute.js";
 import maintenanceWindowRouter from "./routes/maintenanceWindowRoute.js";
 import settingsRouter from "./routes/settingsRoute.js";
+import statusPageRouter from "./routes/statusPageRoute.js";
 import { fileURLToPath } from "url";
 
 import queueRouter from "./routes/queueRoute.js";
@@ -88,6 +89,7 @@ const startApp = async () => {
 	app.use("/api/v1/checks", verifyJWT, checkRouter);
 	app.use("/api/v1/maintenance-window", verifyJWT, maintenanceWindowRouter);
 	app.use("/api/v1/queue", verifyJWT, queueRouter);
+	app.use("/api/v1/status-page", statusPageRouter);
 
 	//health check
 	app.use("/api/v1/healthy", (req, res) => {

Server/routes/statusPageRoute.js

@@ -0,0 +1,11 @@
+import express from "express";
+import { verifyJWT } from "../middleware/verifyJWT.js";
+import {
+	createStatusPage,
+	getStatusPageByUrl,
+} from "../controllers/statusPageController.js";
+const router = express.Router();
+
+router.get("/:url", getStatusPageByUrl);
+router.post("/:url", verifyJWT, createStatusPage);
+export default router;

Server/utils/messages.js

@@ -51,6 +51,10 @@ const errorMessages = {
 
 	// PING Operations
 	PING_CANNOT_RESOLVE: "No response",
+
+	// Status Page Errors
+	STATUS_PAGE_NOT_FOUND: "Status page not found",
+	STATUS_PAGE_URL_NOT_UNIQUE: "Status page url must be unique",
 };
 
 const successMessages = {
@@ -115,6 +119,10 @@ const successMessages = {
 	// App Settings
 	GET_APP_SETTINGS: "Got app settings successfully",
 	UPDATE_APP_SETTINGS: "Updated app settings successfully",
+
+	// Status Page
+	STATUS_PAGE_BY_URL: "Got status page by url successfully",
+	STATUS_PAGE_CREATE: "Status page created successfully",
 };
 
 export { errorMessages, successMessages };

Server/validation/joi.js

@@ -410,6 +410,32 @@ const updateAppSettingsBodyValidation = joi.object({
 	systemEmailPassword: joi.string().allow(""),
 });
 
+//****************************************
+// Status Page Validation
+//****************************************
+
+const getStatusPageParamValidation = joi.object({
+	url: joi.string().required(),
+});
+
+const createStatusPageBodyValidation = joi.object({
+	companyName: joi.string().required(),
+	url: joi.string().required(),
+	timezone: joi.string().required(),
+	color: joi.string().required(),
+	theme: joi.string().required(),
+	monitors: joi
+		.array()
+		.items(joi.string().pattern(/^[0-9a-fA-F]{24}$/))
+		.required()
+		.messages({
+			"string.pattern.base": "Must be a valid monitor ID",
+			"array.base": "Monitors must be an array",
+			"array.empty": "At least one monitor is required",
+			"any.required": "Monitors are required",
+		}),
+});
+
 export {
 	roleValidatior,
 	loginValidation,
@@ -465,4 +491,6 @@ export {
 	editMaintenanceWindowByIdParamValidation,
 	editMaintenanceByIdWindowBodyValidation,
 	updateAppSettingsBodyValidation,
+	createStatusPageBodyValidation,
+	getStatusPageParamValidation,
 };