@finos/legend-application-repl 0.0.30 → 0.0.32

package/src/stores/dataCube/core/DataCubeQuerySnapshot.ts

@@ -15,10 +15,12 @@
  */
 
 import type { V1_Lambda, V1_ValueSpecification } from '@finos/legend-graph';
-import type { DataCubeConfiguration } from '../../../server/models/DataCubeQuery.js';
+import type { DataCubeConfiguration } from './DataCubeConfiguration.js';
 import {
   IllegalStateError,
   guaranteeNonNullable,
+  hashObject,
+  pruneObject,
   uuid,
   type PlainObject,
   type Writable,
@@ -54,7 +56,7 @@ export enum DataCubeQuerySnapshotFilterOperation {
   ENDS_WITH = 'endsWith',
 }
 
-export enum DataCubeQuerySnapshotSortDirection {
+export enum DataCubeQuerySnapshotSortOperation {
   ASCENDING = 'ascending',
   DESCENDING = 'descending',
 }
@@ -90,7 +92,7 @@ export type DataCubeQuerySnapshotExtendedColumn =
   };
 
 export type DataCubeQuerySnapshotSortColumn = DataCubeQuerySnapshotColumn & {
-  direction: DataCubeQuerySnapshotSortDirection;
+  operation: DataCubeQuerySnapshotSortOperation;
 };
 
 export type DataCubeQuerySnapshotAggregateColumn =
@@ -113,7 +115,7 @@ export type DataCubeQuerySnapshotData = {
   name: string;
   runtime: string;
   sourceQuery: PlainObject<V1_ValueSpecification>;
-  configuration: DataCubeConfiguration;
+  configuration: PlainObject<DataCubeConfiguration>;
   originalColumns: DataCubeQuerySnapshotColumn[];
   leafExtendedColumns: DataCubeQuerySnapshotExtendedColumn[];
   filter?: DataCubeQuerySnapshotFilter | undefined;
@@ -138,11 +140,14 @@ export class DataCubeQuerySnapshot {
   timestamp = Date.now();
   readonly data: DataCubeQuerySnapshotData;
 
+  private _finalized = false;
+  private _hashCode?: string | undefined;
+
   private constructor(
     name: string,
     runtime: string,
     sourceQuery: PlainObject<V1_ValueSpecification>,
-    configuration: DataCubeConfiguration,
+    configuration: PlainObject<DataCubeConfiguration>,
   ) {
     this.data = {
       name,
@@ -165,7 +170,7 @@ export class DataCubeQuerySnapshot {
     name: string,
     runtime: string,
     sourceQuery: PlainObject<V1_ValueSpecification>,
-    configuration: DataCubeConfiguration,
+    configuration: PlainObject<DataCubeConfiguration>,
   ) {
     return new DataCubeQuerySnapshot(name, runtime, sourceQuery, configuration);
   }
@@ -204,6 +209,38 @@ export class DataCubeQuerySnapshot {
         throw new IllegalStateError(`Unknown stage '${stage}'`);
     }
   }
+
+  isFinalized(): boolean {
+    return this._finalized;
+  }
+
+  finalize(): DataCubeQuerySnapshot {
+    if (this._finalized) {
+      return this;
+    }
+    this._hashCode = this.computeHashCode();
+    this._finalized = true;
+    return this;
+  }
+
+  get hashCode(): string {
+    if (!this._finalized || !this._hashCode) {
+      throw new IllegalStateError('Snapshot is not finalized');
+    }
+    return this._hashCode;
+  }
+
+  /**
+   * NOTE: if this becomes a performance bottleneck, we can consider
+   * more granular hashing strategy
+   *
+   * Here, we are just hashing the raw object, but we must ensure
+   * to properly prune the snapshot data object before hashing
+   * else there would be mismatch
+   */
+  private computeHashCode(): string {
+    return hashObject(pruneObject(this.data));
+  }
 }
 
 export function _findCol<T extends DataCubeQuerySnapshotColumn>(

package/src/stores/dataCube/core/DataCubeQuerySnapshotBuilder.ts

@@ -36,7 +36,7 @@ import {
 import type { DataCubeQuery } from '../../../server/models/DataCubeQuery.js';
 import {
   DataCubeQuerySnapshot,
-  DataCubeQuerySnapshotSortDirection,
+  DataCubeQuerySnapshotSortOperation,
   type DataCubeQuerySnapshotColumn,
 } from './DataCubeQuerySnapshot.js';
 import {
@@ -50,6 +50,8 @@ import {
   DataCubeFunction,
   type DataCubeQueryFunctionMap,
 } from './DataCubeQueryEngine.js';
+import { DataCubeConfiguration } from './DataCubeConfiguration.js';
+import { buildDefaultConfiguration } from './DataCubeConfigurationBuilder.js';
 
 // --------------------------------- UTILITIES ---------------------------------
 
@@ -113,12 +115,12 @@ const _SUPPORTED_TOP_LEVEL_FUNCTIONS: {
   func: string;
   parameters: number;
 }[] = [
-  { func: DataCubeFunction.EXTEND, parameters: 1 },
   { func: DataCubeFunction.FILTER, parameters: 1 },
+  { func: DataCubeFunction.EXTEND, parameters: 1 },
+  { func: DataCubeFunction.SELECT, parameters: 1 },
   { func: DataCubeFunction.GROUP_BY, parameters: 3 },
   { func: DataCubeFunction.LIMIT, parameters: 1 },
   { func: DataCubeFunction.PIVOT, parameters: 3 },
-  { func: DataCubeFunction.SELECT, parameters: 1 },
   { func: DataCubeFunction.SORT, parameters: 1 },
 
   { func: DataCubeFunction.CAST, parameters: 1 },
@@ -132,13 +134,13 @@ const _FUNCTION_SEQUENCE_COMPOSITION_PATTERN: {
   repeat?: boolean | undefined;
   required?: boolean | undefined;
 }[] = [
-  { func: DataCubeFunction.EXTEND },
   { func: DataCubeFunction.FILTER },
+  { func: DataCubeFunction.EXTEND },
+  { func: DataCubeFunction.SELECT },
   { func: DataCubeFunction.GROUP_BY },
   { func: DataCubeFunction.PIVOT },
   { func: DataCubeFunction.CAST },
   { func: DataCubeFunction.EXTEND },
-  { func: DataCubeFunction.SELECT },
   { func: DataCubeFunction.SORT },
   { func: DataCubeFunction.LIMIT },
 ];
@@ -269,19 +271,19 @@ function extractFunctionMap(
     }
   }
 
+  const select = sequence.find((func) =>
+    matchFunctionName(func.function, DataCubeFunction.SELECT),
+  );
   const filter = sequence.find((func) =>
     matchFunctionName(func.function, DataCubeFunction.FILTER),
   );
   const groupBy = sequence.find((func) =>
     matchFunctionName(func.function, DataCubeFunction.GROUP_BY),
   );
-  const select = sequence.find((func) =>
-    matchFunctionName(func.function, DataCubeFunction.SELECT),
-  );
   const pivot = sequence.find((func) =>
     matchFunctionName(func.function, DataCubeFunction.PIVOT),
   );
-  const cast = sequence.find((func) =>
+  const pivotCast = sequence.find((func) =>
     matchFunctionName(func.function, DataCubeFunction.CAST),
   );
   const sort = sequence.find((func) =>
@@ -292,12 +294,12 @@ function extractFunctionMap(
   );
   return {
     leafExtend,
+    select,
     filter,
     groupBy,
     pivot,
-    pivotCast: cast,
+    pivotCast,
     groupExtend,
-    select,
     sort,
     limit,
   };
@@ -326,7 +328,7 @@ export function validateAndBuildQuerySnapshot(
     baseQuery.name,
     baseQuery.source.runtime,
     V1_serializeValueSpecification(sourceQuery, []),
-    baseQuery.configuration,
+    {},
   );
   const data = snapshot.data;
   const colsMap = new Map<string, DataCubeQuerySnapshotColumn>();
@@ -335,15 +337,27 @@ export function validateAndBuildQuerySnapshot(
 
   // --------------------------------- SOURCE ---------------------------------
 
-  data.originalColumns = baseQuery.source.columns;
+  data.originalColumns = baseQuery.source.columns.map((col) => ({
+    name: col.name,
+    type: col.type,
+  }));
   data.originalColumns.map((col) => colsMap.set(col.name, col));
 
-  // --------------------------------- LEAF EXTEND ---------------------------------
+  // --------------------------------- FILTER ---------------------------------
   // TODO: @akphi - implement this
 
-  // --------------------------------- FILTER ---------------------------------
+  // --------------------------------- LEAF EXTEND ---------------------------------
   // TODO: @akphi - implement this
 
+  // --------------------------------- SELECT ---------------------------------
+
+  if (funcMap.select) {
+    data.selectColumns = _colSpecArrayParam(funcMap.select, 0).colSpecs.map(
+      (colSpec) => ({
+        ..._col(colSpec),
+      }),
+    );
+  }
   // --------------------------------- GROUP BY ---------------------------------
   // TODO: @akphi - implement this
 
@@ -367,25 +381,15 @@ export function validateAndBuildQuerySnapshot(
         ]);
         return {
           ..._col(_colSpecParam(sortColFunc, 0)),
-          direction:
+          operation:
             _name(sortColFunc.function) === DataCubeFunction.ASC
-              ? DataCubeQuerySnapshotSortDirection.ASCENDING
-              : DataCubeQuerySnapshotSortDirection.DESCENDING,
+              ? DataCubeQuerySnapshotSortOperation.ASCENDING
+              : DataCubeQuerySnapshotSortOperation.DESCENDING,
         };
       },
     );
   }
 
-  // --------------------------------- SELECT ---------------------------------
-
-  if (funcMap.select) {
-    data.selectColumns = _colSpecArrayParam(funcMap.select, 0).colSpecs.map(
-      (colSpec) => ({
-        ..._col(colSpec),
-      }),
-    );
-  }
-
   // --------------------------------- LIMIT ---------------------------------
 
   if (funcMap.limit) {
@@ -394,5 +398,21 @@ export function validateAndBuildQuerySnapshot(
     data.limit = value.value;
   }
 
-  return snapshot;
+  // --------------------------------- CONFIGURATION ---------------------------------
+  // The data query takes precedence over the configuration, we do this for 2 reasons
+  // 1. The purpose of the configuration is to provide the layout and styling
+  //    customization on top of the data query result grid. If conflicts happen between
+  //    the configuration and the query, we will reconciliate by modifying the configuration
+  // 2. The configuration when missing, can be generated from default presets. This helps
+  //    helps with use cases where the query might comes from a different source, such as
+  //    Studio or Query, or another part of Engine.
+
+  const configuration = baseQuery.configuration
+    ? DataCubeConfiguration.serialization.fromJson(baseQuery.configuration)
+    : buildDefaultConfiguration(baseQuery.source.columns);
+  // TODO: @akphi - implement this
+  data.configuration =
+    DataCubeConfiguration.serialization.toJson(configuration);
+
+  return snapshot.finalize();
 }

package/src/stores/dataCube/core/DataCubeQuerySnapshotManager.ts

@@ -26,7 +26,7 @@ import {
 } from '@finos/legend-shared';
 import type { DataCubeQuery } from '../../../server/models/DataCubeQuery.js';
 
-// TODO: use this when we implement undo/redo
+// TODO: set a stack depth when we implement undo/redo
 // const DATA_CUBE_MAX_SNAPSHOT_COUNT = 100;
 
 export class DataCubeQuerySnapshotManager {
@@ -77,6 +77,13 @@ export class DataCubeQuerySnapshotManager {
   }
 
   broadcastSnapshot(snapshot: DataCubeQuerySnapshot): void {
+    if (!snapshot.isFinalized()) {
+      this.dataCube.application.logService.error(
+        LogEvent.create(APPLICATION_EVENT.ILLEGAL_APPLICATION_STATE_OCCURRED),
+        `Snapshot must be finalized before broadcasting`,
+      );
+      return;
+    }
     this.snapshots.push(snapshot);
     this.subscribers.forEach((subscriber) => {
       const currentSnapshot = subscriber.getLatestSnapshot();
@@ -87,7 +94,7 @@ export class DataCubeQuerySnapshotManager {
             LogEvent.create(
               APPLICATION_EVENT.ILLEGAL_APPLICATION_STATE_OCCURRED,
             ),
-            `Subscribers receiving and applying new snapshot should be handled gracefully`,
+            `Error occured while subscribers receiving and applying new snapshot should be handled gracefully`,
             error,
           );
         });

package/src/stores/dataCube/core/DataCubeQuerySnapshotSubscriber.ts

@@ -16,28 +16,29 @@
 
 import type { LegendREPLApplicationStore } from '../../LegendREPLBaseStore.js';
 import type { DataCubeState } from '../DataCubeState.js';
-import type { DataCubeEngine } from './DataCubeEngine.js';
 import type { DataCubeQuerySnapshot } from './DataCubeQuerySnapshot.js';
 
 export abstract class DataCubeQuerySnapshotSubscriber {
   readonly dataCube!: DataCubeState;
   readonly application!: LegendREPLApplicationStore;
-  readonly engine!: DataCubeEngine;
 
   private latestSnapshot: DataCubeQuerySnapshot | undefined;
 
   constructor(dataCube: DataCubeState) {
     this.dataCube = dataCube;
     this.application = dataCube.application;
-    this.engine = dataCube.engine;
   }
 
-  abstract applySnapshot(snapshot: DataCubeQuerySnapshot): Promise<void>;
+  abstract applySnapshot(
+    snapshot: DataCubeQuerySnapshot,
+    previousSnapshot: DataCubeQuerySnapshot | undefined,
+  ): Promise<void>;
   abstract initialize(): Promise<void>;
 
   async receiveSnapshot(snapshot: DataCubeQuerySnapshot): Promise<void> {
+    const previousSnapshot = this.latestSnapshot;
     this.latestSnapshot = snapshot;
-    await this.applySnapshot(snapshot);
+    await this.applySnapshot(snapshot, previousSnapshot);
   }
 
   publishSnapshot(snapshot: DataCubeQuerySnapshot): void {

package/src/stores/dataCube/editor/DataCubeEditorCodePanelState.ts

@@ -29,6 +29,7 @@ import {
   SourceInformation,
   V1_ParserError,
 } from '@finos/legend-graph';
+import type { DataCubeEditorState } from './DataCubeEditorState.js';
 
 class DataCubeQueryEditorState {
   uuid = uuid();
@@ -79,11 +80,12 @@ class DataCubeQueryEditorState {
 
 export class DataCubeEditorCodePanelState {
   readonly dataCube!: DataCubeState;
+  readonly editor: DataCubeEditorState;
 
   queryEditorState!: DataCubeQueryEditorState;
   currentSubQuery?: string | undefined;
 
-  constructor(dataCube: DataCubeState) {
+  constructor(editor: DataCubeEditorState) {
     makeObservable(this, {
       currentSubQuery: observable,
       queryEditorState: observable,
@@ -91,7 +93,8 @@ export class DataCubeEditorCodePanelState {
       parseQuery: flow,
     });
 
-    this.dataCube = dataCube;
+    this.editor = editor;
+    this.dataCube = editor.dataCube;
     this.queryEditorState = new DataCubeQueryEditorState('');
   }
 

package/src/stores/dataCube/editor/DataCubeEditorColumnPropertiesPanelState.ts

@@ -0,0 +1,96 @@
+/**
+ * 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 { action, computed, makeObservable, observable } from 'mobx';
+import type { DataCubeState } from '../DataCubeState.js';
+import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
+import type { DataCubeQueryEditorPanelState } from './DataCubeEditorPanelState.js';
+import type { DataCubeEditorState } from './DataCubeEditorState.js';
+import { DataCubeMutableColumnConfiguration } from './DataCubeMutableConfiguration.js';
+import { getNonNullableEntry, type PlainObject } from '@finos/legend-shared';
+
+export class DataCubeEditorColumnPropertiesPanelState
+  implements DataCubeQueryEditorPanelState
+{
+  readonly dataCube!: DataCubeState;
+  readonly editor!: DataCubeEditorState;
+
+  columns: DataCubeMutableColumnConfiguration[] = [];
+  selectedColumnName?: string | undefined;
+  showAdvancedSettings = false;
+
+  constructor(editor: DataCubeEditorState) {
+    makeObservable(this, {
+      columns: observable,
+      setColumns: action,
+
+      selectedColumnName: observable,
+      setSelectedColumnName: action,
+      selectedColumn: computed,
+
+      showAdvancedSettings: observable,
+      setShowAdvancedSettings: action,
+    });
+
+    this.editor = editor;
+    this.dataCube = editor.dataCube;
+  }
+
+  getColumnConfiguration(
+    colName: string | undefined,
+  ): DataCubeMutableColumnConfiguration | undefined {
+    return this.columns.find((col) => col.name === colName);
+  }
+
+  setColumns(val: DataCubeMutableColumnConfiguration[]): void {
+    this.columns = val;
+  }
+
+  setSelectedColumnName(val: string | undefined): void {
+    this.selectedColumnName = val;
+  }
+
+  get selectedColumn(): DataCubeMutableColumnConfiguration | undefined {
+    return this.columns.find(
+      (column) => column.name === this.selectedColumnName,
+    );
+  }
+
+  setShowAdvancedSettings(val: boolean): void {
+    this.showAdvancedSettings = val;
+  }
+
+  applySnaphot(snapshot: DataCubeQuerySnapshot): void {
+    this.setColumns(
+      (snapshot.data.configuration as { columns: PlainObject[] }).columns.map(
+        (column) => DataCubeMutableColumnConfiguration.create(column),
+      ),
+    );
+    if (!this.selectedColumn && this.columns.length) {
+      this.setSelectedColumnName(getNonNullableEntry(this.columns, 0).name);
+    }
+  }
+
+  buildSnapshot(
+    newSnapshot: DataCubeQuerySnapshot,
+    baseSnapshot: DataCubeQuerySnapshot,
+  ): void {
+    newSnapshot.data.configuration = {
+      ...newSnapshot.data.configuration,
+      columns: this.columns.map((column) => column.serialize()),
+    };
+  }
+}

package/src/stores/dataCube/editor/DataCubeEditorColumnsSelectorState.ts

@@ -18,6 +18,9 @@ import { makeObservable, observable, action } from 'mobx';
 
 export abstract class DataCubeEditorColumnsSelectorColumnState {
   abstract get name(): string;
+  resetWhenMadeAvailable(): void {
+    // do nothing
+  }
 }
 
 export class DataCubeEditorColumnsSelectorState<
@@ -45,6 +48,7 @@ export class DataCubeEditorColumnsSelectorState<
     this.availableColumns = val
       .slice()
       .sort((a, b) => a.name.localeCompare(b.name));
+    this.availableColumns.forEach((column) => column.resetWhenMadeAvailable());
   }
 
   setSelectedColumns(val: T[]): void {
@@ -58,4 +62,12 @@ export class DataCubeEditorColumnsSelectorState<
   setSelectedColumnsSearchText(val: string): void {
     this.selectedColumnsSearchText = val;
   }
+
+  getAvailableColumn(colName: string): T | undefined {
+    return this.availableColumns.find((col) => col.name === colName);
+  }
+
+  getSelectedColumn(colName: string): T | undefined {
+    return this.selectedColumns.find((col) => col.name === colName);
+  }
 }

package/src/stores/dataCube/editor/DataCubeEditorGeneralPropertiesPanelState.ts

@@ -18,63 +18,66 @@ import { action, makeObservable, observable } from 'mobx';
 import type { DataCubeState } from '../DataCubeState.js';
 import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
 import type { DataCubeQueryEditorPanelState } from './DataCubeEditorPanelState.js';
+import type { DataCubeEditorState } from './DataCubeEditorState.js';
+import { DataCubeMutableConfiguration } from './DataCubeMutableConfiguration.js';
 
 export class DataCubeEditorGeneralPropertiesPanelState
   implements DataCubeQueryEditorPanelState
 {
   readonly dataCube!: DataCubeState;
+  readonly editor!: DataCubeEditorState;
+
   name = '';
   limit = -1;
+  configuration = new DataCubeMutableConfiguration();
 
-  constructor(dataCube: DataCubeState) {
-    this.dataCube = dataCube;
-
+  constructor(editor: DataCubeEditorState) {
     makeObservable(this, {
       name: observable,
       setName: action,
 
       limit: observable,
       setLimit: action,
+
+      configuration: observable,
+      setConfiguration: action,
     });
+
+    this.editor = editor;
+    this.dataCube = editor.dataCube;
   }
 
   setName(val: string): void {
     this.name = val;
   }
 
-  setLimit(val: number | undefined): void {
-    this.limit = Math.round(val === undefined || val < 0 ? -1 : val);
+  setLimit(val: number): void {
+    this.limit = val;
+  }
+
+  setConfiguration(val: DataCubeMutableConfiguration): void {
+    this.configuration = val;
   }
 
   applySnaphot(snapshot: DataCubeQuerySnapshot): void {
     this.setName(snapshot.data.name);
-    this.setLimit(snapshot.data.limit);
+    this.setLimit(
+      snapshot.data.limit !== undefined && snapshot.data.limit > 0
+        ? snapshot.data.limit
+        : -1,
+    );
+    this.setConfiguration(
+      DataCubeMutableConfiguration.create(snapshot.data.configuration),
+    );
   }
 
   buildSnapshot(
     newSnapshot: DataCubeQuerySnapshot,
     baseSnapshot: DataCubeQuerySnapshot,
-  ): boolean {
-    const data = baseSnapshot.data;
-    // name
-    if (this.name !== data.name) {
-      data.name = this.name;
-      return true;
-    }
-
-    // limit
-    if (data.limit === undefined) {
-      if (this.limit !== -1) {
-        data.limit = this.limit;
-        return true;
-      }
-    } else {
-      if (this.limit !== data.limit) {
-        data.limit = this.limit;
-        return true;
-      }
-    }
-
-    return false;
+  ): void {
+    const data = newSnapshot.data;
+    data.name = this.name;
+    data.limit = this.limit <= 0 ? undefined : this.limit;
+    data.configuration = this.configuration.serialize();
   }
 }

package/src/stores/dataCube/editor/DataCubeEditorHPivotPanelState.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 type { DataCubeState } from '../DataCubeState.js';
+import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
+import type { DataCubeQueryEditorPanelState } from './DataCubeEditorPanelState.js';
+import type { DataCubeEditorState } from './DataCubeEditorState.js';
+
+export class DataCubeEditorGeneralPropertiesPanelState
+  implements DataCubeQueryEditorPanelState
+{
+  readonly dataCube!: DataCubeState;
+  readonly editor!: DataCubeEditorState;
+
+  constructor(editor: DataCubeEditorState) {
+    this.editor = editor;
+    this.dataCube = editor.dataCube;
+  }
+
+  applySnaphot(snapshot: DataCubeQuerySnapshot): void {
+    // TODO
+  }
+
+  buildSnapshot(
+    newSnapshot: DataCubeQuerySnapshot,
+    baseSnapshot: DataCubeQuerySnapshot,
+  ): void {
+    // TODO
+  }
+}

package/src/stores/dataCube/editor/DataCubeEditorPanelState.ts

@@ -29,5 +29,5 @@ export interface DataCubeQueryEditorPanelState {
   buildSnapshot(
     newSnapshot: DataCubeQuerySnapshot,
     baseSnapshot: DataCubeQuerySnapshot,
-  ): boolean;
+  ): void;
 }