[OGUI-1621] Refactor controllers and sync frontend with services

QualityControl/config-default.js

@@ -49,6 +49,8 @@ export const config = {
     timezone: '+00:00',
     logging: false,
     retryThrottle: 5000,
+     //forceSeed: true, --- ONLY IN DEVELOPMENT ---
+    //drop: true, --- ONLY IN DEVELOPMENT ---
   },
   bookkeeping: {
     url: 'http://localhost:4000', // local insance

QualityControl/docker-compose.yml

@@ -22,7 +22,7 @@ services:
         target: /docker-entrypoint-initdb.d
     # Max total time for the container to start 2 mins (20s + 5*20s)
     healthcheck:
-      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-p${MYSQL_ROOT_PASSWORD:-cern}"]
       interval: 20s
       timeout: 20s
       retries: 5

QualityControl/docs/Configuration.md

@@ -86,16 +86,20 @@ qc: {
 ### Database Configuration
 
 The application requires the following database configuration parameters:
-| **Field**       | **Description**                                                                             |
-|-----------------|---------------------------------------------------------------------------------------------|
-| `host`          | Hostname or IP address of the database server.                                              |
-| `port`          | Port number used to connect to the database server.                                         |
-| `username`      | Username for authenticating with the database.                                              |
-| `password`      | Password for the specified database user.                                                   |
-| `database`      | Name of the database to connect to.                                                         |
-| `charset`       | Character encoding used for the connection.                                                 |
-| `collate`       | Collation setting used for string comparison and sorting.                                   |
-| `timezone`      | Time zone used for all date/time values in the database connection.                         |
-| `logging`       | Enables or disables SQL query logging (useful for debugging).                               |
-| `retryThrottle` | Time in milliseconds to wait before retrying a failed database connection.                  |
-| `migrationSeed` | *(Optional)* Set to `true` to execute seeders that populate the database with mock data.   |
+
+| **Field**       | **Type**    | **Description**                                                                             | **Default Value**         |
+|-----------------|-------------|---------------------------------------------------------------------------------------------|---------------------------|
+| `host`          | `string`    | Hostname or IP address of the database server.                                              | `'database'`             |
+| `port`          | `number`    | Port number used to connect to the database server.                                         | `3306`                    |
+| `username`      | `string`    | Username for authenticating with the database.                                              | `'cern'`                  |
+| `password`      | `string`    | Password for the specified database user.                                                   | `'cern'`                  |
+| `database`      | `string`    | Name of the database to connect to.                                                         | `'qcg'`                   |
+| `charset`       | `string`    | Character encoding used for the connection.                                                 | `'utf8mb4'`               |
+| `collate`       | `string`    | Collation setting used for string comparison and sorting.                                   | `'utf8mb4_unicode_ci'`    |
+| `timezone`      | `string`    | Time zone used for all date/time values in the database connection.                         | `'+00:00'`                |
+| `logging`       | `boolean`   | Enables or disables SQL query logging (useful for debugging).                               | `false`                   |
+| `retryThrottle` | `number`    | Time in milliseconds to wait before retrying a failed database connection.                  | `5000`                    |
+| `forceSeed`     | `boolean`   | (for dev mode) Force seeding the database with mock data. **Warning:** Not recommended for production use. | `false`                   |
+| `drop`          | `boolean`   | (for dev mode) Force deleting the data from the database when server starts. **Warning:** This will erase all data—never use in production. | `false`                   |
+
+To know more about the database configuration, please go to: [Database Setup](./Database.md)

QualityControl/docs/Database.md

@@ -0,0 +1,79 @@
+# Database Setup and Configuration
+
+This document explains how to set up and configure the database for development and testing purposes.
+
+## Development Database Setup
+
+There are two ways to set up a database for development:
+
+### Option 1: Docker (Recommended)
+
+The easiest way to get started is using Docker with the default configuration:
+
+```bash
+npm run docker-dev
+```
+
+This command will:
+- Start the database container using Docker Compose
+- Use the default configuration settings
+- Set up the database ready for development
+
+### Option 2: Local MariaDB Installation
+
+For a local MariaDB setup, you'll need to install MariaDB on your system first.
+
+**Installation Guide:** [MariaDB Getting Started](https://mariadb.com/get-started-with-mariadb/)
+
+After installing MariaDB locally, configure your application to connect to your local database instance by updating the appropriate configuration files.
+
+## Testing Database Setup
+
+For running tests, Docker must be installed and running on your system.
+
+To set up the test database:
+
+```bash
+npm run docker-test
+```
+
+This command will:
+- Start a test database container
+- Automatically seed the database with mock data prepared specifically for testing
+- Ensure a clean testing environment
+
+## Database Seeding and Configuration
+
+### Development Seeding
+
+For development purposes, you can seed the database with mock data by setting `forceSeed` to `true` in your configuration.
+
+**Important Notes:**
+- When `forceSeed` is enabled, seeding will execute every time the server reloads
+- The `drop` property will clean all data from the database if set to `true` every time the server reloads
+- Use these options carefully to avoid unintended data loss
+
+### Migrations
+
+Database migrations will be executed automatically if they haven't been run before.
+
+**Clean Setup Recommendation:**
+For a completely clean database setup, it's recommended to run:
+
+```bash
+docker compose down database -v
+```
+
+And delete all existing data.
+
+**WARNING:** Only perform this clean setup the first time or when you specifically need to reset everything, as it will permanently delete all database data.
+
+## Current Status
+
+**Important:** The database is currently not being used by the application or tests, as the services and controllers are not yet configured to utilize the database layer. This functionality is planned for future implementation.
+
+## Database Management Commands
+
+- `npm run docker-dev` - Start development database
+- `npm run docker-test` - Start test database with mock data
+- `docker compose down database -v` - Clean database setup (removes all data)

QualityControl/jsconfig.json

@@ -9,5 +9,7 @@
     "public/**/*.js",
     "lib/**/*.js",
     "test/**/*.js",
-    "lib/database/migrations/*.mjs"  ]
+    "lib/database/migrations/*.mjs",
+    "lib/database/seeders/*.mjs"   
+  ]
 }

