[O2B-1577] Rename include.byName filter to permittedNonPhysicsNames (#2128)

NarrowsProjects · web-flow · commit 7a03dd1797b6 · 2026-05-27T10:47:08.000+02:00
* rename include[byname] to permittedNonPhysicsNames
* the lines of code in datapassService.getAll with regards to filtering have been refactored for readability
diff --git a/lib/domain/enums/NonPhysicsProductionsNamesWords.js b/lib/domain/enums/NonPhysicsProductionsNamesWords.js
@@ -23,3 +23,5 @@ const NonPhysicsProductionsNamesWords = Object.freeze({
 module.exports.NonPhysicsProductionsNamesWords = NonPhysicsProductionsNamesWords;
 
 module.exports.NON_PHYSICS_PRODUCTIONS_NAMES_WORDS = Object.values(NonPhysicsProductionsNamesWords);
+
+module.exports.NON_PHYSICS_PRODUCTIONS_NAMES_TOTAL_LENGTH = Object.values(NonPhysicsProductionsNamesWords).join(',').length;
diff --git a/lib/public/components/Filters/RunsFilter/DetectorsFilterModel.js b/lib/public/components/Filters/RunsFilter/DetectorsFilterModel.js
@@ -62,7 +62,7 @@ export class DetectorsFilterModel extends FilterModel {
             operator: this._combinationOperatorModel.current,
         };
         if (!this.isNone()) {
-            normalized.values = this._dropdownModel.selected.join();
+            normalized.values = this._dropdownModel.normalized;
         }
         return normalized;
     }
diff --git a/lib/public/components/common/selection/SelectionModel.js b/lib/public/components/common/selection/SelectionModel.js
@@ -373,6 +373,6 @@ export class SelectionModel extends Observable {
      * @return {string|string[]|boolean|boolean[]|number|number[]|SelectionOption|SelectionOption[]} the normalized value
      */
     get normalized() {
-        return (this._allowEmpty || this._multiple) ? this.selected.join() : this.current;
+        return (this._allowEmpty || this._multiple) ? this.selected.join(',') : this.current;
     }
 }
diff --git a/lib/public/views/DataPasses/ActiveColumns/dataPassesActiveColumns.js b/lib/public/views/DataPasses/ActiveColumns/dataPassesActiveColumns.js
@@ -102,7 +102,7 @@ export const dataPassesActiveColumns = {
 
     nonPhysicsProductions: {
         name: 'Include nonphysics productions',
-        filter: (filteringModel) => checkboxes(filteringModel.get('include[byName]')),
+        filter: (filteringModel) => checkboxes(filteringModel.get('permittedNonPhysicsNames')),
         visible: false,
     },
 };
diff --git a/lib/public/views/DataPasses/DataPassesOverviewModel.js b/lib/public/views/DataPasses/DataPassesOverviewModel.js
@@ -31,7 +31,7 @@ export class DataPassesOverviewModel extends OverviewPageModel {
             router,
             {
                 names: new TextTokensFilterModel(),
-                'include[byName]': new SelectionModel({
+                permittedNonPhysicsNames: new SelectionModel({
                     availableOptions: NON_PHYSICS_PRODUCTIONS_NAMES_WORDS.map((word) => ({ label: word.toUpperCase(), value: word })),
                 }),
             },
diff --git a/lib/server/controllers/dataPasses.controller.js b/lib/server/controllers/dataPasses.controller.js
@@ -21,7 +21,10 @@ const { dtoValidator } = require('../utilities/dtoValidator.js');
 const { countedItemsToHttpView } = require('../utilities/countedItemsToHttpView.js');
 const { updateExpressResponseFromNativeError } = require('../express/updateExpressResponseFromNativeError');
 const PaginationDto = require('../../domain/dtos/PaginationDto.js');
-const { NON_PHYSICS_PRODUCTIONS_NAMES_WORDS } = require('../../domain/enums/NonPhysicsProductionsNamesWords.js');
+const {
+    NON_PHYSICS_PRODUCTIONS_NAMES_WORDS,
+    NON_PHYSICS_PRODUCTIONS_NAMES_TOTAL_LENGTH,
+} = require('../../domain/enums/NonPhysicsProductionsNamesWords.js');
 
 /**
  * List All DataPasses with statistics
@@ -34,17 +37,14 @@ const listDataPassesHandler = async (req, res) => {
                 lhcPeriodIds: Joi.array().items(Joi.number()),
                 ids: Joi.array().items(Joi.number()),
                 names: Joi.array().items(Joi.string()),
-                include: Joi.object({ byName: Joi.string().custom((value, helper) => {
-                    if (value.length > 10) {
-                        return helper.error('byName cannot have more than 10 characters');
-                    }
-                    const nameTokens = value?.split(',');
+                permittedNonPhysicsNames: Joi.string().max(NON_PHYSICS_PRODUCTIONS_NAMES_TOTAL_LENGTH).custom((value, helper) => {
+                    const nameTokens = value.split(',');
                     const allTokensCorrect = nameTokens.every((token) => NON_PHYSICS_PRODUCTIONS_NAMES_WORDS.includes(token));
                     if (!allTokensCorrect) {
-                        return helper.error(`All byName must comma delimited list of ${NON_PHYSICS_PRODUCTIONS_NAMES_WORDS}`);
+                        return helper.error(`All permittedNonPhysicsNames must comma delimited list of ${NON_PHYSICS_PRODUCTIONS_NAMES_WORDS}`);
                     }
                     return nameTokens;
-                }) }),
+                }),
             },
             page: PaginationDto,
             sort: DtoFactory.order(['id', 'name']),
diff --git a/lib/server/services/dataPasses/DataPassService.js b/lib/server/services/dataPasses/DataPassService.js
@@ -88,13 +88,25 @@ class DataPassService {
      * @returns {Promise<CountedItems<DataPass>>} result
      */
     async getAll({
-        filter,
+        filter = {},
         limit,
         offset,
         sort,
     } = {}) {
         const queryBuilder = this.prepareQueryBuilder();
 
+        /**
+         * @typedef
+         * @property {object} filter
+         * @property {number[]} [filter.lhcPeriodIds] lhcPeriod identifier to filter with
+         * @property {number[]} [filter.simulationPassIds] simulationPass identifier to filter with
+         * @property {number[]} [filter.ids] data passes identifier to filter with
+         * @property {string[]} [filter.names] data passes names to filter with
+         * @property {string[]}  [filter.permittedNonPhysicsNames] list of tokens in data passes names which indicate
+         * a given data pass should not be excluded, possible tokens are 'test', 'debug'.
+         */
+        const { ids, names, permittedNonPhysicsNames = [], lhcPeriodIds, simulationPassIds } = filter;
+
         if (sort) {
             for (const property in sort) {
                 queryBuilder.orderBy(property, sort[property]);
@@ -108,37 +120,24 @@ class DataPassService {
             queryBuilder.offset(offset);
         }
 
-        if (filter) {
-            /**
-             * @typedef
-             * @property {object} filter
-             * @property {number[]} [filter.lhcPeriodIds] lhcPeriod identifier to filter with
-             * @property {number[]} [filter.simulationPassIds] simulationPass identifier to filter with
-             * @property {number[]} [filter.ids] data passes identifier to filter with
-             * @property {string[]} [filter.names] data passes names to filter with
-             * @property {boolean}  [filter.include.byName] list of tokens in data passes names which indicate
-             * a given data pass should not be excluded, possible tokens are 'test', 'debug'.
-             */
-            const { ids, names, lhcPeriodIds, simulationPassIds } = filter;
-            if (lhcPeriodIds) {
-                queryBuilder.where('lhcPeriodId').oneOf(...lhcPeriodIds);
-            }
-            if (simulationPassIds) {
-                queryBuilder.whereAssociation('anchoredSimulationPasses', 'id').oneOf(...simulationPassIds);
-            }
-            if (ids) {
-                queryBuilder.where('id').oneOf(...ids);
-            }
-            if (names) {
-                queryBuilder.where('name').oneOf(...names);
-            }
+        if (lhcPeriodIds) {
+            queryBuilder.where('lhcPeriodId').oneOf(...lhcPeriodIds);
+        }
+        if (simulationPassIds) {
+            queryBuilder.whereAssociation('anchoredSimulationPasses', 'id').oneOf(...simulationPassIds);
+        }
+        if (ids) {
+            queryBuilder.where('id').oneOf(...ids);
+        }
+        if (names) {
+            queryBuilder.where('name').oneOf(...names);
         }
 
-        const byName = filter?.include?.byName ?? [];
-        if (!byName.includes(NonPhysicsProductionsNamesWords.TEST)) {
+        if (!permittedNonPhysicsNames.includes(NonPhysicsProductionsNamesWords.TEST)) {
             queryBuilder.where('name').not().substring(`\\_${NonPhysicsProductionsNamesWords.TEST}`);
         }
-        if (!byName.includes(NonPhysicsProductionsNamesWords.DEBUG)) {
+
+        if (!permittedNonPhysicsNames.includes(NonPhysicsProductionsNamesWords.DEBUG)) {
             queryBuilder.where('name').not().substring(`\\_${NonPhysicsProductionsNamesWords.DEBUG}`);
         }
 
diff --git a/test/api/dataPasses.test.js b/test/api/dataPasses.test.js
@@ -296,13 +296,13 @@ module.exports = () => {
                 });
         });
         it('should successfully include TEST productions', async () => {
-            const response = await request(server).get('/api/dataPasses?filter[lhcPeriodIds][]=2&filter[include][byName]=test');
+            const response = await request(server).get('/api/dataPasses?filter[lhcPeriodIds][]=2&filter[permittedNonPhysicsNames]=test');
             expect(response.status).to.be.equal(200);
             const { data } = await response.body;
             expect(data.map(({ name }) => name)).to.have.all.members(['LHC22b_apass1', 'LHC22b_skimming','LHC22b_apass2_skimmed', 'LHC22b_test']);
         });
         it('should successfully include DEBUG productions', async () => {
-            const response = await request(server).get('/api/dataPasses?filter[lhcPeriodIds][]=2&filter[include][byName]=debug');
+            const response = await request(server).get('/api/dataPasses?filter[lhcPeriodIds][]=2&filter[permittedNonPhysicsNames]=debug');
             expect(response.status).to.be.equal(200);
             const { data } = await response.body;
             expect(data.map(({ name }) => name)).to.have.all.members(['LHC22b_apass1', 'LHC22b_skimming','LHC22b_apass2_skimmed', 'LHC22b_debug']);
diff --git a/test/public/Filters/filtersToUrl.test.js b/test/public/Filters/filtersToUrl.test.js
@@ -352,7 +352,7 @@ module.exports = () => {
             "page": "data-passes-per-lhc-period-overview",
             "lhcPeriodId": "2",
             "filter[names][]": "LHC22b_apass1",
-            "filter[include][byName]": "test"
+            "filter[permittedNonPhysicsNames]": "test"
         });
     });
 
@@ -367,7 +367,7 @@ module.exports = () => {
             "page": "data-passes-per-simulation-pass-overview",
             "simulationPassId": "1",
             "filter[names][]": "LHC22b_apass1",
-            "filter[include][byName]": "test"
+            "filter[permittedNonPhysicsNames]": "test"
         });
     });
 

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ export class DetectorsFilterModel extends FilterModel {`
`62`	`62`	`operator: this._combinationOperatorModel.current,`
`63`	`63`	`};`
`64`	`64`	`if (!this.isNone()) {`
`65`		`- normalized.values = this._dropdownModel.selected.join();`
	`65`	`+ normalized.values = this._dropdownModel.normalized;`
`66`	`66`	`}`
`67`	`67`	`return normalized;`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -373,6 +373,6 @@ export class SelectionModel extends Observable {`
`373`	`373`	`* @return {string\|string[]\|boolean\|boolean[]\|number\|number[]\|SelectionOption\|SelectionOption[]} the normalized value`
`374`	`374`	`*/`
`375`	`375`	`get normalized() {`
`376`		`- return (this._allowEmpty \|\| this._multiple) ? this.selected.join() : this.current;`
	`376`	`+ return (this._allowEmpty \|\| this._multiple) ? this.selected.join(',') : this.current;`
`377`	`377`	`}`
`378`	`378`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export class DataPassesOverviewModel extends OverviewPageModel {`
`31`	`31`	`router,`
`32`	`32`	`{`
`33`	`33`	`names: new TextTokensFilterModel(),`
`34`		`- 'include[byName]': new SelectionModel({`
	`34`	`+ permittedNonPhysicsNames: new SelectionModel({`
`35`	`35`	`availableOptions: NON_PHYSICS_PRODUCTIONS_NAMES_WORDS.map((word) => ({ label: word.toUpperCase(), value: word })),`
`36`	`36`	`}),`
`37`	`37`	`},`