@finos/legend-extension-dsl-data-space 10.1.17 → 10.1.19

package/src/stores/query/DataSpaceQueryBuilderState.ts

@@ -19,13 +19,19 @@ import {
   DEFAULT_TYPEAHEAD_SEARCH_LIMIT,
   DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH,
 } from '@finos/legend-application';
-import { QueryBuilderState } from '@finos/legend-query-builder';
+import {
+  type QueryBuilderConfig,
+  QueryBuilderState,
+} from '@finos/legend-query-builder';
 import {
   type GraphManagerState,
   getMappingCompatibleClasses,
   RuntimePointer,
   type Runtime,
-  type Class,
+  Class,
+  type Mapping,
+  getDescendantsOfPackage,
+  Package,
 } from '@finos/legend-graph';
 import {
   DepotScope,
@@ -38,21 +44,40 @@ import {
   ActionState,
   assertErrorThrown,
   getNullableFirstEntry,
+  filterByType,
+  uniq,
 } from '@finos/legend-shared';
 import { action, flow, makeObservable, observable } from 'mobx';
 import { renderDataSpaceQueryBuilderSetupPanelContent } from '../../components/query/DataSpaceQueryBuilder.js';
-import type {
+import {
   DataSpace,
-  DataSpaceExecutionContext,
+  type DataSpaceExecutionContext,
 } from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
 import { DATA_SPACE_ELEMENT_CLASSIFIER_PATH } from '../../graph-manager/protocol/pure/DSL_DataSpace_PureProtocolProcessorPlugin.js';
 import { type DataSpaceInfo, extractDataSpaceInfo } from './DataSpaceInfo.js';
 import { DataSpaceAdvancedSearchState } from './DataSpaceAdvancedSearchState.js';
 import type { DataSpaceAnalysisResult } from '../../graph-manager/action/analytics/DataSpaceAnalysis.js';
 
-export class DataSpaceQueryBuilderState extends QueryBuilderState {
-  readonly depotServerClient: DepotServerClient;
-  readonly dataSpace: DataSpace;
+export const resolveUsableDataSpaceClasses = (
+  dataSpace: DataSpace,
+  mapping: Mapping,
+  graphManagerState: GraphManagerState,
+): Class[] => {
+  if (dataSpace.elements?.length) {
+    const dataSpaceElements = dataSpace.elements.map((ep) => ep.element.value);
+    return uniq([
+      ...dataSpaceElements.filter(filterByType(Class)),
+      ...dataSpaceElements
+        .filter(filterByType(Package))
+        .map((_package) => Array.from(getDescendantsOfPackage(_package)))
+        .flat()
+        .filter(filterByType(Class)),
+    ]);
+  }
+  return getMappingCompatibleClasses(mapping, graphManagerState.usableClasses);
+};
+
+export class DataSpaceProjectInfo {
   readonly groupId: string;
   readonly artifactId: string;
   readonly versionId: string;
@@ -67,6 +92,33 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
     artifactId: string,
     entityPath: string | undefined,
   ) => Promise<void>;
+
+  constructor(
+    groupId: string,
+    artifactId: string,
+    versionId: string,
+    viewProject: (
+      groupId: string,
+      artifactId: string,
+      versionId: string,
+      entityPath: string | undefined,
+    ) => void,
+    viewSDLCProject: (
+      groupId: string,
+      artifactId: string,
+      entityPath: string | undefined,
+    ) => Promise<void>,
+  ) {
+    this.groupId = groupId;
+    this.artifactId = artifactId;
+    this.versionId = versionId;
+    this.viewProject = viewProject;
+    this.viewSDLCProject = viewSDLCProject;
+  }
+}
+
+export class DataSpaceQueryBuilderState extends QueryBuilderState {
+  readonly depotServerClient: DepotServerClient;
   readonly isAdvancedDataSpaceSearchEnabled: boolean;
   readonly loadDataSpacesState = ActionState.create();
   readonly onDataSpaceChange: (val: DataSpaceInfo) => void;
@@ -76,10 +128,12 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
   readonly onRuntimeChange?: ((val: Runtime) => void) | undefined;
   readonly onClassChange?: ((val: Class) => void) | undefined;
   readonly dataSpaceAnalysisResult?: DataSpaceAnalysisResult | undefined;
+  readonly projectInfo?: DataSpaceProjectInfo | undefined;
 
   override TEMPORARY__setupPanelContentRenderer = (): React.ReactNode =>
     renderDataSpaceQueryBuilderSetupPanelContent(this);
 
+  dataSpace: DataSpace;
   executionContext!: DataSpaceExecutionContext;
   dataSpaces: DataSpaceInfo[] = [];
   showRuntimeSelector = false;
@@ -91,29 +145,18 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
     depotServerClient: DepotServerClient,
     dataSpace: DataSpace,
     executionContext: DataSpaceExecutionContext,
-    groupId: string,
-    artifactId: string,
-    versionId: string,
-    viewProject: (
-      groupId: string,
-      artifactId: string,
-      versionId: string,
-      entityPath: string | undefined,
-    ) => void,
-    viewSDLCProject: (
-      groupId: string,
-      artifactId: string,
-      entityPath: string | undefined,
-    ) => Promise<void>,
     onDataSpaceChange: (val: DataSpaceInfo) => void,
+    isAdvancedDataSpaceSearchEnabled: boolean,
     dataSpaceAnalysisResult?: DataSpaceAnalysisResult | undefined,
     onExecutionContextChange?:
       | ((val: DataSpaceExecutionContext) => void)
       | undefined,
     onRuntimeChange?: ((val: Runtime) => void) | undefined,
     onClassChange?: ((val: Class) => void) | undefined,
+    projectInfo?: DataSpaceProjectInfo | undefined,
+    config?: QueryBuilderConfig | undefined,
   ) {
-    super(applicationStore, graphManagerState);
+    super(applicationStore, graphManagerState, config);
 
     makeObservable(this, {
       dataSpaces: observable,
@@ -130,18 +173,12 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
     this.depotServerClient = depotServerClient;
     this.dataSpace = dataSpace;
     this.executionContext = executionContext;
-    this.groupId = groupId;
-    this.artifactId = artifactId;
-    this.versionId = versionId;
-    this.viewProject = viewProject;
-    this.viewSDLCProject = viewSDLCProject;
+    this.projectInfo = projectInfo;
     this.onDataSpaceChange = onDataSpaceChange;
     this.onExecutionContextChange = onExecutionContextChange;
     this.onRuntimeChange = onRuntimeChange;
     this.onClassChange = onClassChange;
-    // NOTE: if we reuse this state in the future (e.g. in Studio), we might need
-    // to turn this flag off
-    this.isAdvancedDataSpaceSearchEnabled = true;
+    this.isAdvancedDataSpaceSearchEnabled = isAdvancedDataSpaceSearchEnabled;
     this.dataSpaceAnalysisResult = dataSpaceAnalysisResult;
   }
 
@@ -152,25 +189,27 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
   }
 
   showAdvancedSearchPanel(): void {
-    this.advancedSearchState = new DataSpaceAdvancedSearchState(
-      this.applicationStore,
-      this.graphManagerState,
-      this.depotServerClient,
-      {
-        viewProject: this.viewProject,
-        viewSDLCProject: this.viewSDLCProject,
-      },
-      {
-        groupId: this.groupId,
-        artifactId: this.artifactId,
-        versionId: this.versionId,
-        title: this.dataSpace.title,
-        name: this.dataSpace.name,
-        path: this.dataSpace.path,
-        defaultExecutionContext: this.dataSpace.defaultExecutionContext.name,
-      },
-      this.versionId === SNAPSHOT_VERSION_ALIAS,
-    );
+    if (this.projectInfo && this.isAdvancedDataSpaceSearchEnabled) {
+      this.advancedSearchState = new DataSpaceAdvancedSearchState(
+        this.applicationStore,
+        this.graphManagerState,
+        this.depotServerClient,
+        {
+          viewProject: this.projectInfo.viewProject,
+          viewSDLCProject: this.projectInfo.viewSDLCProject,
+        },
+        {
+          groupId: this.projectInfo.groupId,
+          artifactId: this.projectInfo.artifactId,
+          versionId: this.projectInfo.versionId,
+          title: this.dataSpace.title,
+          name: this.dataSpace.name,
+          path: this.dataSpace.path,
+          defaultExecutionContext: this.dataSpace.defaultExecutionContext.name,
+        },
+        this.projectInfo.versionId === SNAPSHOT_VERSION_ALIAS,
+      );
+    }
   }
 
   hideAdvancedSearchPanel(): void {
@@ -186,28 +225,46 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
   }
 
   *loadDataSpaces(searchText: string): GeneratorFn<void> {
-    const isValidSearchString =
-      searchText.length >= DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH;
-    this.loadDataSpacesState.inProgress();
-    const toGetSnapShot = this.versionId === SNAPSHOT_VERSION_ALIAS;
-    try {
-      this.dataSpaces = (
-        (yield this.depotServerClient.getEntitiesByClassifierPath(
-          DATA_SPACE_ELEMENT_CLASSIFIER_PATH,
-          {
-            search: isValidSearchString ? searchText : undefined,
-            scope: toGetSnapShot ? DepotScope.SNAPSHOT : DepotScope.RELEASES,
-            limit: DEFAULT_TYPEAHEAD_SEARCH_LIMIT,
-          },
-        )) as StoredEntity[]
-      ).map((storedEntity) =>
-        extractDataSpaceInfo(storedEntity, toGetSnapShot),
-      );
-      this.loadDataSpacesState.pass();
-    } catch (error) {
-      assertErrorThrown(error);
-      this.loadDataSpacesState.fail();
-      this.applicationStore.notificationService.notifyError(error);
+    if (this.projectInfo) {
+      const isValidSearchString =
+        searchText.length >= DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH;
+      this.loadDataSpacesState.inProgress();
+      const toGetSnapShot =
+        this.projectInfo.versionId === SNAPSHOT_VERSION_ALIAS;
+      try {
+        this.dataSpaces = (
+          (yield this.depotServerClient.getEntitiesByClassifierPath(
+            DATA_SPACE_ELEMENT_CLASSIFIER_PATH,
+            {
+              search: isValidSearchString ? searchText : undefined,
+              scope: toGetSnapShot ? DepotScope.SNAPSHOT : DepotScope.RELEASES,
+              limit: DEFAULT_TYPEAHEAD_SEARCH_LIMIT,
+            },
+          )) as StoredEntity[]
+        ).map((storedEntity) =>
+          extractDataSpaceInfo(storedEntity, toGetSnapShot),
+        );
+        this.loadDataSpacesState.pass();
+      } catch (error) {
+        assertErrorThrown(error);
+        this.loadDataSpacesState.fail();
+        this.applicationStore.notificationService.notifyError(error);
+      }
+    } else {
+      this.dataSpaces = this.graphManagerState.graph.allOwnElements
+        .filter(filterByType(DataSpace))
+        .map(
+          (e) =>
+            ({
+              groupId: undefined,
+              artifactId: undefined,
+              versionId: undefined,
+              path: e.path,
+              name: e.name,
+              title: e.title,
+              defaultExecutionContext: e.defaultExecutionContext.title,
+            }) as DataSpaceInfo,
+        );
     }
   }
 
@@ -233,9 +290,10 @@ export class DataSpaceQueryBuilderState extends QueryBuilderState {
     }
     this.changeRuntime(new RuntimePointer(executionContext.defaultRuntime));
 
-    const compatibleClasses = getMappingCompatibleClasses(
+    const compatibleClasses = resolveUsableDataSpaceClasses(
+      this.dataSpace,
       mapping,
-      this.graphManagerState.usableClasses,
+      this.graphManagerState,
     );
     // if there is no chosen class or the chosen one is not compatible
     // with the mapping then pick a compatible class if possible

package/src/stores/query/DataSpaceQueryCreatorStore.ts

@@ -46,7 +46,10 @@ import {
   QUERY_PROFILE_TAG_DATA_SPACE,
 } from '../../graph/DSL_DataSpace_MetaModelConst.js';
 import { getDataSpace } from '../../graph-manager/DSL_DataSpace_GraphManagerHelper.js';
-import { DataSpaceQueryBuilderState } from './DataSpaceQueryBuilderState.js';
+import {
+  DataSpaceQueryBuilderState,
+  DataSpaceProjectInfo,
+} from './DataSpaceQueryBuilderState.js';
 import type { DataSpaceInfo } from './DataSpaceInfo.js';
 import { generateDataSpaceQueryCreatorRoute } from '../../__lib__/query/DSL_DataSpace_LegendQueryNavigation.js';
 import type { DataSpaceExecutionContext } from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSL_DataSpace_DataSpace.js';
@@ -143,12 +146,7 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
     } catch {
       // do nothing
     }
-    const queryBuilderState = new DataSpaceQueryBuilderState(
-      this.applicationStore,
-      this.graphManagerState,
-      this.depotServerClient,
-      dataSpace,
-      executionContext,
+    const projectInfo = new DataSpaceProjectInfo(
       this.groupId,
       this.artifactId,
       this.versionId,
@@ -157,13 +155,20 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
         this.applicationStore,
         this.depotServerClient,
       ),
+    );
+    const queryBuilderState = new DataSpaceQueryBuilderState(
+      this.applicationStore,
+      this.graphManagerState,
+      this.depotServerClient,
+      dataSpace,
+      executionContext,
       (dataSpaceInfo: DataSpaceInfo) => {
         if (dataSpaceInfo.defaultExecutionContext) {
           this.applicationStore.navigationService.navigator.goToLocation(
             generateDataSpaceQueryCreatorRoute(
-              dataSpaceInfo.groupId,
-              dataSpaceInfo.artifactId,
-              dataSpaceInfo.versionId,
+              guaranteeNonNullable(dataSpaceInfo.groupId),
+              guaranteeNonNullable(dataSpaceInfo.artifactId),
+              guaranteeNonNullable(dataSpaceInfo.versionId),
               dataSpaceInfo.path,
               dataSpaceInfo.defaultExecutionContext,
               undefined,
@@ -176,6 +181,7 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
           );
         }
       },
+      true,
       dataSpaceAnalysisResult,
       (ec: DataSpaceExecutionContext) => {
         // runtime should already be set
@@ -202,9 +208,9 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
         const runtimePointer = guaranteeType(runtimeValue, RuntimePointer);
         queryBuilderState.applicationStore.navigationService.navigator.updateCurrentLocation(
           generateDataSpaceQueryCreatorRoute(
-            queryBuilderState.groupId,
-            queryBuilderState.artifactId,
-            queryBuilderState.versionId,
+            guaranteeNonNullable(queryBuilderState.projectInfo).groupId,
+            guaranteeNonNullable(queryBuilderState.projectInfo).artifactId,
+            guaranteeNonNullable(queryBuilderState.projectInfo).versionId,
             queryBuilderState.dataSpace.path,
             queryBuilderState.executionContext.name,
             runtimePointer.packageableRuntime.value ===
@@ -223,9 +229,9 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
         );
         queryBuilderState.applicationStore.navigationService.navigator.updateCurrentLocation(
           generateDataSpaceQueryCreatorRoute(
-            queryBuilderState.groupId,
-            queryBuilderState.artifactId,
-            queryBuilderState.versionId,
+            guaranteeNonNullable(queryBuilderState.projectInfo).groupId,
+            guaranteeNonNullable(queryBuilderState.projectInfo).artifactId,
+            guaranteeNonNullable(queryBuilderState.projectInfo).versionId,
             queryBuilderState.dataSpace.path,
             queryBuilderState.executionContext.name,
             runtimePointer.packageableRuntime.value ===
@@ -236,6 +242,7 @@ export class DataSpaceQueryCreatorStore extends QueryEditorStore {
           ),
         );
       },
+      projectInfo,
     );
     queryBuilderState.setExecutionContext(executionContext);
     queryBuilderState.propagateExecutionContextChange(executionContext);

package/src/stores/query/DataSpaceQuerySetupStore.ts

@@ -32,11 +32,15 @@ import {
   type GenericLegendApplicationStore,
 } from '@finos/legend-application';
 import { action, flow, makeObservable, observable } from 'mobx';
-import { QueryBuilderState } from '@finos/legend-query-builder';
+import {
+  type QueryBuilderConfig,
+  QueryBuilderState,
+} from '@finos/legend-query-builder';
 import type { ProjectGAVCoordinates } from '@finos/legend-storage';
 import {
   ActionState,
   assertErrorThrown,
+  guaranteeNonNullable,
   UnsupportedOperationError,
   type GeneratorFn,
 } from '@finos/legend-shared';
@@ -85,8 +89,9 @@ export class DataSpaceQuerySetupState extends QueryBuilderState {
       artifactId: string,
       entityPath: string | undefined,
     ) => Promise<void>,
+    config: QueryBuilderConfig | undefined,
   ) {
-    super(applicationStore, graphManagerState);
+    super(applicationStore, graphManagerState, config);
 
     makeObservable(this, {
       dataSpaces: observable,
@@ -175,9 +180,9 @@ export class DataSpaceQuerySetupStore extends QueryEditorStore {
         if (dataSpaceInfo.defaultExecutionContext) {
           this.applicationStore.navigationService.navigator.goToLocation(
             generateDataSpaceQueryCreatorRoute(
-              dataSpaceInfo.groupId,
-              dataSpaceInfo.artifactId,
-              dataSpaceInfo.versionId,
+              guaranteeNonNullable(dataSpaceInfo.groupId),
+              guaranteeNonNullable(dataSpaceInfo.artifactId),
+              guaranteeNonNullable(dataSpaceInfo.versionId),
               dataSpaceInfo.path,
               dataSpaceInfo.defaultExecutionContext,
               undefined,
@@ -195,6 +200,7 @@ export class DataSpaceQuerySetupStore extends QueryEditorStore {
         this.applicationStore,
         this.depotServerClient,
       ),
+      this.applicationStore.config.options.queryBuilderConfig,
     );
 
     return queryBuilderState;

package/tsconfig.json

@@ -96,6 +96,7 @@
     "./src/components/query/DataSpaceQuerySetup.tsx",
     "./src/components/studio/DSL_DataSpace_LegendStudioApplicationPlugin.tsx",
     "./src/components/studio/DataSpacePreviewAction.tsx",
+    "./src/components/studio/DataSpaceQueryAction.tsx",
     "./src/graph-manager/protocol/pure/v1/V1_DSL_DataSpace_SystemModels.json"
   ],
   "include": [