@finos/legend-data-cube 0.0.36 → 0.0.38

package/src/stores/view/editor/DataCubeEditorState.tsx

@@ -17,7 +17,7 @@
 import { action, makeObservable, observable } from 'mobx';
 import type { DataCubeViewState } from '../DataCubeViewState.js';
 import { DataCubeEditorSortsPanelState } from './DataCubeEditorSortsPanelState.js';
-import { DataCubeQuerySnapshotController } from '../DataCubeQuerySnapshotManager.js';
+import { DataCubeQuerySnapshotController } from '../../services/DataCubeQuerySnapshotService.js';
 import {
   type DataCubeQuerySnapshot,
   type DataCubeQuerySnapshotExtendedColumn,
@@ -25,7 +25,7 @@ import {
 import {
   _toCol,
   type DataCubeColumn,
-} from '../../core/models/DataCubeColumn.js';
+} from '../../core/model/DataCubeColumn.js';
 import {
   ActionState,
   assertErrorThrown,
@@ -34,9 +34,9 @@ import {
 import { DataCubeEditorGeneralPropertiesPanelState } from './DataCubeEditorGeneralPropertiesPanelState.js';
 import { DataCubeEditorColumnPropertiesPanelState } from './DataCubeEditorColumnPropertiesPanelState.js';
 import { DataCubeEditorColumnsPanelState } from './DataCubeEditorColumnsPanelState.js';
-import { DataCubeConfiguration } from '../../core/models/DataCubeConfiguration.js';
+import { DataCubeConfiguration } from '../../core/model/DataCubeConfiguration.js';
 import { DataCubeEditorVerticalPivotsPanelState } from './DataCubeEditorVerticalPivotsPanelState.js';
-import type { DisplayState } from '../../core/DataCubeLayoutManagerState.js';
+import type { DisplayState } from '../../services/DataCubeLayoutService.js';
 import { DataCubeEditor } from '../../../components/view/editor/DataCubeEditor.js';
 import { DataCubeEditorHorizontalPivotsPanelState } from './DataCubeEditorHorizontalPivotsPanelState.js';
 import { DataCubeEditorPivotLayoutPanelState } from './DataCubeEditorPivotLayoutPanelState.js';
@@ -62,6 +62,7 @@ export enum DataCubeEditorTab {
  * reasons, those have been separated out into their own respective query editor states.
  */
 export class DataCubeEditorState extends DataCubeQuerySnapshotController {
+  readonly view: DataCubeViewState;
   readonly display: DisplayState;
   readonly finalizationState = ActionState.create();
 
@@ -81,7 +82,7 @@ export class DataCubeEditorState extends DataCubeQuerySnapshotController {
   groupExtendColumns: DataCubeQuerySnapshotExtendedColumn[] = [];
 
   constructor(view: DataCubeViewState) {
-    super(view);
+    super(view.engine, view.settingService, view.snapshotService);
 
     makeObservable(this, {
       currentTab: observable,
@@ -95,9 +96,11 @@ export class DataCubeEditorState extends DataCubeQuerySnapshotController {
       applyChanges: action,
     });
 
-    this.display = this.view.engine.layout.newDisplay('Properties', () => (
-      <DataCubeEditor view={this.view} />
-    ));
+    this.view = view;
+    this.display = this.view.dataCube.layoutService.newDisplay(
+      'Properties',
+      () => <DataCubeEditor view={this.view} />,
+    );
     this.generalProperties = new DataCubeEditorGeneralPropertiesPanelState(
       this,
     );
@@ -160,7 +163,7 @@ export class DataCubeEditorState extends DataCubeQuerySnapshotController {
     // finalize
     newSnapshot.finalize();
     if (newSnapshot.hashCode !== baseSnapshot.hashCode) {
-      const task = this.view.newTask('Validate query');
+      const task = this.view.taskService.newTask('Validate query');
       // NOTE: Compile the query to validate. This is a helpful check for a lot of different scenarios
       // where the consistency of the query might be thrown off by changes from various parts that the
       // editor does not have full control over (i.e. extended columns, pivot cast columns, etc.)
@@ -195,19 +198,24 @@ export class DataCubeEditorState extends DataCubeQuerySnapshotController {
       } catch (error) {
         assertErrorThrown(error);
         if (error instanceof EngineError) {
-          this.view.engine.alertCodeCheckError(error, code, codePrefix, {
-            message: `Query Validation Failure: Can't safely apply changes. Check the query code below for more details.`,
-            text: `Error: ${error.message}`,
-          });
+          this.view.dataCube.alertService.alertCodeCheckError(
+            error,
+            code,
+            codePrefix,
+            {
+              message: `Query Validation Failure: Can't safely apply changes. Check the query code below for more details.`,
+              text: `Error: ${error.message}`,
+            },
+          );
         } else {
-          this.view.engine.alertError(error, {
+          this.view.dataCube.alertService.alertError(error, {
             message: `Query Validation Failure: Can't safely apply changes.`,
             text: `Error: ${error.message}`,
           });
         }
         return;
       } finally {
-        this.view.endTask(task);
+        this.view.taskService.endTask(task);
         this.finalizationState.complete();
       }
 

package/src/stores/view/editor/DataCubeEditorVerticalPivotsPanelState.ts

@@ -15,11 +15,10 @@
  */
 
 import { uniqBy } from '@finos/legend-shared';
-import type { DataCubeViewState } from '../DataCubeViewState.js';
-import type { DataCubeConfiguration } from '../../core/models/DataCubeConfiguration.js';
+import type { DataCubeConfiguration } from '../../core/model/DataCubeConfiguration.js';
 import { DataCubeColumnKind } from '../../core/DataCubeQueryEngine.js';
 import { type DataCubeQuerySnapshot } from '../../core/DataCubeQuerySnapshot.js';
-import { _toCol } from '../../core/models/DataCubeColumn.js';
+import { _toCol } from '../../core/model/DataCubeColumn.js';
 import {
   DataCubeEditorColumnSelectorColumnState,
   DataCubeEditorColumnSelectorState,
@@ -38,16 +37,16 @@ export class DataCubeEditorVerticalPivotColumnSelectorState extends DataCubeEdit
   }
 
   override get availableColumns() {
-    return this.editor.columnProperties.columns
+    return this._editor.columnProperties.columns
       .filter(
         (column) =>
           column.kind === DataCubeColumnKind.DIMENSION &&
           // exclude group-level extended columns
-          !this.editor.groupExtendColumns.find(
+          !this._editor.groupExtendColumns.find(
             (col) => col.name === column.name,
           ) &&
           // exclude pivot columns
-          !this.editor.horizontalPivots.selector.selectedColumns.find(
+          !this._editor.horizontalPivots.selector.selectedColumns.find(
             (col) => col.name === column.name,
           ),
       )
@@ -61,13 +60,9 @@ export class DataCubeEditorVerticalPivotColumnSelectorState extends DataCubeEdit
 export class DataCubeEditorVerticalPivotsPanelState
   implements DataCubeQueryEditorPanelState
 {
-  readonly view!: DataCubeViewState;
-  readonly editor!: DataCubeEditorState;
   readonly selector!: DataCubeEditorVerticalPivotColumnSelectorState;
 
   constructor(editor: DataCubeEditorState) {
-    this.editor = editor;
-    this.view = editor.view;
     this.selector = new DataCubeEditorVerticalPivotColumnSelectorState(editor);
   }
 

package/src/stores/view/extend/DataCubeColumnEditorState.tsx

@@ -16,7 +16,7 @@
 
 import { action, computed, makeObservable, observable, override } from 'mobx';
 import type { DataCubeViewState } from '../DataCubeViewState.js';
-import type { DisplayState } from '../../core/DataCubeLayoutManagerState.js';
+import type { DisplayState } from '../../services/DataCubeLayoutService.js';
 import { DataCubeColumnCreator } from '../../../components/view/extend/DataCubeColumnEditor.js';
 import { editor as monacoEditorAPI, Uri } from 'monaco-editor';
 import {
@@ -42,19 +42,21 @@ import type { DataCubeExtendManagerState } from './DataCubeExtendManagerState.js
 import {
   EngineError,
   PRIMITIVE_TYPE,
-  V1_deserializeValueSpecification,
   V1_Lambda,
-  V1_serializeValueSpecification,
   type V1_ValueSpecification,
 } from '@finos/legend-graph';
-import type { DataCubeColumnConfiguration } from '../../core/models/DataCubeConfiguration.js';
+import type { DataCubeColumnConfiguration } from '../../core/model/DataCubeConfiguration.js';
 import type { DataCubeQuerySnapshotExtendedColumn } from '../../core/DataCubeQuerySnapshot.js';
-import { _lambda } from '../../core/DataCubeQueryBuilderUtils.js';
+import {
+  _lambda,
+  _serializeValueSpecification,
+  _deserializeValueSpecification,
+} from '../../core/DataCubeQueryBuilderUtils.js';
 
 export abstract class DataCubeColumnBaseEditorState {
-  readonly uuid = uuid();
+  protected readonly uuid = uuid();
+  protected readonly _manager: DataCubeExtendManagerState;
   readonly view: DataCubeViewState;
-  readonly manager: DataCubeExtendManagerState;
 
   // NOTE: use UUID in the column name to prevent collision
   // when parsing/compiling the expression
@@ -109,7 +111,7 @@ export abstract class DataCubeColumnBaseEditorState {
       setReturnType: action,
     });
 
-    this.manager = manager;
+    this._manager = manager;
     this.view = manager.view;
     this.display = this.newDisplay(this);
 
@@ -145,7 +147,7 @@ export abstract class DataCubeColumnBaseEditorState {
   }
 
   get isNameValid(): boolean {
-    return !this.manager.allColumnNames.includes(this.name);
+    return !this._manager.allColumnNames.includes(this.name);
   }
 
   setExpectedType(value: string) {
@@ -201,7 +203,7 @@ export abstract class DataCubeColumnBaseEditorState {
 
   buildExtendBaseQuery() {
     const currentSnapshot = guaranteeNonNullable(
-      this.manager.getLatestSnapshot(),
+      this._manager.getLatestSnapshot(),
     );
     const snapshot = currentSnapshot.clone();
     if (!this.isGroupLevel) {
@@ -219,10 +221,10 @@ export abstract class DataCubeColumnBaseEditorState {
       [
         buildExecutableQuery(
           snapshot,
-          this.manager.view.source,
+          this.view.source,
           () => undefined,
-          this.manager.view.engine.filterOperations,
-          this.manager.view.engine.aggregateOperations,
+          this.view.engine.filterOperations,
+          this.view.engine.aggregateOperations,
         ),
       ],
     );
@@ -283,7 +285,7 @@ export abstract class DataCubeColumnBaseEditorState {
         this.showError(error);
         return undefined;
       }
-      this.view.engine.alertError(error, {
+      this.view.dataCube.alertService.alertError(error, {
         message: `Expression Validation Failure: ${error.message}`,
       });
     } finally {
@@ -331,7 +333,7 @@ export class DataCubeNewColumnState extends DataCubeColumnBaseEditorState {
   }
 
   override newDisplay(state: DataCubeColumnBaseEditorState): DisplayState {
-    return this.view.engine.layout.newDisplay(
+    return this.view.dataCube.layoutService.newDisplay(
       'Add New Column',
       () => <DataCubeColumnCreator state={this} />,
       {
@@ -366,7 +368,7 @@ export class DataCubeNewColumnState extends DataCubeColumnBaseEditorState {
       ]);
     } catch (error) {
       assertErrorThrown(error);
-      this.view.engine.alertError(error, {
+      this.view.dataCube.alertService.alertError(error, {
         message: `Expression Validation Failure: ${error.message}`,
       });
       return;
@@ -375,24 +377,24 @@ export class DataCubeNewColumnState extends DataCubeColumnBaseEditorState {
     }
 
     if (!(query instanceof V1_Lambda)) {
-      this.view.engine.alertError(new Error(), {
+      this.view.dataCube.alertService.alertError(new Error(), {
         message: `Expression Validation Failure: Expression must be a lambda.`,
       });
       return;
     }
 
     if (!returnType) {
-      this.view.engine.alertError(new Error(), {
+      this.view.dataCube.alertService.alertError(new Error(), {
         message: `Expression Validation Failure: Can't compute expression return type.`,
       });
       return;
     }
 
-    this.manager.addNewColumn(
+    this._manager.addNewColumn(
       {
         name: this.name,
         type: returnType,
-        mapFn: V1_serializeValueSpecification(query, []),
+        mapFn: _serializeValueSpecification(query),
       },
       this.isGroupLevel,
       this.columnKind,
@@ -435,20 +437,20 @@ export class DataCubeExistingColumnEditorState extends DataCubeColumnBaseEditorS
   }
 
   override get isNameValid(): boolean {
-    return !this.manager.allColumnNames
+    return !this._manager.allColumnNames
       .filter((colName) => colName !== this.initialData.name)
       .includes(this.name);
   }
 
   override async getInitialCode(): Promise<string> {
     return this.view.engine.getValueSpecificationCode(
-      V1_deserializeValueSpecification(this.initialData.mapFn, []),
+      _deserializeValueSpecification(this.initialData.mapFn),
       true,
     );
   }
 
   override newDisplay(state: DataCubeColumnBaseEditorState): DisplayState {
-    return this.view.engine.layout.newDisplay(
+    return this.view.dataCube.layoutService.newDisplay(
       'Edit Column',
       () => <DataCubeColumnCreator state={this} />,
       {
@@ -491,7 +493,7 @@ export class DataCubeExistingColumnEditorState extends DataCubeColumnBaseEditorS
       ]);
     } catch (error) {
       assertErrorThrown(error);
-      this.view.engine.alertError(error, {
+      this.view.dataCube.alertService.alertError(error, {
         message: `Expression Validation Failure: ${error.message}`,
       });
       return;
@@ -500,25 +502,25 @@ export class DataCubeExistingColumnEditorState extends DataCubeColumnBaseEditorS
     }
 
     if (!(query instanceof V1_Lambda)) {
-      this.view.engine.alertError(new Error(), {
+      this.view.dataCube.alertService.alertError(new Error(), {
         message: `Expression Validation Failure: Expression must be a lambda.`,
       });
       return;
     }
 
     if (!returnType) {
-      this.view.engine.alertError(new Error(), {
+      this.view.dataCube.alertService.alertError(new Error(), {
         message: `Expression Validation Failure: Can't compute expression return type.`,
       });
       return;
     }
 
-    await this.manager.updateColumn(
+    await this._manager.updateColumn(
       this.initialData.name,
       {
         name: this.name,
         type: returnType,
-        mapFn: V1_serializeValueSpecification(query, []),
+        mapFn: _serializeValueSpecification(query),
       },
       this.isGroupLevel,
       this.columnKind,

package/src/stores/view/extend/DataCubeExtendManagerState.tsx

@@ -22,7 +22,7 @@ import {
 import {
   _toCol,
   type DataCubeColumn,
-} from '../../core/models/DataCubeColumn.js';
+} from '../../core/model/DataCubeColumn.js';
 import {
   assertErrorThrown,
   deleteEntry,
@@ -31,11 +31,11 @@ import {
   uniqBy,
 } from '@finos/legend-shared';
 import type { DataCubeViewState } from '../DataCubeViewState.js';
-import { DataCubeQuerySnapshotController } from '../DataCubeQuerySnapshotManager.js';
+import { DataCubeQuerySnapshotController } from '../../services/DataCubeQuerySnapshotService.js';
 import {
   DataCubeConfiguration,
   type DataCubeColumnConfiguration,
-} from '../../core/models/DataCubeConfiguration.js';
+} from '../../core/model/DataCubeConfiguration.js';
 import {
   DataCubeExistingColumnEditorState,
   DataCubeNewColumnState,
@@ -50,16 +50,11 @@ import { _lambda } from '../../core/DataCubeQueryBuilderUtils.js';
 import { EngineError } from '@finos/legend-graph';
 
 class DataCubeQueryExtendedColumnState {
-  name: string;
-  type: string;
-  data: DataCubeQuerySnapshotExtendedColumn;
+  readonly name: string;
+  readonly type: string;
+  readonly data: DataCubeQuerySnapshotExtendedColumn;
 
   constructor(data: DataCubeQuerySnapshotExtendedColumn) {
-    makeObservable(this, {
-      name: observable,
-      type: observable,
-    });
-
     this.name = data.name;
     this.type = data.type;
     this.data = data;
@@ -70,6 +65,8 @@ class DataCubeQueryExtendedColumnState {
  * This query editor state backs the form editor for extend columns, i.e. creating new columns.
  */
 export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController {
+  readonly view: DataCubeViewState;
+
   columnConfigurations: DataCubeColumnConfiguration[] = [];
   selectColumns: DataCubeColumn[] = [];
   sourceColumns: DataCubeColumn[] = [];
@@ -82,7 +79,7 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
   existingColumnEditors: DataCubeExistingColumnEditorState[] = [];
 
   constructor(view: DataCubeViewState) {
-    super(view);
+    super(view.engine, view.settingService, view.snapshotService);
 
     makeObservable(this, {
       sourceColumns: observable.ref,
@@ -102,6 +99,8 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
 
       applySnapshot: action,
     });
+
+    this.view = view;
   }
 
   setLeafExtendedColumns(val: DataCubeQueryExtendedColumnState[]): void {
@@ -208,7 +207,7 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
       this.columnConfigurations.find((col) => col.name === columnName),
     );
 
-    const task = this.view.newTask('Column update check');
+    const task = this.view.taskService.newTask('Column update check');
 
     const currentSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
     const tempSnapshot = currentSnapshot.clone();
@@ -246,9 +245,9 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
     };
 
     const codePrefix = `->`;
-    const code = await this.view.engine.getPartialQueryCode(tempSnapshot, true);
+    const code = await this._engine.getPartialQueryCode(tempSnapshot, true);
     try {
-      await this.view.engine.getQueryCodeRelationReturnType(
+      await this._engine.getQueryCodeRelationReturnType(
         codePrefix + code,
         _lambda([], [this.view.source.query]),
         this.view.source,
@@ -256,19 +255,24 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
     } catch (error) {
       assertErrorThrown(error);
       if (error instanceof EngineError) {
-        this.view.engine.alertCodeCheckError(error, code, codePrefix, {
-          message: `Column Update Check Failure: Can't safely update column '${columnName}'. Check the query code below for more details.`,
-          text: `Error: ${error.message}`,
-        });
+        this.view.dataCube.alertService.alertCodeCheckError(
+          error,
+          code,
+          codePrefix,
+          {
+            message: `Column Update Check Failure: Can't safely update column '${columnName}'. Check the query code below for more details.`,
+            text: `Error: ${error.message}`,
+          },
+        );
       } else {
-        this.view.engine.alertError(error, {
+        this.view.dataCube.alertService.alertError(error, {
           message: `Column Update Check Failure: Can't safely update column '${columnName}'.`,
           text: `Error: ${error.message}`,
         });
       }
       return;
     } finally {
-      this.view.endTask(task);
+      this.view.taskService.endTask(task);
     }
 
     this.setLeafExtendedColumns(
@@ -328,7 +332,7 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
       return;
     }
 
-    const task = this.view.newTask('Column delete check');
+    const task = this.view.taskService.newTask('Column delete check');
 
     const currentSnapshot = guaranteeNonNullable(this.getLatestSnapshot());
     const tempSnapshot = currentSnapshot.clone();
@@ -351,9 +355,9 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
     };
 
     const codePrefix = `->`;
-    const code = await this.view.engine.getPartialQueryCode(tempSnapshot, true);
+    const code = await this._engine.getPartialQueryCode(tempSnapshot, true);
     try {
-      await this.view.engine.getQueryCodeRelationReturnType(
+      await this._engine.getQueryCodeRelationReturnType(
         codePrefix + code,
         _lambda([], [this.view.source.query]),
         this.view.source,
@@ -361,19 +365,24 @@ export class DataCubeExtendManagerState extends DataCubeQuerySnapshotController
     } catch (error) {
       assertErrorThrown(error);
       if (error instanceof EngineError) {
-        this.view.engine.alertCodeCheckError(error, code, codePrefix, {
-          message: `Column Delete Check Failure: Can't safely delete column '${columnName}'. Check the query code below for more details.`,
-          text: `Error: ${error.message}`,
-        });
+        this.view.dataCube.alertService.alertCodeCheckError(
+          error,
+          code,
+          codePrefix,
+          {
+            message: `Column Delete Check Failure: Can't safely delete column '${columnName}'. Check the query code below for more details.`,
+            text: `Error: ${error.message}`,
+          },
+        );
       } else {
-        this.view.engine.alertError(error, {
+        this.view.dataCube.alertService.alertError(error, {
           message: `Column Delete Check Failure: Can't safely delete column '${columnName}'.`,
           text: `Error: ${error.message}`,
         });
       }
       return;
     } finally {
-      this.view.endTask(task);
+      this.view.taskService.endTask(task);
     }
 
     this.setLeafExtendedColumns(

package/src/stores/view/filter/DataCubeFilterEditorState.tsx

@@ -34,12 +34,12 @@ import {
   buildFilterEditorTree,
   buildFilterQuerySnapshot,
 } from '../../core/filter/DataCubeQueryFilterEditorState.js';
-import { DataCubeQuerySnapshotController } from '../DataCubeQuerySnapshotManager.js';
+import { DataCubeQuerySnapshotController } from '../../services/DataCubeQuerySnapshotService.js';
 import {
   DataCubeConfiguration,
   type DataCubeColumnConfiguration,
-} from '../../core/models/DataCubeConfiguration.js';
-import type { DisplayState } from '../../core/DataCubeLayoutManagerState.js';
+} from '../../core/model/DataCubeConfiguration.js';
+import type { DisplayState } from '../../services/DataCubeLayoutService.js';
 import { DataCubeFilterEditor } from '../../../components/view/filter/DataCubeFilterEditor.js';
 
 /**
@@ -47,6 +47,8 @@ import { DataCubeFilterEditor } from '../../../components/view/filter/DataCubeFi
  * to the filter in the form editor.
  */
 export class DataCubeFilterEditorState extends DataCubeQuerySnapshotController {
+  private readonly _view: DataCubeViewState;
+
   readonly display: DisplayState;
 
   tree: DataCubeFilterEditorTree;
@@ -54,7 +56,7 @@ export class DataCubeFilterEditorState extends DataCubeQuerySnapshotController {
   columns: DataCubeColumnConfiguration[] = [];
 
   constructor(view: DataCubeViewState) {
-    super(view);
+    super(view.engine, view.settingService, view.snapshotService);
 
     makeObservable(this, {
       tree: observable.ref,
@@ -73,9 +75,10 @@ export class DataCubeFilterEditorState extends DataCubeQuerySnapshotController {
       layerFilterNode: action,
     });
 
-    this.display = this.view.engine.layout.newDisplay(
+    this._view = view;
+    this.display = this._view.dataCube.layoutService.newDisplay(
       'Filter',
-      () => <DataCubeFilterEditor view={this.view} />,
+      () => <DataCubeFilterEditor view={this._view} />,
       {
         x: -50,
         y: 50,
@@ -143,7 +146,7 @@ export class DataCubeFilterEditorState extends DataCubeQuerySnapshotController {
           name: columnConfig.name,
           type: columnConfig.type,
         };
-        const operation = this.view.engine.getFilterOperation(
+        const operation = this._engine.getFilterOperation(
           DataCubeQueryFilterOperator.EQUAL,
         );
         return new DataCubeFilterEditorConditionTreeNode(
@@ -308,7 +311,7 @@ export class DataCubeFilterEditorState extends DataCubeQuerySnapshotController {
           snapshot.data.filter,
           undefined,
           this.tree.nodes,
-          (op) => this.view.engine.getFilterOperation(op),
+          (op) => this._engine.getFilterOperation(op),
         )
       : undefined;
     this.setSelectedNode(undefined);