@finos/legend-data-cube 0.0.2 → 0.0.4

package/src/stores/grid/DataCubeGridControllerState.ts

@@ -17,6 +17,7 @@
 import {
   guaranteeNonNullable,
   isNonNullable,
+  uniq,
   uniqBy,
 } from '@finos/legend-shared';
 import { DataCubeConfiguration } from '../core/DataCubeConfiguration.js';
@@ -28,7 +29,7 @@ import {
 } from '../core/DataCubeQuerySnapshot.js';
 import { DataCubeQuerySnapshotController } from '../core/DataCubeQuerySnapshotManager.js';
 import {
-  type DataCubeQuerySortOperator,
+  type DataCubeQuerySortDirection,
   type DataCubeColumnPinPlacement,
   DataCubeColumnKind,
   DataCubeQueryFilterGroupOperator,
@@ -50,6 +51,7 @@ import {
   type DataCubeFilterEditorTree,
   type DataCubeFilterEditorTreeNode,
 } from '../core/filter/DataCubeQueryFilterEditorState.js';
+import { _pruneExpandedPaths } from '../core/DataCubeQuerySnapshotBuilderUtils.js';
 
 /**
  * This query editor state is responsible for capturing updates to the data cube query
@@ -244,11 +246,8 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotController
     if (isPivotResultColumnName(colName)) {
       const baseColumnName = getPivotResultColumnBaseColumnName(colName);
       const columnConfiguration = this.getColumnConfiguration(baseColumnName);
-      if (
-        columnConfiguration &&
-        !columnConfiguration.excludedFromHorizontalPivot
-      ) {
-        columnConfiguration.excludedFromHorizontalPivot = true;
+      if (columnConfiguration && !columnConfiguration.excludedFromPivot) {
+        columnConfiguration.excludedFromPivot = true;
         this.applyChanges();
       }
     }
@@ -256,8 +255,8 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotController
 
   includeColumnInHorizontalPivot(colName: string) {
     const columnConfiguration = this.getColumnConfiguration(colName);
-    if (columnConfiguration?.excludedFromHorizontalPivot) {
-      columnConfiguration.excludedFromHorizontalPivot = false;
+    if (columnConfiguration?.excludedFromPivot) {
+      columnConfiguration.excludedFromPivot = false;
       this.applyChanges();
     }
   }
@@ -311,6 +310,26 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotController
     this.applyChanges();
   }
 
+  collapseAllPaths() {
+    this.view.grid.client.collapseAll();
+    this.configuration.pivotLayout.expandedPaths = [];
+    this.applyChanges();
+  }
+
+  expandPath(path: string) {
+    this.configuration.pivotLayout.expandedPaths = uniq([
+      ...this.configuration.pivotLayout.expandedPaths,
+      path,
+    ]).sort();
+    this.applyChanges();
+  }
+
+  collapsePath(path: string) {
+    this.configuration.pivotLayout.expandedPaths =
+      this.configuration.pivotLayout.expandedPaths.filter((p) => p !== path);
+    this.applyChanges();
+  }
+
   // --------------------------------- SORT ---------------------------------
 
   sortColumns: DataCubeQuerySnapshotSortColumn[] = [];
@@ -329,38 +348,38 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotController
 
   private getActionableSortColumn(
     colName: string,
-    operation: DataCubeQuerySortOperator,
+    direction: DataCubeQuerySortDirection,
   ) {
     const column = this.getSortableColumn(colName);
     if (!column) {
       return undefined;
     }
     const sortColumn = this.sortColumns.find((col) => col.name === colName);
-    if (sortColumn && sortColumn.operation !== operation) {
+    if (sortColumn && sortColumn.direction !== direction) {
       return sortColumn;
     }
     if (!sortColumn) {
-      return { ...column, operation };
+      return { ...column, direction };
     }
     return undefined;
   }
 
-  setSortByColumn(colName: string, operation: DataCubeQuerySortOperator) {
-    const column = this.getActionableSortColumn(colName, operation);
+  setSortByColumn(colName: string, direction: DataCubeQuerySortDirection) {
+    const column = this.getActionableSortColumn(colName, direction);
     if (!column) {
       return;
     }
-    column.operation = operation;
+    column.direction = direction;
     this.sortColumns = [column];
     this.applyChanges();
   }
 
-  addSortByColumn(colName: string, operation: DataCubeQuerySortOperator) {
-    const column = this.getActionableSortColumn(colName, operation);
+  addSortByColumn(colName: string, direction: DataCubeQuerySortDirection) {
+    const column = this.getActionableSortColumn(colName, direction);
     if (!column) {
       return;
     }
-    column.operation = operation;
+    column.direction = direction;
     this.sortColumns = [...this.sortColumns, column];
     this.applyChanges();
   }
@@ -411,11 +430,16 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotController
     this.menuBuilder = generateMenuBuilder(this);
   }
 
-  private propagateChanges() {
+  private propagateChanges(baseSnapshot: DataCubeQuerySnapshot) {
     this.verticalPivotColumns = this.verticalPivotColumns.filter(
       (col) =>
         !this.horizontalPivotColumns.find((column) => column.name === col.name),
     );
+    this.configuration.pivotLayout.expandedPaths = _pruneExpandedPaths(
+      baseSnapshot.data.groupBy?.columns ?? [],
+      this.verticalPivotColumns,
+      this.configuration.pivotLayout.expandedPaths,
+    );
 
     this.selectColumns = uniqBy(
       [
@@ -459,11 +483,11 @@ export class DataCubeGridControllerState extends DataCubeQuerySnapshotController
   }
 
   private applyChanges() {
-    this.propagateChanges();
-
     const baseSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
     const snapshot = baseSnapshot.clone();
 
+    this.propagateChanges(baseSnapshot);
+
     snapshot.data.configuration = DataCubeConfiguration.serialization.toJson(
       this.configuration,
     );

package/src/stores/grid/DataCubeGridMenuBuilder.tsx

@@ -21,7 +21,7 @@ import type {
 } from '@ag-grid-community/core';
 import { WIP_GridMenuItem } from '../../components/grid/DataCubeGridShared.js';
 import {
-  DataCubeQuerySortOperator,
+  DataCubeQuerySortDirection,
   DataCubeColumnPinPlacement,
   DEFAULT_COLUMN_MIN_WIDTH,
   DataCubeColumnKind,
@@ -39,6 +39,7 @@ import type { DataCubeGridControllerState } from './DataCubeGridControllerState.
 import {
   DataCubeGridClientExportFormat,
   INTERNAL__GRID_CLIENT_MISSING_VALUE,
+  INTERNAL__GRID_CLIENT_TREE_COLUMN_ID,
 } from './DataCubeGridClientEngine.js';
 import { PRIMITIVE_TYPE } from '@finos/legend-graph';
 import type { DataCubeColumnConfiguration } from '../core/DataCubeConfiguration.js';
@@ -204,7 +205,7 @@ export function generateMenuBuilder(
                   action: () =>
                     controller.setSortByColumn(
                       columnName,
-                      DataCubeQuerySortOperator.ASCENDING,
+                      DataCubeQuerySortDirection.ASCENDING,
                     ),
                 },
                 {
@@ -218,7 +219,7 @@ export function generateMenuBuilder(
                   action: () =>
                     controller.setSortByColumn(
                       columnName,
-                      DataCubeQuerySortOperator.DESCENDING,
+                      DataCubeQuerySortDirection.DESCENDING,
                     ),
                 },
                 {
@@ -241,13 +242,13 @@ export function generateMenuBuilder(
                     controller.sortColumns.find(
                       (col) =>
                         col.name === columnName &&
-                        col.operation === DataCubeQuerySortOperator.ASCENDING,
+                        col.direction === DataCubeQuerySortDirection.ASCENDING,
                     ),
                   ),
                   action: () =>
                     controller.addSortByColumn(
                       columnName,
-                      DataCubeQuerySortOperator.ASCENDING,
+                      DataCubeQuerySortDirection.ASCENDING,
                     ),
                 },
                 {
@@ -262,13 +263,13 @@ export function generateMenuBuilder(
                     controller.sortColumns.find(
                       (col) =>
                         col.name === columnName &&
-                        col.operation === DataCubeQuerySortOperator.DESCENDING,
+                        col.direction === DataCubeQuerySortDirection.DESCENDING,
                     ),
                   ),
                   action: () =>
                     controller.addSortByColumn(
                       columnName,
-                      DataCubeQuerySortOperator.DESCENDING,
+                      DataCubeQuerySortDirection.DESCENDING,
                     ),
                 },
                 {
@@ -290,56 +291,73 @@ export function generateMenuBuilder(
     ] satisfies (string | MenuItemDef)[];
 
     let newFilterMenu: MenuItemDef[] = [];
-    if (columnConfiguration && column && value !== undefined) {
-      if (value !== INTERNAL__GRID_CLIENT_MISSING_VALUE) {
-        const filterValue = toFilterValue(value, columnConfiguration);
-        const filterOperations = getColumnFilterOperations(columnConfiguration);
+    if (column && value !== undefined) {
+      let _columnConfiguration = columnConfiguration;
+      if (
+        column.getColId() === INTERNAL__GRID_CLIENT_TREE_COLUMN_ID &&
+        controller.verticalPivotColumns.length &&
+        'node' in params &&
+        params.node
+      ) {
+        const groupByColumn =
+          controller.verticalPivotColumns[params.node.level];
+        _columnConfiguration = controller.getColumnConfiguration(
+          groupByColumn?.name,
+        );
+      }
+
+      if (_columnConfiguration) {
+        if (value !== INTERNAL__GRID_CLIENT_MISSING_VALUE) {
+          const filterValue = toFilterValue(value, _columnConfiguration);
+          const filterOperations =
+            getColumnFilterOperations(_columnConfiguration);
 
-        if (
-          filterOperations.length &&
-          filterOperations.includes(DataCubeQueryFilterOperator.EQUAL)
-        ) {
-          const moreFilterOperations = filterOperations.filter(
-            (op) => op !== DataCubeQueryFilterOperator.EQUAL,
-          );
+          if (
+            filterOperations.length &&
+            filterOperations.includes(DataCubeQueryFilterOperator.EQUAL)
+          ) {
+            const moreFilterOperations = filterOperations.filter(
+              (op) => op !== DataCubeQueryFilterOperator.EQUAL,
+            );
 
+            newFilterMenu = [
+              buildNewFilterConditionMenuItem(
+                _columnConfiguration,
+                DataCubeQueryFilterOperator.EQUAL,
+                filterValue,
+                controller,
+              ),
+              moreFilterOperations.length
+                ? {
+                    name: `More Filters on ${columnName}...`,
+                    subMenu: moreFilterOperations.map((operator) =>
+                      buildNewFilterConditionMenuItem(
+                        _columnConfiguration,
+                        operator,
+                        filterValue,
+                        controller,
+                      ),
+                    ),
+                  }
+                : undefined,
+            ].filter(isNonNullable);
+          }
+        } else {
           newFilterMenu = [
             buildNewFilterConditionMenuItem(
-              columnConfiguration,
-              DataCubeQueryFilterOperator.EQUAL,
-              filterValue,
+              _columnConfiguration,
+              DataCubeQueryFilterOperator.IS_NULL,
+              undefined,
               controller,
             ),
-            moreFilterOperations.length
-              ? {
-                  name: `More Filters on ${columnName}...`,
-                  subMenu: moreFilterOperations.map((operator) =>
-                    buildNewFilterConditionMenuItem(
-                      columnConfiguration,
-                      operator,
-                      filterValue,
-                      controller,
-                    ),
-                  ),
-                }
-              : undefined,
-          ].filter(isNonNullable);
+            buildNewFilterConditionMenuItem(
+              _columnConfiguration,
+              DataCubeQueryFilterOperator.IS_NOT_NULL,
+              undefined,
+              controller,
+            ),
+          ];
         }
-      } else {
-        newFilterMenu = [
-          buildNewFilterConditionMenuItem(
-            columnConfiguration,
-            DataCubeQueryFilterOperator.IS_NULL,
-            undefined,
-            controller,
-          ),
-          buildNewFilterConditionMenuItem(
-            columnConfiguration,
-            DataCubeQueryFilterOperator.IS_NOT_NULL,
-            undefined,
-            controller,
-          ),
-        ];
       }
     }
 
@@ -548,7 +566,7 @@ export function generateMenuBuilder(
           ...(column &&
           columnName &&
           baseColumnConfiguration?.kind === DataCubeColumnKind.MEASURE &&
-          !baseColumnConfiguration.excludedFromHorizontalPivot &&
+          !baseColumnConfiguration.excludedFromPivot &&
           controller.horizontalPivotColumns.length !== 0 // pivot must be active
             ? [
                 {
@@ -562,7 +580,7 @@ export function generateMenuBuilder(
           ...(column &&
           columnName &&
           columnConfiguration?.kind === DataCubeColumnKind.MEASURE &&
-          columnConfiguration.excludedFromHorizontalPivot &&
+          columnConfiguration.excludedFromPivot &&
           controller.horizontalPivotColumns.length !== 0 // pivot must be active
             ? [
                 {
@@ -804,6 +822,17 @@ export function generateMenuBuilder(
         disabled: !columnConfiguration,
         action: () => controller.showColumn(columnName, false),
       },
+      ...(columnName === INTERNAL__GRID_CLIENT_TREE_COLUMN_ID
+        ? [
+            'separator',
+            {
+              name: 'Collapse All',
+              action: () => {
+                controller.collapseAllPaths();
+              },
+            },
+          ]
+        : []),
       'separator',
       {
         name: 'Heatmap',

package/src/stores/grid/DataCubeGridQueryBuilder.ts

@@ -14,11 +14,7 @@
  * limitations under the License.
  */
 
-import {
-  PRIMITIVE_TYPE,
-  type V1_AppliedFunction,
-  extractElementNameFromPath as _name,
-} from '@finos/legend-graph';
+import { PRIMITIVE_TYPE, type V1_AppliedFunction } from '@finos/legend-graph';
 import { type DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
 import {
   DataCubeQueryFilterGroupOperator,
@@ -90,7 +86,7 @@ export function generateRowGroupingDrilldownExecutableQueryPostProcessor(
         sequence.splice(
           sequence.indexOf(funcMap.groupBy),
           0,
-          _function(_name(DataCubeFunction.FILTER), [
+          _function(DataCubeFunction.FILTER, [
             _lambda(
               [_var()],
               [
@@ -171,7 +167,7 @@ export function generateRowGroupingDrilldownExecutableQueryPostProcessor(
           0,
           drilldownValues.length + 1,
         );
-        const groupByFunc = _function(_name(DataCubeFunction.GROUP_BY), [
+        const groupByFunc = _function(DataCubeFunction.GROUP_BY, [
           _cols(groupByColumns.map((col) => _colSpec(col.name))),
           _cols([
             ..._groupByAggCols(

package/src/stores/grid/DataCubeGridQuerySnapshotBuilder.ts

@@ -31,12 +31,13 @@ import {
   INTERNAL__GRID_CLIENT_TREE_COLUMN_ID,
 } from './DataCubeGridClientEngine.js';
 import {
-  DataCubeQuerySortOperator,
+  DataCubeQuerySortDirection,
   getPivotResultColumnBaseColumnName,
   isPivotResultColumnName,
 } from '../core/DataCubeQueryEngine.js';
 import { DataCubeConfiguration } from '../core/DataCubeConfiguration.js';
 import { guaranteeNonNullable, uniqBy } from '@finos/legend-shared';
+import { _pruneExpandedPaths } from '../core/DataCubeQuerySnapshotBuilderUtils.js';
 
 export function getColumnConfiguration(
   colName: string,
@@ -81,7 +82,9 @@ export function buildQuerySnapshot(
         columns: request.pivotCols.map((col) =>
           _toCol(getColumnConfiguration(col.id, configuration)),
         ),
-        castColumns: [],
+        // NOTE: since we re-fetch the cast columns anyway in this flow, we just
+        // reuse the current cast columns
+        castColumns: baseSnapshot.data.pivot?.castColumns ?? [],
       }
     : undefined;
 
@@ -98,11 +101,11 @@ export function buildQuerySnapshot(
   // --------------------------------- SORT ---------------------------------
 
   snapshot.data.sortColumns = request.sortModel
-    // Make sure the tree group is not being sorted since it's a synthetic column
+    // Make sure the tree column is not being sorted since it's a synthetic column
     // the sorting state of this special column is `synthesized` by ag-grid
     // so when all group by columns are sorted in the same direction, the tree group
     // column will be sorted in that direction, and vice versa, when user sorts
-    // the tree-group, all group-by columns will be sorted in that direction
+    // the tree column, all groupBy columns will be sorted in that direction
     .filter((item) => item.colId !== INTERNAL__GRID_CLIENT_TREE_COLUMN_ID)
     .map((item) => ({
       ..._toCol(
@@ -113,12 +116,22 @@ export function buildQuerySnapshot(
           configuration,
         ),
       ),
-      operation:
+      direction:
         item.sort === GridClientSortDirection.ASCENDING
-          ? DataCubeQuerySortOperator.ASCENDING
-          : DataCubeQuerySortOperator.DESCENDING,
+          ? DataCubeQuerySortDirection.ASCENDING
+          : DataCubeQuerySortDirection.DESCENDING,
     }));
 
+  // --------------------------------- CONFIGURATION ---------------------------------
+
+  configuration.pivotLayout.expandedPaths = _pruneExpandedPaths(
+    baseSnapshot.data.groupBy?.columns ?? [],
+    snapshot.data.groupBy?.columns ?? [],
+    configuration.pivotLayout.expandedPaths,
+  );
+  snapshot.data.configuration =
+    DataCubeConfiguration.serialization.toJson(configuration);
+
   // --------------------------------- FINALIZE ---------------------------------
 
   return snapshot;

package/src/stores/grid/DataCubeGridState.ts

@@ -66,7 +66,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     makeObservable(this, {
       clientDataSource: observable,
 
-      queryConfiguration: observable,
+      queryConfiguration: observable.ref,
 
       rowLimit: observable,
 
@@ -118,19 +118,23 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     snapshot: DataCubeQuerySnapshot,
     previousSnapshot: DataCubeQuerySnapshot | undefined,
   ) {
-    const queryConfiguration = DataCubeConfiguration.serialization.fromJson(
+    const configuration = DataCubeConfiguration.serialization.fromJson(
       snapshot.data.configuration,
     );
-    this.queryConfiguration = queryConfiguration;
+    this.queryConfiguration = configuration;
     this.rowLimit = snapshot.data.limit;
 
     const gridOptions = generateGridOptionsFromSnapshot(
       snapshot,
-      queryConfiguration,
+      configuration,
       this.view,
     );
+    if (this.view.engine.enableDebugMode) {
+      this.view.application.debugProcess(`New Grid Options`, gridOptions);
+    }
     this.client.updateGridOptions({
       ...gridOptions,
+      rowBuffer: this.view.engine.gridClientRowBuffer,
       // 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
@@ -147,7 +151,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
         type: 'equals',
         filter: computeHashCodeForDataFetchManualTrigger(
           snapshot,
-          queryConfiguration,
+          configuration,
         ),
       },
     });

package/tsconfig.json

@@ -71,6 +71,7 @@
     "./src/stores/editor/DataCubeEditorHorizontalPivotsPanelState.ts",
     "./src/stores/editor/DataCubeEditorMutableConfiguration.ts",
     "./src/stores/editor/DataCubeEditorPanelState.ts",
+    "./src/stores/editor/DataCubeEditorPivotLayoutPanelState.ts",
     "./src/stores/editor/DataCubeEditorSortsPanelState.ts",
     "./src/stores/editor/DataCubeEditorVerticalPivotsPanelState.ts",
     "./src/stores/engine/DataCubeEngine.ts",