Merge pull request #2974 from bluewave-labs/fix/cleanup

move v1 to v1 dir, add build workflow

.github/workflows/build-check.yml

@@ -0,0 +1,23 @@
+name: Build Check (Server)
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build-server:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install server dependencies
+        working-directory: server
+        run: npm install
+
+      - name: Check server formatting
+        working-directory: server
+        run: npm run build

server/src/app.js

@@ -1,16 +1,16 @@
 import express from "express";
 import path from "path";
-import { responseHandler } from "./middleware/responseHandler.js";
+import { responseHandler } from "./middleware/v1/responseHandler.js";
 import cors from "cors";
 import helmet from "helmet";
 import compression from "compression";
 import cookieParser from "cookie-parser";
-import languageMiddleware from "./middleware/languageMiddleware.js";
+import languageMiddleware from "./middleware/v1/languageMiddleware.js";
 import swaggerUi from "swagger-ui-express";
-import { handleErrors } from "./middleware/handleErrors.js";
+import { handleErrors } from "./middleware/v1/handleErrors.js";
 import { setupRoutes } from "./config/routes.js";
-import { generalApiLimiter } from "./middleware/rateLimiter.js";
-import { sanitizeBody, sanitizeQuery } from "./middleware/sanitization.js";
+import { generalApiLimiter } from "./middleware/v1/rateLimiter.js";
+import { sanitizeBody, sanitizeQuery } from "./middleware/v1/sanitization.js";
 
 export const createApp = ({ services, controllers, envSettings, frontendPath, openApiSpec }) => {
 	const allowedOrigin = envSettings.clientHost;

server/src/config/routes.js

@@ -1,5 +1,5 @@
-import { verifyJWT } from "../middleware/verifyJWT.js";
-import { authApiLimiter } from "../middleware/rateLimiter.js";
+import { verifyJWT } from "../middleware/v1/verifyJWT.js";
+import { authApiLimiter } from "../middleware/v1/rateLimiter.js";
 
 import AuthRoutes from "../routes/v1/authRoute.js";
 import InviteRoutes from "../routes/v1//inviteRoute.js";

server/src/config/services.js

@@ -1,22 +1,22 @@
-import ServiceRegistry from "../service/system/serviceRegistry.js";
-import TranslationService from "../service/system/translationService.js";
-import StringService from "../service/system/stringService.js";
+import ServiceRegistry from "../service/v1/system/serviceRegistry.js";
+import TranslationService from "../service/v1/system/translationService.js";
+import StringService from "../service/v1/system/stringService.js";
 import MongoDB from "../db/mongo/MongoDB.js";
-import NetworkService from "../service/infrastructure/networkService.js";
-import EmailService from "../service/infrastructure/emailService.js";
-import BufferService from "../service/infrastructure/bufferService.js";
-import StatusService from "../service/infrastructure/statusService.js";
-import NotificationUtils from "../service/infrastructure/notificationUtils.js";
-import NotificationService from "../service/infrastructure/notificationService.js";
-import ErrorService from "../service/infrastructure/errorService.js";
-import SuperSimpleQueueHelper from "../service/infrastructure/SuperSimpleQueue/SuperSimpleQueueHelper.js";
-import SuperSimpleQueue from "../service/infrastructure/SuperSimpleQueue/SuperSimpleQueue.js";
-import UserService from "../service/business/userService.js";
-import CheckService from "../service/business/checkService.js";
-import DiagnosticService from "../service/business/diagnosticService.js";
-import InviteService from "../service/business/inviteService.js";
-import MaintenanceWindowService from "../service/business/maintenanceWindowService.js";
-import MonitorService from "../service/business/monitorService.js";
+import NetworkService from "../service/v1/infrastructure/networkService.js";
+import EmailService from "../service/v1/infrastructure/emailService.js";
+import BufferService from "../service/v1/infrastructure/bufferService.js";
+import StatusService from "../service/v1/infrastructure/statusService.js";
+import NotificationUtils from "../service/v1/infrastructure/notificationUtils.js";
+import NotificationService from "../service/v1/infrastructure/notificationService.js";
+import ErrorService from "../service/v1/infrastructure/errorService.js";
+import SuperSimpleQueueHelper from "../service/v1/infrastructure/SuperSimpleQueue/SuperSimpleQueueHelper.js";
+import SuperSimpleQueue from "../service/v1/infrastructure/SuperSimpleQueue/SuperSimpleQueue.js";
+import UserService from "../service/v1/business/userService.js";
+import CheckService from "../service/v1/business/checkService.js";
+import DiagnosticService from "../service/v1/business/diagnosticService.js";
+import InviteService from "../service/v1/business/inviteService.js";
+import MaintenanceWindowService from "../service/v1/business/maintenanceWindowService.js";
+import MonitorService from "../service/v1/business/monitorService.js";
 import papaparse from "papaparse";
 import axios from "axios";
 import got from "got";

server/src/controllers/v1/baseController.js

@@ -1,4 +1,4 @@
-import { AppError } from "../../service/infrastructure/errorService.js";
+import { AppError } from "../../service/v1/infrastructure/errorService.js";
 
 export const createCommonDependencies = (db, errorService, logger, stringService) => {
 	return {

server/src/index.js

@@ -7,7 +7,7 @@ import path from "path";
 import fs from "fs";
 
 import Logger from "./utils/logger.js";
-import SettingsService from "./service/system/settingsService.js";
+import SettingsService from "./service/v1/system/settingsService.js";
 import AppSettings from "./db/models/AppSettings.js";
 
 const SERVICE_NAME = "Server";

server/src/middleware/v1/handleErrors.js

@@ -1,6 +1,6 @@
-import { logger } from "../utils/logger.js";
-import ServiceRegistry from "../service/system/serviceRegistry.js";
-import StringService from "../service/system/stringService.js";
+import { logger } from "../../utils/logger.js";
+import ServiceRegistry from "../../service/v1/system/serviceRegistry.js";
+import StringService from "../../service/v1/system/stringService.js";
 
 const handleErrors = (error, req, res, next) => {
 	const status = error.status || 500;

server/src/middleware/v1/isAllowed.js

@@ -1,9 +1,9 @@
 import jwt from "jsonwebtoken";
 const TOKEN_PREFIX = "Bearer ";
 const SERVICE_NAME = "allowedRoles";
-import ServiceRegistry from "../service/system/serviceRegistry.js";
-import StringService from "../service/system/stringService.js";
-import SettingsService from "../service/system/settingsService.js";
+import ServiceRegistry from "../../service/v1/system/serviceRegistry.js";
+import StringService from "../../service/v1/system/stringService.js";
+import SettingsService from "../../service/v1/system/settingsService.js";
 
 const isAllowed = (allowedRoles) => {
 	return (req, res, next) => {

server/src/middleware/v1/languageMiddleware.js

@@ -1,4 +1,4 @@
-import { logger } from "../utils/logger.js";
+import { logger } from "../../utils/logger.js";
 
 const languageMiddleware = (stringService, translationService) => async (req, res, next) => {
 	try {

server/src/middleware/v1/verifyJWT.js

@@ -1,7 +1,7 @@
 import jwt from "jsonwebtoken";
-import ServiceRegistry from "../service/system/serviceRegistry.js";
-import SettingsService from "../service/system/settingsService.js";
-import StringService from "../service/system/stringService.js";
+import ServiceRegistry from "../../service/v1/system/serviceRegistry.js";
+import SettingsService from "../../service/v1/system/settingsService.js";
+import StringService from "../../service/v1/system/stringService.js";
 const SERVICE_NAME = "verifyJWT";
 const TOKEN_PREFIX = "Bearer ";
 

server/src/middleware/v1/verifyOwnership.js

@@ -1,6 +1,6 @@
-import { logger } from "../utils/logger.js";
-import ServiceRegistry from "../service/system/serviceRegistry.js";
-import StringService from "../service/system/stringService.js";
+import { logger } from "../../utils/logger.js";
+import ServiceRegistry from "../../service/v1/system/serviceRegistry.js";
+import StringService from "../../service/v1/system/stringService.js";
 import { ObjectId } from "mongodb";
 
 const SERVICE_NAME = "verifyOwnership";

server/src/middleware/v1/verifySuperAdmin.js

@@ -1,5 +1,5 @@
 const jwt = require("jsonwebtoken");
-const logger = require("../utils/logger");
+const logger = require("../../utils/logger.js");
 const SERVICE_NAME = "verifyAdmin";
 const TOKEN_PREFIX = "Bearer ";
 import ServiceRegistry from "../service/serviceRegistry.js";

server/src/routes/v1/authRoute.js

@@ -1,6 +1,6 @@
 import { Router } from "express";
-import { verifyJWT } from "../../middleware/verifyJWT.js";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { verifyJWT } from "../../middleware/v1/verifyJWT.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 import multer from "multer";
 
 const upload = multer();

server/src/routes/v1/checkRoute.js

@@ -1,6 +1,6 @@
 import { Router } from "express";
 
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 
 class CheckRoutes {
 	constructor(checkController) {

server/src/routes/v1/diagnosticRoute.js

@@ -1,6 +1,6 @@
 import { Router } from "express";
-import { verifyJWT } from "../../middleware/verifyJWT.js";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { verifyJWT } from "../../middleware/v1/verifyJWT.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 
 class DiagnosticRoutes {
 	constructor(diagnosticController) {

server/src/routes/v1/inviteRoute.js

@@ -1,6 +1,6 @@
 import { Router } from "express";
-import { verifyJWT } from "../../middleware/verifyJWT.js";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { verifyJWT } from "../../middleware/v1/verifyJWT.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 
 class InviteRoutes {
 	constructor(inviteController) {

server/src/routes/v1/logRoutes.js

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 class LogRoutes {
 	constructor(logController) {
 		this.router = Router();

server/src/routes/v1/monitorRoute.js

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 import multer from "multer";
 import { fetchMonitorCertificate } from "../../controllers/v1/controllerUtils.js";
 const upload = multer({

server/src/routes/v1/queueRoute.js

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 class QueueRoutes {
 	constructor(queueController) {
 		this.router = Router();

server/src/routes/v1/settingsRoute.js

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { isAllowed } from "../../middleware/isAllowed.js";
+import { isAllowed } from "../../middleware/v1/isAllowed.js";
 
 class SettingsRoutes {
 	constructor(settingsController) {

server/src/routes/v1/statusPageRoute.js

@@ -1,5 +1,5 @@
 import { Router } from "express";
-import { verifyJWT } from "../../middleware/verifyJWT.js";
+import { verifyJWT } from "../../middleware/v1/verifyJWT.js";
 import multer from "multer";
 const upload = multer();
 

server/src/service/v1/business/monitorService.js

@@ -1,4 +1,4 @@
-import { createMonitorsBodyValidation } from "../../validation/joi.js";
+import { createMonitorsBodyValidation } from "../../../validation/joi.js";
 
 const SERVICE_NAME = "MonitorService";
 class MonitorService {

server/src/service/v1/infrastructure/SuperSimpleQueue/SuperSimpleQueueHelper.js

@@ -5,11 +5,11 @@ class SuperSimpleQueueHelper {
 
 	/**
 	 * @param {{
-	 * 	db: import("../database").Database,
-	 * 	logger: import("../logger").Logger,
-	 * 	networkService: import("../networkService").NetworkService,
-	 * 	statusService: import("../statusService").StatusService,
-	 * 	notificationService: import("../notificationService").NotificationService
+	 * 	db: import("../database.js").Database,
+	 * 	logger: import("../logger.js").Logger,
+	 * 	networkService: import("../networkService.js").NetworkService,
+	 * 	statusService: import("../statusService.js").StatusService,
+	 * 	notificationService: import("../notificationService.js").NotificationService
 	 * }}
 	 */
 	constructor({ db, logger, networkService, statusService, notificationService }) {

server/src/service/v1/infrastructure/statusService.js

@@ -1,4 +1,4 @@
-import MonitorStats from "../../db/models/MonitorStats.js";
+import MonitorStats from "../../../db/models/MonitorStats.js";
 const SERVICE_NAME = "StatusService";
 
 class StatusService {

server/src/service/v2/business/AuthService.ts

@@ -3,6 +3,45 @@ import { User, Role, ITokenizedUser } from "../../../db/models/index.js";
 import ApiError from "../../../utils/ApiError.js";
 import { Types } from "mongoose";
 
+export const PERMISSIONS = {
+	users: {
+		all: "users.*",
+		create: "users.create",
+		view: "users.view",
+		update: "users.update",
+		delete: "users.delete",
+	},
+
+	monitors: {
+		all: "monitors.*",
+		create: "monitors.create",
+		view: "monitors.view",
+		update: "monitors.update",
+		delete: "monitors.delete",
+	},
+	notifications: {
+		all: "notifications.*",
+		create: "notifications.create",
+		view: "notifications.view",
+		update: "notifications.update",
+		delete: "notifications.delete",
+	},
+	checks: {
+		all: "checks.*",
+		create: "checks.create",
+		view: "checks.view",
+		update: "checks.update",
+		delete: "checks.delete",
+	},
+	statusPages: {
+		all: "statusPages.*",
+		create: "statusPages.create",
+		view: "statusPages.view",
+		update: "statusPages.update",
+		delete: "statusPages.delete",
+	},
+};
+
 export const DEFAULT_ROLES = [
 	{
 		name: "SuperAdmin",
@@ -13,19 +52,19 @@ export const DEFAULT_ROLES = [
 	{
 		name: "Admin",
 		description: "Admin with full permissions",
-		permissions: ["monitor.*", "users.*"],
+		permissions: [PERMISSIONS.monitors.all, PERMISSIONS.users.all],
 		isSystem: true,
 	},
 	{
 		name: "Manager",
 		description: "Can manage users",
-		permissions: ["users.create", "users.update", "monitors.*"],
+		permissions: [PERMISSIONS.users.create, PERMISSIONS.users.update, PERMISSIONS.monitors.all],
 		isSystem: true,
 	},
 	{
 		name: "Member",
 		description: "Basic team member",
-		permissions: ["users.update", "monitors.create", "monitors.view", "monitors.update"],
+		permissions: [PERMISSIONS.users.update, PERMISSIONS.monitors.create, PERMISSIONS.monitors.view, PERMISSIONS.monitors.update],
 		isSystem: true,
 	},
 ];
@@ -126,7 +165,7 @@ class AuthService implements IAuthService {
 		}
 
 		// Check password
-		const isPasswordValid = await bcrypt.compare(password, user.passwordHash);
+		const isPasswordValid = await bcrypt.compare(password, user.password);
 		if (!isPasswordValid) {
 			throw new Error("Invalid email or password");
 		}

server/src/types/express.d.ts

@@ -0,0 +1,10 @@
+import { ITokenizedUser } from "../db/models/index.ts";
+
+declare global {
+	namespace Express {
+		interface Request {
+			user?: ITokenizedUser;
+			resource?: any;
+		}
+	}
+}