Merge branch 'main' into improv/O2B-1520/Add-filtering-by-run-intervals-to-envs

Author: isaachilly

lib/domain/dtos/filters/LhcFillsFilterDto.js

@@ -12,11 +12,13 @@
  */
 const Joi = require('joi');
 const { validateRange, RANGE_INVALID } = require('../../../utilities/rangeUtils');
+const { validateTimeDuration } = require('../../../utilities/validateTime');
 
 exports.LhcFillsFilterDto = Joi.object({
     hasStableBeams: Joi.boolean(),
     fillNumbers: Joi.string().trim().custom(validateRange).messages({
         [RANGE_INVALID]: '{{#message}}',
         'string.base': 'Fill numbers must be comma-separated numbers or ranges (e.g. 12,15-18)',
     }),
+    beamDuration: validateTimeDuration,
 });

lib/domain/dtos/filters/NumericalComparisonDto.js

@@ -24,3 +24,5 @@ exports.FloatComparisonDto = Joi.object({
     operator: Joi.string().valid(...NUMERICAL_COMPARISON_OPERATORS),
     limit: Joi.number().min(0),
 });
+
+exports.NUMERICAL_COMPARISON_OPERATORS = NUMERICAL_COMPARISON_OPERATORS;

lib/public/components/Filters/LhcFillsFilter/beamDurationFilter.js

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE Trg. 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-Trg.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.
+ */
+
+import { comparisonOperatorFilter } from '../common/filters/comparisonOperatorFilter.js';
+import { rawTextFilter } from '../common/filters/rawTextFilter.js';
+
+/**
+ * Component to filter LHC-fills by beam duration
+ *
+ * @param {TextComparisonFilterModel} beamDurationFilterModel beamDurationFilterModel
+ * @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)' },
+    );
+
+    return comparisonOperatorFilter(durationFilter, beamDurationFilterModel.operatorSelectionModel.current, (value) =>
+        beamDurationFilterModel.operatorSelectionModel.select(value), { id: 'beam-duration-filter-operator' });
+};

lib/public/components/Filters/common/filters/TextComparisonFilterModel.js

@@ -0,0 +1,78 @@
+/**
+ * @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.
+ */
+import { ComparisonSelectionModel } from './ComparisonSelectionModel.js';
+import { FilterModel } from '../FilterModel.js';
+import { RawTextFilterModel } from './RawTextFilterModel.js';
+
+/**
+ * TextComparisonFilterModel
+ */
+export class TextComparisonFilterModel extends FilterModel {
+    /**
+     * Constructor
+     */
+    constructor() {
+        super();
+
+        this._operatorSelectionModel = new ComparisonSelectionModel();
+        this._operatorSelectionModel.visualChange$.bubbleTo(this._visualChange$);
+
+        this._operandInputModel = new RawTextFilterModel();
+        // Unless the filter contains a value don't apply the filters.
+        this._operatorSelectionModel.observe(() => this._operandInputModel.value ? this.notify() : this._visualChange$.notify());
+        this._addSubmodel(this._operandInputModel);
+    }
+
+    /**
+     * Return raw text filter model
+     *
+     * @return {RawTextFilterModel} operand input model
+     */
+    get operandInputModel() {
+        return this._operandInputModel;
+    }
+
+    /**
+     * Get operator selection model
+     *
+     * @return {ComparisonSelectionModel} selection model
+     */
+    get operatorSelectionModel() {
+        return this._operatorSelectionModel;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    reset() {
+        this._operandInputModel.reset();
+        this._operatorSelectionModel.reset();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get normalized() {
+        return {
+            operator: this._operatorSelectionModel.current,
+            limit: this._operandInputModel.value,
+        };
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get isEmpty() {
+        return !this._operandInputModel.value;
+    }
+}

lib/public/components/Filters/common/filters/rawTextFilter.js

@@ -23,11 +23,12 @@ import { h } from '/js/src/index.js';
  * @return {Component} the filter
  */
 export const rawTextFilter = (filterModel, configuration) => {
-    const { classes = [], placeholder = '' } = configuration || {};
+    const { classes = [], placeholder = '', id } = configuration || {};
     return h(
         'input',
         {
             type: 'text',
+            id: id,
             class: classes.join(' '),
             value: filterModel.value,
             placeholder: placeholder,

lib/public/views/Home/Overview/HomePageModel.js

@@ -32,7 +32,7 @@ export class HomePageModel extends Observable {
         this._logsOverviewModel = new LogsOverviewModel(model, true);
         this._logsOverviewModel.bubbleTo(this);
 
-        this._lhcFillsOverviewModel = new LhcFillsOverviewModel(true);
+        this._lhcFillsOverviewModel = new LhcFillsOverviewModel(model, true);
         this._lhcFillsOverviewModel.bubbleTo(this);
     }
 

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

@@ -25,6 +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';
 
 /**
  * List of active columns for a lhc fills table
@@ -108,6 +109,7 @@ export const lhcFillsActiveColumns = {
 
             return '-';
         },
+        filter: (lhcFillModel) => beamDurationFilter(lhcFillModel.filteringModel.get('beamDuration')),
         profiles: {
             lhcFill: true,
             environment: true,

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

@@ -17,6 +17,7 @@ import { StableBeamFilterModel } from '../../../components/Filters/LhcFillsFilte
 import { RawTextFilterModel } from '../../../components/Filters/common/filters/RawTextFilterModel.js';
 import { OverviewPageModel } from '../../../models/OverviewModel.js';
 import { addStatisticsToLhcFill } from '../../../services/lhcFill/addStatisticsToLhcFill.js';
+import { TextComparisonFilterModel } from '../../../components/Filters/common/filters/TextComparisonFilterModel.js';
 
 /**
  * Model for the LHC fills overview page
@@ -27,17 +28,19 @@ 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) {
         super();
 
         this._filteringModel = new FilteringModel({
             fillNumbers: new RawTextFilterModel(),
+            beamDuration: new TextComparisonFilterModel(),
             hasStableBeams: new StableBeamFilterModel(),
         });
 
-        this._filteringModel.observe(() => this._applyFilters(true));
+        this._filteringModel.observe(() => this._applyFilters());
         this._filteringModel.visualChange$.bubbleTo(this);
 
         this.reset(false);
@@ -61,7 +64,10 @@ export class LhcFillsOverviewModel extends OverviewPageModel {
      * @inheritDoc
      */
     getRootEndpoint() {
-        return buildUrl('/api/lhcFills', { filter: this.filteringModel.normalized });
+        const params = {
+            filter: this.filteringModel.normalized,
+        };
+        return buildUrl('/api/lhcFills', params);
     }
 
     /**
@@ -83,7 +89,7 @@ export class LhcFillsOverviewModel extends OverviewPageModel {
         this._filteringModel.reset();
 
         if (fetch) {
-            this._applyFilters(true);
+            this._applyFilters();
         }
     }
 

lib/usecases/lhcFill/GetAllLhcFillsUseCase.js

@@ -45,7 +45,7 @@ class GetAllLhcFillsUseCase {
         const queryBuilder = new QueryBuilder();
 
         if (filter) {
-            const { hasStableBeams, fillNumbers } = filter;
+            const { hasStableBeams, fillNumbers, beamDuration } = filter;
             if (hasStableBeams) {
                 // For now, if a stableBeamsStart is present, then a beam is stable
                 queryBuilder.where('stableBeamsStart').not().is(null);
@@ -62,6 +62,10 @@ class GetAllLhcFillsUseCase {
                         : queryBuilder.where('fillNumber').oneOf(...finalFillnumberList);
                 }
             }
+            // Beam duration filter, limit and corresponding operator.
+            if (beamDuration?.limit !== undefined && beamDuration?.operator) {
+                queryBuilder.where('stableBeamsDuration').applyOperator(beamDuration.operator, beamDuration.limit);
+            }
         }
 
         const { count, rows } = await TransactionHelper.provide(async () => {

lib/utilities/validateTime.js

@@ -0,0 +1,51 @@
+/**
+ * @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.
+ */
+import Joi from 'joi';
+import { NUMERICAL_COMPARISON_OPERATORS } from '../domain/dtos/filters/NumericalComparisonDto.js';
+
+const joiTimeDurationErrorText = 'Invalid duration value';
+
+/**
+ * Transform digital time in string format
+ *
+ * @param {string} incomingValue  The time to transform
+ * @param {*} helpers The Joi helpers object
+ * @returns {number|import("joi").ValidationError} The value if transformation passes, as seconds (Number)
+ */
+export const transformTime = (incomingValue, helpers) => {
+    try {
+        // Extract time to seconds...
+        const [hoursStr, minutesStr, secondsStr] = incomingValue.split(':');
+
+        const hours = Number(hoursStr);
+        const minutes = Number(minutesStr);
+        const seconds = Number(secondsStr);
+
+        return hours * 3600 + minutes * 60 + seconds;
+    } catch (error) {
+        return helpers.error('any.invalid', { message: `Validation error: ${error?.message ?? 'failed to transform time'}` });
+    }
+};
+
+/**
+ * Joi object that validates time duration filters.
+ * This is for duration, not a point in time. 10000:59:59 is valid.
+ * The operator is also validated.
+ */
+export const validateTimeDuration = Joi.object({
+    limit: Joi.string().trim().pattern(/^\d+:[0-5]?\d:[0-5]?\d$/).custom(transformTime).messages({
+        'string.pattern.base': joiTimeDurationErrorText,
+        'string.base': joiTimeDurationErrorText,
+    }),
+    operator: Joi.string().valid(...NUMERICAL_COMPARISON_OPERATORS),
+});