Split the DTOs to provide easier maintainability

Author: graduta

lib/domain/dtos/common/BeamTypeDto.js

@@ -17,17 +17,22 @@ const { CustomJoi } = require('../CustomJoi.js');
 /**
  * Used by Bookkeeping-LHC Plugin to send data as per LHC
  */
-const DASH_SEPARATED_BEAM_TYPE_PATTERN = /^[A-Za-z0-9]+ ?- ?[A-Za-z0-9]+$/;
+const DASH_SEPARATED_BEAM_TYPE_PATTERN = /^[A-Za-z0-9]{1,6} ?- ?[A-Za-z0-9]{1,6}$/;
 
 /**
  * User Input format declared by user at deployment of environment
  */
 const COMPACT_BEAM_TYPE_PATTERN = /^[A-Za-z]{2,15}$/;
 
+const BEAM_TYPE_MIN_LENGTH = 5;
+const BEAM_TYPE_MAX_LENGTH = 15;
+const PDP_BEAM_TYPE_MIN_LENGTH = 2;
+const PDP_BEAM_TYPE_MAX_LENGTH = 10;
+
 /**
  * @typedef {string[]} BeamTypesDto
  * @description An array of beam types, each represented as a string.
- * Each beam type must be a string with a minimum length of 3 characters and a maximum length of 15 characters.
+ * Each beam type must be a string with a minimum length of 2 characters and a maximum length of 15 characters.
  * The string must match patterns such as "PROTON - PROTON", "NE10 - NE10", where the two parts are separated by a hyphen and optional spaces.
  *
  * RUN3 has the following beam types:
@@ -36,20 +41,45 @@ const COMPACT_BEAM_TYPE_PATTERN = /^[A-Za-z]{2,15}$/;
  * "O8 - O8"
  * "PB82 - PB82"
  * "PROTON - O8"
- * "PROTON - PROTON"
+ *
+ * RUN3 has the following compact beam types:
+ * "pp"
+ * "pPb"
+ * "NeNe"
+ * "OO"
+ * "cosmic"
+ * "technical"
  *
  * @example
  * const beamTypes = ["PROTON - PROTON", "NE10 - NE10"];
  */
 exports.BeamTypesDto = CustomJoi.stringArray()
     .items(Joi.string()
         .trim()
-        .min(2)
-        .max(15)
-        .pattern(new RegExp(`(?:${DASH_SEPARATED_BEAM_TYPE_PATTERN.source})|(?:${COMPACT_BEAM_TYPE_PATTERN.source})`))
+        .min(BEAM_TYPE_MIN_LENGTH)
+        .max(BEAM_TYPE_MAX_LENGTH)
+        .pattern(DASH_SEPARATED_BEAM_TYPE_PATTERN)
         .messages({
             'string.base': 'Beam type must be a string',
-            'string.min': 'Beam type must be at least 2 characters long',
-            'string.max': 'Beam type must be at most 15 characters long',
-            'string.pattern.base': 'Beam type must look like "PROTON - PROTON", "NE10 - NE10", "pp", "pPb", "NeNe", "OO", etc.',
+            'string.min': `Beam type must be at least ${BEAM_TYPE_MIN_LENGTH} characters long`,
+            'string.max': `Beam type must be at most ${BEAM_TYPE_MAX_LENGTH} characters long`,
+            'string.pattern.base': 'Beam type must look like "PROTON - PROTON", "NE10 - NE10", etc.',
+        }));
+
+/**
+ * @typedef {string[]} PdpBeamTypesDto
+ * @description An array of compact PDP beam types represented as strings.
+ * Values can include examples like "pp", "pPb", "NeNe", "OO", "cosmic", and "technical".
+ */
+exports.PdpBeamTypesDto = CustomJoi.stringArray()
+    .items(Joi.string()
+        .trim()
+        .min(PDP_BEAM_TYPE_MIN_LENGTH)
+        .max(PDP_BEAM_TYPE_MAX_LENGTH)
+        .pattern(COMPACT_BEAM_TYPE_PATTERN)
+        .messages({
+            'string.base': 'PDP beam type must be a string',
+            'string.min': `PDP beam type must be at least ${PDP_BEAM_TYPE_MIN_LENGTH} characters long`,
+            'string.max': `PDP beam type must be at most ${PDP_BEAM_TYPE_MAX_LENGTH} characters long`,
+            'string.pattern.base': 'PDP beam type must look like "pp", "pPb", "NeNe", "OO", "cosmic", "technical", etc.',
         }));

lib/domain/dtos/filters/RunFilterDto.js

@@ -12,7 +12,7 @@
  */
 const Joi = require('joi');
 const { CustomJoi } = require('../CustomJoi.js');
-const { BeamTypesDto } = require('../common/BeamTypeDto.js');
+const { BeamTypesDto, PdpBeamTypesDto } = require('../common/BeamTypeDto.js');
 const { FromToFilterDto } = require('./FromToFilterDto.js');
 const { RUN_QUALITIES } = require('../../enums/RunQualities.js');
 const { IntegerComparisonDto, FloatComparisonDto } = require('./NumericalComparisonDto.js');
@@ -41,7 +41,7 @@ exports.RunFilterDto = Joi.object({
             'Beam modes "{{#value}}" must contain only uppercase letters and single spaces between words.',
         })),
     beamTypes: BeamTypesDto,
-    pdpBeamTypes: BeamTypesDto,
+    pdpBeamTypes: PdpBeamTypesDto,
     runNumbers: Joi.string().trim().custom(validateRange).messages({
         [RANGE_INVALID]: '{{#message}}',
         'string.base': 'Run numbers must be comma-separated numbers or ranges (e.g. 12,15-18)',

test/api/runs.test.js

@@ -229,17 +229,17 @@ module.exports = () => {
             let { errors: [error] } = response.body;
 
             expect(error.title).to.equal('Invalid Attribute');
-            expect(error.detail).to.equal(`"query.filter.pdpBeamTypes[0]" length must be at least 2 characters long`);
+            expect(error.detail).to.equal(`PDP beam type must be at least 2 characters long`);
 
-            const pdpBeamTypesLong = 'This is definitely not a pdp beam type'; // Too short
+            const pdpBeamTypesLong = 'This is definitely not a pdp beam type'; // Too long
             const responseLong = await request(server).get(`/api/runs?filter[pdpBeamTypes]=${pdpBeamTypesLong}`);
 
             expect(responseLong.status).to.equal(400);
 
             ({ errors: [error] } = responseLong.body);
 
             expect(error.title).to.equal('Invalid Attribute');
-            expect(error.detail).to.equal(`"query.filter.pdpBeamTypes[0]" length must be less than or equal to 20 characters long`);
+            expect(error.detail).to.equal(`PDP beam type must be at most 10 characters long`);
         });
 
         it('should return 400 if beamModes filter has the incorrect format', async () => {