@finos/legend-application-repl 0.0.40 → 0.0.41

package/src/stores/dataCube/grid/DataCubeGridConfigurationBuilder.tsx

@@ -52,13 +52,14 @@ import {
   INTERNAL__GRID_CLIENT_TOOLTIP_SHOW_DELAY,
   INTERNAL__GRID_CLIENT_SIDE_BAR_WIDTH,
   INTERNAL__GRID_CLIENT_ROW_GROUPING_COUNT_AGG_COLUMN_ID,
+  INTERNAL__GRID_CLIENT_MISSING_VALUE,
 } from './DataCubeGridClientEngine.js';
 import { PRIMITIVE_TYPE } from '@finos/legend-graph';
 import {
   getQueryParameters,
   getQueryParameterValue,
-  IllegalStateError,
   isNonNullable,
+  isNullable,
   isNumber,
   isValidUrl,
 } from '@finos/legend-shared';
@@ -67,7 +68,6 @@ import type {
   DataCubeConfiguration,
 } from '../core/DataCubeConfiguration.js';
 import {
-  DataCubeAggregateFunction,
   DataCubeColumnDataType,
   DataCubeColumnPinPlacement,
   DataCubeNumberScale,
@@ -76,6 +76,7 @@ import {
   getDataType,
   DataCubeQuerySortOperation,
   DataCubeColumnKind,
+  DEFAULT_MISSING_VALUE_DISPLAY_TEXT,
 } from '../core/DataCubeQueryEngine.js';
 import type { CustomLoadingCellRendererProps } from '@ag-grid-community/react';
 import { DataCubeIcon } from '@finos/legend-art';
@@ -83,7 +84,7 @@ import type { DataCubeState } from '../DataCubeState.js';
 
 // --------------------------------- UTILITIES ---------------------------------
 
-// See https://www.ag-grid.com/javascript-data-grid/cell-data-types/
+// See https://www.ag-grid.com/react-data-grid/cell-data-types/
 function _cellDataType(column: DataCubeQuerySnapshotColumn) {
   switch (column.type) {
     case PRIMITIVE_TYPE.NUMBER:
@@ -124,25 +125,6 @@ function _allowedAggFuncs(column: DataCubeQuerySnapshotColumn) {
   }
 }
 
-function _aggFunc(
-  func: DataCubeAggregateFunction,
-): GridClientAggregateOperation {
-  switch (func) {
-    case DataCubeAggregateFunction.AVERAGE:
-      return GridClientAggregateOperation.AVERAGE;
-    case DataCubeAggregateFunction.COUNT:
-      return GridClientAggregateOperation.COUNT;
-    case DataCubeAggregateFunction.MAX:
-      return GridClientAggregateOperation.MAX;
-    case DataCubeAggregateFunction.MIN:
-      return GridClientAggregateOperation.MIN;
-    case DataCubeAggregateFunction.SUM:
-      return GridClientAggregateOperation.SUM;
-    default:
-      throw new IllegalStateError(`Unsupported aggregate function '${func}'`);
-  }
-}
-
 function scaleNumber(
   value: number,
   type: DataCubeNumberScale | undefined,
@@ -267,8 +249,15 @@ function _displaySpec(columnData: ColumnData) {
       dataType === DataCubeColumnDataType.NUMBER
         ? (params) => {
             const value = params.value as number | null | undefined;
-            if (value === null || value === undefined) {
-              return null;
+            if (
+              isNullable(value) ||
+              (value as unknown as string) ===
+                INTERNAL__GRID_CLIENT_MISSING_VALUE
+            ) {
+              return (
+                column.missingValueDisplayText ??
+                DEFAULT_MISSING_VALUE_DISPLAY_TEXT
+              );
             }
             const showNegativeNumberInParens =
               column.negativeNumberInParens && value < 0;
@@ -296,7 +285,11 @@ function _displaySpec(columnData: ColumnData) {
               (scaledNumber.unit ? ` ${scaledNumber.unit}` : '')
             );
           }
-        : (params) => params.value,
+        : (params) =>
+            params.value === INTERNAL__GRID_CLIENT_MISSING_VALUE
+              ? (column.missingValueDisplayText ??
+                DEFAULT_MISSING_VALUE_DISPLAY_TEXT)
+              : params.value,
     loadingCellRenderer: DataCubeGridLoadingCellRenderer,
     cellClassRules: {
       [generateFontFamilyUtilityClassName(fontFamily)]: () => true,
@@ -355,7 +348,8 @@ function _displaySpec(columnData: ColumnData) {
           : GridClientPinnedAlignement.LEFT
         : null,
     tooltipValueGetter: (params) =>
-      isNonNullable(params.value)
+      isNonNullable(params.value) &&
+      params.value !== INTERNAL__GRID_CLIENT_MISSING_VALUE
         ? `Value = ${params.value === '' ? "''" : params.value === true ? 'TRUE' : params.value === false ? 'FALSE' : params.value}`
         : `Missing Value`,
   } as ColDef;
@@ -410,9 +404,15 @@ function _rowGroupSpec(columnData: ColumnData) {
     enableRowGroup: column.kind === DataCubeColumnKind.DIMENSION,
     enableValue: column.kind === DataCubeColumnKind.MEASURE,
     rowGroup: Boolean(groupByCol),
-    // TODO: @akphi - add this from configuration object
+    rowGroupIndex: groupByCol
+      ? (data.groupBy?.columns.indexOf(groupByCol) ?? null)
+      : null,
+    // NOTE: we don't quite care about populating these accurately
+    // since ag-grid aggregation does not support parameters, so
+    // its set of supported aggregators will never match that specified
+    // in the editor, so we just assign dummy values here
     aggFunc: aggCol
-      ? _aggFunc(aggCol.function)
+      ? aggCol.operation
       : rowGroupColumn
         ? (
             [
@@ -425,7 +425,6 @@ function _rowGroupSpec(columnData: ColumnData) {
           ? GridClientAggregateOperation.SUM
           : null
         : null,
-    // TODO: @akphi - add this from configuration object
     allowedAggFuncs: rowGroupColumn ? _allowedAggFuncs(rowGroupColumn) : [],
   } satisfies ColDef;
 }

package/src/stores/dataCube/grid/DataCubeGridControllerState.ts

@@ -34,6 +34,7 @@ import type {
 } from '@ag-grid-community/core';
 import type { DataCubeState } from '../DataCubeState.js';
 import { generateMenuBuilder } from './DataCubeGridMenuBuilder.js';
+import { _groupByAggCols } from './DataCubeGridQuerySnapshotBuilder.js';
 
 /**
  * This state is responsible for capturing edition to the data cube query
@@ -96,7 +97,7 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotSubscriber
     this.applyChanges();
   }
 
-  showColumn(colName: string | undefined, isVisible: boolean): void {
+  showColumn(colName: string | undefined, isVisible: boolean) {
     const columnConfiguration = this.getColumnConfiguration(colName);
     if (columnConfiguration) {
       columnConfiguration.hideFromView = !isVisible;
@@ -184,7 +185,7 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotSubscriber
     this.applyChanges();
   }
 
-  private applyChanges(): void {
+  private applyChanges() {
     const baseSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
     const snapshot = baseSnapshot.clone();
 
@@ -197,20 +198,10 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotSubscriber
     snapshot.data.groupBy = this.verticalPivotedColumns.length
       ? {
           columns: this.verticalPivotedColumns,
-          aggColumns: this.configuration.columns
-            .filter(
-              (column) =>
-                column.kind === DataCubeColumnKind.MEASURE &&
-                column.aggregateFunction !== undefined &&
-                !this.verticalPivotedColumns.find(
-                  (col) => col.name === column.name,
-                ),
-            )
-            .map((column) => ({
-              name: column.name,
-              type: column.type,
-              function: guaranteeNonNullable(column.aggregateFunction),
-            })),
+          aggColumns: _groupByAggCols(
+            baseSnapshot.data.groupBy,
+            this.configuration,
+          ),
         }
       : undefined;
 

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

@@ -15,6 +15,7 @@
  */
 
 import {
+  PRIMITIVE_TYPE,
   type V1_AppliedFunction,
   extractElementNameFromPath as _name,
 } from '@finos/legend-graph';
@@ -25,9 +26,9 @@ import {
   DataCubeFunction,
   type DataCubeQueryFunctionMap,
 } from '../core/DataCubeQueryEngine.js';
-import { guaranteeNonNullable } from '@finos/legend-shared';
+import { guaranteeNonNullable, isNullable } from '@finos/legend-shared';
 import {
-  _aggCols,
+  _groupByAggCols,
   _colSpec,
   _cols,
   _filter,
@@ -36,7 +37,11 @@ import {
   _lambda,
   _var,
 } from '../core/DataCubeQueryBuilder.js';
-import { INTERNAL__GRID_CLIENT_ROW_GROUPING_COUNT_AGG_COLUMN_ID } from './DataCubeGridClientEngine.js';
+import {
+  INTERNAL__GRID_CLIENT_MISSING_VALUE,
+  INTERNAL__GRID_CLIENT_ROW_GROUPING_COUNT_AGG_COLUMN_ID,
+} from './DataCubeGridClientEngine.js';
+import type { DataCubeConfiguration } from '../core/DataCubeConfiguration.js';
 
 /*****************************************************************************
  * [GRID]
@@ -60,12 +65,13 @@ function _rowGroupingCountCol() {
 // --------------------------------- MAIN ---------------------------------
 
 export function generateRowGroupingDrilldownExecutableQueryPostProcessor(
-  drilldownValues: string[],
+  drilldownValues: (string | null | undefined)[],
 ) {
   return (
     snapshot: DataCubeQuerySnapshot,
     sequence: V1_AppliedFunction[],
     funcMap: DataCubeQueryFunctionMap,
+    configuration: DataCubeConfiguration,
   ) => {
     const _unprocess = (funcMapKey: keyof DataCubeQueryFunctionMap) => {
       const func = funcMap[funcMapKey];
@@ -91,11 +97,64 @@ export function generateRowGroupingDrilldownExecutableQueryPostProcessor(
               [_var()],
               [
                 _filter({
-                  conditions: drilldownValues.map((drilldownValue, i) => ({
-                    ...guaranteeNonNullable(groupBy.columns[i]),
-                    operation: DataCubeQueryFilterOperation.EQUAL,
-                    value: drilldownValue,
-                  })),
+                  conditions: drilldownValues.map((value, i) => {
+                    const groupByColumn = guaranteeNonNullable(
+                      groupBy.columns[i],
+                    );
+                    if (
+                      isNullable(value) ||
+                      value === INTERNAL__GRID_CLIENT_MISSING_VALUE
+                    ) {
+                      return {
+                        ...groupByColumn,
+                        operation: DataCubeQueryFilterOperation.BLANK,
+                        value: undefined,
+                      };
+                    }
+                    const condition = {
+                      ...groupByColumn,
+                      operation: DataCubeQueryFilterOperation.EQUAL,
+                      value: undefined,
+                    };
+                    switch (groupByColumn.type) {
+                      case PRIMITIVE_TYPE.BOOLEAN:
+                        return {
+                          ...condition,
+                          value: {
+                            type: PRIMITIVE_TYPE.BOOLEAN,
+                            value: value === 'true',
+                          },
+                        };
+                      case PRIMITIVE_TYPE.INTEGER:
+                        return {
+                          ...condition,
+                          value: {
+                            type: groupByColumn.type,
+                            value: parseInt(value, 10),
+                          },
+                        };
+                      case PRIMITIVE_TYPE.NUMBER:
+                      case PRIMITIVE_TYPE.DECIMAL:
+                      case PRIMITIVE_TYPE.FLOAT:
+                        return {
+                          ...condition,
+                          value: {
+                            type: groupByColumn.type,
+                            value: parseFloat(value),
+                          },
+                        };
+                      case PRIMITIVE_TYPE.STRING:
+                      case PRIMITIVE_TYPE.DATE:
+                      case PRIMITIVE_TYPE.DATETIME:
+                      case PRIMITIVE_TYPE.STRICTDATE:
+                      case PRIMITIVE_TYPE.STRICTTIME:
+                      default:
+                        return {
+                          ...condition,
+                          value: { type: groupByColumn.type, value },
+                        };
+                    }
+                  }),
                   groupOperation: DataCubeQueryFilterGroupOperation.AND,
                 }),
               ],
@@ -113,7 +172,10 @@ export function generateRowGroupingDrilldownExecutableQueryPostProcessor(
         );
         const groupByFunc = _function(_name(DataCubeFunction.GROUP_BY), [
           _cols(groupByColumns.map((col) => _colSpec(col.name))),
-          _cols([..._aggCols(groupBy.aggColumns), _rowGroupingCountCol()]),
+          _cols([
+            ..._groupByAggCols(groupBy.aggColumns),
+            _rowGroupingCountCol(),
+          ]),
         ]);
         sequence[groupByIdx] = groupByFunc;
         funcMap.groupBy = groupByFunc;

package/src/stores/dataCube/grid/DataCubeGridQuerySnapshotBuilder.ts

@@ -24,41 +24,34 @@
 import type { IServerSideGetRowsRequest } from '@ag-grid-community/core';
 import {
   type DataCubeQuerySnapshot,
+  type DataCubeQuerySnapshotGroupBy,
   _getCol,
 } from '../core/DataCubeQuerySnapshot.js';
+import { GridClientSortDirection } from './DataCubeGridClientEngine.js';
 import {
-  IllegalStateError,
-  guaranteeNonNullable,
-  isNonNullable,
-} from '@finos/legend-shared';
-import {
-  GridClientAggregateOperation,
-  GridClientSortDirection,
-} from './DataCubeGridClientEngine.js';
-import {
+  DataCubeColumnKind,
   DataCubeQuerySortOperation,
-  DataCubeAggregateFunction,
 } from '../core/DataCubeQueryEngine.js';
+import { DataCubeConfiguration } from '../core/DataCubeConfiguration.js';
+import { _defaultAggCol } from '../core/DataCubeQuerySnapshotBuilder.js';
+import { isNonNullable } from '@finos/legend-shared';
 
-// --------------------------------- UTILITIES ---------------------------------
-
-function _aggFunc(
-  func: GridClientAggregateOperation,
-): DataCubeAggregateFunction {
-  switch (func) {
-    case GridClientAggregateOperation.AVERAGE:
-      return DataCubeAggregateFunction.AVERAGE;
-    case GridClientAggregateOperation.COUNT:
-      return DataCubeAggregateFunction.COUNT;
-    case GridClientAggregateOperation.MAX:
-      return DataCubeAggregateFunction.MAX;
-    case GridClientAggregateOperation.MIN:
-      return DataCubeAggregateFunction.MIN;
-    case GridClientAggregateOperation.SUM:
-      return DataCubeAggregateFunction.SUM;
-    default:
-      throw new IllegalStateError(`Unsupported aggregate function '${func}'`);
-  }
+export function _groupByAggCols(
+  groupBy: DataCubeQuerySnapshotGroupBy | undefined,
+  configuration: DataCubeConfiguration,
+) {
+  return configuration.columns
+    .filter(
+      (column) =>
+        column.kind === DataCubeColumnKind.MEASURE &&
+        !groupBy?.columns.find((col) => col.name === column.name),
+    )
+    .map(
+      (column) =>
+        groupBy?.aggColumns.find((col) => col.name === column.name) ??
+        _defaultAggCol(column.name, column.type),
+    )
+    .filter(isNonNullable);
 }
 
 // --------------------------------- MAIN ---------------------------------
@@ -66,7 +59,10 @@ function _aggFunc(
 export function buildQuerySnapshot(
   request: IServerSideGetRowsRequest,
   baseSnapshot: DataCubeQuerySnapshot,
-): DataCubeQuerySnapshot {
+) {
+  const configuration = DataCubeConfiguration.serialization.fromJson(
+    baseSnapshot.data.configuration,
+  );
   const snapshot = baseSnapshot.clone();
 
   // --------------------------------- GROUP BY ---------------------------------
@@ -78,13 +74,7 @@ export function buildQuerySnapshot(
         name: col.id,
         type: _getCol(availableCols, col.id).type,
       })),
-      aggColumns: request.valueCols
-        .filter((col) => isNonNullable(col.field) && isNonNullable(col.aggFunc))
-        .map((col) => ({
-          name: guaranteeNonNullable(col.field),
-          type: _getCol(availableCols, guaranteeNonNullable(col.field)).type,
-          function: _aggFunc(col.aggFunc as GridClientAggregateOperation),
-        })),
+      aggColumns: _groupByAggCols(baseSnapshot.data.groupBy, configuration),
     };
   } else {
     snapshot.data.groupBy = undefined;

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

@@ -18,7 +18,11 @@ import { guaranteeNonNullable, hashArray } from '@finos/legend-shared';
 import { action, makeObservable, observable, runInAction } from 'mobx';
 import type { GridApi } from '@ag-grid-community/core';
 import type { DataCubeState } from '../DataCubeState.js';
-import { DataCubeGridClientServerSideDataSource } from './DataCubeGridClientEngine.js';
+import {
+  DataCubeGridClientServerSideDataSource,
+  INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE,
+  INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE,
+} from './DataCubeGridClientEngine.js';
 import { DataCubeQuerySnapshotSubscriber } from '../core/DataCubeQuerySnapshotSubscriber.js';
 import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
 import { generateGridOptionsFromSnapshot } from './DataCubeGridConfigurationBuilder.js';
@@ -37,7 +41,7 @@ class DataCubeGridDatasourceConfiguration {
     this.limit = snapshot?.data.limit;
   }
 
-  get hashCode(): string {
+  get hashCode() {
     return hashArray([`limit: ${this.limit ?? ''}`]);
   }
 }
@@ -76,7 +80,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotSubscriber {
     this.clientDataSource = new DataCubeGridClientServerSideDataSource(this);
   }
 
-  setPaginationEnabled(val: boolean): void {
+  setPaginationEnabled(val: boolean) {
     this.isPaginationEnabled = val;
 
     // hard reset the grid, this will force the grid to fetch data again
@@ -84,24 +88,31 @@ export class DataCubeGridState extends DataCubeQuerySnapshotSubscriber {
     // for how many page that we loaded when pagination is off, the datasource
     // will fire that many data fetch operations which is expensive.
     this.clientDataSource = new DataCubeGridClientServerSideDataSource(this);
+    // 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
+    this.client.updateGridOptions({
+      cacheBlockSize: val
+        ? INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE
+        : INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE,
+    });
   }
 
-  setScrollHintText(val: string | undefined): void {
+  setScrollHintText(val: string | undefined) {
     this.scrollHintText = val;
   }
 
-  get client(): GridApi {
+  get client() {
     return guaranteeNonNullable(this._client, 'Grid client is not configured');
   }
 
-  configureClient(val: GridApi | undefined): void {
+  configureClient(val: GridApi | undefined) {
     this._client = val;
   }
 
   override async applySnapshot(
     snapshot: DataCubeQuerySnapshot,
     previousSnapshot: DataCubeQuerySnapshot | undefined,
-  ): Promise<void> {
+  ) {
     const existingExtraConfiguration = this.datasourceConfiguration;
     const queryConfiguration = DataCubeConfiguration.serialization.fromJson(
       snapshot.data.configuration,
@@ -130,10 +141,17 @@ export class DataCubeGridState extends DataCubeQuerySnapshotSubscriber {
       queryConfiguration,
       this.dataCube,
     );
-    this.client.updateGridOptions(gridOptions);
+    this.client.updateGridOptions({
+      ...gridOptions,
+      // 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
+        ? INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE
+        : INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE,
+    });
   }
 
-  override async initialize(): Promise<void> {
+  override async initialize() {
     // do nothing
   }
 }