[OGUI 1574] Add production enabled flag

QualityControl/.gitignore

@@ -1,5 +1,6 @@
 /config.js
 public/config.cjs
+public/index.js
 test/setup/seeders/qcg-mock-data.json
 *~
 .DS_Store

QualityControl/environmentSetup.js

@@ -0,0 +1,47 @@
+import { LogManager } from '@aliceo2/web-ui';
+import { fileURLToPath } from 'url';
+import { envIndexFiles } from './environments.js';
+import { join, dirname } from 'path';
+import fs from 'fs';
+
+/**
+ * Initializes environment-specific JavaScript file and logging configuration.
+ * - Copies the appropriate environment-specific index.js file (dev/prod/test) to index.js
+ * - Sets up test environment mocks when in test mode
+ * @async
+ * @function initializeEnvironment
+ * @returns {Promise<Logger>} logger instance
+ * @description
+ * This function performs environment setup tasks:
+ * 1. Determines correct environment-specific JS file based on NODE_ENV
+ * 2. Copies the environment-specific file to index.js in public directory
+ * 3. Initializes test mocks when in test environment
+ * 4. Returns a configured logger instance
+ */
+export default async function () {
+  const { NODE_ENV, npm_config_log_label } = process.env;
+  const logger = LogManager.getLogger(`${npm_config_log_label ?? 'qcg'}/index`);
+
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+
+  const envIndexFile = envIndexFiles[NODE_ENV];
+
+  const publicDir = join(__dirname, 'public');
+  const sourceJsPath =
+    join(publicDir, envIndexFiles[NODE_ENV]); // These files will have different properties per environment
+  const targetJsPath = join(publicDir, 'index.js'); // the former file will be overwrite this file.
+
+  fs.copyFileSync(sourceJsPath, targetJsPath);
+  logger.infoMessage(`Using ${envIndexFile} as index.js for environment: ${process.env.NODE_ENV}`);
+
+  if (NODE_ENV === 'test') {
+    // Initialize nock for CCDB and Bookkeeping only if we are in test environment
+    const { initializeNockForCcdb } = await import('./test/setup/testSetupForCcdb.js');
+    const { initializeNockForBkp } = await import('./test/setup/testSetupForBkp.js');
+
+    initializeNockForCcdb();
+    initializeNockForBkp();
+  }
+
+  return logger;
+}

QualityControl/environments.js

@@ -0,0 +1,5 @@
+export const envIndexFiles = Object.freeze({
+  development: 'index.dev.js',
+  test: 'index.test.js',
+  production: 'index.production.js',
+});

QualityControl/index.js

@@ -12,49 +12,36 @@
  * or submit itself to any jurisdiction.
  */
 
-import { LogManager, HttpServer, WebSocket } from '@aliceo2/web-ui';
-const logger = LogManager.getLogger(`${process.env.npm_config_log_label ?? 'qcg'}/index`);
-import path from 'path';
+import { HttpServer, WebSocket } from '@aliceo2/web-ui';
+import { join, dirname } from 'path';
 import { setup } from './lib/api.js';
-
-// Reading config file
+import { fileURLToPath } from 'url';
 import { config } from './lib/config/configProvider.js';
+import { createRequire } from 'module';
+import environmentSetup from './environmentSetup.js';
 
-// Quick check config at start
-
+const logger = await environmentSetup();
+// Reading config file
 if (config.http.tls) {
-  logger.info(`HTTPS endpoint: https://${config.http.hostname}:${config.http.portSecure}`);
+  logger.infoMessage(`HTTPS endpoint: https://${config.http.hostname}:${config.http.portSecure}`);
 }
-logger.info(`HTTP endpoint: http://${config.http.hostname}:${config.http.port}`);
+logger.infoMessage(`HTTP endpoint: http://${config.http.hostname}:${config.http.port}`);
 if (typeof config.demoData != 'undefined' && config.demoData) {
-  logger.info('Using demo data');
+  logger.infoMessage('Using demo data');
 } else {
   config.demoData = false;
 }
 
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
 const __dirname = dirname(fileURLToPath(import.meta.url));