QualityControl/lib/QCModel.js

@@ -23,7 +23,6 @@ import { Kafka, logLevel } from 'kafkajs';
 import { CcdbService } from './services/ccdb/CcdbService.js';
 import { IntervalsService } from './services/Intervals.service.js';
 import { StatusService } from './services/Status.service.js';
-import { JsonFileService } from './services/JsonFileService.js';
 import { QcObjectService } from './services/QcObject.service.js';
 import { FilterService } from './services/FilterService.js';
 import { BookkeepingService } from './services/BookkeepingService.js';
@@ -36,9 +35,6 @@ import { FilterController } from './controllers/FilterController.js';
 import { UserController } from './controllers/UserController.js';
 
 import { config } from './config/configProvider.js';
-import { LayoutRepository } from './repositories/LayoutRepository.js';
-import { UserRepository } from './repositories/UserRepository.js';
-import { ChartRepository } from './repositories/ChartRepository.js';
 import { initDatabase } from './database/index.js';
 import { SequelizeDatabase } from './database/SequelizeDatabase.js';
 import { objectGetByIdValidationMiddlewareFactory }
@@ -49,6 +45,9 @@ import { objectGetContentsValidationMiddlewareFactory }
 import { RunModeService } from './services/RunModeService.js';
 import { KafkaConfigDto } from './dtos/KafkaConfigurationDto.js';
 import { QcdbDownloadService } from './services/QcdbDownload.service.js';
