@finos/legend-data-cube 0.1.0 → 0.1.2

package/src/stores/view/grid/DataCubeGridQueryBuilder.ts

@@ -60,11 +60,10 @@ import {
   type DataCubeGridClientDataFetchRequest,
 } from './DataCubeGridClientEngine.js';
 import { DataCubeConfiguration } from '../../core/model/DataCubeConfiguration.js';
-import type { DataCubeQueryFilterOperation } from '../../core/filter/DataCubeQueryFilterOperation.js';
-import type { DataCubeQueryAggregateOperation } from '../../core/aggregation/DataCubeQueryAggregateOperation.js';
 import { _colSpecArrayParam } from '../../core/DataCubeQuerySnapshotBuilderUtils.js';
 import { buildExecutableQuery } from '../../core/DataCubeQueryBuilder.js';
 import type { DataCubeSource } from '../../core/model/DataCubeSource.js';
+import type { DataCubeEngine } from '../../core/DataCubeEngine.js';
 
 /*****************************************************************************
  * [GRID]
@@ -148,11 +147,7 @@ export function buildGridDataFetchExecutableQuery(
   request: DataCubeGridClientDataFetchRequest,
   snapshot: DataCubeQuerySnapshot,
   source: DataCubeSource,
-  executionContextBuilder: (
-    source: DataCubeSource,
-  ) => V1_AppliedFunction | undefined,
-  filterOperations: DataCubeQueryFilterOperation[],
-  aggregateOperations: DataCubeQueryAggregateOperation[],
+  engine: DataCubeEngine,
   enablePagination: boolean,
 ) {
   const processedSnapshot = snapshot.clone();
@@ -170,28 +165,21 @@ export function buildGridDataFetchExecutableQuery(
       ],
     };
   }
-  return buildExecutableQuery(
-    processedSnapshot,
-    source,
-    executionContextBuilder,
-    filterOperations,
-    aggregateOperations,
-    {
-      postProcessor: generateGridDataFetchExecutableQueryPostProcessor(request),
-      rootAggregation: {
-        columnName: INTERNAL__GRID_CLIENT_ROOT_AGGREGATION_COLUMN_ID,
-      },
-      pagination:
-        enablePagination &&
-        request.startRow !== undefined &&
-        request.endRow !== undefined
-          ? {
-              start: request.startRow,
-              end: request.endRow,
-            }
-          : undefined,
+  return buildExecutableQuery(processedSnapshot, source, engine, {
+    postProcessor: generateGridDataFetchExecutableQueryPostProcessor(request),
+    rootAggregation: {
+      columnName: INTERNAL__GRID_CLIENT_ROOT_AGGREGATION_COLUMN_ID,
     },
-  );
+    pagination:
+      enablePagination &&
+      request.startRow !== undefined &&
+      request.endRow !== undefined
+        ? {
+            start: request.startRow,
+            end: request.endRow,
+          }
+        : undefined,
+  });
 }
 
 function generateGridDataFetchExecutableQueryPostProcessor(
@@ -202,8 +190,7 @@ function generateGridDataFetchExecutableQueryPostProcessor(
     sequence: V1_AppliedFunction[],
     funcMap: DataCubeQueryFunctionMap,
     configuration: DataCubeConfiguration,
-    filterOperations: DataCubeQueryFilterOperation[],
-    aggregateOperations: DataCubeQueryAggregateOperation[],
+    engine: DataCubeEngine,
   ) => {
     const _unprocess = _functionCompositionUnProcessor(sequence, funcMap);
     const data = snapshot.data;
@@ -285,7 +272,7 @@ function generateGridDataFetchExecutableQueryPostProcessor(
                     }),
                     groupOperator: DataCubeQueryFilterGroupOperator.AND,
                   },
-                  filterOperations,
+                  engine.filterOperations,
                 ),
               ],
             ),
@@ -312,7 +299,7 @@ function generateGridDataFetchExecutableQueryPostProcessor(
               groupByColumns,
               snapshot,
               configuration,
-              aggregateOperations,
+              engine.aggregateOperations,
             ),
 
             // if pivot is present, add sum aggregation columns for each

package/src/stores/view/grid/DataCubeGridState.ts

@@ -19,7 +19,7 @@ import {
   guaranteeNonNullable,
   type DebouncedFunc,
 } from '@finos/legend-shared';
-import { action, makeObservable, observable } from 'mobx';
+import { action, makeObservable, observable, runInAction } from 'mobx';
 import type { GridApi } from 'ag-grid-community';
 import type { DataCubeViewState } from '../DataCubeViewState.js';
 import {
@@ -38,6 +38,8 @@ import { DataCubeConfiguration } from '../../core/model/DataCubeConfiguration.js
 import { DataCubeGridControllerState } from './DataCubeGridControllerState.js';
 import { DataCubeGridClientExportEngine } from './DataCubeGridClientExportEngine.js';
 import { DataCubeSettingKey } from '../../../__lib__/DataCubeSetting.js';
+import { DEFAULT_ALERT_WINDOW_CONFIG } from '../../services/DataCubeLayoutService.js';
+import { AlertType } from '../../services/DataCubeAlertService.js';
 
 /**
  * This query editor state is responsible for syncing the internal state of ag-grid
@@ -125,15 +127,94 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
   }
 
   async setCachingEnabled(val: boolean) {
-    this.isCachingEnabled = val;
-    if (this.isCachingEnabled) {
-      this._client?.setGridOption('loading', true);
+    if (val === this.isCachingEnabled) {
+      return;
+    }
+
+    // disable caching
+    if (val === false) {
+      await this._view.disposeCache();
+
+      runInAction(() => {
+        this.isCachingEnabled = val;
+
+        // hard reset the grid, this will force the grid to fetch data again
+        this.clientDataSource = new DataCubeGridClientServerSideDataSource(
+          this,
+          this._view,
+        );
+      });
+
+      return;
+    }
+
+    // enable caching
+    const run = async () => {
       await this._view.initializeCache();
-      this._client?.setGridOption('loading', false);
+
+      // only update value if cache processing succeeds
+      if (this._view.processCacheState.hasSucceeded) {
+        runInAction(() => {
+          this.isCachingEnabled = val;
+
+          // hard reset the grid, this will force the grid to fetch data again
+          this.clientDataSource = new DataCubeGridClientServerSideDataSource(
+            this,
+            this._view,
+          );
+        });
+      }
+    };
+
+    // TODO?: we might want to do a quick check here for the amount of data the cache
+    // will handle, so maybe fire a COUNT query to check for the number of records
+    // and check that against a threshold, we will need to alter the prompt below accordingly.
+    if (
+      this._settingService.getBooleanValue(
+        DataCubeSettingKey.GRID_CLIENT__SHOW_CACHE_PERFORMANCE_WARNING,
+      )
+    ) {
+      this._view.alertService.alert({
+        message: `Confirm you want to proceed with caching`,
+        text: `When enabled, the source dataset will be cached locally in order to boost query performance. But depending on computational resource available to your environment, sometimes, caching can negatively impact the overall performance, and can even lead to crashes.\nDo you still want to proceed?`,
+        type: AlertType.WARNING,
+        actions: [
+          {
+            label: 'Abort',
+            handler: () => {},
+          },
+          {
+            label: 'Proceed',
+            handler: () => {
+              run().catch((error) =>
+                this._view.alertService.alertUnhandledError(error),
+              );
+            },
+          },
+          {
+            label: 'Dismiss Warning and Proceed',
+            handler: () => {
+              this._view.settingService.updateValue(
+                this._view.dataCube.api,
+                DataCubeSettingKey.GRID_CLIENT__SHOW_CACHE_PERFORMANCE_WARNING,
+                false,
+              );
+              run().catch((error) =>
+                this._view.alertService.alertUnhandledError(error),
+              );
+            },
+          },
+        ],
+        windowConfig: {
+          ...DEFAULT_ALERT_WINDOW_CONFIG,
+          width: 600,
+          height: 210,
+          minWidth: 300,
+          minHeight: 150,
+        },
+      });
     } else {
-      this._client?.setGridOption('loading', true);
-      await this._view.clearCache();
-      this._client?.setGridOption('loading', false);
+      await run();
     }
   }