@finos/legend-data-cube 0.0.35 → 0.0.37

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

@@ -53,6 +53,7 @@ import {
   buildGridDataFetchExecutableQuery,
 } from './DataCubeGridQueryBuilder.js';
 import { _colSpecArrayParam } from '../../core/DataCubeQuerySnapshotBuilderUtils.js';
+import { DataCubeSettingKey } from '../../core/DataCubeSetting.js';
 
 type DataCubeGridClientCellValue = string | number | boolean | null | undefined;
 type DataCubeGridClientRowData = {
@@ -121,7 +122,7 @@ export const INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE = 500;
 export const INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION = true;
 // NOTE: The cache block size is used by ag-grid to pre-allocate memory for the grid
 // so the value set must be reasonable, or else it can crash the engine!
-export const INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE = 1e4;
+export const INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE = 1e3;
 
 export const INTERNAL__GRID_CLIENT_PIVOT_COLUMN_GROUP_COLOR_ROTATION_SIZE = 5;
 export const INTERNAL__GRID_CLIENT_SIDE_BAR_WIDTH = 200;
@@ -299,11 +300,11 @@ async function getCastColumns(
 
   const lambda = new V1_Lambda();
   lambda.body.push(query);
-  const result = await view.engine.executeQuery(
-    lambda,
-    view.source,
-    view.dataCube,
-  );
+  const result = await view.engine.executeQuery(lambda, view.source, {
+    debug: view.dataCube.settings.getBooleanValue(
+      DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE,
+    ),
+  });
 
   return result.result.builder.columns.map((column) => ({
     name: column.name,
@@ -423,10 +424,18 @@ export class DataCubeGridClientServerSideDataSource
       const result = await this.grid.view.engine.executeQuery(
         lambda,
         this.grid.view.source,
-        this.grid.view.dataCube,
+        {
+          debug: this.grid.view.dataCube.settings.getBooleanValue(
+            DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE,
+          ),
+        },
       );
       const rowData = buildRowData(result.result.result, newSnapshot);
-      if (this.grid.view.dataCube.settings.enableDebugMode) {
+      if (
+        this.grid.view.dataCube.settings.getBooleanValue(
+          DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE,
+        )
+      ) {
         this.grid.view.engine.debugProcess(
           `Execution`,
           ['Query', result.executedQuery],
@@ -473,8 +482,9 @@ export class DataCubeGridClientServerSideDataSource
         // behavior by forcing a scroll top for every data fetch and also reset the cache block size to the default value to save memory
         if (rowData.length > INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE) {
           if (
-            !this.grid.view.dataCube.settings
-              .gridClientSuppressLargeDatasetWarning
+            !this.grid.view.dataCube.settings.getBooleanValue(
+              DataCubeSettingKey.GRID_CLIENT__SUPPRESS_LARGE_DATASET_WARNING,
+            )
           ) {
             this.grid.view.engine.alert({
               message: `Large dataset (>${INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE} rows) detected!`,
@@ -490,7 +500,8 @@ export class DataCubeGridClientServerSideDataSource
                 {
                   label: 'Dismiss Warning',
                   handler: () => {
-                    this.grid.view.dataCube.settings.setGridClientSuppressLargeDatasetWarning(
+                    this.grid.view.dataCube.settings.updateValue(
+                      DataCubeSettingKey.GRID_CLIENT__SUPPRESS_LARGE_DATASET_WARNING,
                       true,
                     );
                   },

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

@@ -21,6 +21,7 @@ import {
   type V1_AppliedFunction,
   V1_GenericType,
   V1_RelationType,
+  V1_getGenericTypeFullPath,
 } from '@finos/legend-graph';
 import { type DataCubeQuerySnapshot } from '../../core/DataCubeQuerySnapshot.js';
 import {
@@ -109,7 +110,12 @@ function _addCountAggColumnToPivot(
       ).rawType,
       V1_RelationType,
     ).columns.map((column) =>
-      _colSpec(column.name, undefined, undefined, column.type),
+      _colSpec(
+        column.name,
+        undefined,
+        undefined,
+        V1_getGenericTypeFullPath(column.genericType),
+      ),
     );
     uniq(
       castColumns

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

@@ -36,6 +36,7 @@ import { generateGridOptionsFromSnapshot } from './DataCubeGridConfigurationBuil
 import { DataCubeConfiguration } from '../../core/models/DataCubeConfiguration.js';
 import { DataCubeGridControllerState } from './DataCubeGridControllerState.js';
 import { DataCubeGridClientExportEngine } from './DataCubeGridClientExportEngine.js';
+import { DataCubeSettingKey } from '../../core/DataCubeSetting.js';
 
 /**
  * This query editor state is responsible for syncing the internal state of ag-grid
@@ -73,7 +74,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     makeObservable(this, {
       clientDataSource: observable,
 
-      queryConfiguration: observable.ref,
+      queryConfiguration: observable,
 
       rowLimit: observable,
 
@@ -113,6 +114,10 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     this.scrollHintText = val;
   }
 
+  get isClientConfigured() {
+    return Boolean(this._client);
+  }
+
   get client() {
     return guaranteeNonNullable(this._client, 'Grid client is not configured');
   }
@@ -144,7 +149,11 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
       configuration,
       this.view,
     );
-    if (this.view.dataCube.settings.enableDebugMode) {
+    if (
+      this.view.dataCube.settings.getBooleanValue(
+        DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE,
+      )
+    ) {
       this.view.engine.debugProcess(`New Grid Options`, [
         'Grid Options',
         gridOptions,
@@ -152,7 +161,12 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     }
     this.client.updateGridOptions({
       ...gridOptions,
-      rowBuffer: this.view.dataCube.settings.gridClientRowBuffer,
+      rowBuffer: this.view.dataCube.settings.getNumericValue(
+        DataCubeSettingKey.GRID_CLIENT__ROW_BUFFER,
+      ),
+      purgeClosedRowNodes: this.view.dataCube.settings.getBooleanValue(
+        DataCubeSettingKey.GRID_CLIENT__PURGE_CLOSED_ROW_NODES,
+      ),
       // NOTE: ag-grid uses the cache block size as page size, so it's important to set this
       // in corresponding to the pagination setting, else it would cause unexpected scrolling behavior
       cacheBlockSize: this.isPaginationEnabled

package/tsconfig.json

@@ -52,9 +52,9 @@
   ],
   "files": [
     "./src/__lib__/DataCubeDocumentation.ts",
+    "./src/__lib__/DataCubeEvent.ts",
     "./src/stores/DataCubeAPI.ts",
     "./src/stores/DataCubeOptions.ts",
-    "./src/stores/DataCubeSettings.ts",
     "./src/stores/core/DataCubeConfigurationBuilder.ts",
     "./src/stores/core/DataCubeLayoutManagerState.ts",
     "./src/stores/core/DataCubeQueryBuilder.ts",
@@ -63,9 +63,11 @@
     "./src/stores/core/DataCubeQuerySnapshot.ts",
     "./src/stores/core/DataCubeQuerySnapshotBuilder.ts",
     "./src/stores/core/DataCubeQuerySnapshotBuilderUtils.ts",
+    "./src/stores/core/DataCubeSetting.ts",
     "./src/stores/core/aggregation/DataCubeQueryAggregateOperation.ts",
     "./src/stores/core/filter/DataCubeQueryFilterEditorState.ts",
     "./src/stores/core/filter/DataCubeQueryFilterOperation.ts",
+    "./src/stores/core/models/AdhocQueryDataCubeSource.ts",
     "./src/stores/core/models/DataCubeColumn.ts",
     "./src/stores/core/models/DataCubeConfiguration.ts",
     "./src/stores/core/models/DataCubeQuery.ts",
@@ -112,6 +114,7 @@
     "./src/components/view/filter/DataCubeFilterEditor.tsx",
     "./src/components/view/grid/DataCubeGrid.tsx",
     "./src/components/view/grid/DataCubeGridShared.tsx",
+    "./src/stores/DataCubeSettings.tsx",
     "./src/stores/DataCubeState.tsx",
     "./src/stores/core/DataCubeEngine.tsx",
     "./src/stores/core/aggregation/DataCubeQueryAggregateOperation__Average.tsx",

package/src/stores/DataCubeSettings.ts

@@ -1,107 +0,0 @@
-/**
- * Copyright (c) 2020-present, Goldman Sachs
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { makeObservable, observable, action } from 'mobx';
-import type { DataCubeState } from './DataCubeState.js';
-
-export enum DataCubeSettingKey {
-  ENABLE_DEBUG_MODE = 'engine.enableDebugMode',
-  GRID_CLIENT_ROW_BUFFER = 'engine.grid-client.rowBuffer',
-  GRID_CLIENT_PURGE_CLOSED_ROW_NODES = 'engine.grid-client.purgeClosedRowNodes',
-  GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING = 'engine.grid-client.suppressLargeDatasetWarning',
-}
-
-export const DEFAULT_SETTINGS = {
-  [DataCubeSettingKey.ENABLE_DEBUG_MODE]: false,
-  [DataCubeSettingKey.GRID_CLIENT_ROW_BUFFER]: 50,
-  [DataCubeSettingKey.GRID_CLIENT_PURGE_CLOSED_ROW_NODES]: false,
-  [DataCubeSettingKey.GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING]: false,
-};
-
-export class DataCubeSettings {
-  readonly dataCube: DataCubeState;
-
-  constructor(dataCube: DataCubeState) {
-    makeObservable(this, {
-      enableDebugMode: observable,
-      setEnableDebugMode: action,
-
-      gridClientRowBuffer: observable,
-      setGridClientRowBuffer: action,
-
-      gridClientPurgeClosedRowNodes: observable,
-      setGridClientPurgeClosedRowNodes: action,
-
-      gridClientSuppressLargeDatasetWarning: observable,
-      setGridClientSuppressLargeDatasetWarning: action,
-    });
-
-    this.dataCube = dataCube;
-  }
-
-  enableDebugMode = DEFAULT_SETTINGS[DataCubeSettingKey.ENABLE_DEBUG_MODE];
-  gridClientRowBuffer =
-    DEFAULT_SETTINGS[DataCubeSettingKey.GRID_CLIENT_ROW_BUFFER];
-  gridClientPurgeClosedRowNodes =
-    DEFAULT_SETTINGS[DataCubeSettingKey.GRID_CLIENT_PURGE_CLOSED_ROW_NODES];
-  gridClientSuppressLargeDatasetWarning =
-    DEFAULT_SETTINGS[
-      DataCubeSettingKey.GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING
-    ];
-
-  setEnableDebugMode(value: boolean) {
-    this.enableDebugMode = value;
-    this.dataCube.onSettingChanged?.(
-      DataCubeSettingKey.ENABLE_DEBUG_MODE,
-      value,
-    );
-  }
-
-  setGridClientRowBuffer(value: number) {
-    this.gridClientRowBuffer = value;
-    this.dataCube.onSettingChanged?.(
-      DataCubeSettingKey.GRID_CLIENT_ROW_BUFFER,
-      value,
-    );
-    this.propagateGridOptionUpdates();
-  }
-
-  setGridClientPurgeClosedRowNodes(value: boolean) {
-    this.gridClientPurgeClosedRowNodes = value;
-    this.dataCube.onSettingChanged?.(
-      DataCubeSettingKey.GRID_CLIENT_PURGE_CLOSED_ROW_NODES,
-      value,
-    );
-    this.propagateGridOptionUpdates();
-  }
-
-  setGridClientSuppressLargeDatasetWarning(value: boolean) {
-    this.gridClientSuppressLargeDatasetWarning = value;
-    this.dataCube.onSettingChanged?.(
-      DataCubeSettingKey.GRID_CLIENT_SUPPRESS_LARGE_DATASET_WARNING,
-      value,
-    );
-  }
-
-  private propagateGridOptionUpdates() {
-    this.dataCube.runTaskForEachView((view) => {
-      view.grid.client.updateGridOptions({
-        rowBuffer: this.gridClientRowBuffer,
-        purgeClosedRowNodes: this.gridClientPurgeClosedRowNodes,
-      });
-    });
-  }
-}