[O2B-1506] LHCfills run duration filter (#2038)

- LHCfills page now has a total run duration filter.
- GetAllLhcFillsUseCase.js will now execute a JOIN on statistics (fill_statistics) when runDuration and runDurationOperator are defined in the filter.

Author: Houwie7000

lib/database/utilities/QueryBuilder.js

@@ -145,7 +145,55 @@ class WhereQueryBuilder {
     }
 
     /**
-     * Set the next filter condition according to a comparison operator ("<", "<=", ">=", ">")
+     * Set a min range limit using the provided value OR null (useful when 0 is stored as null)
+     *
+     * @param {*} min the lower limit criteria
+     * @param {boolean} strict if true, the comparison is exclusive, else it will be inclusive (equality match)
+     *
+     * @return {void}
+     */
+    greaterThanOrNull(min, strict) {
+        if (this.notFlag) {
+            this.notFlag = !this.notFlag;
+            this.lowerThan(min, !strict);
+            this.notFlag = !this.notFlag;
+            return;
+        }
+        const operation = {
+            [Op.or]: [
+                { [Op.is]: null },
+                { [strict ? Op.gt : Op.gte]: min },
+            ],
+        };
+        this._op(operation);
+    }
+
+    /**
+     * Set a max range limit using the provided value OR null (useful when 0 is stored as null)
+     *
+     * @param {*} max the upper limit criteria
+     * @param {boolean} strict if true, the comparison is exclusive, else it will be inclusive (equality match)
+     *
+     * @return {void}
+     */
+    lowerThanOrNull(max, strict) {
+        if (this.notFlag) {
+            this.notFlag = !this.notFlag;
+            this.greaterThan(max, !strict);
+            this.notFlag = !this.notFlag;
+            return;
+        }
+        const operation = {
+            [Op.or]: [
+                { [Op.is]: null },
+                { [strict ? Op.lt : Op.lte]: max },
+            ],
+        };
+        this._op(operation);
+    }
+
+    /**
+     * Set the next filter condition according to a comparison operator ("<", "<=", ">=", ">", "=")
      *
      * @param {"<"|"<="|"="|">="|">"} operator the operator to apply
      * @param {*} limit the limit to compare to

lib/domain/dtos/filters/LhcFillsFilterDto.js

@@ -19,5 +19,6 @@ exports.LhcFillsFilterDto = Joi.object({
     fillNumbers: Joi.string().trim().custom(validateRange).messages({
         'any.invalid': '{{#message}}',
     }),
+    runDuration: validateTimeDuration,
     beamDuration: validateTimeDuration,
 });

…ers/LhcFillsFilter/beamDurationFilter.js …Filters/LhcFillsFilter/durationFilter.jslib/public/components/Filters/LhcFillsFilter/beamDurationFilter.js renamed to lib/public/components/Filters/LhcFillsFilter/durationFilter.js lib/public/components/Filters/LhcFillsFilter/beamDurationFilter.js renamed to lib/public/components/Filters/LhcFillsFilter/durationFilter.js

@@ -15,17 +15,18 @@ import { comparisonOperatorFilter } from '../common/filters/comparisonOperatorFi
 import { rawTextFilter } from '../common/filters/rawTextFilter.js';
 
 /**
- * Component to filter LHC-fills by beam duration
+ * Component to filter LHC-fills by duration
  *
- * @param {TextComparisonFilterModel} beamDurationFilterModel beamDurationFilterModel
+ * @param {TextComparisonFilterModel} durationFilterModel durationFilterModel
+ * @param {string} id id used for the operand and operator elements, becomes: `${id}-operator` OR `${id}-operand`.
  * @returns {Component} the text field
  */
-export const beamDurationFilter = (beamDurationFilterModel) => {
-    const durationFilter = rawTextFilter(
-        beamDurationFilterModel.operandInputModel,
-        { id: 'beam-duration-filter-operand', classes: ['w-100', 'beam-duration-filter'], placeholder: 'e.g 16:14:15 (HH:MM:SS)' },
+export const durationFilter = (durationFilterModel, id) => {
+    const amountFilter = rawTextFilter(
+        durationFilterModel.operandInputModel,
+        { id: `${id}-operand`, classes: ['w-100'], placeholder: 'e.g 16:14:15 (HH:MM:SS)' },
     );
 
-    return comparisonOperatorFilter(durationFilter, beamDurationFilterModel.operatorSelectionModel.current, (value) =>
-        beamDurationFilterModel.operatorSelectionModel.select(value), { id: 'beam-duration-filter-operator' });
+    return comparisonOperatorFilter(amountFilter, durationFilterModel.operatorSelectionModel.current, (value) =>
+        durationFilterModel.operatorSelectionModel.select(value), { id: `${id}-operator` });
 };

lib/public/views/LhcFills/ActiveColumns/lhcFillsActiveColumns.js

@@ -25,7 +25,7 @@ import { formatBeamType } from '../../../utilities/formatting/formatBeamType.js'
 import { frontLink } from '../../../components/common/navigation/frontLink.js';
 import { toggleStableBeamOnlyFilter } from '../../../components/Filters/LhcFillsFilter/stableBeamFilter.js';
 import { fillNumberFilter } from '../../../components/Filters/LhcFillsFilter/fillNumberFilter.js';
-import { beamDurationFilter } from '../../../components/Filters/LhcFillsFilter/beamDurationFilter.js';
+import { durationFilter } from '../../../components/Filters/LhcFillsFilter/durationFilter.js';
 
 /**
  * List of active columns for a lhc fills table
@@ -109,7 +109,7 @@ export const lhcFillsActiveColumns = {
 
             return '-';
         },
-        filter: (lhcFillModel) => beamDurationFilter(lhcFillModel.filteringModel.get('beamDuration')),
+        filter: (lhcFillModel) => durationFilter(lhcFillModel.filteringModel.get('beamDuration'), 'beam-duration-filter'),
         profiles: {
             lhcFill: true,
             environment: true,
@@ -141,6 +141,7 @@ export const lhcFillsActiveColumns = {
         visible: true,
         size: 'w-8',
         format: (duration) => formatDuration(duration),
+        filter: (lhcFillModel) => durationFilter(lhcFillModel.filteringModel.get('runDuration'), 'run-duration-filter'),
     },
     efficiency: {
         name: 'Fill Efficiency',

lib/public/views/LhcFills/Overview/LhcFillsOverviewModel.js

@@ -28,7 +28,6 @@ export class LhcFillsOverviewModel extends OverviewPageModel {
     /**
      * Constructor
      *
-     * @param {model} model global model
      * @param {boolean} [stableBeamsOnly=false] if true, overview will load stable beam only
      */
     constructor(stableBeamsOnly = false) {
@@ -37,6 +36,7 @@ export class LhcFillsOverviewModel extends OverviewPageModel {
         this._filteringModel = new FilteringModel({
             fillNumbers: new RawTextFilterModel(),
             beamDuration: new TextComparisonFilterModel(),
+            runDuration: new TextComparisonFilterModel(),
             hasStableBeams: new StableBeamFilterModel(),
         });
 

lib/usecases/lhcFill/GetAllLhcFillsUseCase.js

@@ -44,8 +44,10 @@ class GetAllLhcFillsUseCase {
 
         const queryBuilder = new QueryBuilder();
 
+        let associatedStatisticsRequired = false;
+
         if (filter) {
-            const { hasStableBeams, fillNumbers, beamDuration } = filter;
+            const { hasStableBeams, fillNumbers, beamDuration, runDuration } = filter;
             if (hasStableBeams) {
                 // For now, if a stableBeamsStart is present, then a beam is stable
                 queryBuilder.where('stableBeamsStart').not().is(null);
@@ -62,6 +64,23 @@ class GetAllLhcFillsUseCase {
                         : queryBuilder.where('fillNumber').oneOf(...finalFillnumberList);
                 }
             }
+
+            if (runDuration?.limit !== undefined && runDuration?.operator) {
+                associatedStatisticsRequired = true;
+                // 00:00:00 aka 0 value is saved in the DB as null (bookkeeping.fill_statistics.runs_coverage)
+                if (runDuration.operator === '<=' && Number(runDuration.limit) === 0) {
+                    queryBuilder.whereAssociation('statistics', 'runsCoverage').lowerThanOrNull(0, false);
+                } else if (runDuration.operator === '>=' && Number(runDuration.limit) === 0) {
+                    queryBuilder.whereAssociation('statistics', 'runsCoverage').greaterThanOrNull(0, false);
+                } else if ((runDuration.operator === '>' || runDuration.operator === '<') && Number(runDuration.limit) === 0) {
+                    queryBuilder.whereAssociation('statistics', 'runsCoverage').applyOperator(runDuration.operator, 0);
+                } else if (Number(runDuration.limit) === 0) {
+                    queryBuilder.whereAssociation('statistics', 'runsCoverage').applyOperator(runDuration.operator, null);
+                } else {
+                    queryBuilder.whereAssociation('statistics', 'runsCoverage').applyOperator(runDuration.operator, runDuration.limit);
+                }
+            }
+
             // Beam duration filter, limit and corresponding operator.
             if (beamDuration?.limit !== undefined && beamDuration?.operator) {
                 queryBuilder.where('stableBeamsDuration').applyOperator(beamDuration.operator, beamDuration.limit);
@@ -74,6 +93,14 @@ class GetAllLhcFillsUseCase {
                 where: { definition: RunDefinition.PHYSICS },
                 required: false,
             });
+
+            if (associatedStatisticsRequired) {
+                queryBuilder.include({
+                    association: 'statistics',
+                    required: true,
+                });
+            }
+
             queryBuilder.orderBy('fillNumber', 'desc');
             queryBuilder.limit(limit);
             queryBuilder.offset(offset);