cleanup

Author: xsalonx

lib/public/models/DataExportModel.js

@@ -15,17 +15,30 @@ import { Observable } from '/js/src/index.js';
 import { createCSVExport, createJSONExport } from '../utilities/export.js';
 import pick from '../utilities/pick.js';
 
+/**
+ * @typedef FieldExportConfiguration
+ *
+ * @property {function|null} exportFormat
+ */
+
+/**
+ * @typdef DataExportConfiguration
+ *
+ * @type {object<string, FieldExportConfiguration>} mapping: field name -> field export configuration
+ */
+
 /**
  * Model handling export configuration and creation
  */
 export class DataExportModel extends Observable {
     /**
      * Constructor
+     *
      * @param {ObservableData<RemoteData<T[]>>} items$ observable data used as source for export
-     * @param {object<string, {exportFormat: function|null|undefined}>} fieldsFormatting defines selectable fields and their formatting
+     * @param {DataExportConfiguration} dataExportConfiguration defines selectable fields and their formatting
      * @param {function} onDataNotAskedAction function to be called in case of missing data
      */
-    constructor(items$, fieldsFormatting, onDataNotAskedAction) {
+    constructor(items$, dataExportConfiguration, onDataNotAskedAction) {
         super();
 
         this._items$ = items$;
@@ -39,7 +52,7 @@ export class DataExportModel extends Observable {
 
         this._exportName = 'data';
 
-        this._fieldsFormatting = fieldsFormatting;
+        this._dataExportConfiguration = dataExportConfiguration;
         this._onDataNotAskedAction = onDataNotAskedAction;
 
         this._disabled = null;
@@ -48,15 +61,17 @@ export class DataExportModel extends Observable {
     }
 
     /**
-     * Get mapping of selecteble fields to their format functions
-     * @return {object<string, {exportFormat: function|null|undefined}>} mapping
+     * Get data export configuration
+     *
+     * @return {DataExportConfiguration>} configuration
      */
-    get fieldsFormatting() {
-        return this._fieldsFormatting;
+    get dataExportConfiguration() {
+        return this._dataExportConfiguration;
     }
 
     /**
      * Get total number of items that model knows they exist
+     *
      * @return {number} totalExistingItemsCount
      */
     get totalExistingItemsCount() {
@@ -113,6 +128,7 @@ export class DataExportModel extends Observable {
 
     /**
      * Observable notified when the export configuration visually changes
+     *
      * @return {Observable} the visual change observable
      */
     get visualChange$() {
@@ -121,6 +137,7 @@ export class DataExportModel extends Observable {
 
     /**
      * Get export type selected by the user
+     *
      * @return {string} export type
      */
     get selectedExportType() {
@@ -129,6 +146,7 @@ export class DataExportModel extends Observable {
 
     /**
      * Set export type
+     *
      * @param {string} exportType export type
      * @return {void}
      */
@@ -140,6 +158,7 @@ export class DataExportModel extends Observable {
 
     /**
      * Get selected fields
+     *
      * @return {string[]} selected fields
      */
     get selectedFields() {
@@ -148,6 +167,7 @@ export class DataExportModel extends Observable {
 
     /**
      * Update selected fields from HTML options list
+     *
      * @param {HTMLCollection|Array} selectedOptions options collection
      * @return {void}
      */
@@ -160,6 +180,7 @@ export class DataExportModel extends Observable {
 
     /**
      * Create export using current items observable
+     *
      * @return {Promise<void>} void
      */
     async createExport() {
@@ -170,7 +191,7 @@ export class DataExportModel extends Observable {
                 const formatted = items.map((item) => {
                     const selectedEntries = Object.entries(pick(item, selectedFields));
                     const mappedEntries = selectedEntries.map(([key, value]) => {
-                        const formatter = this.fieldsFormatting[key]?.exportFormat || ((v) => v);
+                        const formatter = this.dataExportConfiguration[key]?.exportFormat || ((v) => v);
                         return [key, formatter(value, item)];
                     });
 

lib/public/models/OverviewModel.js

@@ -46,29 +46,29 @@ export class OverviewPageModel extends Observable {
         });
         this._sortModel.visualChange$.bubbleTo(this);
 
+        // Single page data handling
         this._pagination = new PaginationModel();
         this._pagination.observe(() => this.load());
         this._pagination.itemsPerPageSelector$.observe(() => this.notify());
 
         const dataSourceObservable = ObservableData.builder().initialValue(RemoteData.loading()).build();
-        dataSourceObservable.observe(() => this.parseApiRemoteData(dataSourceObservable.getCurrent()));
+        dataSourceObservable.observe(() => this.parseApiPaginatedRemoteData(dataSourceObservable.getCurrent()));
 
         this._dataSource = new PaginatedRemoteDataSource();
         this._dataSource.pipe(dataSourceObservable);
 
         this._item$ = ObservableData.builder().initialValue(RemoteData.loading()).build();
         this._item$.bubbleTo(this);
 
-        {
-            const allDataSourceObservable = ObservableData.builder().initialValue(RemoteData.loading()).build();
-            allDataSourceObservable.observe(() => this.parseAllApiRemoteData(allDataSourceObservable.getCurrent()));
+        // All data handling
+        const allDataSourceObservable = ObservableData.builder().initialValue(RemoteData.loading()).build();
+        allDataSourceObservable.observe(() => this.parseApiNotPaginatedRemoteData(allDataSourceObservable.getCurrent()));
 
-            this._allDataSource = new PaginatedRemoteDataSource();
-            this._allDataSource.pipe(allDataSourceObservable);
+        this._allDataSource = new PaginatedRemoteDataSource();
+        this._allDataSource.pipe(allDataSourceObservable);
 
-            this._allItems$ = ObservableData.builder().initialValue(RemoteData.loading()).build();
-            this._allItems$.bubbleTo(this);
-        }
+        this._allItems$ = ObservableData.builder().initialValue(RemoteData.loading()).build();
+        this._allItems$.bubbleTo(this);
 
         /**
          * @type {ObservableData<TableConfiguration>}
@@ -105,7 +105,7 @@ export class OverviewPageModel extends Observable {
      * @param {RemoteData<{items: T[], totalCount: number}, *>} remoteData the API remote data
      * @return {void}
      */
-    parseApiRemoteData(remoteData) {
+    parseApiPaginatedRemoteData(remoteData) {
         /*
          * When fetching data, to avoid concurrency issues, save a flag stating if the fetched data should be concatenated with the current one
          * (infinite scroll) or if they should replace them
@@ -135,7 +135,7 @@ export class OverviewPageModel extends Observable {
      * @param {RemoteData<{items: T[], totalCount: number}, *>} remoteData the API remote data
      * @return {void}
      */
-    parseAllApiRemoteData(remoteData) {
+    parseApiNotPaginatedRemoteData(remoteData) {
         remoteData.match({
             NotAsked: () => this._allItems$.setCurrent(RemoteData.notAsked()),
             Loading: () => this._allItems$.setCurrent(RemoteData.loading()),
@@ -158,7 +158,7 @@ export class OverviewPageModel extends Observable {
 
     /**
      * Fetch all the relevant items from the API
-     * it takes into account pagination parameters
+     * it takes into account pagination parameters, but also reset not-paginated observable data
      *
      * @return {Promise<void>} void
      */

lib/public/views/Runs/Overview/RunsOverviewModel.js

@@ -34,7 +34,7 @@ import { RunDefinitionFilterModel } from '../../../components/Filters/RunsFilter
 import { RUN_QUALITIES } from '../../../domain/enums/RunQualities.js';
 import { SelectionFilterModel } from '../../../components/Filters/common/filters/SelectionFilterModel.js';
 import { DataExportModel } from '../../../models/DataExportModel.js';
-import { runsActiveColumns as fieldsFormattingConf } from '../ActiveColumns/runsActiveColumns.js';
+import { runsActiveColumns as dataExportConfiguration } from '../ActiveColumns/runsActiveColumns.js';
 
 /**
  * Model representing handlers for runs page
@@ -101,7 +101,7 @@ export class RunsOverviewModel extends OverviewPageModel {
             this._debouncedLoad = debounce(this.load.bind(this), model.inputDebounceTime);
         };
 
-        this._exportModel = new DataExportModel(this._allItems$, fieldsFormattingConf, () => this.loadAll());
+        this._exportModel = new DataExportModel(this._allItems$, dataExportConfiguration, () => this.loadAll());
         this._item$.observe(() => {
             this._exportModel.setDisabled(!this.hasAnyData());
             this._exportModel.setTotalExistingItemsCount(this._pagination.itemsCount);

lib/public/views/Runs/Overview/exportTriggerAndModal.js

@@ -27,7 +27,7 @@ const exportForm = (exportModel, modalHandler) => {
 
     const { selectedFields } = exportModel;
     const { selectedExportType } = exportModel;
-    const fields = Object.keys(exportModel.fieldsFormatting);
+    const fields = Object.keys(exportModel.dataExportConfiguration);
 
     const fieldsSelected = selectedFields.length > 0;