[O2B-1489] Add filtering support to EnvironmentOverviewModel

Adds FilteringModel to EnvironmentOverviewModel, enabling filter state management.

Author: isaachilly

lib/public/views/Environments/EnvironmentModel.js

@@ -23,12 +23,13 @@ import { EnvironmentDetailsModel } from './Details/EnvironmentDetailsModel.js';
 export class EnvironmentModel extends Observable {
     /**
      * The constructor of the Overview model object
+     * @param {Model} model global model
      */
-    constructor() {
+    constructor(model) {
         super();
 
         // Sub-models
-        this._overviewModel = new EnvironmentOverviewModel();
+        this._overviewModel = new EnvironmentOverviewModel(model);
         this._overviewModel.bubbleTo(this);
 
         this._detailsModel = new EnvironmentDetailsModel();

lib/public/views/Environments/Overview/EnvironmentOverviewModel.js

@@ -11,17 +11,34 @@
  * or submit itself to any jurisdiction.
  */
 
+import { FilteringModel } from '../../../components/Filters/common/FilteringModel.js';
 import { OverviewPageModel } from '../../../models/OverviewModel.js';
+import { debounce } from '../../../utilities/debounce.js';
 
 /**
  * Environment overview page model
  */
 export class EnvironmentOverviewModel extends OverviewPageModel {
     /**
      * Constructor
+     * @param {Model} model global model
      */
-    constructor() {
+    constructor(model) {
         super();
+
+        this._filteringModel = new FilteringModel({
+        });
+
+        this._filteringModel.observe(() => this._applyFilters(true));
+        this._filteringModel.visualChange$?.bubbleTo(this);
+
+        this.reset(false);
+        const updateDebounceTime = () => {
+            this._debouncedLoad = debounce(this.load.bind(this), model.inputDebounceTime);
+        };
+
+        model.appConfiguration$.observe(() => updateDebounceTime());
+        updateDebounceTime();
     }
 
     /**
@@ -31,6 +48,16 @@ export class EnvironmentOverviewModel extends OverviewPageModel {
         return '/api/environments';
     }
 
+    /**
+     * @inheritDoc
+     */
+    async getLoadParameters() {
+        return {
+            ...await super.getLoadParameters(),
+            filter: this._filteringModel.normalized,
+        };
+    }
+
     /**
      * Returns the current environments list as remote data
      *
@@ -39,4 +66,56 @@ export class EnvironmentOverviewModel extends OverviewPageModel {
     get environments() {
         return this.items;
     }
+
+    /**
+     * Returns all filtering, sorting and pagination settings to their default values
+     * @param {boolean} [fetch = true] whether to refetch all data after filters have been reset
+     * @return {void}
+     */
+    reset(fetch = true) {
+        super.reset();
+        this.resetFiltering(fetch);
+    }
+
+    /**
+     * Reset all filtering models
+     * @param {boolean} fetch Whether to refetch all data after filters have been reset
+     * @return {void}
+     */
+    resetFiltering(fetch = true) {
+        this._filteringModel.reset();
+
+        if (fetch) {
+            this._applyFilters(true);
+        }
+    }
+
+    /**
+     * Checks if any filter value has been modified from their default (empty)
+     * @return {Boolean} If any filter is active
+     */
+    isAnyFilterActive() {
+        return this._filteringModel.isAnyFilterActive();
+    }
+
+    /**
+     * Return the filtering model
+     *
+     * @return {FilteringModel} the filtering model
+     */
+    get filteringModel() {
+        return this._filteringModel;
+    }
+
+    /**
+     * Apply the current filtering and update the remote data list
+     *
+     * @param {boolean} now if true, filtering will be applied now without debouncing
+     *
+     * @return {void}
+     */
+    _applyFilters(now = false) {
+        this._pagination.currentPage = 1;
+        now ? this.load() : this._debouncedLoad(true);
+    }
 }