@finos/legend-application-repl 0.0.31 → 0.0.32

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

@@ -14,34 +14,62 @@
  * limitations under the License.
  */
 
-import { guaranteeNonNullable } from '@finos/legend-shared';
-import { action, makeObservable, observable } from 'mobx';
+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 { DataCubeQuerySnapshotSubscriber } from '../core/DataCubeQuerySnapshotSubscriber.js';
 import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
 import { generateGridOptionsFromSnapshot } from './DataCubeGridQuerySnapshotAnalyzer.js';
+import { DataCubeConfiguration } from '../core/DataCubeConfiguration.js';
+
+class DataCubeGridDatasourceConfiguration {
+  readonly limit?: number | undefined;
+
+  constructor(input: {
+    snapshot?: DataCubeQuerySnapshot | undefined;
+    queryConfiguration?: DataCubeConfiguration | undefined;
+  }) {
+    const { snapshot } = input;
+    this.limit = snapshot?.data.limit;
+  }
+
+  get hashCode(): string {
+    return hashArray([`limit: ${this.limit ?? ''}`]);
+  }
+}
 
 export class DataCubeGridState extends DataCubeQuerySnapshotSubscriber {
   private _client?: GridApi | undefined;
   clientDataSource: DataCubeGridClientServerSideDataSource;
   clientLicenseKey?: string | undefined;
+
   isPaginationEnabled = false;
+  scrollHintText = '';
+  datasourceConfiguration: DataCubeGridDatasourceConfiguration;
+  queryConfiguration: DataCubeConfiguration;
 
   constructor(dataCube: DataCubeState) {
     super(dataCube);
 
     makeObservable(this, {
       clientDataSource: observable,
+      datasourceConfiguration: observable,
+      queryConfiguration: observable,
 
       clientLicenseKey: observable,
       setClientLicenseKey: action,
 
       isPaginationEnabled: observable,
       setPaginationEnabled: action,
+
+      scrollHintText: observable,
+      setScrollHintText: action,
     });
 
+    this.datasourceConfiguration = new DataCubeGridDatasourceConfiguration({});
+    this.queryConfiguration = new DataCubeConfiguration();
     this.clientDataSource = new DataCubeGridClientServerSideDataSource(this);
   }
 
@@ -52,32 +80,57 @@ export class DataCubeGridState extends DataCubeQuerySnapshotSubscriber {
   setPaginationEnabled(val: boolean): void {
     this.isPaginationEnabled = val;
 
-    // When pagination is toggled off, we don't need to reset the grid since data is
-    // already loaded data will still be there, but we need to collapse all expanded
-    // row groupings since the data there are now stale.
-    // Maybe, we can handle this transition more elegantly by refreshing data for all
-    // expanded row groupings as well, but for now, we opt for the simple mechanics.
-    if (!this.isPaginationEnabled) {
-      this.client.collapseAll();
-      this.client.refreshServerSide();
-    } else {
-      // When pagination is toggled on, we simply reset the grid to clear all data and reset scroll;
-      // otherwise each page that we already loaded when pagination is off will get refetched by
-      // server-side data source, which is expensive.
-      this.clientDataSource = new DataCubeGridClientServerSideDataSource(this);
-    }
+    // hard reset the grid, this will force the grid to fetch data again
+    // 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);
   }
 
-  configureClient(val: GridApi | undefined): void {
-    this._client = val;
+  setScrollHintText(val: string): void {
+    this.scrollHintText = val;
   }
 
   get client(): GridApi {
     return guaranteeNonNullable(this._client, 'Grid client is not configured');
   }
 
-  override async applySnapshot(snapshot: DataCubeQuerySnapshot): Promise<void> {
-    const gridOptions = generateGridOptionsFromSnapshot(snapshot);
+  configureClient(val: GridApi | undefined): void {
+    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,
+    );
+
+    // NOTE: if one of the change affects the structure of the data cube but cannot be captured
+    // in the grid client options, we will need to manually reset the grid by resetting the
+    // datasource to ensure we don't fetch the result twice while forcing the data to be refreshed
+    runInAction(() => {
+      this.datasourceConfiguration = new DataCubeGridDatasourceConfiguration({
+        snapshot,
+        queryConfiguration,
+      });
+      this.queryConfiguration = queryConfiguration;
+    });
+    if (
+      existingExtraConfiguration.hashCode !==
+      this.datasourceConfiguration.hashCode
+    ) {
+      // reset the entire grid
+      this.clientDataSource = new DataCubeGridClientServerSideDataSource(this);
+    }
+
+    const gridOptions = generateGridOptionsFromSnapshot(
+      snapshot,
+      queryConfiguration,
+      this.dataCube,
+    );
     this.client.updateGridOptions(gridOptions);
   }
 

package/tsconfig.json

@@ -57,12 +57,12 @@
     "./src/server/models/DataCubeQuery.ts",
     "./src/stores/LegendREPLApplicationPlugin.ts",
     "./src/stores/LegendREPLBaseStore.ts",
+    "./src/stores/REPLStore.ts",
+    "./src/stores/dataCube/DataCubeInfrastructure.ts",
     "./src/stores/dataCube/DataCubeState.ts",
-    "./src/stores/dataCube/REPLStore.ts",
     "./src/stores/dataCube/core/DataCubeConfiguration.ts",
     "./src/stores/dataCube/core/DataCubeConfigurationBuilder.ts",
     "./src/stores/dataCube/core/DataCubeCoreState.ts",
-    "./src/stores/dataCube/core/DataCubeEngine.ts",
     "./src/stores/dataCube/core/DataCubeQueryBuilder.ts",
     "./src/stores/dataCube/core/DataCubeQueryEngine.ts",
     "./src/stores/dataCube/core/DataCubeQuerySnapshot.ts",
@@ -88,6 +88,7 @@
     "./src/components/LegendREPLApplication.tsx",
     "./src/components/LegendREPLFrameworkProvider.tsx",
     "./src/components/REPLStoreProvider.tsx",
+    "./src/components/REPLWindow.tsx",
     "./src/components/dataCube/DataCube.tsx",
     "./src/components/dataCube/editor/DataCubeEditor.tsx",
     "./src/components/dataCube/editor/DataCubeEditorCodePanel.tsx",

package/lib/stores/dataCube/REPLStore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"REPLStore.d.ts","sourceRoot":"","sources":["../../../src/stores/dataCube/REPLStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,qBAAa,SAAS;IACpB,QAAQ,CAAC,gBAAgB,EAAE,0BAA0B,CAAC;IACtD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAGlC,QAAQ,EAAG,aAAa,CAAC;gBAEb,gBAAgB,EAAE,0BAA0B;CAezD"}

package/lib/stores/dataCube/REPLStore.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"REPLStore.js","sourceRoot":"","sources":["../../../src/stores/dataCube/REPLStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,OAAO,SAAS;IACX,gBAAgB,CAA6B;IAC7C,MAAM,CAAmB;IAElC,6EAA6E;IAC7E,QAAQ,CAAiB;IAEzB,YAAY,gBAA4C;QACtD,cAAc,CAAC,IAAI,EAAE;YACnB,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAgB,CAChC,IAAI,aAAa,CAAC;YAChB,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,oBAAoB;gBACxD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM;oBACtB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAChE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO;SACzC,CAAC,CACH,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF"}

package/lib/stores/dataCube/core/DataCubeEngine.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DataCubeEngine.d.ts","sourceRoot":"","sources":["../../../../src/stores/dataCube/core/DataCubeEngine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,KAAK,SAAS,EAGd,KAAK,qBAAqB,EAC1B,kBAAkB,EAGnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EACL,0BAA0B,EAC1B,KAAK,cAAc,EACpB,MAAM,gDAAgD,CAAC;AAGxD,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;gBAE9B,MAAM,EAAE,gBAAgB;IAI9B,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI1C,iBAAiB,CACrB,IAAI,EAAE,MAAM,EACZ,SAAS,CAAC,EAAE,OAAO,GAClB,OAAO,CAAC,cAAc,EAAE,CAAC;IAOtB,UAAU,CACd,IAAI,EAAE,MAAM,EACZ,uBAAuB,CAAC,EAAE,OAAO,GAChC,OAAO,CAAC,qBAAqB,CAAC;IAO3B,YAAY,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAMnD,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAWlE"}

package/lib/stores/dataCube/core/DataCubeEngine.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DataCubeEngine.js","sourceRoot":"","sources":["../../../../src/stores/dataCube/core/DataCubeEngine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAEL,gCAAgC,EAChC,8BAA8B,EAE9B,kBAAkB,EAClB,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,0BAA0B,GAE3B,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,MAAM,OAAO,cAAc;IACR,MAAM,CAAmB;IAE1C,YAAY,MAAwB;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,uBAAuB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,IAAY,EACZ,SAAmB;QAEnB,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAC1C,IAAI;YACJ,SAAS;SACV,CAAC,CAAqB,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,UAAU,CACd,IAAY,EACZ,uBAAiC;QAEjC,OAAO,gCAAgC,CACrC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,EAC/D,EAAE,CACH,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,0BAA0B,CAAC,aAAa,CAAC,QAAQ,CACtD,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CACjC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAgB;QACjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC5C,KAAK,EAAE,8BAA8B,CAAC,KAAK,EAAE,EAAE,CAAC;SACjD,CAAC,CAAC;QACH,OAAO,aAAa,CAClB,uBAAuB,CACrB,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CACvD,EACD,kBAAkB,CACnB,CAAC;IACJ,CAAC;CACF"}