@finos/legend-query-builder 4.14.9 → 4.14.10

package/src/stores/QueryBuilderChangeHistoryState.ts

@@ -0,0 +1,129 @@
+/**
+ * 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 RawLambda } from '@finos/legend-graph';
+import {
+  ActionState,
+  LogEvent,
+  assertErrorThrown,
+  guaranteeNonNullable,
+} from '@finos/legend-shared';
+import { makeObservable, observable, computed, action } from 'mobx';
+import type { QueryBuilderState } from './QueryBuilderState.js';
+import { QUERY_BUILDER_EVENT } from '../__lib__/QueryBuilderEvent.js';
+
+export class QueryBuilderChangeHistoryState {
+  readonly queryBuilderState: QueryBuilderState;
+  readonly initState = ActionState.create();
+
+  querySnapshotBuffer: RawLambda[] = [];
+  currentQuery: RawLambda | undefined;
+  pointer = -1;
+  bufferSize = 10;
+
+  constructor(queryBuilderState: QueryBuilderState) {
+    makeObservable(this, {
+      currentQuery: observable,
+      pointer: observable,
+      querySnapshotBuffer: observable,
+      initialize: action,
+      undo: action,
+      redo: action,
+      setCurrentQuery: action,
+      cacheNewQuery: action,
+      canRedo: computed,
+      canUndo: computed,
+    });
+
+    this.queryBuilderState = queryBuilderState;
+  }
+
+  get canRedo(): boolean {
+    return this.pointer < this.querySnapshotBuffer.length - 1;
+  }
+
+  get canUndo(): boolean {
+    return this.pointer > 0;
+  }
+
+  redo(): void {
+    if (this.canRedo) {
+      this.pointer = this.pointer + 1;
+      const query = this.querySnapshotBuffer[this.pointer];
+      this.setCurrentQuery(query);
+      this.queryBuilderState.rebuildWithQuery(guaranteeNonNullable(query), {
+        preserveParameterValues: true,
+        preserveResult: true,
+      });
+    }
+  }
+
+  undo(): void {
+    if (this.canUndo) {
+      this.pointer = this.pointer - 1;
+      const query = this.querySnapshotBuffer[this.pointer];
+      this.setCurrentQuery(query);
+      this.queryBuilderState.rebuildWithQuery(guaranteeNonNullable(query), {
+        preserveParameterValues: true,
+        preserveResult: true,
+      });
+    }
+  }
+
+  setCurrentQuery(query: RawLambda | undefined): void {
+    this.currentQuery = query;
+  }
+
+  initialize(initialQuery: RawLambda): void {
+    if (this.queryBuilderState.isQuerySupported) {
+      this.initState.inProgress();
+      this.currentQuery = initialQuery;
+      this.querySnapshotBuffer.push(initialQuery);
+      this.pointer = this.pointer + 1;
+      this.initState.complete();
+    }
+  }
+
+  cacheNewQuery(query: RawLambda): void {
+    try {
+      if (this.queryBuilderState.isQuerySupported) {
+        if (query.hashCode !== this.currentQuery?.hashCode) {
+          if (
+            this.querySnapshotBuffer.length === this.bufferSize &&
+            this.pointer === this.querySnapshotBuffer.length - 1
+          ) {
+            // only record 10 query snapshots
+            this.querySnapshotBuffer = this.querySnapshotBuffer.slice(1);
+          } else {
+            this.querySnapshotBuffer = this.querySnapshotBuffer.slice(
+              0,
+              this.pointer + 1,
+            );
+          }
+          this.querySnapshotBuffer.push(query);
+          this.pointer = this.querySnapshotBuffer.length - 1;
+          this.setCurrentQuery(query);
+        }
+      }
+    } catch (error) {
+      assertErrorThrown(error);
+      this.queryBuilderState.applicationStore.logService.error(
+        LogEvent.create(QUERY_BUILDER_EVENT.CHANGE_HISTORY_ERROR),
+        `Can't cache query in query builder change history buffer: ${error.message}`,
+      );
+    }
+  }
+}

package/src/stores/QueryBuilderState.ts

@@ -104,6 +104,7 @@ import {
 } from './QueryBuilderExecutionContextState.js';
 import type { QueryBuilderConfig } from '../graph-manager/QueryBuilderConfig.js';
 import { QUERY_BUILDER_EVENT } from '../__lib__/QueryBuilderEvent.js';
+import { QueryBuilderChangeHistoryState } from './QueryBuilderChangeHistoryState.js';
 
 export interface QuerySDLC {}
 
@@ -136,6 +137,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
   resultState: QueryBuilderResultState;
   textEditorState: QueryBuilderTextEditorState;
   unsupportedQueryState: QueryBuilderUnsupportedQueryState;
+  changeHistoryState: QueryBuilderChangeHistoryState;
   showFunctionsExplorerPanel = false;
   showParametersPanel = false;
   isEditingWatermark = false;
@@ -184,6 +186,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       isCheckingEntitlments: observable,
       isCalendarEnabled: observable,
       changeDetectionState: observable,
+      changeHistoryState: observable,
       executionContextState: observable,
       class: observable,
       isQueryChatOpened: observable,
@@ -236,6 +239,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
       this.graphManagerState.pluginManager.getPureGraphManagerPlugins(),
     );
     this.changeDetectionState = new QueryBuilderChangeDetectionState(this);
+    this.changeHistoryState = new QueryBuilderChangeHistoryState(this);
     this.config = config;
     this.sourceInfo = sourceInfo;
   }
@@ -441,6 +445,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     this.explorerState.refreshTreeData();
     this.fetchStructureState.implementation.onClassChange(val);
     this.milestoningState.updateMilestoningConfiguration();
+    this.changeHistoryState.cacheNewQuery(this.buildQuery());
   }
 
   changeMapping(val: Mapping, options?: { keepQueryContent?: boolean }): void {
@@ -553,6 +558,7 @@ export abstract class QueryBuilderState implements CommandRegistrar {
     });
     this.resetQueryResult();
     this.changeDetectionState.initialize(query);
+    this.changeHistoryState.initialize(query);
   }
 
   /**

package/tsconfig.json

@@ -56,6 +56,7 @@
     "./src/graph-manager/protocol/pure/v1/V1_QueryBuilder_PureGraphManagerExtension.ts",
     "./src/graph-manager/protocol/pure/v1/V1_QueryValueSpecificationBuilderHelper.ts",
     "./src/stores/QueryBuilderChangeDetectionState.ts",
+    "./src/stores/QueryBuilderChangeHistoryState.ts",
     "./src/stores/QueryBuilderCommand.ts",
     "./src/stores/QueryBuilderConfig.ts",
     "./src/stores/QueryBuilderConstantsState.ts",