@finos/legend-data-cube 0.1.32 → 0.2.1

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

@@ -62,9 +62,13 @@ import {
 } from './DataCubeGridClientEngine.js';
 import { DataCubeConfiguration } from '../../core/model/DataCubeConfiguration.js';
 import { _colSpecArrayParam } from '../../core/DataCubeSnapshotBuilderUtils.js';
-import { buildExecutableQuery } from '../../core/DataCubeQueryBuilder.js';
+import {
+  buildDimensionalExecutableQuery,
+  buildExecutableQuery,
+} from '../../core/DataCubeQueryBuilder.js';
 import type { DataCubeSource } from '../../core/model/DataCubeSource.js';
 import type { DataCubeEngine } from '../../core/DataCubeEngine.js';
+import type { DataCubeDimensionalNode } from './DataCubeGridDimensionalTree.js';
 
 /*****************************************************************************
  * [GRID]
@@ -188,6 +192,23 @@ export function buildGridDataFetchExecutableQuery(
   });
 }
 
+export function buildDimensionalGridDataFetchExecutableQuery(
+  snapshot: DataCubeSnapshot,
+  source: DataCubeSource,
+  engine: DataCubeEngine,
+  nodes: DataCubeDimensionalNode[],
+) {
+  //TODO: Try to remove this cloning
+  const processedSnapshot = snapshot.clone();
+  //TODO: check if we need to show root aggregation in this mode
+  return buildDimensionalExecutableQuery(
+    processedSnapshot,
+    source,
+    engine,
+    nodes,
+  );
+}
+
 function generateGridDataFetchExecutableQueryPostProcessor(
   request: DataCubeGridClientDataFetchRequest,
 ) {

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

@@ -21,7 +21,7 @@ import {
   type DebouncedFunc,
 } from '@finos/legend-shared';
 import { action, makeObservable, observable, runInAction } from 'mobx';
-import type { GridApi } from 'ag-grid-community';
+import type { CellDoubleClickedEvent, GridApi } from 'ag-grid-community';
 import type { DataCubeViewState } from '../DataCubeViewState.js';
 import {
   DataCubeGridClientServerSideDataSource,
@@ -31,6 +31,7 @@ import {
   INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION,
   computeHashCodeForDataFetchManualTrigger,
   INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_CACHING,
+  fetchDimensionalQueryRows,
 } from './DataCubeGridClientEngine.js';
 import { DataCubeSnapshotController } from '../../services/DataCubeSnapshotService.js';
 import type { DataCubeSnapshot } from '../../core/DataCubeSnapshot.js';
@@ -41,8 +42,19 @@ import { DataCubeGridClientExportEngine } from './DataCubeGridClientExportEngine
 import { DataCubeSettingKey } from '../../../__lib__/DataCubeSetting.js';
 import { DEFAULT_ALERT_WINDOW_CONFIG } from '../../services/DataCubeLayoutService.js';
 import { AlertType } from '../../services/DataCubeAlertService.js';
-import { DataCubeGridMode } from '../../core/DataCubeQueryEngine.js';
+import {
+  DataCubeClientModelOption,
+  DataCubeGridMode,
+} from '../../core/DataCubeQueryEngine.js';
 import { DataCubeEvent } from '../../../__lib__/DataCubeEvent.js';
+import {
+  cloneDimensionalTree,
+  hydrateDataCubeDimensionalTree,
+  removeSubtreeNode,
+  type DataCubeDimensionalTree,
+  type DataCubeDimensionalMetadata,
+} from './DataCubeGridDimensionalTree.js';
+
 /**
  * This query editor state is responsible for syncing the internal state of ag-grid
  * server-side row model data source with the data cube query state. When new snapshot
@@ -271,6 +283,84 @@ export class DataCubeGridState extends DataCubeSnapshotController {
     }
   }
 
+  async configureDimensionGridClient(val: GridApi | undefined) {
+    this._client = val;
+    this.debouncedAutoResizeColumns = debounce(
+      () => val?.autoSizeAllColumns(),
+      100,
+    );
+    const latestSnapshot = this.getLatestSnapshot();
+
+    if (latestSnapshot) {
+      if (!latestSnapshot.data.dimensionalTree) {
+        latestSnapshot.data.dimensionalTree = hydrateDataCubeDimensionalTree(
+          DataCubeConfiguration.serialization.fromJson(
+            latestSnapshot.data.configuration,
+          ),
+        );
+      }
+      await this._applyDimensionalSnapshot(latestSnapshot);
+    }
+  }
+
+  async retrieveDrilloutData(
+    metadata: Map<string, DataCubeDimensionalMetadata>,
+    dimension: string,
+  ) {
+    const latestSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
+    const previousTree = cloneDimensionalTree(
+      guaranteeNonNullable(latestSnapshot.data.dimensionalTree),
+    );
+    removeSubtreeNode(
+      guaranteeNonNullable(latestSnapshot.data.dimensionalTree),
+      dimension,
+      guaranteeNonNullable(metadata.get(dimension)?.column),
+      guaranteeNonNullable(metadata.get(dimension)?.groupByNodes),
+    );
+    await this._applyDimensionalSnapshot(latestSnapshot, previousTree);
+  }
+
+  async retrieveDrilldownData(data?: CellDoubleClickedEvent) {
+    const latestSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
+    const previousTree = cloneDimensionalTree(
+      guaranteeNonNullable(latestSnapshot.data.dimensionalTree),
+    );
+    latestSnapshot.data.dimensionalTree = hydrateDataCubeDimensionalTree(
+      DataCubeConfiguration.serialization.fromJson(
+        latestSnapshot.data.configuration,
+      ),
+      data,
+      latestSnapshot.data.dimensionalTree,
+    );
+    await this._applyDimensionalSnapshot(latestSnapshot, previousTree);
+  }
+
+  private async _applyDimensionalSnapshot(
+    snapshot: DataCubeSnapshot,
+    previousTree?: DataCubeDimensionalTree,
+  ) {
+    this._client?.hideOverlay();
+    this._client?.setGridOption(DataCubeClientModelOption.LOADING, true);
+    const result = await fetchDimensionalQueryRows(
+      snapshot,
+      this._view,
+      previousTree,
+    );
+    this._client?.setGridOption(
+      DataCubeClientModelOption.ROW_DATA,
+      result.rowData,
+    );
+    this._client?.setGridOption(
+      DataCubeClientModelOption.COLUMN_DEFS,
+      result.columnDefs,
+    );
+    if (result.rowData.length === 0) {
+      this._client?.showNoRowsOverlay();
+    }
+    this._client?.setGridOption(DataCubeClientModelOption.LOADING, false);
+    this.publishSnapshot(snapshot);
+  }
+
   override getSnapshotSubscriberName() {
     return 'grid';
   }

package/tsconfig.json

@@ -94,6 +94,7 @@
     "./src/stores/view/grid/DataCubeGridClientEngine.ts",
     "./src/stores/view/grid/DataCubeGridClientExportEngine.ts",
     "./src/stores/view/grid/DataCubeGridControllerState.ts",
+    "./src/stores/view/grid/DataCubeGridDimensionalTree.ts",
     "./src/stores/view/grid/DataCubeGridQueryBuilder.ts",
     "./src/stores/view/grid/DataCubeGridSnapshotBuilder.ts",
     "./src/stores/view/grid/DataCubeGridState.ts",