@finos/legend-query-builder 4.18.32 → 4.19.0

package/src/stores/QueryLoaderState.ts

@@ -24,15 +24,18 @@ import {
   type AbstractPureGraphManager,
   type Query,
   type RawLambda,
+  type V1_Query,
   QuerySearchSpecification,
   GRAPH_MANAGER_EVENT,
   QuerySearchSortBy,
+  V1_PureGraphManager,
 } from '@finos/legend-graph';
 import {
   type GeneratorFn,
   ActionState,
   assertErrorThrown,
   guaranteeNonNullable,
+  guaranteeType,
   LogEvent,
 } from '@finos/legend-shared';
 import { makeObservable, observable, action, flow } from 'mobx';
@@ -54,20 +57,37 @@ export enum SORT_BY_OPTIONS {
 
 export type SortByOption = { label: SORT_BY_OPTIONS; value: SORT_BY_OPTIONS };
 
+/**
+ * One side of a grammar diff between two query revisions in the history view.
+ * `isLatest` refers to the current (latest) version, whose content is not part
+ * of the `/history` payload and is fetched on demand.
+ */
+export interface QueryRevisionDiffInput {
+  label: string;
+  isLatest: boolean;
+  content: string | undefined;
+}
+
 export class QueryLoaderState {
   readonly applicationStore: GenericLegendApplicationStore;
   readonly graphManager: AbstractPureGraphManager;
 
   readonly searchQueriesState = ActionState.create();
   readonly renameQueryState = ActionState.create();
+  readonly revertQueryState = ActionState.create();
   readonly deleteQueryState = ActionState.create();
   readonly previewQueryState = ActionState.create();
+  readonly queryHistoryState = ActionState.create();
+  readonly queryHistoryDiffState = ActionState.create();
 
   readonly decorateSearchSpecification?:
     | ((val: QuerySearchSpecification) => QuerySearchSpecification)
     | undefined;
 
-  readonly loadQuery: (query: LightQuery) => void;
+  readonly loadQuery: (
+    query: LightQuery,
+    revisionId?: string | undefined,
+  ) => void;
   readonly fetchDefaultQueries?: (() => Promise<LightQuery[]>) | undefined;
   readonly generateDefaultQueriesSummaryText?:
     | ((queries: LightQuery[]) => string)
@@ -95,6 +115,21 @@ export class QueryLoaderState {
   queryPreviewContent?: QueryInfo | { name: string; content: string };
   sortBy = SORT_BY_OPTIONS.SORT_BY_VIEW;
 
+  // version history
+  showHistoryViewer = false;
+  // true when the history viewer is opened directly (e.g. from the editor menu)
+  // rather than drilled into from the query list — in this mode there is no
+  // query list to go "back" to, so the back button is hidden
+  isHistoryViewerStandalone = false;
+  historyQuery?: LightQuery | undefined;
+  queryHistoryRevisions: V1_Query[] = [];
+
+  // grammar diff between two revisions in the history view
+  selectedRevisionKeysForDiff: string[] = [];
+  showHistoryDiff = false;
+  historyDiffGrammars?: { from: string; to: string } | undefined;
+  historyDiffLabels?: { from: string; to: string } | undefined;
+
   constructor(
     applicationStore: GenericLegendApplicationStore,
     graphManager: AbstractPureGraphManager,
@@ -103,7 +138,7 @@ export class QueryLoaderState {
         | ((val: QuerySearchSpecification) => QuerySearchSpecification)
         | undefined;
 
-      loadQuery: (query: LightQuery) => void;
+      loadQuery: (query: LightQuery, revisionId?: string | undefined) => void;
       fetchDefaultQueries?: (() => Promise<LightQuery[]>) | undefined;
       generateDefaultQueriesSummaryText?:
         | ((queries: LightQuery[]) => string)
@@ -125,17 +160,33 @@ export class QueryLoaderState {
       isCuratedTemplateToggled: observable,
       curatedTemplateQuerySpecifications: observable,
       sortBy: observable,
+      showHistoryViewer: observable,
+      isHistoryViewerStandalone: observable,
+      historyQuery: observable,
+      queryHistoryRevisions: observable,
+      selectedRevisionKeysForDiff: observable,
+      showHistoryDiff: observable,
+      historyDiffGrammars: observable.ref,
+      historyDiffLabels: observable.ref,
       setSortBy: action,
       setSearchText: action,
       setQueryLoaderDialogOpen: action,
       setQueries: action,
       setShowCurrentUserQueriesOnly: action,
       setShowPreviewViewer: action,
+      setShowHistoryViewer: action,
+      setHistoryViewerStandalone: action,
+      toggleRevisionForDiff: action,
+      clearHistoryDiffSelection: action,
+      setShowHistoryDiff: action,
       setIsCuratedTemplateToggled: action,
       searchQueries: flow,
       getPreviewQueryContent: flow,
+      getQueryHistory: flow,
+      computeHistoryDiff: flow,
       deleteQuery: flow,
       renameQuery: flow,
+      revertToRevision: flow,
       initialize: flow,
     });
 
@@ -200,6 +251,39 @@ export class QueryLoaderState {
     this.showPreviewViewer = val;
   }
 
+  setShowHistoryViewer(val: boolean): void {
+    this.showHistoryViewer = val;
+  }
+
+  setHistoryViewerStandalone(val: boolean): void {
+    this.isHistoryViewerStandalone = val;
+  }
+
+  toggleRevisionForDiff(key: string): void {
+    if (this.selectedRevisionKeysForDiff.includes(key)) {
+      this.selectedRevisionKeysForDiff =
+        this.selectedRevisionKeysForDiff.filter((entry) => entry !== key);
+    } else {
+      // only two revisions can be compared, so keep the two most recently picked
+      this.selectedRevisionKeysForDiff = [
+        ...this.selectedRevisionKeysForDiff,
+        key,
+      ].slice(-2);
+    }
+  }
+
+  clearHistoryDiffSelection(): void {
+    this.selectedRevisionKeysForDiff = [];
+  }
+
+  setShowHistoryDiff(val: boolean): void {
+    this.showHistoryDiff = val;
+    if (!val) {
+      this.historyDiffGrammars = undefined;
+      this.historyDiffLabels = undefined;
+    }
+  }
+
   setShowCurrentUserQueriesOnly(val: boolean): void {
     this.showCurrentUserQueriesOnly = val;
   }
@@ -207,6 +291,10 @@ export class QueryLoaderState {
   reset(): void {
     this.setShowCurrentUserQueriesOnly(false);
     this.setIsCuratedTemplateToggled(false);
+    this.setShowHistoryViewer(false);
+    this.setHistoryViewerStandalone(false);
+    this.setShowHistoryDiff(false);
+    this.clearHistoryDiffSelection();
   }
 
   *initialize(queryBuilderState: QueryBuilderState): GeneratorFn<void> {
@@ -346,6 +434,33 @@ export class QueryLoaderState {
     }
   }
 
+  *revertToRevision(revisionId: string): GeneratorFn<void> {
+    const query = guaranteeNonNullable(
+      this.historyQuery,
+      `Can't revert: no query is being viewed in history`,
+    );
+    this.revertQueryState.inProgress();
+    try {
+      const reverted = (yield this.graphManager.revertQueryToRevision(
+        query.id,
+        revisionId,
+      )) as LightQuery;
+      this.applicationStore.notificationService.notifySuccess(
+        'Reverted query to the selected revision',
+      );
+      this.revertQueryState.pass();
+      // the revert is saved as the new current version, so close the loader and
+      // load it straight away (as the current head, not a historical revision)
+      this.setShowHistoryViewer(false);
+      this.setQueryLoaderDialogOpen(false);
+      this.loadQuery(reverted);
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.notificationService.notifyError(error);
+      this.revertQueryState.fail();
+    }
+  }
+
   *deleteQuery(queryId: string): GeneratorFn<void> {
     this.deleteQueryState.inProgress();
     try {
@@ -399,4 +514,60 @@ export class QueryLoaderState {
       this.previewQueryState.fail();
     }
   }
+
+  *getQueryHistory(query: LightQuery): GeneratorFn<void> {
+    this.queryHistoryState.inProgress();
+    try {
+      const revisions = (yield guaranteeType(
+        this.graphManager,
+        V1_PureGraphManager,
+      ).getQueryHistory(query.id)) as V1_Query[];
+      this.historyQuery = query;
+      this.queryHistoryRevisions = revisions;
+      this.clearHistoryDiffSelection();
+      this.setShowHistoryDiff(false);
+      this.setShowHistoryViewer(true);
+      this.queryHistoryState.pass();
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.notificationService.notifyError(error);
+      this.queryHistoryState.fail();
+    }
+  }
+
+  private async resolveRevisionGrammar(
+    side: QueryRevisionDiffInput,
+  ): Promise<string> {
+    if (side.isLatest) {
+      // the latest/current version is not returned by `/history`, so fetch it
+      const info = await this.graphManager.getQueryInfo(
+        guaranteeNonNullable(this.historyQuery).id,
+      );
+      return this.graphManager.prettyLambdaContent(info.content);
+    }
+    return this.graphManager.prettyLambdaContent(
+      guaranteeNonNullable(side.content),
+    );
+  }
+
+  *computeHistoryDiff(
+    from: QueryRevisionDiffInput,
+    to: QueryRevisionDiffInput,
+  ): GeneratorFn<void> {
+    this.queryHistoryDiffState.inProgress();
+    try {
+      const [fromGrammar, toGrammar] = (yield Promise.all([
+        this.resolveRevisionGrammar(from),
+        this.resolveRevisionGrammar(to),
+      ])) as [string, string];
+      this.historyDiffGrammars = { from: fromGrammar, to: toGrammar };
+      this.historyDiffLabels = { from: from.label, to: to.label };
+      this.setShowHistoryDiff(true);
+      this.queryHistoryDiffState.pass();
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.notificationService.notifyError(error);
+      this.queryHistoryDiffState.fail();
+    }
+  }
 }

package/src/stores/workflows/dataProduct/DataProductQueryBuilderState.ts

@@ -182,6 +182,12 @@ export const buildModelAccessPointGroupOption = (
 export type ExecutionIdOption = {
   label: string;
   tag: string;
+  /**
+   * For Lakehouse access points, this is the enclosing access point group id.
+   * Used in the UI to disambiguate access points that share the same title/id
+   * across different groups.
+   */
+  groupId?: string | undefined;
   value:
     | NativeModelExecutionContext
     | ModelAccessPointGroup
@@ -545,6 +551,7 @@ export class DataProductQueryBuilderState extends QueryBuilderState {
         .map((ap) => ({
           label: ap.title ?? ap.id,
           tag: 'LAKEHOUSE',
+          groupId: ap.__owner.id,
           value: ap,
         }));
     return [...modelOptions, ...lakehouseOptions, ...nativeOptions].sort(
@@ -570,6 +577,7 @@ export class DataProductQueryBuilderState extends QueryBuilderState {
       return {
         label: state.exectionValue.title ?? state.exectionValue.id,
         tag: 'LAKEHOUSE',
+        groupId: state.exectionValue.__owner.id,
         value: state.exectionValue,
       };
     }
@@ -744,17 +752,18 @@ export class DataProductQueryBuilderState extends QueryBuilderState {
         this.changeRuntime(this.executionState.selectedRuntime);
       } else if (
         this.executionState instanceof LakehouseDataProductExecutionState &&
-        accessor &&
-        this.executionState.selectedRuntime instanceof PackageableRuntime
+        accessor
       ) {
         this.setSourceElement(accessor);
-        this.changeRuntime(
-          new RuntimePointer(
-            PackageableElementExplicitReference.create(
-              this.executionState.selectedRuntime,
+        if (this.executionState.selectedRuntime instanceof PackageableRuntime) {
+          this.changeRuntime(
+            new RuntimePointer(
+              PackageableElementExplicitReference.create(
+                this.executionState.selectedRuntime,
+              ),
             ),
-          ),
-        );
+          );
+        }
       }
       if (mapping) {
         const coverageResult = this.mappingToMappingCoverageResult?.get(

package/tsconfig.json

@@ -102,7 +102,6 @@
     "./src/stores/QueryBuilderValueSpecificationBuilderHelper.ts",
     "./src/stores/QueryBuilderValueSpecificationHelper.ts",
     "./src/stores/QueryBuilder_LegendApplicationPlugin_Extension.ts",
-    "./src/stores/QueryChatState.ts",
     "./src/stores/QueryLoaderState.ts",
     "./src/stores/ServiceInfo.ts",
     "./src/stores/__test-utils__/QueryBuilderStateTestUtils.ts",
@@ -240,7 +239,6 @@
     "./src/components/QueryBuilderSideBar.tsx",
     "./src/components/QueryBuilderTextEditor.tsx",
     "./src/components/QueryBuilderUnsupportedQueryEditor.tsx",
-    "./src/components/QueryChat.tsx",
     "./src/components/QueryLoader.tsx",
     "./src/components/QueryUsageViewer.tsx",
     "./src/components/ServiceQuerySetupUtils.tsx",
@@ -279,6 +277,7 @@
     "./src/components/fetch-structure/QueryBuilderTDSPanel.tsx",
     "./src/components/fetch-structure/QueryBuilderTDSWindowPanel.tsx",
     "./src/components/filter/QueryBuilderFilterPanel.tsx",
+    "./src/components/lakehouse/IngestionDefinitionArtifactViewer.tsx",
     "./src/components/lineage/LineageViewer.tsx",
     "./src/components/lineage/PropertyOwnerNode.tsx",
     "./src/components/result/QueryBuilderResultPanel.tsx",

package/lib/components/QueryChat.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryChat.d.ts","sourceRoot":"","sources":["../../src/components/QueryChat.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAExE,eAAO,MAAM,SAAS,WACZ;IAAE,iBAAiB,EAAE,iBAAiB,CAAA;CAAE;;CAejD,CAAC"}

package/lib/components/QueryChat.js

@@ -1,26 +0,0 @@
-/**
- * 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 { observer } from 'mobx-react-lite';
-import { useApplicationStore } from '@finos/legend-application';
-export const QueryChat = observer((props) => {
-    const { queryBuilderState } = props;
-    const applicationStore = useApplicationStore();
-    const extraQueryChatConfigurations = applicationStore.pluginManager
-        .getApplicationPlugins()
-        .flatMap((plugin) => plugin.getExtraQueryChatRenderers?.() ?? []);
-    return extraQueryChatConfigurations[0]?.(queryBuilderState);
-});
-//# sourceMappingURL=QueryChat.js.map

package/lib/components/QueryChat.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryChat.js","sourceRoot":"","sources":["../../src/components/QueryChat.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAIhE,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAC/B,CAAC,KAA+C,EAAE,EAAE;IAClD,MAAM,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAC;IACpC,MAAM,gBAAgB,GAAG,mBAAmB,EAAE,CAAC;IAE/C,MAAM,4BAA4B,GAAG,gBAAgB,CAAC,aAAa;SAChE,qBAAqB,EAAE;SACvB,OAAO,CACN,CAAC,MAAM,EAAE,EAAE,CAEP,MACD,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,CACzC,CAAC;IAEJ,OAAO,4BAA4B,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC;AAC9D,CAAC,CACF,CAAC"}

package/lib/stores/QueryChatState.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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.
- */
-export declare abstract class QueryChatState {
-    abstract abort(): void;
-}
-//# sourceMappingURL=QueryChatState.d.ts.map

package/lib/stores/QueryChatState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryChatState.d.ts","sourceRoot":"","sources":["../../src/stores/QueryChatState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,8BAAsB,cAAc;IAClC,QAAQ,CAAC,KAAK,IAAI,IAAI;CACvB"}

package/lib/stores/QueryChatState.js

@@ -1,18 +0,0 @@
-/**
- * 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.
- */
-export class QueryChatState {
-}
-//# sourceMappingURL=QueryChatState.js.map

package/lib/stores/QueryChatState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"QueryChatState.js","sourceRoot":"","sources":["../../src/stores/QueryChatState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,OAAgB,cAAc;CAEnC"}

package/src/components/QueryChat.tsx

@@ -1,38 +0,0 @@
-/**
- * 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 { observer } from 'mobx-react-lite';
-import { useApplicationStore } from '@finos/legend-application';
-import type { QueryBuilder_LegendApplicationPlugin_Extension } from '../stores/QueryBuilder_LegendApplicationPlugin_Extension.js';
-import type { QueryBuilderState } from '../stores/QueryBuilderState.js';
-
-export const QueryChat = observer(
-  (props: { queryBuilderState: QueryBuilderState }) => {
-    const { queryBuilderState } = props;
-    const applicationStore = useApplicationStore();
-
-    const extraQueryChatConfigurations = applicationStore.pluginManager
-      .getApplicationPlugins()
-      .flatMap(
-        (plugin) =>
-          (
-            plugin as QueryBuilder_LegendApplicationPlugin_Extension
-          ).getExtraQueryChatRenderers?.() ?? [],
-      );
-
-    return extraQueryChatConfigurations[0]?.(queryBuilderState);
-  },
-);

package/src/stores/QueryChatState.ts

@@ -1,19 +0,0 @@
-/**
- * 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.
- */
-
-export abstract class QueryChatState {
-  abstract abort(): void;
-}