@finos/legend-application-query 13.5.2 → 13.5.4

package/src/components/QueryEditor.tsx

@@ -89,6 +89,8 @@ import { buildVersionOption, type VersionOption } from './QuerySetup.js';
 import { QueryEditorExistingQueryVersionRevertModal } from './QueryEdtiorExistingQueryVersionRevertModal.js';
 import { debounce, compareSemVerVersions } from '@finos/legend-shared';
 import { LegendQueryInfo } from './LegendQueryAppInfo.js';
+import { QueryEditorDataspaceInfoModal } from './data-space/DataSpaceInfo.js';
+import { DataSpaceQueryBuilderState } from '@finos/legend-extension-dsl-data-space/application';
 
 const CreateQueryDialog = observer(() => {
   const editorStore = useQueryEditorStore();
@@ -729,6 +731,16 @@ export const QueryEditor = observer(() => {
           closeModal={() => editorStore.setShowAppInfo(false)}
         />
       )}
+      {editorStore.showDataspaceInfo &&
+        editorStore.queryBuilderState instanceof DataSpaceQueryBuilderState && (
+          <QueryEditorDataspaceInfoModal
+            editorStore={editorStore}
+            dataspace={editorStore.queryBuilderState.dataSpace}
+            executionContext={editorStore.queryBuilderState.executionContext}
+            open={editorStore.showDataspaceInfo}
+            closeModal={() => editorStore.setShowDataspaceInfo(false)}
+          />
+        )}
       {isExistingQuery &&
         editorStore.updateState.showQueryInfo &&
         editorStore.query && (

package/src/components/data-space/DataSpaceInfo.tsx

@@ -0,0 +1,174 @@
+/**
+ * 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 {
+  Dialog,
+  Modal,
+  ModalTitle,
+  Panel,
+  PanelFullContent,
+} from '@finos/legend-art';
+import { StoreProjectData } from '@finos/legend-server-depot';
+import { observer } from 'mobx-react-lite';
+import { type QueryEditorStore } from '../../stores/QueryEditorStore.js';
+import type {
+  DataSpace,
+  DataSpaceExecutionContext,
+} from '@finos/legend-extension-dsl-data-space/graph';
+import { EXTERNAL_APPLICATION_NAVIGATION__generateStudioSDLCProjectViewUrl } from '../../__lib__/LegendQueryNavigation.js';
+import { flowResult } from 'mobx';
+import { assertErrorThrown } from '@finos/legend-shared';
+
+export const QueryEditorDataspaceInfoModal = observer(
+  (props: {
+    editorStore: QueryEditorStore;
+    dataspace: DataSpace;
+    executionContext: DataSpaceExecutionContext;
+    open: boolean;
+    closeModal: () => void;
+  }) => {
+    const { editorStore, dataspace, executionContext, open, closeModal } =
+      props;
+    const projectInfo = editorStore.getProjectInfo();
+    const visitElement = async (path: string): Promise<void> => {
+      try {
+        if (projectInfo) {
+          const project = StoreProjectData.serialization.fromJson(
+            await editorStore.depotServerClient.getProject(
+              projectInfo.groupId,
+              projectInfo.artifactId,
+            ),
+          );
+          editorStore.applicationStore.navigationService.navigator.visitAddress(
+            EXTERNAL_APPLICATION_NAVIGATION__generateStudioSDLCProjectViewUrl(
+              editorStore.applicationStore.config.studioApplicationUrl,
+              project.projectId,
+              path,
+            ),
+          );
+        }
+      } catch (error) {
+        assertErrorThrown(error);
+        editorStore.applicationStore.notificationService.notifyError(
+          `Can't visit element of path: '${path}'`,
+        );
+      }
+    };
+
+    return (
+      <Dialog
+        open={open}
+        onClose={closeModal}
+        classes={{ container: 'dataspace-info-modal__container' }}
+        PaperProps={{
+          classes: { root: 'dataspace-info-modal__inner-container' },
+        }}
+      >
+        <Modal
+          darkMode={
+            !editorStore.applicationStore.layoutService
+              .TEMPORARY__isLightColorThemeEnabled
+          }
+          className="dataspace-info-modal"
+        >
+          <ModalTitle title="About Dataspace" />
+          <Panel>
+            <PanelFullContent>
+              {projectInfo && (
+                <div className="dataspace-info-modal__field">
+                  <div className="dataspace-info-modal__field__label">
+                    Project
+                  </div>
+                  <div className="dataspace-info-modal__field__value">
+                    {`${projectInfo.groupId}:${projectInfo.artifactId}:${projectInfo.versionId}`}
+                  </div>
+                </div>
+              )}
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">Name</div>
+                <div className="dataspace-info-modal__field__value">
+                  {dataspace.title}
+                </div>
+              </div>
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">
+                  Execution Context
+                </div>
+                <div className="dataspace-info-modal__field__value">
+                  {executionContext.name}
+                </div>
+              </div>
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">
+                  Mapping
+                </div>
+                <div
+                  className="dataspace-info-modal__field__value dataspace-info-modal__field__value--linkable"
+                  onClick={() =>
+                    flowResult(
+                      visitElement(executionContext.mapping.value.path),
+                    )
+                  }
+                >
+                  {executionContext.mapping.value.name}
+                </div>
+              </div>
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">
+                  Runtime
+                </div>
+                <div
+                  className="dataspace-info-modal__field__value  dataspace-info-modal__field__value--linkable"
+                  onClick={() =>
+                    flowResult(
+                      visitElement(executionContext.defaultRuntime.value.path),
+                    )
+                  }
+                >
+                  {executionContext.defaultRuntime.value.name}
+                </div>
+              </div>
+              <div className="dataspace-info-modal__field">
+                <div className="dataspace-info-modal__field__label">
+                  Configuration
+                </div>
+                <div
+                  className="dataspace-info-modal__field__value dataspace-info-modal__field__value--linkable"
+                  onClick={() => flowResult(visitElement(dataspace.path))}
+                >
+                  Show Dataspace Configuration
+                </div>
+              </div>
+              {dataspace.supportInfo?.documentationUrl && (
+                <div className="dataspace-info-modal__field">
+                  <div className="dataspace-info-modal__field__label">
+                    Support Email
+                  </div>
+                  <a
+                    className="dataspace-info-modal__field__value dataspace-info-modal__field__value--linkable"
+                    href={`mailto:${dataspace.supportInfo.documentationUrl}`}
+                  >
+                    {dataspace.supportInfo.documentationUrl}
+                  </a>
+                </div>
+              )}
+            </PanelFullContent>
+          </Panel>
+        </Modal>
+      </Dialog>
+    );
+  },
+);

package/src/stores/EditExistingQuerySetupStore.ts

@@ -14,13 +14,16 @@
  * limitations under the License.
  */
 
-import { QueryLoaderState } from '@finos/legend-query-builder';
+import {
+  QUERY_LOADER_DEFAULT_QUERY_SEARCH_LIMIT,
+  QueryLoaderState,
+} from '@finos/legend-query-builder';
 import { BaseQuerySetupStore } from './QuerySetupStore.js';
 import type { DepotServerClient } from '@finos/legend-server-depot';
 import { quantifyList } from '@finos/legend-shared';
 import { LegendQueryUserDataHelper } from '../__lib__/LegendQueryUserDataHelper.js';
 import type { LegendQueryApplicationStore } from './LegendQueryBaseStore.js';
-import type { LightQuery } from '@finos/legend-graph';
+import { QuerySearchSpecification, type LightQuery } from '@finos/legend-graph';
 import { generateExistingQueryEditorRoute } from '../__lib__/LegendQueryNavigation.js';
 import { LegendQueryTelemetryHelper } from '../__lib__/LegendQueryTelemetryHelper.js';
 
@@ -44,12 +47,22 @@ export class EditExistingQuerySetupStore extends BaseQuerySetupStore {
             { ignoreBlocking: true },
           );
         },
-        fetchDefaultQueries: () =>
-          this.graphManagerState.graphManager.getQueries(
-            LegendQueryUserDataHelper.getRecentlyViewedQueries(
-              this.applicationStore.userDataService,
-            ),
-          ),
+        fetchDefaultQueries: async (): Promise<LightQuery[]> => {
+          const recentReviewedQueries =
+            await this.graphManagerState.graphManager.getQueries(
+              LegendQueryUserDataHelper.getRecentlyViewedQueries(
+                this.applicationStore.userDataService,
+              ),
+            );
+          if (recentReviewedQueries.length <= 0) {
+            const searchSpecification = new QuerySearchSpecification();
+            searchSpecification.limit = QUERY_LOADER_DEFAULT_QUERY_SEARCH_LIMIT;
+            return this.graphManagerState.graphManager.searchQueries(
+              searchSpecification,
+            );
+          }
+          return recentReviewedQueries;
+        },
         generateDefaultQueriesSummaryText: (queries) =>
           queries.length
             ? `Showing ${quantifyList(

package/src/stores/QueryEditorStore.ts

@@ -66,6 +66,7 @@ import {
   cloneQueryTaggedValue,
   QueryDataSpaceExecutionContext,
   QueryExplicitExecutionContext,
+  QueryProjectCoordinates,
 } from '@finos/legend-graph';
 import {
   generateExistingQueryEditorRoute,
@@ -77,6 +78,7 @@ import {
   type Entity,
   type ProjectGAVCoordinates,
   type EntitiesWithOrigin,
+  parseGACoordinates,
 } from '@finos/legend-storage';
 import {
   type DepotServerClient,
@@ -104,6 +106,7 @@ import {
   QueryLoaderState,
   QueryBuilderDataBrowserWorkflow,
   QueryBuilderActionConfig,
+  QUERY_LOADER_DEFAULT_QUERY_SEARCH_LIMIT,
 } from '@finos/legend-query-builder';
 import { LegendQueryUserDataHelper } from '../__lib__/LegendQueryUserDataHelper.js';
 import { LegendQueryTelemetryHelper } from '../__lib__/LegendQueryTelemetryHelper.js';
@@ -261,6 +264,7 @@ export abstract class QueryEditorStore {
   existingQueryName: string | undefined;
   showRegisterServiceModal = false;
   showAppInfo = false;
+  showDataspaceInfo = false;
 
   constructor(
     applicationStore: LegendQueryApplicationStore,
@@ -272,11 +276,13 @@ export abstract class QueryEditorStore {
       existingQueryName: observable,
       showRegisterServiceModal: observable,
       showAppInfo: observable,
+      showDataspaceInfo: observable,
       queryBuilderState: observable,
       isPerformingBlockingAction: computed,
       setExistingQueryName: action,
       setShowRegisterServiceModal: action,
       setShowAppInfo: action,
+      setShowDataspaceInfo: action,
       initialize: flow,
       buildGraph: flow,
       searchExistingQueryName: flow,
@@ -304,12 +310,22 @@ export abstract class QueryEditorStore {
             },
           );
         },
-        fetchDefaultQueries: () =>
-          this.graphManagerState.graphManager.getQueries(
-            LegendQueryUserDataHelper.getRecentlyViewedQueries(
-              this.applicationStore.userDataService,
-            ),
-          ),
+        fetchDefaultQueries: async (): Promise<LightQuery[]> => {
+          const recentReviewedQueries =
+            await this.graphManagerState.graphManager.getQueries(
+              LegendQueryUserDataHelper.getRecentlyViewedQueries(
+                this.applicationStore.userDataService,
+              ),
+            );
+          if (recentReviewedQueries.length <= 0) {
+            const searchSpecification = new QuerySearchSpecification();
+            searchSpecification.limit = QUERY_LOADER_DEFAULT_QUERY_SEARCH_LIMIT;
+            return this.graphManagerState.graphManager.searchQueries(
+              this.decorateSearchSpecification(searchSpecification),
+            );
+          }
+          return recentReviewedQueries;
+        },
         generateDefaultQueriesSummaryText: (queries) =>
           queries.length
             ? `Showing ${quantifyList(
@@ -362,6 +378,10 @@ export abstract class QueryEditorStore {
     this.showAppInfo = val;
   }
 
+  setShowDataspaceInfo(val: boolean): void {
+    this.showDataspaceInfo = val;
+  }
+
   setShowRegisterServiceModal(val: boolean): void {
     this.showRegisterServiceModal = val;
   }
@@ -370,6 +390,12 @@ export abstract class QueryEditorStore {
     return this.queryCreatorState.createQueryState.isInProgress;
   }
 
+  decorateSearchSpecification(
+    val: QuerySearchSpecification,
+  ): QuerySearchSpecification {
+    return val;
+  }
+
   abstract getProjectInfo(): ProjectGAVCoordinates | undefined;
   /**
    * Set up the editor state before building the graph
@@ -743,6 +769,29 @@ export class MappingQueryCreatorStore extends QueryEditorStore {
       },
     };
   }
+
+  override decorateSearchSpecification(
+    val: QuerySearchSpecification,
+  ): QuerySearchSpecification {
+    const currentProjectCoordinates = new QueryProjectCoordinates();
+    currentProjectCoordinates.groupId = this.groupId;
+    currentProjectCoordinates.artifactId = this.artifactId;
+    val.projectCoordinates = [
+      // either get queries for the current project
+      currentProjectCoordinates,
+      // or any of its dependencies
+      ...Array.from(
+        this.graphManagerState.graph.dependencyManager.projectDependencyModelsIndex.keys(),
+      ).map((dependencyKey) => {
+        const { groupId, artifactId } = parseGACoordinates(dependencyKey);
+        const coordinates = new QueryProjectCoordinates();
+        coordinates.groupId = groupId;
+        coordinates.artifactId = artifactId;
+        return coordinates;
+      }),
+    ];
+    return val;
+  }
 }
 
 export class ServiceQueryCreatorStore extends QueryEditorStore {
@@ -850,6 +899,29 @@ export class ServiceQueryCreatorStore extends QueryEditorStore {
       },
     };
   }
+
+  override decorateSearchSpecification(
+    val: QuerySearchSpecification,
+  ): QuerySearchSpecification {
+    const currentProjectCoordinates = new QueryProjectCoordinates();
+    currentProjectCoordinates.groupId = this.groupId;
+    currentProjectCoordinates.artifactId = this.artifactId;
+    val.projectCoordinates = [
+      // either get queries for the current project
+      currentProjectCoordinates,
+      // or any of its dependencies
+      ...Array.from(
+        this.graphManagerState.graph.dependencyManager.projectDependencyModelsIndex.keys(),
+      ).map((dependencyKey) => {
+        const { groupId, artifactId } = parseGACoordinates(dependencyKey);
+        const coordinates = new QueryProjectCoordinates();
+        coordinates.groupId = groupId;
+        coordinates.artifactId = artifactId;
+        return coordinates;
+      }),
+    ];
+    return val;
+  }
 }
 
 export class ExistingQueryUpdateState {
@@ -1441,4 +1513,29 @@ export class ExistingQueryEditorStore extends QueryEditorStore {
       },
     };
   }
+
+  override decorateSearchSpecification(
+    val: QuerySearchSpecification,
+  ): QuerySearchSpecification {
+    const currentProjectCoordinates = new QueryProjectCoordinates();
+    if (this.query) {
+      currentProjectCoordinates.groupId = this.query.groupId;
+      currentProjectCoordinates.artifactId = this.query.artifactId;
+    }
+    val.projectCoordinates = [
+      // either get queries for the current project
+      currentProjectCoordinates,
+      // or any of its dependencies
+      ...Array.from(
+        this.graphManagerState.graph.dependencyManager.projectDependencyModelsIndex.keys(),
+      ).map((dependencyKey) => {
+        const { groupId, artifactId } = parseGACoordinates(dependencyKey);
+        const coordinates = new QueryProjectCoordinates();
+        coordinates.groupId = groupId;
+        coordinates.artifactId = artifactId;
+        return coordinates;
+      }),
+    ];
+    return val;
+  }
 }

package/src/stores/data-space/DataSpaceQueryCreatorStore.ts

@@ -16,10 +16,12 @@
 
 import {
   type Query,
+  type QuerySearchSpecification,
+  type RawLambda,
   extractElementNameFromPath,
   RuntimePointer,
   PackageableElementExplicitReference,
-  type RawLambda,
+  QueryProjectCoordinates,
 } from '@finos/legend-graph';
 import {
   type DepotServerClient,
@@ -39,7 +41,11 @@ import {
   QueryBuilderDataBrowserWorkflow,
   type QueryBuilderState,
 } from '@finos/legend-query-builder';
-import type { Entity, ProjectGAVCoordinates } from '@finos/legend-storage';
+import {
+  parseGACoordinates,
+  type Entity,
+  type ProjectGAVCoordinates,
+} from '@finos/legend-storage';
 import {
   type DataSpaceExecutionContext,
   DSL_DataSpace_getGraphManagerExtension,
@@ -55,6 +61,7 @@ import type { LegendQueryApplicationStore } from '../LegendQueryBaseStore.js';
 import {
   DataSpaceQueryBuilderState,
   createQueryClassTaggedValue,
+  createQueryDataSpaceTaggedValue,
   type DataSpaceInfo,
 } from '@finos/legend-extension-dsl-data-space/application';
 import { LegendQueryUserDataHelper } from '../../__lib__/LegendQueryUserDataHelper.js';
@@ -471,4 +478,34 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
       );
     }
   }
+
+  override decorateSearchSpecification(
+    val: QuerySearchSpecification,
+  ): QuerySearchSpecification {
+    if (this.queryableDataSpace) {
+      const currentProjectCoordinates = new QueryProjectCoordinates();
+      currentProjectCoordinates.groupId = this.queryableDataSpace.groupId;
+      currentProjectCoordinates.artifactId = this.queryableDataSpace.artifactId;
+      val.projectCoordinates = [
+        // either get queries for the current project
+        currentProjectCoordinates,
+        // or any of its dependencies
+        ...Array.from(
+          this.graphManagerState.graph.dependencyManager.projectDependencyModelsIndex.keys(),
+        ).map((dependencyKey) => {
+          const { groupId, artifactId } = parseGACoordinates(dependencyKey);
+          const coordinates = new QueryProjectCoordinates();
+          coordinates.groupId = groupId;
+          coordinates.artifactId = artifactId;
+          return coordinates;
+        }),
+      ];
+      val.taggedValues = [
+        createQueryDataSpaceTaggedValue(this.queryableDataSpace.dataSpacePath),
+      ];
+      val.combineTaggedValuesCondition = true;
+    }
+
+    return val;
+  }
 }

package/src/stores/data-space/DataSpaceTemplateQueryCreatorStore.ts

@@ -15,9 +15,11 @@
  */
 
 import {
+  QueryProjectCoordinates,
   extractElementNameFromPath,
   type Query,
   type RawLambda,
+  type QuerySearchSpecification,
 } from '@finos/legend-graph';
 import {
   type DepotServerClient,
@@ -28,7 +30,10 @@ import {
   type QueryBuilderState,
   QueryBuilderDataBrowserWorkflow,
 } from '@finos/legend-query-builder';
-import type { ProjectGAVCoordinates } from '@finos/legend-storage';
+import {
+  parseGACoordinates,
+  type ProjectGAVCoordinates,
+} from '@finos/legend-storage';
 import {
   QueryBuilderActionConfig_QueryApplication,
   QueryEditorStore,
@@ -44,6 +49,7 @@ import {
 import {
   DataSpaceQueryBuilderState,
   createQueryClassTaggedValue,
+  createQueryDataSpaceTaggedValue,
   type DataSpaceInfo,
 } from '@finos/legend-extension-dsl-data-space/application';
 import { createDataSpaceDepoRepo } from './DataSpaceQueryBuilderHelper.js';
@@ -181,4 +187,29 @@ export class DataSpaceTemplateQueryCreatorStore extends QueryEditorStore {
       },
     };
   }
+
+  override decorateSearchSpecification(
+    val: QuerySearchSpecification,
+  ): QuerySearchSpecification {
+    const currentProjectCoordinates = new QueryProjectCoordinates();
+    currentProjectCoordinates.groupId = this.groupId;
+    currentProjectCoordinates.artifactId = this.artifactId;
+    val.projectCoordinates = [
+      // either get queries for the current project
+      currentProjectCoordinates,
+      // or any of its dependencies
+      ...Array.from(
+        this.graphManagerState.graph.dependencyManager.projectDependencyModelsIndex.keys(),
+      ).map((dependencyKey) => {
+        const { groupId, artifactId } = parseGACoordinates(dependencyKey);
+        const coordinates = new QueryProjectCoordinates();
+        coordinates.groupId = groupId;
+        coordinates.artifactId = artifactId;
+        return coordinates;
+      }),
+    ];
+    val.taggedValues = [createQueryDataSpaceTaggedValue(this.dataSpacePath)];
+    val.combineTaggedValuesCondition = true;
+    return val;
+  }
 }

package/tsconfig.json

@@ -92,6 +92,7 @@
     "./src/components/QuerySetup.tsx",
     "./src/components/UpdateExistingServiceQuerySetup.tsx",
     "./src/components/__test-utils__/QueryEditorComponentTestUtils.tsx",
+    "./src/components/data-space/DataSpaceInfo.tsx",
     "./src/components/data-space/DataSpaceQueryCreator.tsx",
     "./src/components/data-space/DataSpaceQuerySetup.tsx",
     "./src/components/data-space/DataSpaceTemplateQueryCreator.tsx",