-// Start servers
-const http = new HttpServer(config.http, config.jwt, config.openId);
-http.addStaticPath(path.join(__dirname, 'common'));
-http.addStaticPath(path.join(__dirname, 'public'));
-
-import { createRequire } from 'module';
-
 const require = createRequire(import.meta.url);
 const pathName = require.resolve('jsroot');
-http.addStaticPath(path.join(pathName, '../..'), 'jsroot');
 
-const ws = new WebSocket(http);
+// Start servers
+const http = new HttpServer(config.http, config.jwt, config.openId);
+http.addStaticPath(join(__dirname, 'common'));
+http.addStaticPath(join(__dirname, 'public'));
+http.addStaticPath(join(pathName, '../..'), 'jsroot');
 
-if (process.env.NODE_ENV === 'test') {
-  // Initialize nock for CCDB and Bookkeeping only if we are in test environment
-  const { initializeNockForCcdb } = await import('./test/setup/testSetupForCcdb.js');
-  const { initializeNockForBkp } = await import('./test/setup/testSetupForBkp.js');
+const ws = new WebSocket(http);
 
-  initializeNockForCcdb();
-  initializeNockForBkp();
-}
 setup(http, ws);

QualityControl/lib/dtos/QCObjectNameDto.js

@@ -0,0 +1,80 @@
+/**
+ * @license
+ * Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+ * See http://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+ * All rights not expressly granted are reserved.
+ *
+ * This software is distributed under the terms of the GNU General Public
+ * License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+import Joi from 'joi';
+import { LogManager } from '@aliceo2/web-ui';
+
+const logger = LogManager.getLogger(`${process.env.npm_config_log_label ?? 'qcg'}/qcObj-Dto`);
+
+/**
+ * Validates if a path segment is valid (non-empty and no whitespace)
+ * @param {string} path - The path to validate
+ * @returns {boolean} True if the path is valid
+ */
+function isValidPath(path) {
+  if (typeof path !== 'string' || path === '') {
+    logger.debugMessage(`Invalid path: Path is empty or not a string (${path})`);
+    return false;
+  }
+
+  if (path.endsWith('/')) {
+    logger.debugMessage(`Invalid path: Path ends with a slash (${path})`);
+    return false;
+  }
+
+  let segmentStart = 0;
+  for (let i = 0; i <= path.length; i++) {
+    const char = path[i];
+
+    if (i === path.length || char === '/') {
+      const segment = path.slice(segmentStart, i);
+      const hasWhitespace = /\s/.test(segment);
+      if (segment.length === 0) {
+        logger.debugMessage(`Invalid path: Empty segment found in path (${path})`);
+        return false;
+      }
+      if (hasWhitespace) {
+        logger.debugMessage(`Invalid path: Segment contains whitespace (${segment}) in path (${path})`);
+        return false;
+      }
+      segmentStart = i + 1;
+    }
+  }
+  return true;
+}
+
+/**
+ * Joi schema that validates the path
+ */
+export const qcObjectNameDto = Joi.string()
+  .custom((value) => {
+    if (!isValidPath(value)) {
+      logger.debugMessage(`Found invalid QC object name: ${value}`);
+      return value;
+    }
+    return value;
+  }, 'QC Object Name Validator');
+
+export const qcObjectNameArrayDto = Joi.array()
+  .items(qcObjectNameDto)
+  .custom((value) => {
+    const filtered = value.filter((item) => isValidPath(item));
+
+    if (filtered.length !== value.length) {
+      logger.debugMessage(`Filtered ${value.length - filtered.length} invalid QC object names from array`);
+    }
+
+    return filtered;
+  }, 'QC Object Array Validator')
+  .options({ stripUnknown: { arrays: true } });

QualityControl/lib/services/ccdb/CcdbService.js

@@ -17,6 +17,7 @@ import { httpHeadJson, httpGetJson } from '../../utils/httpRequests.js';
 import {
   CCDB_MONITOR, CCDB_VERSION_KEY, CCDB_RESPONSE_BODY_KEYS, CCDB_FILTER_FIELDS, CCDB_RESPONSE_HEADER_KEYS,
 } from './CcdbConstants.js';
