add filtering to api

Author: xsalonx

lib/server/controllers/qcFlag.controller.js

@@ -322,6 +322,7 @@ const getQcFlagsSummaryHandler = async (req, res) => {
             simulationPassId: Joi.number(),
             mcReproducibleAsNotBad: Joi.boolean().optional(),
             lhcPeriodId: Joi.number(),
+            filter: qcFlagFilterDTO,
         }).xor('dataPassId', 'simulationPassId', 'lhcPeriodId')),
         req,
         res,
@@ -333,9 +334,14 @@ const getQcFlagsSummaryHandler = async (req, res) => {
                 simulationPassId,
                 lhcPeriodId,
                 mcReproducibleAsNotBad = false,
+                filter,
             } = validatedDTO.query;
 
-            const data = await qcFlagSummaryService.getSummary({ dataPassId, simulationPassId, lhcPeriodId }, { mcReproducibleAsNotBad });
+            const data = await qcFlagSummaryService.getSummary(
+                { dataPassId, simulationPassId, lhcPeriodId },
+                { mcReproducibleAsNotBad },
+                filter,
+            );
             res.json({ data });
         } catch (error) {
             updateExpressResponseFromNativeError(res, error);

lib/server/services/qualityControlFlag/QcFlagService.js

@@ -36,6 +36,7 @@ const { getOneSimulationPassOrFail } = require('../simulationPasses/getOneSimula
 const { AccessDeniedError } = require('../../errors/AccessDeniedError.js');
 const { LogManager } = require('@aliceo2/web-ui');
 const { DetectorType } = require('../../../domain/enums/DetectorTypes.js');
+const { getCreatedByFilterClause } = require('./getQcFlagFiltering.js');
 
 /**
  * @typedef UserWithRoles
@@ -64,17 +65,6 @@ const validateUserDetectorAccess = (userRoles, detectorName) => {
     }
 };
 
-/**
- * @typedef CreatedByFilter
- * @property {string} names
- * @property {'or'|'none'} operator
- */
-
-/**
- * @typedef QcFlagFilter
- * @property {CreatedByFilter} createdBy
- */
-
 /**
  * Quality control flags service
  */
@@ -394,27 +384,6 @@ class QcFlagService {
         });
     }
 
-    /**
-     * Get sequelize clause for CreateByFilter
-     *
-     * @param {QcFlagFilter} filter filter
-     * @returns {object} sequelize clause
-     * @throws {Error} if bad operator provided
-     */
-    getCreatedByFilterClause(filter = {}) {
-        const { createdBy: { names: createdByNames, operator: createdByOperator } = {} } = filter;
-
-        if (createdByNames && createdByOperator) {
-            if (createdByOperator === 'or') {
-                return { name: { [Op.or]: createdByNames } };
-            } else if (createdByOperator === 'none') {
-                return { [Op.not]: { name: { [Op.or]: createdByNames } } };
-            } else {
-                throw Error(`Operator ${createdByOperator} is not suppoerted`);
-            }
-        }
-    }
-
     /**
      * Return a paginated list of QC flags related to a given data pass, run and dpl detector
      *
@@ -439,7 +408,7 @@ class QcFlagService {
                     { association: 'flagType' },
                     {
                         association: 'createdBy',
-                        where: this.getCreatedByFilterClause(filter),
+                        where: getCreatedByFilterClause(filter),
                     },
                     { association: 'verifications', include: [{ association: 'createdBy' }] },
                     { association: 'effectivePeriods' },
@@ -496,7 +465,7 @@ class QcFlagService {
                     { association: 'flagType' },
                     {
                         association: 'createdBy',
-                        where: this.getCreatedByFilterClause(filter),
+                        where: getCreatedByFilterClause(filter),
                     },
                     { association: 'verifications', include: [{ association: 'createdBy' }] },
                     { association: 'effectivePeriods' },
@@ -556,7 +525,7 @@ class QcFlagService {
                 { association: 'flagType' },
                 {
                     association: 'createdBy',
-                    where: this.getCreatedByFilterClause(filter),
+                    where: getCreatedByFilterClause(filter),
                 },
                 { association: 'verifications', include: [{ association: 'createdBy' }] },
                 { association: 'dataPasses', required: false },

lib/server/services/qualityControlFlag/QcFlagSummaryService.js

@@ -34,6 +34,7 @@ const { dataSource } = require('../../../database/DataSource.js');
 const { QcFlagRepository } = require('../../../database/repositories/index.js');
 const { Op } = require('sequelize');
 const { QcSummarProperties } = require('../../../domain/enums/QcSummaryProperties.js');
+const { getCreatedByFilterClause } = require('./getQcFlagFiltering.js');
 
 /**
  * QC flag summary service
@@ -82,9 +83,10 @@ class QcFlagSummaryService {
      * @param {object} [options] additional options
      * @param {boolean} [options.mcReproducibleAsNotBad = false] if set to true, `Limited Acceptance MC Reproducible` flag type is treated as
      *     good one
+     * @param {QcFlagFilter} [filter] filter
      * @return {Promise<QcSummary>} summary
      */
-    async getSummary({ dataPassId, simulationPassId, lhcPeriodId, dplDetectorIds }, { mcReproducibleAsNotBad = false } = {}) {
+    async getSummary({ dataPassId, simulationPassId, lhcPeriodId, dplDetectorIds }, { mcReproducibleAsNotBad = false } = {}, filter = {}) {
         if (Boolean(dataPassId) + Boolean(simulationPassId) + Boolean(lhcPeriodId) !== 1) {
             throw new BadParameterError('One and exactly one of `dataPassId`, `simulationPassId` and `lhcPeriodId` is required');
         }
@@ -112,6 +114,11 @@ class QcFlagSummaryService {
             queryBuilder.where('detectorId').oneOf(...dplDetectorIds);
         }
 
+        queryBuilder.include({
+            association: 'createdBy',
+            where: getCreatedByFilterClause(filter),
+        });
+
         queryBuilder
             .include({ association: 'effectivePeriods', attributes: [], required: true })
             .include({ association: 'flagType', attributes: [] })

lib/server/services/qualityControlFlag/getQcFlagFiltering.js

@@ -0,0 +1,35 @@
+const { Op } = require('sequelize');
+
+/**
+ * @typedef CreatedByFilter
+ * @property {string} names
+ * @property {'or'|'none'} operator
+ */
+
+/**
+ * @typedef QcFlagFilter
+ * @property {CreatedByFilter} createdBy
+ */
+
+/**
+ * Get sequelize clause for CreateByFilter
+ *
+ * @param {QcFlagFilter} filter filter
+ * @returns {object} sequelize clause
+ * @throws {Error} if bad operator provided
+ */
+const getCreatedByFilterClause = (filter = {}) => {
+    const { createdBy: { names: createdByNames, operator: createdByOperator } = {} } = filter;
+
+    if (createdByNames && createdByOperator) {
+        if (createdByOperator === 'or') {
+            return { name: { [Op.or]: createdByNames } };
+        } else if (createdByOperator === 'none') {
+            return { [Op.not]: { name: { [Op.or]: createdByNames } } };
+        } else {
+            throw Error(`Operator ${createdByOperator} is not suppoerted`);
+        }
+    }
+};
+
+module.exports.getCreatedByFilterClause = getCreatedByFilterClause;