refactor

Author: xsalonx

lib/domain/dtos/GetAllRunsDto.js

@@ -15,18 +15,21 @@ const Joi = require('joi');
 const PaginationDto = require('./PaginationDto');
 const { RunFilterDto } = require('./filters/RunFilterDto.js');
 const { DtoFactory } = require('./DtoFactory');
+const { singleRunsCollectionCustomCheck } = require('./utils.js');
 
 const QueryDto = Joi.object({
     filter: RunFilterDto,
     page: PaginationDto,
     sort: DtoFactory.order(['id', 'runNumber', 'text']),
     include: Joi.object({ effectiveQcFlags: Joi.boolean().custom((effectiveQcFlags, helpers) => {
         const [, { filter: { dataPassIds, simulationPassIds, lhcPeriodIds } = {} }] = helpers.state.ancestors;
-        const runsCollectionFilters = [dataPassIds, simulationPassIds, lhcPeriodIds].filter(({ length } = {}) => length >= 1);
-        if (runsCollectionFilters.length !== 1 || runsCollectionFilters[0].length !== 1) {
-            return helpers.message('Including effectiveQcFlags is allowed only when filtering by one and exactly one of: ' +
-                    'dataPassIds, simulationPassIds, lhcPeriodIds with exactly one ID.');
-        }
+
+        singleRunsCollectionCustomCheck(
+            { dataPassIds, simulationPassIds, lhcPeriodIds },
+            helpers,
+            'Including effectiveQcFlags is allowed only when ' +
+            'the dataPassIds, simulationPassIds and lhcPeriodIds filters collectively contain exactly one ID',
+        );
 
         return effectiveQcFlags;
     }) }),

lib/domain/dtos/filters/RunFilterDto.js

@@ -17,6 +17,7 @@ const { RUN_QUALITIES } = require('../../enums/RunQualities.js');
 const { IntegerComparisonDto, FloatComparisonDto } = require('./NumericalComparisonDto.js');
 const { RUN_CALIBRATION_STATUS } = require('../../enums/RunCalibrationStatus.js');
 const { RUN_DEFINITIONS } = require('../../enums/RunDefinition.js');
+const { singleRunsCollectionCustomCheck } = require('../utils.js');
 
 const DetectorsFilterDto = Joi.object({
     operator: Joi.string().valid('or', 'and', 'none').required(),
@@ -128,12 +129,13 @@ exports.RunFilterDto = Joi.object({
         })
         .custom((detectorsQcObj, helpers) => {
             const [{ dataPassIds, simulationPassIds, lhcPeriodIds }] = helpers.state.ancestors;
-            const runsCollectionFilters = [dataPassIds, simulationPassIds, lhcPeriodIds].filter(({ length } = {}) => length >= 1);
 
-            if (runsCollectionFilters.length !== 1 || runsCollectionFilters[0].length !== 1) {
-                return helpers.message('Filtering by detector not-bad fraction is allowed only with exactly one of: ' +
-                    'dataPassIds, simulationPassIds, lhcPeriodIds with exactly one ID.');
-            }
+            singleRunsCollectionCustomCheck(
+                { dataPassIds, simulationPassIds, lhcPeriodIds },
+                helpers,
+                'Filtering by detector not-bad fraction is allowed only when ' +
+                'the dataPassIds, simulationPassIds and lhcPeriodIds filters collectively contain exactly one ID',
+            );
 
             return detectorsQcObj;
         }),

lib/domain/dtos/utils.js

@@ -0,0 +1,33 @@
+/**
+ * @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.
+ */
+
+/**
+ * Used in Joi schemas to assert that the dataPassIds, simulationPassIds and lhcPeriodIds filters collectively contain exactly one ID
+ *
+ * @param {object} collections runs ids collections
+ * @param {number[]} collections.dataPassIds data pass ids
+ * @param {number[]} collections.simulationPassIds simulation pass ids
+ * @param {number[]} collections.lhcPeriodIds LHC periods ids
+ * @param {Joi.helpers} helpers joi helpers
+ * @param {string} message to be send in case of filters refer to more than one runs collection
+ * @returns {void}
+ */
+const singleRunsCollectionCustomCheck = ({ dataPassIds, simulationPassIds, lhcPeriodIds }, helpers, message) => {
+    const runsCollectionFilters = [dataPassIds, simulationPassIds, lhcPeriodIds].filter(({ length } = {}) => length >= 1);
+
+    if (runsCollectionFilters.length !== 1 || runsCollectionFilters[0].length !== 1) {
+        return helpers.message(message);
+    }
+};
+
+module.exports.singleRunsCollectionCustomCheck = singleRunsCollectionCustomCheck;