+import { qcObjectNameArrayDto } from '../../dtos/QCObjectNameDto.js';
 
 const {
   LAST_MODIFIED, VALID_FROM, VALID_UNTIL, CREATED, PATH, SIZE, FILE_NAME, METADATA, ID,
@@ -107,12 +108,13 @@ export class CcdbService {
    * @rejects {Error}
    */
   async getObjectsTreeList(prefix = this._PREFIX) {
-    const { subfolders } = await httpGetJson(this._hostname, this._port, `/tree/${prefix}.*`);
+    let { subfolders } = await httpGetJson(this._hostname, this._port, `/tree/${prefix}.*`);
 
     if (!Array.isArray(subfolders)) {
       throw new FailedDependencyError('Invalid response format from server - expected subfolders array');
     }
-    // console.log(await this.getObjectsLatestVersionList(prefix));
+
+    subfolders = await qcObjectNameArrayDto.validateAsync(subfolders);
 
     return subfolders.map((folder) => ({ path: folder }));
   }

QualityControl/package.json

@@ -18,8 +18,8 @@
   "type": "module",
   "homepage": "https://alice-o2-project.web.cern.ch/",
   "scripts": {
-    "start": "node index.js",
-    "dev": "nodemon --watch index.js --watch lib --watch config.js index.js",
+    "start": "cross-env NODE_ENV=production node index.js",
+    "dev": "cross-env NODE_ENV=development nodemon --watch index.js --watch lib --watch config.js index.js",
     "lint": "./node_modules/.bin/eslint --config eslint.config.js lib public",
     "coverage-lcov": "node --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info test/test-index.js",
     "coverage-local": "node --test --experimental-test-coverage --test-reporter=spec test/test-index.js",
@@ -38,6 +38,7 @@
   ],
   "dependencies": {
     "@aliceo2/web-ui": "2.8.4",
+    "cross-env": "^7.0.3",
     "joi": "17.13.3",
     "jsroot": "7.9.0",
     "mariadb": "^3.4.1",

QualityControl/public/app.css

@@ -23,7 +23,12 @@
   100% { opacity: 1; }
 }
 
-.object-selectable { cursor: pointer; text-decoration: none; }
+.object-selectable { 
+  cursor: pointer; 
+  text-decoration: none; 
+  display: block;
+  padding: 0.3em;
+}
 .object-selectable:hover { cursor: pointer; background-color: var(--color-gray-dark) !important; color: var(--color-gray-lighter); }
 
 .layout-selectable { border: 0.0em solid var(--color-primary); transition: border 0.1s; }
@@ -62,6 +67,30 @@
   height: 100%;
 }
 
+.heading {
+  font-weight: bold;
+  padding: 0.3em;
+  background-color: var(--color-gray-light);
+}
+
+.root-tree {
+  list-style-type: none;
+  margin: 0;
+  padding-left: 0.1em;
+}
+
+ul.object-tree-list { 
+  list-style-type: none;
+  margin: 0;
+  padding-left: 1em;
+}
+
+li.object-tree-branch, ul.object-tree-list {
+  display: flex;
+  flex-direction: column;
+}
+
+
 .folderHeader, .cardHeader {
   border-radius: .5rem .5rem 0 0;
 }
@@ -75,6 +104,14 @@
 .jsroot-container {}
 .jsroot-container pre { background-color: initial; }
 .jsrootdiv:hover + .resize-element, .resize-element:hover{ display: flex !important; }
+.jsrootdiv {
+  z-index: 90;
+  overflow: hidden;
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+}
+
 
 .resize-button { position: absolute; right: 0%; z-index: 100 }
 
@@ -100,3 +137,7 @@
   border: 1px solid #ddd;
   background: var(--color-gray-light);
 }
+
+/* Standardised styles to potentially be moved to bootstrap */
+.ph0 { padding-left: 0; padding-right: 0; }
+.pv0 { padding-top: 0; padding-bottom: 0; }