[O2B-1555] Add normalize setter functions to all classes that extend filter model and selection model (#2143)

Notable changes for users:
- Setting filters will now display them in the url

Notable changes for developers:
- All filters now have a normalized setter that will set the values of the filters based on the output of the normalize getter in query parameter form.

Author: NarrowsProjects

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

@@ -12,12 +12,12 @@
  */
 
 import { beamTypesProvider } from '../../../services/beamTypes/beamTypesProvider.js';
-import { SelectionFilterModel } from '../common/filters/SelectionFilterModel.js';
+import { SelectionModel } from '../../common/selection/SelectionModel.js';
 
 /**
  * Beam type filter model
  */
-export class BeamTypeFilterModel extends SelectionFilterModel {
+export class BeamTypeFilterModel extends SelectionModel {
     /**
      * Constructor
      */
@@ -28,7 +28,7 @@ export class BeamTypeFilterModel extends SelectionFilterModel {
             beamTypesProvider.items$.getCurrent().apply({
                 Success: (types) => {
                     const beamTypes = types.map((type) => ({ value: type.beam_type }));
-                    this._selectionModel.setAvailableOptions(beamTypes);
+                    this.setAvailableOptions(beamTypes);
                 },
             });
         });

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

@@ -19,8 +19,4 @@ import { checkboxes } from '../common/filters/checkboxFilter.js';
  * @param {BeamTypeFilterModel} beamTypeFilterModel beamTypeFilterModel
  * @return {Component} the filter
  */
-export const beamTypeFilter = (beamTypeFilterModel) =>
-    checkboxes(
-        beamTypeFilterModel.selectionModel,
-        { selector: 'beam-types' },
-    );
+export const beamTypeFilter = (beamTypeFilterModel) => checkboxes(beamTypeFilterModel, { selector: 'beam-types' });

lib/public/components/Filters/RunsFilter/BeamModeFilterModel.js

@@ -12,50 +12,17 @@
  */
 
 import { ObservableBasedSelectionDropdownModel } from '../../detector/ObservableBasedSelectionDropdownModel.js';
-import { FilterModel } from '../common/FilterModel.js';
 
 /**
  * Beam mode filter model
  */
-export class BeamModeFilterModel extends FilterModel {
+export class BeamModeFilterModel extends ObservableBasedSelectionDropdownModel {
     /**
      * Constructor
      *
      * @param {ObservableData<RemoteData<{name: string}, ApiError>>} beamModes$ observable remote data of objects representing beam modes
      */
     constructor(beamModes$) {
-        super();
-        this._selectionDropdownModel = new ObservableBasedSelectionDropdownModel(beamModes$, ({ name }) => ({ value: name }));
-        this._addSubmodel(this._selectionDropdownModel);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    reset() {
-        this._selectionDropdownModel.reset();
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get isEmpty() {
-        return this._selectionDropdownModel.isEmpty;
-    }
-
-    /**
-     * Return the underlying dropdown model
-     *
-     * @return {ObservableDropDownModel} the underlying dropdown model
-     */
-    get selectionDropdownModel() {
-        return this._selectionDropdownModel;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get normalized() {
-        return this._selectionDropdownModel.selected;
+        super(beamModes$, ({ name }) => ({ value: name }));
     }
 }

lib/public/components/Filters/RunsFilter/DetectorsFilterModel.js

@@ -67,6 +67,14 @@ export class DetectorsFilterModel extends FilterModel {
         return normalized;
     }
 
+    /**
+     * @inheritDoc
+     */
+    set normalized({ operator, values }) {
+        this._combinationOperatorModel.normalized = operator;
+        this._dropdownModel.normalized = values;
+    }
+
     /**
      * Return true if the current combination operator is none
      *

lib/public/components/Filters/RunsFilter/EorReasonFilterModel.js

@@ -66,6 +66,15 @@ export class EorReasonFilterModel extends FilterModel {
         return ret;
     }
 
+    /**
+     * @inheritDoc
+     */
+    set normalized({ category, title, description }) {
+        this._category = category;
+        this._title = title;
+        this._description = description;
+    }
+
     /**
      * Returns the EOR reason filter category
      *

lib/public/components/Filters/RunsFilter/GaqFilterModel.js

@@ -69,6 +69,14 @@ export class GaqFilterModel extends FilterModel {
         return normalized;
     }
 
+    /**
+     * @inheritDoc
+     */
+    set normalized({ notBadFraction, mcReproducibleAsNotBad }) {
+        this._notBadFraction.normalized = notBadFraction;
+        this._mcReproducibleAsNotBad.normalized = mcReproducibleAsNotBad;
+    }
+
     /**
      * Return the underlying notBadFraction model
      *

lib/public/components/Filters/RunsFilter/MagnetsFilteringModel.js

@@ -11,86 +11,63 @@
  * or submit itself to any jurisdiction.
  */
 
-import { FilterModel } from '../common/FilterModel.js';
 import { ObservableBasedSelectionDropdownModel } from '../../detector/ObservableBasedSelectionDropdownModel.js';
 
 /**
  * Return the option value corresponding to a given magnets current level
  *
  * @param {MagnetsCurrentLevels} currentLevels the current levels
- * @return {string} the option's value
+ * @return {object<value: string>} the option's value
  */
-const magnetsCurrentLevelsToOptionValue = ({ l3, dipole }) => `${l3}kA/${dipole}kA`;
+const magnetsCurrentLevelsToKey = ({ l3, dipole }) => ({ value: `${l3}kA/${dipole}kA` });
+
+/**
+ * Return the magnets current lever based on a key string
+ *
+ * @param {object} value string containing the current levels
+ * @return {MagnetsCurrentLevels}
+ */
+const keyToMagnetsCurrentLevels = (value) => {
+    const [l3, dipole] = value.split('/').map((str) => parseFloat(str.slice(0, -2)));
+    return { l3, dipole };
+};
 
 /**
  * AliceL3AndDipoleFilteringModel
  */
-export class MagnetsFilteringModel extends FilterModel {
+export class MagnetsFilteringModel extends ObservableBasedSelectionDropdownModel {
     /**
      * Constructor
      *
      * @param {ObservableData<RemoteData<MagnetsCurrentLevels[], ApiError>>} magnetsCurrentLevels$ observable remote data of magnets current
      * levels
      */
     constructor(magnetsCurrentLevels$) {
-        super();
-        this._selectionDropdownModel = new ObservableBasedSelectionDropdownModel(
-            magnetsCurrentLevels$,
-            (magnetsCurrentLevels) => ({ value: magnetsCurrentLevelsToOptionValue(magnetsCurrentLevels) }),
-            { multiple: false },
-        );
-        this._addSubmodel(this._selectionDropdownModel);
-
-        this._valueToFilteringParamsMap = new Map();
-        magnetsCurrentLevels$.observe(() => {
-            magnetsCurrentLevels$.getCurrent().match({
-
-                /**
-                 * Fill map indexing current level by their corresponding value
-                 *
-                 * @param {MagnetsCurrentLevels[]} currentLevels the current levels to map
-                 * @return {void}
-                 */
-                Success: (currentLevels) => {
-                    this._valueToFilteringParamsMap = new Map(currentLevels.map(({ l3, dipole }) => [
-                        magnetsCurrentLevelsToOptionValue({ l3, dipole }),
-                        { l3, dipole },
-                    ]));
-                },
-                Other: () => {
-                    this._valueToFilteringParamsMap = new Map();
-                },
-            });
-        });
+        super(magnetsCurrentLevels$, magnetsCurrentLevelsToKey, { multiple: false });
     }
 
     /**
      * @inheritDoc
      */
-    reset() {
-        this._selectionDropdownModel.reset();
-    }
+    get normalized() {
+        const [selectedOption] = this.selected;
 
-    /**
-     * @inheritDoc
-     */
-    get isEmpty() {
-        return this._selectionDropdownModel.isEmpty;
-    }
+        if (selectedOption === undefined) {
+            return null;
+        }
 
-    /**
-     * @inheritDoc
-     */
-    get normalized() {
-        return this._valueToFilteringParamsMap.get(this._selectionDropdownModel.selected[0]) ?? null;
+        return keyToMagnetsCurrentLevels(selectedOption);
     }
 
     /**
-     * Return the underlying selection dropdown model
+     * Sets selected options based on an object containing l3 and dipole fields.
+     * Accounts for the options being either RemoteData or an array.
      *
-     * @return {SelectionDropdownModel} the dropdown model
+     * @param {MagnetsCurrentLevels} value the magnets current levels
+     * @param {number} value.l3 the L3 current level in kA
+     * @param {number} value.dipole the dipole current level in kA
      */
-    get selectionDropdownModel() {
-        return this._selectionDropdownModel;
+    set normalized(value) {
+        super.normalized = magnetsCurrentLevelsToKey(value).value;
     }
 }

lib/public/components/Filters/RunsFilter/MultiCompositionFilterModel.js

@@ -89,4 +89,15 @@ export class MultiCompositionFilterModel extends FilterModel {
 
         return normalized;
     }
+
+    /**
+     * @inheritDoc
+     */
+    set normalized(filters) {
+        for (const [key, value] of Object.entries(filters)) {
+            if (key in this._filters) {
+                this._filters[key].normalized = value;
+            }
+        }
+    }
 }

lib/public/components/Filters/RunsFilter/RunDefinitionFilterModel.js

@@ -1,10 +1,10 @@
 import { RUN_DEFINITIONS, RunDefinition } from '../../../domain/enums/RunDefinition.js';
-import { SelectionFilterModel } from '../common/filters/SelectionFilterModel.js';
+import { SelectionModel } from '../../common/selection/SelectionModel.js';
 
 /**
  * Run definition filter model
  */
-export class RunDefinitionFilterModel extends SelectionFilterModel {
+export class RunDefinitionFilterModel extends SelectionModel {
     /**
      * Constructor
      */
@@ -18,7 +18,7 @@ export class RunDefinitionFilterModel extends SelectionFilterModel {
      * @return {boolean} true if filter is physics only
      */
     isPhysicsOnly() {
-        const selectedOptions = this._selectionModel.selected;
+        const selectedOptions = this.selected;
         return selectedOptions.length === 1 && selectedOptions[0] === RunDefinition.Physics;
     }
 
@@ -29,8 +29,8 @@ export class RunDefinitionFilterModel extends SelectionFilterModel {
      */
     setPhysicsOnly() {
         if (!this.isPhysicsOnly()) {
-            this._selectionModel.selectedOptions = [];
-            this._selectionModel.select(RunDefinition.Physics);
+            this.selectedOptions = [];
+            this.select(RunDefinition.Physics);
             this.notify();
         }
     }

lib/public/components/Filters/RunsFilter/TimeRangeFilter.js

@@ -45,6 +45,13 @@ export class TimeRangeFilterModel extends FilterModel {
         return normalized;
     }
 
+    /**
+     * @inheritDoc
+     */
+    set normalized({ from, to }) {
+        this._timeRangeInputModel.normalized = { from, to };
+    }
+
     /**
      * Return the underlying time range input model
      *