@finos/legend-data-cube 0.0.48 → 0.1.1

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 {
@@ -29,6 +29,7 @@ import {
   INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE,
   INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION,
   computeHashCodeForDataFetchManualTrigger,
+  INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_CACHING,
 } from './DataCubeGridClientEngine.js';
 import { DataCubeQuerySnapshotController } from '../../services/DataCubeQuerySnapshotService.js';
 import type { DataCubeQuerySnapshot } from '../../core/DataCubeQuerySnapshot.js';
@@ -65,6 +66,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
   queryConfiguration: DataCubeConfiguration;
   rowLimit?: number | undefined;
   isPaginationEnabled = INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION;
+  isCachingEnabled = INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_CACHING;
   scrollHintText?: string | undefined;
   // As we resize columns dynamically to fit their content, virtual columns are being rendered
   // and resized as user scrolls horizontally, this can cause performance issues, so we debounce.
@@ -83,6 +85,9 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
       isPaginationEnabled: observable,
       setPaginationEnabled: action,
 
+      isCachingEnabled: observable,
+      setCachingEnabled: action,
+
       scrollHintText: observable,
       setScrollHintText: action,
 
@@ -119,6 +124,35 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     });
   }
 
+  async setCachingEnabled(val: boolean) {
+    const currentVal = this.isCachingEnabled;
+    if (val === currentVal) {
+      return;
+    }
+
+    runInAction(() => {
+      this.isCachingEnabled = val;
+    });
+
+    if (val) {
+      await this._view.initializeCache();
+      if (this._view.processCacheState.hasFailed) {
+        this.isCachingEnabled = currentVal;
+        return;
+      }
+    } else {
+      await this._view.disposeCache();
+    }
+
+    runInAction(() => {
+      // hard reset the grid, this will force the grid to fetch data again
+      this.clientDataSource = new DataCubeGridClientServerSideDataSource(
+        this,
+        this._view,
+      );
+    });
+  }
+
   setScrollHintText(val: string | undefined) {
     this.scrollHintText = val;
   }

package/tsconfig.json

@@ -67,6 +67,7 @@
     "./src/stores/core/filter/DataCubeQueryFilterEditorState.ts",
     "./src/stores/core/filter/DataCubeQueryFilterOperation.ts",
     "./src/stores/core/model/AdhocQueryDataCubeSource.ts",
+    "./src/stores/core/model/CachedDataCubeSource.ts",
     "./src/stores/core/model/DataCubeColumn.ts",
     "./src/stores/core/model/DataCubeConfiguration.ts",
     "./src/stores/core/model/DataCubeQuery.ts",