+import { LayoutService } from './services/layout/LayoutService.js';
+import { setupRepositories } from './database/repositories/index.js';
+import { UserService } from './services/layout/UserService.js';
 const LOG_FACILITY = `${process.env.npm_config_log_label ?? 'qcg'}/model-setup`;
 
 /**
@@ -63,10 +62,13 @@ export const setupQcModel = async (eventEmitter) => {
   const __dirname = dirname(__filename);
   const packageJSON = JSON.parse(readFileSync(`${__dirname}/../package.json`));
 
-  const jsonFileService = new JsonFileService(config.dbFile || `${__dirname}/../db.json`);
-  if (config.database) {
-    initDatabase(new SequelizeDatabase(config?.database || {}));
+  const databaseConfig = config.database || {};
+  if (!databaseConfig || Object.keys(databaseConfig).length === 0) {
+    logger.errorMessage('Database configuration is not provided. The application cannot be initialized');
+    return;
   }
+  const sequelizeDatabase = new SequelizeDatabase(databaseConfig);
+  initDatabase(sequelizeDatabase, { forceSeed: config?.database?.forceSeed, drop: config?.database?.drop });
 
   if (config?.kafka?.enabled) {
     try {
@@ -85,12 +87,29 @@ export const setupQcModel = async (eventEmitter) => {
     }
   }
 
-  const layoutRepository = new LayoutRepository(jsonFileService);
-  const userRepository = new UserRepository(jsonFileService);
-  const chartRepository = new ChartRepository(jsonFileService);
+  const {
+    layoutRepository,
+    gridTabCellRepository,
+    userRepository,
+    tabRepository,
+    chartRepository,
+    chartOptionRepository,
+    optionRepository,
+  } = setupRepositories(sequelizeDatabase);
+
+  const userService = new UserService(userRepository);
+  const layoutService = new LayoutService(
+    layoutRepository,
+    userService,
+    tabRepository,
+    gridTabCellRepository,
+    chartRepository,
+    chartOptionRepository,
+    optionRepository,
+  );
 
-  const userController = new UserController(userRepository);
-  const layoutController = new LayoutController(layoutRepository);
+  const userController = new UserController(userService);
+  const layoutController = new LayoutController(layoutService);
 
   const statusService = new StatusService({ version: packageJSON?.version ?? '-' }, { qc: config.qc ?? {} });
   const statusController = new StatusController(statusService);
@@ -100,7 +119,7 @@ export const setupQcModel = async (eventEmitter) => {
   const ccdbService = CcdbService.setup(config.ccdb);
   statusService.dataService = ccdbService;
 
-  const qcObjectService = new QcObjectService(ccdbService, chartRepository, { openFile, toJSON });
+  const qcObjectService = new QcObjectService(ccdbService, layoutService, { openFile, toJSON });
   qcObjectService.refreshCache();
 
   const intervalsService = new IntervalsService();
@@ -125,9 +144,8 @@ export const setupQcModel = async (eventEmitter) => {
     statusController,
     objectController,
     intervalsService,
+    layoutService,
     filterController,
-    layoutRepository,
-    jsonFileService,
     objectGetByIdValidation,
     objectsGetValidation,
     objectGetContentsValidation,

QualityControl/lib/api.js

@@ -16,8 +16,6 @@ import { setupQcModel } from './QCModel.js';
 import { minimumRoleMiddleware } from './middleware/minimumRole.middleware.js';
 import { UserRole } from './../common/library/userRole.enum.js';
 import { layoutOwnerMiddleware } from './middleware/layouts/layoutOwner.middleware.js';
-import { layoutIdMiddleware } from './middleware/layouts/layoutId.middleware.js';
-import { layoutServiceMiddleware } from './middleware/layouts/layoutService.middleware.js';
 import { statusComponentMiddleware } from './middleware/status/statusComponent.middleware.js';
 import { runStatusFilterMiddleware } from './middleware/filters/runStatusFilter.middleware.js';
 import { runModeMiddleware } from './middleware/filters/runMode.middleware.js';
@@ -39,7 +37,6 @@ export const setup = async (http, ws, eventEmitter) => {
    *   statusController: import('./controllers/StatusController.js').StatusController,
    *   statusService: import('./services/statusService').StatusService,
    *   userController: import('./controllers/UserController.js').UserController,
-   *   jsonFileService: import('./services/JsonFileService.js').JsonFileService
    * }}
    */
   const {
@@ -48,8 +45,7 @@ export const setup = async (http, ws, eventEmitter) => {
     statusController,
     statusService,
     userController,
-    layoutRepository,
-    jsonFileService,
+    layoutService,
     filterController,
     objectGetByIdValidation,
     objectsGetValidation,
@@ -75,23 +71,17 @@ export const setup = async (http, ws, eventEmitter) => {
   http.post('/layout', layoutController.postLayoutHandler.bind(layoutController));
   http.put(
     '/layout/:id',
-    layoutServiceMiddleware(jsonFileService),
-    layoutIdMiddleware(layoutRepository),
-    layoutOwnerMiddleware(layoutRepository),
+    layoutOwnerMiddleware(layoutService),
     layoutController.putLayoutHandler.bind(layoutController),
   );
   http.patch(
     '/layout/:id',
-    layoutServiceMiddleware(jsonFileService),
-    layoutIdMiddleware(layoutRepository),
     minimumRoleMiddleware(UserRole.GLOBAL),
     layoutController.patchLayoutHandler.bind(layoutController),
   );
   http.delete(
     '/layout/:id',
-    layoutServiceMiddleware(jsonFileService),
-    layoutIdMiddleware(layoutRepository),
-    layoutOwnerMiddleware(layoutRepository),
+    layoutOwnerMiddleware(layoutService),
     layoutController.deleteLayoutHandler.bind(layoutController),
   );
 

QualityControl/lib/config/database.js

@@ -29,5 +29,7 @@ export function getDbConfig(config) {
     timezone: config.timezone ?? '+00:00',
     logging: config.logging ?? false,
     retryThrottle: config.retryThrottle ?? 5000,
+    forceSeed: config.forceSeed ?? false,
+    drop: config.drop ?? false,
   };
 };