@finos/legend-data-cube 0.0.37 → 0.0.39

package/lib/stores/view/grid/DataCubeGridState.js

@@ -16,12 +16,12 @@
 import { debounce, guaranteeNonNullable, } from '@finos/legend-shared';
 import { action, makeObservable, observable } from 'mobx';
 import { DataCubeGridClientServerSideDataSource, INTERNAL__GRID_CLIENT_DEFAULT_CACHE_BLOCK_SIZE, INTERNAL__GRID_CLIENT_DATA_FETCH_MANUAL_TRIGGER_COLUMN_ID, INTERNAL__GRID_CLIENT_MAX_CACHE_BLOCK_SIZE, INTERNAL__GRID_CLIENT_DEFAULT_ENABLE_PAGINATION, computeHashCodeForDataFetchManualTrigger, } from './DataCubeGridClientEngine.js';
-import { DataCubeQuerySnapshotController } from '../DataCubeQuerySnapshotManager.js';
+import { DataCubeQuerySnapshotController } from '../../services/DataCubeQuerySnapshotService.js';
 import { generateGridOptionsFromSnapshot } from './DataCubeGridConfigurationBuilder.js';
-import { DataCubeConfiguration } from '../../core/models/DataCubeConfiguration.js';
+import { DataCubeConfiguration } from '../../core/model/DataCubeConfiguration.js';
 import { DataCubeGridControllerState } from './DataCubeGridControllerState.js';
 import { DataCubeGridClientExportEngine } from './DataCubeGridClientExportEngine.js';
