[O2B-1592] Add infologger listeners middleware to overview page endpoints

lib/server/Loggers/FilterLogger.js

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * 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.
+ */
+const { LogManager, LogLevel } = require('@aliceo2/web-ui');
+
+/**
+ * Logger dedicated to filter-related endpoint access events.
+ */
+class FilterLogger {
+    /**
+     * Creates an instance of FilterLogger.
+     */
+    constructor(silent = process.env.NODE_ENV === 'test') {
+        LogManager.configure({ infologger: true });
+        this._logger = LogManager.getLogger('FILTERING');
+        this._logLevel = LogLevel.OPERATIONS;
+        this._silent = silent;
+    }
+
+    /**
+     * Logs an informational message about endpoint access and applied filters.
+     *
+     * @param {object} request the request received at any given endpoint.
+     * @param {string} endpoint the endpoint that was accessed.
+     * @param {string|number} id identifier of the user accessing the endpoint.
+     * @param {Object} [filters={}] filters applied to the request.
+     * @returns {void}
+     */
+    infoMessage({ path, session: { id }, query = {} }) {
+        if (this._silent) {
+            return;
+        }
+
+        const filters = query.filters ?? {};
+
+        let message = `Endpoint ${path} was accessed by user ${id} `;
+
+        if (!Object.keys(filters).length) {
+            message += 'without filters';
+        } else {
+            message += 'with the following filters:\n';
+            message += JSON.stringify(filters);
+        }
+
+        this._logger.infoMessage(message, { level: this._logLevel });
+    }
+}
+
+module.exports = new FilterLogger();

lib/server/middleware/InfoLoggerListener.middleware.js

@@ -0,0 +1,23 @@
+/**
+ *  @license
+ *  Copyright CERN and copyright holders of ALICE O2. This software is
+ *  distributed under the terms of the GNU General Public License v3 (GPL
+ *  Version 3), copied verbatim in the file "COPYING".
+ *
+ *  See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ *  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.
+ */
+
+/**
+ * Logger based middleware generator
+ *
+ * @param {Class} logger class that exposes an infoMessage function that recceives the request and then sends specific data to InfoLogger
+ * @return {(function(*, *, *): void)} the infoLoggerListener middleware
+ */
+exports.infoLoggerListenerMiddleware = (logger) => (request, _response, next) => {
+    logger.infoMessage(request);
+    next();
+};

lib/server/routers/dataPasses.router.js

@@ -14,11 +14,13 @@
 const { DataPassesController } = require('../controllers/dataPasses.controller.js');
 const { rbacMiddleware } = require('../middleware/rbac.middleware.js');
 const { BkpRoles } = require('../../domain/enums/BkpRoles.js');
+const FilterLogger = require('../Loggers/FilterLogger.js');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware.js');
 
 exports.dataPassesRouter = {
     path: '/dataPasses',
     method: 'get',
-    controller: DataPassesController.listDataPassesHandler,
+    controller: [infoLoggerListenerMiddleware(FilterLogger), DataPassesController.listDataPassesHandler],
 
     children: [
         {

lib/server/routers/environments.router.js

@@ -12,11 +12,13 @@
  */
 
 const { EnvironmentsController } = require('../controllers');
+const FilterLogger = require('../Loggers/FilterLogger');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware');
 
 module.exports = {
     method: 'get',
     path: '/environments',
-    controller: EnvironmentsController.getAllEnvironments,
+    controller: [infoLoggerListenerMiddleware(FilterLogger), EnvironmentsController.getAllEnvironments],
     children: [
         {
             method: 'post',

lib/server/routers/lhcFills.router.js

@@ -12,13 +12,15 @@
  */
 
 const { LhcFillsController } = require('../controllers');
+const FilterLogger = require('../Loggers/FilterLogger');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware');
 
 module.exports = {
     path: '/lhcFills',
     children: [
         {
             method: 'get',
-            controller: LhcFillsController.listLhcFills,
+            controller: [infoLoggerListenerMiddleware(FilterLogger), LhcFillsController.listLhcFills],
         },
         {
             method: 'post',

lib/server/routers/lhcPeriodsStatistics.router.js

@@ -12,13 +12,15 @@
  */
 
 const { LhcPeriodStatisticsController } = require('../controllers/lhcPeriodStatistics.controller.js');
+const FilterLogger = require('../Loggers/FilterLogger.js');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware.js');
 
 exports.lhcPeriodsRouter = {
     path: '/lhcPeriodsStatistics',
     children: [
         {
             method: 'get',
-            controller: LhcPeriodStatisticsController.listLhcPeriodStatisticsHandler,
+            controller: [infoLoggerListenerMiddleware(FilterLogger), LhcPeriodStatisticsController.listLhcPeriodStatisticsHandler],
         },
         {
             method: 'get',

lib/server/routers/logs.router.js

@@ -12,12 +12,14 @@
  */
 
 const { LogsController } = require('../controllers');
+const FilterLogger = require('../Loggers/FilterLogger');
 const { multerMiddleware: { attachmentMiddleware } } = require('../middleware');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware');
 
 module.exports = {
     method: 'get',
     path: '/logs',
-    controller: LogsController.listLogs,
+    controller: [infoLoggerListenerMiddleware(FilterLogger), LogsController.listLogs],
     children: [
         {
             method: 'get',

lib/server/routers/qcFlag.router.js

@@ -13,6 +13,8 @@
 
 const { BkpRoles } = require('../../domain/enums/BkpRoles.js');
 const { QcFlagController } = require('../controllers/qcFlag.controller.js');
+const FilterLogger = require('../Loggers/FilterLogger.js');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware.js');
 const { rbacMiddleware } = require('../middleware/rbac.middleware.js');
 
 exports.qcFlagsRouter = {
@@ -21,7 +23,7 @@ exports.qcFlagsRouter = {
         {
             path: 'gaq',
             method: 'get',
-            controller: QcFlagController.getGaqQcFlagsHandler,
+            controller: [infoLoggerListenerMiddleware(FilterLogger), QcFlagController.getGaqQcFlagsHandler],
         },
         {
             path: 'summary',

lib/server/routers/runs.router.js

@@ -12,6 +12,8 @@
  */
 
 const { RunsController } = require('../controllers');
+const FilterLogger = require('../Loggers/FilterLogger');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware');
 
 module.exports = {
     children: [
@@ -30,7 +32,7 @@ module.exports = {
                 },
                 {
                     method: 'get',
-                    controller: RunsController.listRuns,
+                    controller: [infoLoggerListenerMiddleware(FilterLogger), RunsController.listRuns],
                 },
                 {
                     method: 'get',

lib/server/routers/simulationPasses.router.js

@@ -12,6 +12,8 @@
  */
 
 const { SimulationPassesController } = require('../controllers/simulationPasses.controller.js');
+const FilterLogger = require('../Loggers/FilterLogger.js');
+const { infoLoggerListenerMiddleware } = require('../middleware/InfoLoggerListener.middleware.js');
 
 exports.simulationPassesRouter = {
     path: '/simulationPasses',
@@ -23,7 +25,7 @@ exports.simulationPassesRouter = {
         },
         {
             method: 'get',
-            controller: SimulationPassesController.listSimulationPassesHandler,
+            controller: [infoLoggerListenerMiddleware(FilterLogger), SimulationPassesController.listSimulationPassesHandler],
         },
     ],
 };