@finos/legend-data-cube 0.1.4 → 0.1.6

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotEqualColumn.tsx

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
-import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
+import type { DataCubeSnapshotFilterCondition } from '../DataCubeSnapshot.js';
 import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
@@ -36,7 +36,7 @@ import { type V1_AppliedFunction } from '@finos/legend-graph';
 import {
   _filterCondition_base,
   _unwrapNotFilterCondition,
-} from '../DataCubeQuerySnapshotBuilderUtils.js';
+} from '../DataCubeSnapshotBuilderUtils.js';
 
 export class DataCubeQueryFilterOperation__NotEqualColumn extends DataCubeQueryFilterOperation {
   override get label() {
@@ -92,7 +92,7 @@ export class DataCubeQueryFilterOperation__NotEqualColumn extends DataCubeQueryF
     );
   }
 
-  buildConditionExpression(condition: DataCubeQuerySnapshotFilterCondition) {
+  buildConditionExpression(condition: DataCubeSnapshotFilterCondition) {
     return _not(
       _function(_functionName(DataCubeFunction.EQUAL), [
         _property(condition.name),

package/src/stores/core/filter/DataCubeQueryFilterOperation__NotStartWith.tsx

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
-import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
+import type { DataCubeSnapshotFilterCondition } from '../DataCubeSnapshot.js';
 import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
@@ -37,7 +37,7 @@ import { type V1_AppliedFunction } from '@finos/legend-graph';
 import {
   _unwrapNotFilterCondition,
   _filterCondition_base,
-} from '../DataCubeQuerySnapshotBuilderUtils.js';
+} from '../DataCubeSnapshotBuilderUtils.js';
 
 export class DataCubeQueryFilterOperation__NotStartWith extends DataCubeQueryFilterOperation {
   override get label() {
@@ -90,7 +90,7 @@ export class DataCubeQueryFilterOperation__NotStartWith extends DataCubeQueryFil
     );
   }
 
-  buildConditionExpression(condition: DataCubeQuerySnapshotFilterCondition) {
+  buildConditionExpression(condition: DataCubeSnapshotFilterCondition) {
     return _not(
       _function(_functionName(DataCubeFunction.STARTS_WITH), [
         _property(condition.name),

package/src/stores/core/filter/DataCubeQueryFilterOperation__StartWith.tsx

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
-import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
+import type { DataCubeSnapshotFilterCondition } from '../DataCubeSnapshot.js';
 import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
@@ -32,7 +32,7 @@ import {
   _value,
 } from '../DataCubeQueryBuilderUtils.js';
 import { type V1_AppliedFunction } from '@finos/legend-graph';
-import { _filterCondition_base } from '../DataCubeQuerySnapshotBuilderUtils.js';
+import { _filterCondition_base } from '../DataCubeSnapshotBuilderUtils.js';
 import { isString } from '@finos/legend-shared';
 
 export class DataCubeQueryFilterOperation__StartWith extends DataCubeQueryFilterOperation {
@@ -86,7 +86,7 @@ export class DataCubeQueryFilterOperation__StartWith extends DataCubeQueryFilter
     );
   }
 
-  buildConditionExpression(condition: DataCubeQuerySnapshotFilterCondition) {
+  buildConditionExpression(condition: DataCubeSnapshotFilterCondition) {
     return _function(_functionName(DataCubeFunction.STARTS_WITH), [
       _property(condition.name),
       _value(condition.value),

package/src/stores/core/filter/DataCubeQueryFilterOperation__StartWithCaseInsensitive.tsx

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { DataCubeQueryFilterOperation } from './DataCubeQueryFilterOperation.js';
-import type { DataCubeQuerySnapshotFilterCondition } from '../DataCubeQuerySnapshot.js';
+import type { DataCubeSnapshotFilterCondition } from '../DataCubeSnapshot.js';
 import type { DataCubeColumn } from '../model/DataCubeColumn.js';
 import {
   DataCubeColumnDataType,
@@ -32,7 +32,7 @@ import {
   _value,
 } from '../DataCubeQueryBuilderUtils.js';
 import { type V1_AppliedFunction } from '@finos/legend-graph';
-import { _filterCondition_caseSensitive } from '../DataCubeQuerySnapshotBuilderUtils.js';
+import { _filterCondition_caseSensitive } from '../DataCubeSnapshotBuilderUtils.js';
 import { isString } from '@finos/legend-shared';
 
 export class DataCubeQueryFilterOperation__StartWithCaseInsensitive extends DataCubeQueryFilterOperation {
@@ -86,7 +86,7 @@ export class DataCubeQueryFilterOperation__StartWithCaseInsensitive extends Data
     );
   }
 
-  buildConditionExpression(condition: DataCubeQuerySnapshotFilterCondition) {
+  buildConditionExpression(condition: DataCubeSnapshotFilterCondition) {
     return _function(_functionName(DataCubeFunction.STARTS_WITH), [
       _function(_functionName(DataCubeFunction.TO_LOWERCASE), [
         _property(condition.name),

package/src/stores/core/model/DataCubeConfiguration.ts

@@ -98,7 +98,7 @@ export class DataCubeColumnConfiguration {
   /**
    * Unlike `isSelected`, this is used to indicate if the column is to be displayed
    * in the grid or not, this would not influence data-fetching, i.e. the column
-   * is still fetched and used in various part of the queries, but the column associated
+   * is still fetched and used in various part of the query, but the column associated
    * will not be displayed in the result grid.
    */
   hideFromView = false;

package/src/stores/core/model/{DataCubeQuery.ts → DataCubeSpecification.ts}

@@ -19,19 +19,33 @@ import {
   usingModelSchema,
   type PlainObject,
 } from '@finos/legend-shared';
-import { createModelSchema, primitive, raw } from 'serializr';
+import { createModelSchema, optional, primitive, raw } from 'serializr';
 import { DataCubeConfiguration } from './DataCubeConfiguration.js';
 
-export class DataCubeQuery {
+export class DataCubeSpecificationOptions {
+  autoEnableCache?: boolean | undefined;
+
+  static readonly serialization = new SerializationFactory(
+    createModelSchema(DataCubeSpecificationOptions, {
+      autoEnableCache: optional(primitive()),
+    }),
+  );
+}
+
+export class DataCubeSpecification {
   query!: string;
   configuration?: DataCubeConfiguration | undefined;
   source!: PlainObject;
+  options?: DataCubeSpecificationOptions | undefined;
 
   static readonly serialization = new SerializationFactory(
-    createModelSchema(DataCubeQuery, {
+    createModelSchema(DataCubeSpecification, {
       configuration: usingModelSchema(
         DataCubeConfiguration.serialization.schema,
       ),
+      options: optional(
+        usingModelSchema(DataCubeSpecificationOptions.serialization.schema),
+      ),
       query: primitive(),
       source: raw(),
     }),

package/src/stores/services/DataCubeSettingService.tsx

@@ -55,6 +55,7 @@ export type DataCubeSettingValues = {
 
 export enum DataCubeSettingGroup {
   DEBUG = 'Debug',
+  EDITOR = 'Editor',
   GRID = 'Grid',
 }
 
@@ -169,6 +170,28 @@ export class DataCubeSettingService {
         type: DataCubeSettingType.BOOLEAN,
         defaultValue: true,
       } satisfies DataCubeSetting<boolean>,
+      {
+        key: DataCubeSettingKey.GRID_CLIENT__SHOW_AUTO_ENABLE_CACHE_PERFORMANCE_WARNING,
+        title: `Caching (Auto-Enabled) Performance Warning: Enabled`,
+        description: `Alerts user that caching is auto-enabled for the DataCube and of potential performance and resource-related issues that caching can cause when enabled.`,
+        group: DataCubeSettingGroup.GRID,
+        type: DataCubeSettingType.BOOLEAN,
+        defaultValue: true,
+      } satisfies DataCubeSetting<boolean>,
+      {
+        key: DataCubeSettingKey.EDITOR__MAX_HISTORY_STACK_SIZE,
+        title: `Max History Stack Size`,
+        description: `Sets the number of maximum snapshots to store in edit history.`,
+        group: DataCubeSettingGroup.EDITOR,
+        type: DataCubeSettingType.NUMERIC,
+        defaultValue: 100,
+        numericValueMin: 10,
+        numericValueStep: 10,
+        action: (api, newValue) =>
+          (api as INTERNAL__DataCubeAPI)._runTaskForEachView((view) => {
+            view.snapshotService.adjustHistorySize(newValue);
+          }),
+      } satisfies DataCubeSetting<number>,
       {
         key: DataCubeSettingKey.GRID_CLIENT__SUPPRESS_LARGE_DATASET_WARNING,
         title: `Large Dataset Warning: Disabled`,

package/src/stores/services/{DataCubeQuerySnapshotService.ts → DataCubeSnapshotService.ts}

@@ -14,42 +14,38 @@
  * limitations under the License.
  */
 
-import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
+import type { DataCubeSnapshot } from '../core/DataCubeSnapshot.js';
 import {
   IllegalStateError,
   assertErrorThrown,
   at,
   deepDiff,
-  guaranteeNonNullable,
 } from '@finos/legend-shared';
-import type { DataCubeQuery } from '../core/model/DataCubeQuery.js';
 import { DataCubeSettingKey } from '../../__lib__/DataCubeSetting.js';
 import type { DataCubeEngine } from '../core/DataCubeEngine.js';
 import type { DataCubeSettingService } from './DataCubeSettingService.js';
 import type { DataCubeLogService } from './DataCubeLogService.js';
+import { action, computed, makeObservable, observable } from 'mobx';
 
-// TODO: set a stack depth when we implement undo/redo
-// const DATA_CUBE_MAX_SNAPSHOT_COUNT = 100;
-
-interface DataCubeQuerySnapshotSubscriber {
+interface DataCubeSnapshotSubscriber {
   getSnapshotSubscriberName(): string;
-  getLatestSnapshot(): DataCubeQuerySnapshot | undefined;
-  receiveSnapshot(snapshot: DataCubeQuerySnapshot): Promise<void>;
+  getLatestSnapshot(): DataCubeSnapshot | undefined;
+  receiveSnapshot(snapshot: DataCubeSnapshot): Promise<void>;
 }
 
-export abstract class DataCubeQuerySnapshotController
-  implements DataCubeQuerySnapshotSubscriber
+export abstract class DataCubeSnapshotController
+  implements DataCubeSnapshotSubscriber
 {
   protected readonly _engine: DataCubeEngine;
   protected readonly _settingService: DataCubeSettingService;
-  protected readonly _snapshotService: DataCubeQuerySnapshotService;
+  protected readonly _snapshotService: DataCubeSnapshotService;
 
-  private _latestSnapshot: DataCubeQuerySnapshot | undefined;
+  private _latestSnapshot: DataCubeSnapshot | undefined;
 
   constructor(
     engine: DataCubeEngine,
     settingService: DataCubeSettingService,
-    snapshotService: DataCubeQuerySnapshotService,
+    snapshotService: DataCubeSnapshotService,
   ) {
     this._engine = engine;
     this._settingService = settingService;
@@ -62,7 +58,7 @@ export abstract class DataCubeQuerySnapshotController
     return this._latestSnapshot;
   }
 
-  async receiveSnapshot(snapshot: DataCubeQuerySnapshot) {
+  async receiveSnapshot(snapshot: DataCubeSnapshot) {
     const previousSnapshot = this._latestSnapshot;
     this._latestSnapshot = snapshot;
 
@@ -72,11 +68,11 @@ export abstract class DataCubeQuerySnapshotController
   }
 
   abstract applySnapshot(
-    snapshot: DataCubeQuerySnapshot,
-    previousSnapshot: DataCubeQuerySnapshot | undefined,
+    snapshot: DataCubeSnapshot,
+    previousSnapshot: DataCubeSnapshot | undefined,
   ): Promise<void>;
 
-  publishSnapshot(snapshot: DataCubeQuerySnapshot) {
+  publishSnapshot(snapshot: DataCubeSnapshot) {
     const previousSnapshot = this._latestSnapshot;
     this._latestSnapshot = snapshot;
 
@@ -98,25 +94,44 @@ export abstract class DataCubeQuerySnapshotController
   }
 }
 
-export class DataCubeQuerySnapshotService {
-  private readonly _engine: DataCubeEngine;
+const MINIMUM_HISTORY_SIZE = 10;
+
+export class DataCubeSnapshotService {
   private readonly _logService: DataCubeLogService;
+  private readonly _settingService: DataCubeSettingService;
 
-  private readonly _subscribers: DataCubeQuerySnapshotSubscriber[] = [];
-  private readonly _snapshots: DataCubeQuerySnapshot[] = []; // stack
-  private _initialSnapshot: DataCubeQuerySnapshot | undefined;
-  private _initialQuery: DataCubeQuery | undefined;
+  private readonly _subscribers: DataCubeSnapshotSubscriber[] = [];
 
-  constructor(engine: DataCubeEngine, logService: DataCubeLogService) {
-    this._engine = engine;
+  private _snapshots: DataCubeSnapshot[] = []; // stack
+  private _pointer = -1;
+  private _historySize;
+
+  constructor(
+    logService: DataCubeLogService,
+    settingService: DataCubeSettingService,
+  ) {
+    makeObservable<DataCubeSnapshotService, '_snapshots' | '_pointer'>(this, {
+      _snapshots: observable.struct,
+      _pointer: observable,
+      canUndo: computed,
+      canRedo: computed,
+      undo: action,
+      redo: action,
+      adjustHistorySize: action,
+      broadcastSnapshot: action,
+    });
     this._logService = logService;
-  }
+    this._settingService = settingService;
 
-  get currentSnapshot() {
-    return at(this._snapshots, this._snapshots.length - 1);
+    this._historySize = Math.max(
+      this._settingService.getNumericValue(
+        DataCubeSettingKey.EDITOR__MAX_HISTORY_STACK_SIZE,
+      ),
+      MINIMUM_HISTORY_SIZE,
+    );
   }
 
-  registerSubscriber(subscriber: DataCubeQuerySnapshotSubscriber) {
+  registerSubscriber(subscriber: DataCubeSnapshotSubscriber) {
     const existingSubscriber = this._subscribers.find(
       (sub) =>
         sub.getSnapshotSubscriberName() ===
@@ -137,41 +152,7 @@ export class DataCubeQuerySnapshotService {
     this._subscribers.push(subscriber);
   }
 
-  initialize(
-    initialSnapshot: DataCubeQuerySnapshot,
-    initialQuery: DataCubeQuery,
-  ) {
-    if (this._initialSnapshot || this._initialQuery) {
-      throw new IllegalStateError(
-        `Snapshot manager has already been initialized`,
-      );
-    }
-    this._initialSnapshot = initialSnapshot;
-    this._initialQuery = initialQuery;
-  }
-
-  get initialSnapshot() {
-    return guaranteeNonNullable(
-      this._initialSnapshot,
-      `Snapshot manager has not been initialized`,
-    );
-  }
-
-  get initialQuery() {
-    return guaranteeNonNullable(
-      this._initialQuery,
-      `Snapshot manager has not been initialized`,
-    );
-  }
-
-  broadcastSnapshot(snapshot: DataCubeQuerySnapshot) {
-    if (!snapshot.isFinalized()) {
-      this._logService.logIllegalStateError(
-        `Snapshot must be finalized before broadcasting`,
-      );
-      return;
-    }
-    this._snapshots.push(snapshot);
+  private propagateSnapshot(snapshot: DataCubeSnapshot): void {
     this._subscribers.forEach((subscriber) => {
       const currentSnapshot = subscriber.getLatestSnapshot();
       if (currentSnapshot?.uuid !== snapshot.uuid) {
@@ -185,4 +166,74 @@ export class DataCubeQuerySnapshotService {
       }
     });
   }
+
+  getCurrentSnapshot() {
+    return at(this._snapshots, this._pointer);
+  }
+
+  getHistory(options?: { full?: boolean }) {
+    return options?.full
+      ? [...this._snapshots]
+      : this._snapshots.slice(0, this._pointer + 1);
+  }
+
+  get canUndo() {
+    return this._pointer > 0;
+  }
+
+  get canRedo() {
+    return this._pointer < this._snapshots.length - 1;
+  }
+
+  undo() {
+    // Always leave one snapshot in the stack
+    this._pointer = Math.max(this._pointer - 1, 0);
+    this.propagateSnapshot(this.getCurrentSnapshot());
+  }
+
+  redo() {
+    this._pointer = Math.min(this._pointer + 1, this._snapshots.length - 1);
+    this.propagateSnapshot(this.getCurrentSnapshot());
+  }
+
+  adjustHistorySize(size: number): void {
+    let newSize = size;
+    if (size <= MINIMUM_HISTORY_SIZE) {
+      this._logService.logIllegalStateError(
+        `Can't adjust history size to ${size}: value must be greator than ${MINIMUM_HISTORY_SIZE}`,
+      );
+      newSize = Math.max(size, MINIMUM_HISTORY_SIZE);
+    }
+    const snapshots = this.getHistory();
+    if (snapshots.length > newSize) {
+      this._snapshots = snapshots.slice(-newSize);
+      this._pointer = Math.min(
+        Math.max(this._pointer - (snapshots.length - newSize), 0),
+        snapshots.length - 1,
+      );
+    } else {
+      this._snapshots = snapshots;
+      this._pointer = snapshots.length - 1;
+    }
+    this._historySize = newSize;
+  }
+
+  broadcastSnapshot(snapshot: DataCubeSnapshot) {
+    if (!snapshot.isFinalized()) {
+      this._logService.logIllegalStateError(
+        `Snapshot must be finalized before broadcasting`,
+      );
+      return;
+    }
+
+    this._snapshots = [
+      ...this._snapshots.slice(0, this._pointer + 1),
+      snapshot,
+    ];
+    this._pointer += 1;
+    // always adjust to history size after adding a new snapshot
+    this.adjustHistorySize(this._historySize);
+
+    this.propagateSnapshot(snapshot);
+  }
 }

package/src/stores/view/DataCubeInfoState.ts

@@ -16,8 +16,8 @@
 
 import { action, makeObservable, observable } from 'mobx';
 import type { DataCubeViewState } from './DataCubeViewState.js';
-import { DataCubeQuerySnapshotController } from '../services/DataCubeQuerySnapshotService.js';
-import type { DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
+import { DataCubeSnapshotController } from '../services/DataCubeSnapshotService.js';
+import type { DataCubeSnapshot } from '../core/DataCubeSnapshot.js';
 import { DataCubeConfiguration } from '../core/model/DataCubeConfiguration.js';
 
 /**
@@ -25,7 +25,7 @@ import { DataCubeConfiguration } from '../core/model/DataCubeConfiguration.js';
  * modification to the query, it simplies subscribe to extract information
  * from the latest snapshot to help display latest static info about the query.
  */
-export class DataCubeInfoState extends DataCubeQuerySnapshotController {
+export class DataCubeInfoState extends DataCubeSnapshotController {
   private readonly _view: DataCubeViewState;
 
   name = '';
@@ -48,8 +48,8 @@ export class DataCubeInfoState extends DataCubeQuerySnapshotController {
   }
 
   override async applySnapshot(
-    snapshot: DataCubeQuerySnapshot,
-    previousSnapshot: DataCubeQuerySnapshot | undefined,
+    snapshot: DataCubeSnapshot,
+    previousSnapshot: DataCubeSnapshot | undefined,
   ) {
     const data = snapshot.data;
     const configuration = DataCubeConfiguration.serialization.fromJson(