-import { DataCubeSettingKey } from '../../core/DataCubeSetting.js';
+import { DataCubeSettingKey } from '../../../__lib__/DataCubeSetting.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
@@ -38,6 +38,7 @@ import { DataCubeSettingKey } from '../../core/DataCubeSetting.js';
  * trigger publishing a new snapshot, hence not propagated.
  */
 export class DataCubeGridState extends DataCubeQuerySnapshotController {
+    _view;
     controller;
     exportEngine;
     _client;
@@ -50,7 +51,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
     // and resized as user scrolls horizontally, this can cause performance issues, so we debounce.
     debouncedAutoResizeColumns;
     constructor(view) {
-        super(view);
+        super(view.engine, view.settingService, view.snapshotService);
         makeObservable(this, {
             clientDataSource: observable,
             queryConfiguration: observable,
@@ -61,10 +62,11 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
             setScrollHintText: action,
             applySnapshot: action,
         });
-        this.controller = new DataCubeGridControllerState(this.view);
+        this._view = view;
+        this.controller = new DataCubeGridControllerState(this._view);
         this.exportEngine = new DataCubeGridClientExportEngine(this);
         this.queryConfiguration = new DataCubeConfiguration();
-        this.clientDataSource = new DataCubeGridClientServerSideDataSource(this);
+        this.clientDataSource = new DataCubeGridClientServerSideDataSource(this, this._view);
     }
     setPaginationEnabled(val) {
         this.isPaginationEnabled = val;
@@ -72,7 +74,7 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
         // NOTE: if we don't fully reset the datasource, and say we just turned on pagination,
         // 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);
+        this.clientDataSource = new DataCubeGridClientServerSideDataSource(this, this._view);
         // 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({
@@ -101,17 +103,17 @@ export class DataCubeGridState extends DataCubeQuerySnapshotController {
         const configuration = DataCubeConfiguration.serialization.fromJson(snapshot.data.configuration);
         this.queryConfiguration = configuration;
         this.rowLimit = snapshot.data.limit;
-        const gridOptions = generateGridOptionsFromSnapshot(snapshot, configuration, this.view);
-        if (this.view.dataCube.settings.getBooleanValue(DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE)) {
-            this.view.engine.debugProcess(`New Grid Options`, [
+        const gridOptions = generateGridOptionsFromSnapshot(snapshot, configuration, this._view);
+        if (this._settingService.getBooleanValue(DataCubeSettingKey.DEBUGGER__ENABLE_DEBUG_MODE)) {
+            this._engine.debugProcess(`New Grid Options`, [
                 'Grid Options',
                 gridOptions,
             ]);
         }
         this.client.updateGridOptions({
             ...gridOptions,
-            rowBuffer: this.view.dataCube.settings.getNumericValue(DataCubeSettingKey.GRID_CLIENT__ROW_BUFFER),
-            purgeClosedRowNodes: this.view.dataCube.settings.getBooleanValue(DataCubeSettingKey.GRID_CLIENT__PURGE_CLOSED_ROW_NODES),
+            rowBuffer: this._settingService.getNumericValue(DataCubeSettingKey.GRID_CLIENT__ROW_BUFFER),
+            purgeClosedRowNodes: this._settingService.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/lib/stores/view/grid/DataCubeGridState.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataCubeGridState.js","sourceRoot":"","sources":["../../../../src/stores/view/grid/DataCubeGridState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,QAAQ,EACR,oBAAoB,GAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAG1D,OAAO,EACL,sCAAsC,EACtC,8CAA8C,EAC9C,yDAAyD,EACzD,0CAA0C,EAC1C,+CAA+C,EAC/C,wCAAwC,GACzC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,oCAAoC,CAAC;AAErF,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,4CAA4C,CAAC;AACnF,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,iBAAkB,SAAQ,+BAA+B;IAC3D,UAAU,CAA+B;IACzC,YAAY,CAAkC;IAC/C,OAAO,CAAuB;IAEtC,gBAAgB,CAAyC;IAEzD,kBAAkB,CAAwB;IAC1C,QAAQ,CAAsB;IAC9B,mBAAmB,GAAG,+CAA+C,CAAC;IACtE,cAAc,CAAsB;IACpC,4FAA4F;IAC5F,+FAA+F;IAC/F,0BAA0B,CAA6B;IAEvD,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,cAAc,CAAC,IAAI,EAAE;YACnB,gBAAgB,EAAE,UAAU;YAE5B,kBAAkB,EAAE,UAAU;YAE9B,QAAQ,EAAE,UAAU;YAEpB,mBAAmB,EAAE,UAAU;YAC/B,oBAAoB,EAAE,MAAM;YAE5B,cAAc,EAAE,UAAU;YAC1B,iBAAiB,EAAE,MAAM;YAEzB,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,GAAG,IAAI,2BAA2B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,GAAG,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,kBAAkB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED,oBAAoB,CAAC,GAAY;QAC/B,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;QAE/B,oEAAoE;QACpE,sFAAsF;QACtF,0EAA0E;QAC1E,gEAAgE;QAChE,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAAC,IAAI,CAAC,CAAC;QACzE,sFAAsF;QACtF,gGAAgG;QAChG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,cAAc,EAAE,GAAG;gBACjB,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,GAAuB;QACvC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;IAC7E,CAAC;IAED,eAAe,CAAC,GAAwB;QACtC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,IAAI,CAAC,0BAA0B,GAAG,QAAQ,CACxC,GAAG,EAAE,CAAC,GAAG,EAAE,kBAAkB,EAAE,EAC/B,GAAG,CACJ,CAAC;IACJ,CAAC;IAEQ,yBAAyB;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEQ,KAAK,CAAC,aAAa,CAC1B,QAA+B,EAC/B,gBAAmD;QAEnD,MAAM,aAAa,GAAG,qBAAqB,CAAC,aAAa,CAAC,QAAQ,CAChE,QAAQ,CAAC,IAAI,CAAC,aAAa,CAC5B,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAEpC,MAAM,WAAW,GAAG,+BAA+B,CACjD,QAAQ,EACR,aAAa,EACb,IAAI,CAAC,IAAI,CACV,CAAC;QACF,IACE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CACzC,kBAAkB,CAAC,2BAA2B,CAC/C,EACD,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,kBAAkB,EAAE;gBAChD,cAAc;gBACd,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,GAAG,WAAW;YACd,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CACpD,kBAAkB,CAAC,uBAAuB,CAC3C;YACD,mBAAmB,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAC9D,kBAAkB,CAAC,mCAAmC,CACvD;YACD,sFAAsF;YACtF,gGAAgG;YAChG,cAAc,EAAE,IAAI,CAAC,mBAAmB;gBACtC,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;QAEH,+FAA+F;QAC/F,6FAA6F;QAC7F,gGAAgG;QAChG,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;YACzB,CAAC,yDAAyD,CAAC,EAAE;gBAC3D,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,wCAAwC,CAC9C,QAAQ,EACR,aAAa,CACd;aACF;SACF,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"DataCubeGridState.js","sourceRoot":"","sources":["../../../../src/stores/view/grid/DataCubeGridState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,QAAQ,EACR,oBAAoB,GAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAG1D,OAAO,EACL,sCAAsC,EACtC,8CAA8C,EAC9C,yDAAyD,EACzD,0CAA0C,EAC1C,+CAA+C,EAC/C,wCAAwC,GACzC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AAEjG,OAAO,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,iBAAkB,SAAQ,+BAA+B;IACnD,KAAK,CAAoB;IAEjC,UAAU,CAA8B;IAExC,YAAY,CAAiC;IAC9C,OAAO,CAAuB;IACtC,gBAAgB,CAAyC;IAEzD,kBAAkB,CAAwB;IAC1C,QAAQ,CAAsB;IAC9B,mBAAmB,GAAG,+CAA+C,CAAC;IACtE,cAAc,CAAsB;IACpC,4FAA4F;IAC5F,+FAA+F;IAC/F,0BAA0B,CAA6B;IAEvD,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAE9D,cAAc,CAAC,IAAI,EAAE;YACnB,gBAAgB,EAAE,UAAU;YAE5B,kBAAkB,EAAE,UAAU;YAE9B,QAAQ,EAAE,UAAU;YAEpB,mBAAmB,EAAE,UAAU;YAC/B,oBAAoB,EAAE,MAAM;YAE5B,cAAc,EAAE,UAAU;YAC1B,iBAAiB,EAAE,MAAM;YAEzB,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,IAAI,CAAC,YAAY,GAAG,IAAI,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,kBAAkB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;IACJ,CAAC;IAED,oBAAoB,CAAC,GAAY;QAC/B,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;QAE/B,oEAAoE;QACpE,sFAAsF;QACtF,0EAA0E;QAC1E,gEAAgE;QAChE,IAAI,CAAC,gBAAgB,GAAG,IAAI,sCAAsC,CAChE,IAAI,EACJ,IAAI,CAAC,KAAK,CACX,CAAC;QACF,sFAAsF;QACtF,gGAAgG;QAChG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,cAAc,EAAE,GAAG;gBACjB,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,GAAuB;QACvC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,+BAA+B,CAAC,CAAC;IAC7E,CAAC;IAED,eAAe,CAAC,GAAwB;QACtC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,IAAI,CAAC,0BAA0B,GAAG,QAAQ,CACxC,GAAG,EAAE,CAAC,GAAG,EAAE,kBAAkB,EAAE,EAC/B,GAAG,CACJ,CAAC;IACJ,CAAC;IAEQ,yBAAyB;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEQ,KAAK,CAAC,aAAa,CAC1B,QAA+B,EAC/B,gBAAmD;QAEnD,MAAM,aAAa,GAAG,qBAAqB,CAAC,aAAa,CAAC,QAAQ,CAChE,QAAQ,CAAC,IAAI,CAAC,aAAa,CAC5B,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;QAEpC,MAAM,WAAW,GAAG,+BAA+B,CACjD,QAAQ,EACR,aAAa,EACb,IAAI,CAAC,KAAK,CACX,CAAC;QACF,IACE,IAAI,CAAC,eAAe,CAAC,eAAe,CAClC,kBAAkB,CAAC,2BAA2B,CAC/C,EACD,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,EAAE;gBAC5C,cAAc;gBACd,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC5B,GAAG,WAAW;YACd,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CAC7C,kBAAkB,CAAC,uBAAuB,CAC3C;YACD,mBAAmB,EAAE,IAAI,CAAC,eAAe,CAAC,eAAe,CACvD,kBAAkB,CAAC,mCAAmC,CACvD;YACD,sFAAsF;YACtF,gGAAgG;YAChG,cAAc,EAAE,IAAI,CAAC,mBAAmB;gBACtC,CAAC,CAAC,8CAA8C;gBAChD,CAAC,CAAC,0CAA0C;SAC/C,CAAC,CAAC;QAEH,+FAA+F;QAC/F,6FAA6F;QAC7F,gGAAgG;QAChG,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;YACzB,CAAC,yDAAyD,CAAC,EAAE;gBAC3D,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,wCAAwC,CAC9C,QAAQ,EACR,aAAa,CACd;aACF;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-data-cube",
-  "version": "0.0.37",
+  "version": "0.0.39",
   "description": "Legend DataCube",
   "keywords": [
     "legend",
@@ -42,11 +42,11 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@finos/legend-art": "7.1.73",
-    "@finos/legend-code-editor": "2.0.32",
-    "@finos/legend-graph": "32.0.0",
-    "@finos/legend-shared": "10.0.65",
-    "@types/react": "19.0.2",
+    "@finos/legend-art": "7.1.74",
+    "@finos/legend-code-editor": "2.0.33",
+    "@finos/legend-graph": "32.0.1",
+    "@finos/legend-shared": "10.0.66",
+    "@types/react": "19.0.3",
     "ag-grid-community": "33.0.3",
     "ag-grid-enterprise": "33.0.3",
     "ag-grid-react": "33.0.3",
@@ -66,7 +66,7 @@
     "jest": "29.7.0",
     "npm-run-all": "4.1.5",
     "rimraf": "6.0.1",
-    "sass": "1.83.0",
+    "sass": "1.83.1",
     "typescript": "5.7.2"
   },
   "peerDependencies": {

package/src/__lib__/DataCubeDocumentation.ts

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-export enum DocumentationKey {
-  DATA_CUBE_EXTENDED_COLUMN_LEVELS = 'data-cube.extended-column.levels',
-  DATA_CUBE_GRID_CONFIGURATION_ROW_LIMIT = 'data-cube.grid-configuration.row-limit',
-  DATA_CUBE_COLUMN_CONFIGURATION_KIND = 'data-cube.column-configuration.kind',
-  DATA_CUBE_COLUMN_CONFIGURATION_UNIT = 'data-cube.column-configuration.unit',
-  DATA_CUBE_COLUMN_CONFIGURATION_DISPLAY_AS_LINK = 'data-cube.column-configuration.display-value-as-link',
-  DATA_CUBE_COLUMN_CONFIGURATION_MISSING_VALUE_FORMAT = 'data-cube.column-configuration.missing-value-format',
+export enum DataCubeDocumentationKey {
+  EXTENDED_COLUMN_LEVELS = 'data-cube.extended-column.levels',
+  GRID_CONFIGURATION_ROW_LIMIT = 'data-cube.grid-configuration.row-limit',
+  COLUMN_CONFIGURATION_KIND = 'data-cube.column-configuration.kind',
+  COLUMN_CONFIGURATION_UNIT = 'data-cube.column-configuration.unit',
+  COLUMN_CONFIGURATION_DISPLAY_AS_LINK = 'data-cube.column-configuration.display-value-as-link',
+  COLUMN_CONFIGURATION_MISSING_VALUE_FORMAT = 'data-cube.column-configuration.missing-value-format',
 }

package/src/__lib__/DataCubeSetting.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+
+export enum DataCubeSettingKey {
+  DEBUGGER__ENABLE_DEBUG_MODE = 'dataCube.debugger.enableDebugMode',
+  DEBUGGER__ACTION__RELOAD = 'dataCube.debugger.action.reload',
+  GRID_CLIENT__ROW_BUFFER = 'dataCube.grid.rowBuffer',
+  GRID_CLIENT__PURGE_CLOSED_ROW_NODES = 'dataCube.grid.purgeClosedRowNodes',
+  GRID_CLIENT__SUPPRESS_LARGE_DATASET_WARNING = 'dataCube.grid.suppressLargeDatasetWarning',
+  GRID_CLIENT__ACTION__RETRY_FAILED_DATA_FETCHES = 'dataCube.grid.action.retryFailedDataFetches',
+}

package/src/components/DataCube.tsx

@@ -15,105 +15,58 @@
  */
 
 import { observer, useLocalObservable } from 'mobx-react-lite';
-import {
-  DataCubeIcon,
-  DropdownMenu,
-  DropdownMenuItem,
-  useDropdownMenu,
-} from '@finos/legend-art';
-import { DataCubeLayoutManager } from './core/DataCubeLayoutManager.js';
+import { DataCubeLayout } from './core/DataCubeLayout.js';
 import { INTERNAL__MonacoEditorWidgetsRoot } from './core/DataCubePureCodeEditorUtils.js';
-import { DataCubeBlockingActionAlert } from './core/DataCubeAlert.js';
 import { DataCubeView } from './DataCubeView.js';
 import { useEffect } from 'react';
 import type { DataCubeEngine } from '../stores/core/DataCubeEngine.js';
 import { DataCubeState } from '../stores/DataCubeState.js';
 import { type DataCubeOptions } from '../stores/DataCubeOptions.js';
 import { DataCubeContextProvider, useDataCube } from './DataCubeProvider.js';
-import type { DataCubeQuery } from '../stores/core/models/DataCubeQuery.js';
-import { FormBadge_WIP } from './core/DataCubeFormUtils.js';
-
-const DataCubeTitleBar = observer(() => {
-  const dataCube = useDataCube();
-  const engine = dataCube.engine;
-  const view = dataCube.view;
-  const [openMenuDropdown, closeMenuDropdown, menuDropdownProps] =
-    useDropdownMenu();
-
-  return (
-    <div className="flex h-7 justify-between bg-neutral-100">
-      <div className="flex select-none items-center pl-1 pr-2 text-lg font-medium">
-        <DataCubeIcon.Cube className="mr-1 h-4 w-4" />
-        <div>{view.info.name}</div>
-      </div>
-      <div className="flex">
-        {dataCube.innerHeaderComponent?.(dataCube) ?? null}
-        <button
-          className="flex aspect-square h-full flex-shrink-0 items-center justify-center text-lg"
-          onClick={openMenuDropdown}
-        >
-          <DataCubeIcon.Menu />
-        </button>
-        <DropdownMenu
-          {...menuDropdownProps}
-          menuProps={{
-            anchorOrigin: { vertical: 'bottom', horizontal: 'right' },
-            transformOrigin: { vertical: 'top', horizontal: 'left' },
-            classes: {
-              paper: 'rounded-none mt-[1px]',
-              list: 'w-40 p-0 rounded-none border border-neutral-400 bg-white max-h-40 overflow-y-auto py-0.5',
-            },
-          }}
-        >
-          <DropdownMenuItem
-            className="flex h-[22px] w-full items-center px-2.5 text-base hover:bg-neutral-100 focus:bg-neutral-100"
-            onClick={() => {
-              const url = engine.getDocumentationURL();
-              if (url) {
-                engine.openLink(url);
-              }
-              closeMenuDropdown();
-            }}
-            disabled={true} // TODO: enable when we set up the documentation website
-          >
-            See Documentation
-            <FormBadge_WIP />
-          </DropdownMenuItem>
-          <div className="my-0.5 h-[1px] w-full bg-neutral-200" />
-          <DropdownMenuItem
-            className="flex h-[22px] w-full items-center px-2.5 text-base hover:bg-neutral-100 focus:bg-neutral-100"
-            onClick={() => {
-              view.dataCube.settings.display.open();
-              closeMenuDropdown();
-            }}
-          >
-            Settings...
-          </DropdownMenuItem>
-        </DropdownMenu>
-      </div>
-    </div>
-  );
-});
+import type { DataCubeQuery } from '../stores/core/model/DataCubeQuery.js';
+import { DataCubeTitleBar } from './DataCubeTitleBar.js';
+import { DEFAULT_REPORT_NAME } from '../stores/core/DataCubeQueryEngine.js';
+import {
+  DataCubePlaceholderErrorDisplay,
+  DataCubePlaceholder,
+} from './DataCubePlaceholder.js';
 
 const DataCubeRoot = observer(() => {
   const dataCube = useDataCube();
-  const engine = dataCube.engine;
   const view = dataCube.view;
 
   useEffect(() => {
     dataCube.view
       .initialize(dataCube.query)
-      .catch((error) => dataCube.engine.logUnhandledError(error));
+      .catch((error) => dataCube.logService.logUnhandledError(error));
   }, [dataCube]);
 
   return (
     <div className="data-cube relative flex h-full w-full flex-col bg-white">
-      <DataCubeTitleBar />
+      <DataCubeTitleBar
+        title={view.info.name}
+        menuItems={[
+          {
+            label: 'See Documentation',
+            action: () => {
+              const url = dataCube.options?.documentationUrl;
+              if (url) {
+                dataCube.navigationService.openLink(url);
+              }
+            },
+          },
+          {
+            label: 'Settings...',
+            action: () => dataCube.settingService.display.open(),
+          },
+        ]}
+      >
+        {dataCube.options?.innerHeaderRenderer?.({ api: dataCube.api }) ?? null}
+      </DataCubeTitleBar>
 
       <DataCubeView view={view} />
 
-      <DataCubeLayoutManager layout={engine.layout} />
-      <DataCubeBlockingActionAlert />
+      <DataCubeLayout layout={dataCube.layoutService.manager} />
       <INTERNAL__MonacoEditorWidgetsRoot />
     </div>
   );
@@ -126,22 +79,39 @@ export const DataCube = observer(
     options?: DataCubeOptions | undefined;
   }) => {
     const { query, engine, options } = props;
-    const state = useLocalObservable(
+    const dataCube = useLocalObservable(
       () => new DataCubeState(query, engine, options),
     );
 
     useEffect(() => {
-      state
+      dataCube
         .initialize()
-        .catch((error) => state.engine.logUnhandledError(error));
-    }, [state]);
+        .catch((error) => dataCube.logService.logUnhandledError(error));
+      return () => dataCube.dispose();
+    }, [dataCube]);
 
-    if (!state.initializeState.hasSucceeded) {
-      return <></>;
+    if (!dataCube.initializeState.hasSucceeded) {
+      return (
+        <DataCubePlaceholder
+          title={DEFAULT_REPORT_NAME}
+          headerContent={
+            dataCube.options?.innerHeaderRenderer?.({ api: dataCube.api }) ??
+            null
+          }
+          layoutManager={dataCube.layoutService.manager}
+        >
+          {dataCube.initializeState.hasFailed && (
+            <DataCubePlaceholderErrorDisplay
+              message="Initialization Failure"
+              prompt="Resolve the issue and reload."
+            />
+          )}
+        </DataCubePlaceholder>
+      );
     }
     return (
-      <DataCubeContextProvider value={state}>
-        <DataCubeRoot key={state.uuid} />
+      <DataCubeContextProvider value={dataCube}>
+        <DataCubeRoot key={dataCube.uuid} />
       </DataCubeContextProvider>
     );
   },

package/src/components/DataCubePlaceholder.tsx

@@ -0,0 +1,97 @@
+/**
+ * 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 { observer } from 'mobx-react-lite';
+import type { DataCubeMenuItem } from '../stores/DataCubeOptions.js';
+import { DataCubeTitleBar } from './DataCubeTitleBar.js';
+import { DataCubeStatusBar } from './DataCubeStatusBar.js';
+import type React from 'react';
+import type { LayoutManager } from '../stores/services/DataCubeLayoutService.js';
+import { DataCubeLayout } from './core/DataCubeLayout.js';
+import { DataCubeIcon } from '@finos/legend-art';
+import type { TaskManager } from '../stores/services/DataCubeTaskService.js';
+
+export const DataCubePlaceholderErrorDisplay = (props: {
+  message: string;
+  prompt?: string | undefined;
+}) => {
+  const { message, prompt } = props;
+
+  return (
+    <div className="flex h-full w-full overflow-auto p-5">
+      <div className="mr-3">
+        <DataCubeIcon.AlertError className="flex-shrink-0 stroke-[0.5px] text-[40px] text-red-500" />
+      </div>
+      <div>
+        <div className="whitespace-break-spaces text-lg">{message}</div>
+        <div className="mt-1 whitespace-break-spaces text-neutral-500">
+          {prompt}
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export const DataCubeViewPlaceholder = observer(
+  (props: {
+    children?: React.ReactNode | undefined;
+    taskManager?: TaskManager | undefined;
+  }) => {
+    const { children, taskManager } = props;
+
+    return (
+      <>
+        <div className="h-[calc(100%_-_48px)] w-full border border-x-0 border-neutral-200 bg-neutral-50">
+          {children ?? null}
+        </div>
+        <DataCubeStatusBar taskManager={taskManager} />
+      </>
+    );
+  },
+);
+
+export const DataCubePlaceholder = observer(
+  (props: {
+    children?: React.ReactNode | undefined;
+    title: string;
+    headerContent?: React.ReactNode | undefined;
+    menuItems?: DataCubeMenuItem[] | undefined;
+    layoutManager?: LayoutManager | undefined;
+    taskManager?: TaskManager | undefined;
+  }) => {
+    const {
+      children,
+      title,
+      menuItems,
+      headerContent,
+      layoutManager,
+      taskManager,
+    } = props;
+
+    return (
+      <div className="data-cube relative flex h-full w-full flex-col bg-white">
+        <DataCubeTitleBar title={title} menuItems={menuItems}>
+          {headerContent ?? null}
+        </DataCubeTitleBar>
+
+        <DataCubeViewPlaceholder taskManager={taskManager}>
+          {children}
+        </DataCubeViewPlaceholder>
+        {layoutManager ? <DataCubeLayout layout={layoutManager} /> : null}
+      </div>
+    );
+  },
+);

package/src/components/DataCubeStatusBar.tsx

@@ -0,0 +1,71 @@
+/**
+ * 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 { DataCubeIcon, ProgressBar } from '@finos/legend-art';
+import { observer } from 'mobx-react-lite';
+import type { DataCubeViewState } from '../stores/view/DataCubeViewState.js';
+import type { TaskManager } from '../stores/services/DataCubeTaskService.js';
+
+export const DataCubeStatusBar = observer(
+  (props: {
+    view?: DataCubeViewState | undefined;
+    taskManager?: TaskManager | undefined;
+  }) => {
+    const { view, taskManager: _taskManager } = props;
+    const tasks = view?.taskService.tasks ?? _taskManager?.tasks;
+
+    return (
+      <div className="flex h-5 w-full justify-between bg-neutral-100">
+        <div className="flex">
+          <button
+            className="flex items-center px-2 text-sky-600 hover:text-sky-700 disabled:text-neutral-400"
+            onClick={() => view?.editor.display.open()}
+            disabled={!view}
+          >
+            <DataCubeIcon.Settings className="text-xl" />
+            <div className="pl-0.5 underline">Properties</div>
+          </button>
+          <div className="flex">
+            <button
+              className="flex items-center text-sky-600 hover:text-sky-700 disabled:text-neutral-400"
+              onClick={() => {
+                view?.filter.display.open();
+              }}
+              disabled={!view}
+            >
+              <DataCubeIcon.TableFilter className="text-lg" />
+              <div className="pl-0.5 underline">Filter</div>
+            </button>
+          </div>
+        </div>
+        <div className="flex items-center px-2">
+          <div className="flex h-3.5 w-48 border-[0.5px] border-neutral-300">
+            {tasks !== undefined && tasks.length > 0 && (
+              <ProgressBar
+                classes={{
+                  root: 'h-3.5 w-full bg-transparent',
+                  bar1Indeterminate: 'bg-green-500',
+                  bar2Indeterminate: 'bg-green-500',
+                }}
+                variant="indeterminate"
+              />
+            )}
+          </div>
+        </div>
+      </div>
+    );
+  },
+);

package/src/components/DataCubeTitleBar.tsx

@@ -0,0 +1,81 @@
+/**
+ * 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 {
+  useDropdownMenu,
+  DataCubeIcon,
+  DropdownMenu,
+  DropdownMenuItem,
+} from '@finos/legend-art';
+import { observer } from 'mobx-react-lite';
+import type { DataCubeMenuItem } from '../stores/DataCubeOptions.js';
+
+export const DataCubeTitleBar = observer(
+  (props: {
+    children: React.ReactNode;
+    title: string;
+    menuItems?: DataCubeMenuItem[] | undefined;
+  }) => {
+    const { children, title, menuItems } = props;
+    const [openMenuDropdown, closeMenuDropdown, menuDropdownProps] =
+      useDropdownMenu();
+
+    return (
+      <div className="flex h-7 justify-between bg-neutral-100">
+        <div className="flex select-none items-center pl-1 pr-2 text-lg font-medium">
+          <DataCubeIcon.Cube className="mr-1 h-4 w-4" />
+          <div>{title}</div>
+        </div>
+        <div className="flex">
+          {children}
+          <button
+            className="flex aspect-square h-full flex-shrink-0 items-center justify-center text-lg disabled:text-neutral-400"
+            onClick={openMenuDropdown}
+            disabled={!menuItems?.length}
+          >
+            <DataCubeIcon.Menu />
+          </button>
+          <DropdownMenu
+            {...menuDropdownProps}
+            menuProps={{
+              anchorOrigin: { vertical: 'bottom', horizontal: 'right' },
+              transformOrigin: { vertical: 'top', horizontal: 'left' },
+              classes: {
+                paper: 'rounded-none mt-[1px]',
+                list: 'w-40 p-0 rounded-none border border-neutral-400 bg-white max-h-40 overflow-y-auto py-0.5',
+              },
+            }}
+          >
+            {menuItems?.map((item, idx) => (
+              <DropdownMenuItem
+                // eslint-disable-next-line react/no-array-index-key
+                key={idx}
+                className="flex h-[22px] w-full items-center px-2.5 text-base hover:bg-neutral-100 focus:bg-neutral-100"
+                onClick={() => {
+                  item.action();
+                  closeMenuDropdown();
+                }}
+                disabled={Boolean(item.disabled)}
+              >
+                {item.label}
+              </DropdownMenuItem>
+            ))}
+          </DropdownMenu>
+        </div>
+      </div>
+    );
+  },
+);