@finos/legend-extension-dsl-data-space 4.0.5 → 6.1.0

package/src/components/query/DataSpaceQuerySetup.tsx

@@ -26,8 +26,9 @@ import {
   ArrowLeftIcon,
   CustomSelectorInput,
   SearchIcon,
+  createFilter,
 } from '@finos/legend-art';
-import { useQuerySetupStore, useLegendQueryStore } from '@finos/legend-query';
+import { useQuerySetupStore } from '@finos/legend-application-query';
 import { generateGAVCoordinates } from '@finos/legend-server-depot';
 import { debounce } from '@finos/legend-shared';
 import { flowResult } from 'mobx';
@@ -41,7 +42,7 @@ import { DataSpaceViewer } from '../DataSpaceViewer.js';
 
 type DataSpaceOption = { label: string; value: DataSpaceContext };
 const buildDataSpaceOption = (value: DataSpaceContext): DataSpaceOption => ({
-  label: value.path,
+  label: value.title ?? value.name,
   value: value,
 });
 
@@ -50,7 +51,6 @@ export const DataspaceQuerySetup = observer(
     const { querySetupState } = props;
     const applicationStore = useApplicationStore();
     const setupStore = useQuerySetupStore();
-    const queryStore = useLegendQueryStore();
     const dataSpaceSearchRef = useRef<SelectComponent>(null);
     const [searchText, setSearchText] = useState('');
 
@@ -73,7 +73,6 @@ export const DataspaceQuerySetup = observer(
     const back = (): void => {
       setupStore.setSetupState(undefined);
       querySetupState.setCurrentDataSpace(undefined);
-      queryStore.graphManagerState.resetGraph();
     };
 
     // query
@@ -84,18 +83,35 @@ export const DataspaceQuerySetup = observer(
       : null;
     const onDataSpaceOptionChange = (option: DataSpaceOption | null): void => {
       if (option?.value !== querySetupState.currentDataSpace) {
-        queryStore.graphManagerState.resetGraph();
         querySetupState.setCurrentDataSpace(option?.value);
         querySetupState.setDataSpaceViewerState(undefined);
       }
     };
+    const filterOption = createFilter({
+      ignoreCase: true,
+      ignoreAccents: false,
+      stringify: (option: DataSpaceOption): string =>
+        `${option.label} - ${option.value.path}`,
+    });
     const formatQueryOptionLabel = (
       option: DataSpaceOption,
     ): React.ReactNode => (
-      <div className="query-setup__data-space__option">
+      <div
+        className="query-setup__data-space__option"
+        title={`${option.label} - ${
+          option.value.path
+        } - ${generateGAVCoordinates(
+          option.value.groupId,
+          option.value.artifactId,
+          option.value.versionId,
+        )}`}
+      >
         <div className="query-setup__data-space__option__label">
           {option.label}
         </div>
+        <div className="query-setup__data-space__option__path">
+          {option.value.path}
+        </div>
         <div className="query-setup__data-space__option__gav">
           {generateGAVCoordinates(
             option.value.groupId,
@@ -133,7 +149,7 @@ export const DataspaceQuerySetup = observer(
     useEffect(() => {
       if (querySetupState.currentDataSpace) {
         flowResult(
-          querySetupState.setUpDataSpace(querySetupState.currentDataSpace),
+          querySetupState.loadDataSpace(querySetupState.currentDataSpace),
         ).catch(applicationStore.alertUnhandledError);
       }
     }, [querySetupState, applicationStore, querySetupState.currentDataSpace]);
@@ -184,6 +200,7 @@ export const DataspaceQuerySetup = observer(
               isClearable={true}
               escapeClearsValue={true}
               darkMode={true}
+              filterOption={filterOption}
               formatOptionLabel={formatQueryOptionLabel}
             />
             <button
@@ -202,40 +219,34 @@ export const DataspaceQuerySetup = observer(
           </div>
           <div className="query-setup__data-space__view">
             <PanelLoadingIndicator
-              isLoading={querySetupState.setUpDataSpaceState.isInProgress}
+              isLoading={querySetupState.loadDataSpaceState.isInProgress}
             />
             {querySetupState.dataSpaceViewerState && (
               <DataSpaceViewer
                 dataSpaceViewerState={querySetupState.dataSpaceViewerState}
               />
             )}
-            {!querySetupState.dataSpaceViewerState &&
-              querySetupState.setUpDataSpaceState.isInProgress && (
-                <BlankPanelContent>
-                  {querySetupState.queryStore.buildGraphState.message ??
-                    querySetupState.queryStore.graphManagerState
-                      .systemBuildState.message ??
-                    querySetupState.queryStore.graphManagerState
-                      .dependenciesBuildState.message ??
-                    querySetupState.queryStore.graphManagerState
-                      .generationsBuildState.message ??
-                    querySetupState.queryStore.graphManagerState.graphBuildState
-                      .message}
-                </BlankPanelContent>
-              )}
-            {!querySetupState.dataSpaceViewerState &&
-              querySetupState.setUpDataSpaceState.hasFailed && (
-                <BlankPanelContent>
-                  <div className="query-setup__data-space__view--failed">
-                    <div className="query-setup__data-space__view--failed__icon">
-                      <TimesCircleIcon />
-                    </div>
-                    <div className="query-setup__data-space__view--failed__text">
-                      Can&apos;t load data space
+            {!querySetupState.dataSpaceViewerState && (
+              <>
+                {querySetupState.loadDataSpaceState.isInProgress && (
+                  <BlankPanelContent>
+                    {querySetupState.loadDataSpaceState.message}
+                  </BlankPanelContent>
+                )}
+                {querySetupState.loadDataSpaceState.hasFailed && (
+                  <BlankPanelContent>
+                    <div className="query-setup__data-space__view--failed">
+                      <div className="query-setup__data-space__view--failed__icon">
+                        <TimesCircleIcon />
+                      </div>
+                      <div className="query-setup__data-space__view--failed__text">
+                        Can&apos;t load data space
+                      </div>
                     </div>
-                  </div>
-                </BlankPanelContent>
-              )}
+                  </BlankPanelContent>
+                )}
+              </>
+            )}
           </div>
         </div>
       </div>

package/src/components/studio/{DSLDataSpace_LegendStudioPlugin.tsx → DSLDataSpace_LegendStudioApplicationPlugin.tsx}

@@ -20,7 +20,7 @@ import {
   type ElementTypeGetter,
   type ElementProjectExplorerDnDTypeGetter,
   type ElementIconGetter,
-  type DSL_LegendStudioPlugin_Extension,
+  type DSL_LegendStudioApplicationPlugin_Extension,
   type NewElementState,
   type ElementEditorStateCreator,
   type EditorStore,
@@ -31,8 +31,8 @@ import {
   type PureGrammarTextSuggestion,
   type PureGrammarParserElementSnippetSuggestionsGetter,
   UnsupportedElementEditorState,
-  LegendStudioPlugin,
-} from '@finos/legend-studio';
+  LegendStudioApplicationPlugin,
+} from '@finos/legend-application-studio';
 import { SquareIcon } from '@finos/legend-art';
 import {
   PackageableElementExplicitReference,
@@ -43,25 +43,25 @@ import {
 import {
   DataSpace,
   DataSpaceExecutionContext,
-} from '../../models/metamodels/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+} from '../../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
 import { DSL_DATA_SPACE_LEGEND_STUDIO_DOCUMENTATION_KEY } from './DSLDataSpace_LegendStudioDocumentation.js';
 import {
   PURE_GRAMMAR_DATA_SPACE_ELEMENT_TYPE_LABEL,
   PURE_GRAMMAR_DATA_SPACE_PARSER_NAME,
 } from '../../graphManager/DSLDataSpace_PureGraphManagerPlugin.js';
 import { SIMPLE_DATA_SPACE_SNIPPET } from './DSLDataSpace_CodeSnippets.js';
-import type { LegendApplicationDocumentationEntry } from '@finos/legend-application';
+import type { DocumentationEntry } from '@finos/legend-application';
 
 const DATA_SPACE_ELEMENT_TYPE = 'DATA SPACE';
 const DATA_SPACE_ELEMENT_PROJECT_EXPLORER_DND_TYPE =
   'PROJECT_EXPLORER_DATA_SPACE';
 
-export class DSLDataSpace_LegendStudioPlugin
-  extends LegendStudioPlugin
-  implements DSL_LegendStudioPlugin_Extension
+export class DSLDataSpace_LegendStudioApplicationPlugin
+  extends LegendStudioApplicationPlugin
+  implements DSL_LegendStudioApplicationPlugin_Extension
 {
   constructor() {
-    super(packageJson.extensions.studioPlugin, packageJson.version);
+    super(packageJson.extensions.applicationStudioPlugin, packageJson.version);
   }
 
   override getExtraRequiredDocumentationKeys(): string[] {
@@ -162,7 +162,7 @@ export class DSLDataSpace_LegendStudioPlugin
         editorStore: EditorStore,
         parserKeyword: string,
         elementKeyword: string,
-      ): LegendApplicationDocumentationEntry | undefined => {
+      ): DocumentationEntry | undefined => {
         if (parserKeyword === PURE_GRAMMAR_DATA_SPACE_PARSER_NAME) {
           if (elementKeyword === PURE_GRAMMAR_DATA_SPACE_ELEMENT_TYPE_LABEL) {
             return editorStore.applicationStore.documentationService.getDocEntry(
@@ -180,7 +180,7 @@ export class DSLDataSpace_LegendStudioPlugin
       (
         editorStore: EditorStore,
         parserKeyword: string,
-      ): LegendApplicationDocumentationEntry | undefined => {
+      ): DocumentationEntry | undefined => {
         if (parserKeyword === PURE_GRAMMAR_DATA_SPACE_PARSER_NAME) {
           return editorStore.applicationStore.documentationService.getDocEntry(
             DSL_DATA_SPACE_LEGEND_STUDIO_DOCUMENTATION_KEY.GRAMMAR_PARSER,

package/src/graph/DSLDataSpace_PureGraphPlugin.ts

@@ -15,7 +15,7 @@
  */
 
 import packageJson from '../../package.json';
-import { DataSpace } from '../models/metamodels/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+import { DataSpace } from '../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
 import type { Clazz } from '@finos/legend-shared';
 import { type PackageableElement, PureGraphPlugin } from '@finos/legend-graph';
 

package/src/{models/metamodels → graph/metamodel}/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.ts

@@ -22,7 +22,7 @@ import {
   type PackageableRuntime,
   type PackageableElementVisitor,
 } from '@finos/legend-graph';
-import { DATA_SPACE_HASH_STRUCTURE } from '../../../../../DSLDataSpace_ModelUtils.js';
+import { DATA_SPACE_HASH_STRUCTURE } from '../../../../../DSLDataSpace_HashUtils.js';
 import type { Diagram } from '@finos/legend-extension-dsl-diagram';
 
 export abstract class DataSpaceSupportInfo implements Hashable {
@@ -64,6 +64,7 @@ export class DataSpace extends PackageableElement implements Hashable {
   executionContexts: DataSpaceExecutionContext[] = [];
   defaultExecutionContext!: DataSpaceExecutionContext;
   featuredDiagrams?: PackageableElementReference<Diagram>[] | undefined;
+  title?: string | undefined;
   description?: string | undefined;
   supportInfo?: DataSpaceSupportInfo | undefined;
 
@@ -81,6 +82,7 @@ export class DataSpace extends PackageableElement implements Hashable {
           (diagram) => diagram.valueForSerialization ?? '',
         ),
       ),
+      this.title ?? '',
       this.description ?? '',
       this.supportInfo ?? '',
     ]);

package/src/graphManager/DSLDataSpace_GraphManagerHelper.ts

@@ -16,7 +16,7 @@
 
 import type { BasicModel, PureModel } from '@finos/legend-graph';
 import { guaranteeNonNullable } from '@finos/legend-shared';
-import { DataSpace } from '../models/metamodels/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+import { DataSpace } from '../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
 
 export const getDataSpace = (path: string, graph: PureModel): DataSpace =>
   graph.getExtensionElement(path, DataSpace, `Can't find data space '${path}'`);

package/src/graphManager/DSLDataSpace_PureGraphManagerPlugin.ts

@@ -15,15 +15,17 @@
  */
 
 import packageJson from '../../package.json';
-import { DataSpace } from '../models/metamodels/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+import { DataSpace } from '../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
 import {
   PureGraphManagerPlugin,
   type ObserverContext,
   type ElementObserver,
   type PackageableElement,
   type PureGrammarElementLabeler,
+  type PureGraphManagerExtensionBuilder,
 } from '@finos/legend-graph';
 import { observe_DataSpace } from './action/changeDetection/DSLDataSpace_ObserverHelper.js';
+import { DSLDataSpace_buildGraphManagerExtension } from './protocol/pure/DSLDataSpace_PureGraphManagerExtensionBuilder.js';
 
 export const PURE_GRAMMAR_DATA_SPACE_PARSER_NAME = 'DataSpace';
 export const PURE_GRAMMAR_DATA_SPACE_ELEMENT_TYPE_LABEL = 'DataSpace';
@@ -33,6 +35,10 @@ export class DSLDataSpace_PureGraphManagerPlugin extends PureGraphManagerPlugin
     super(packageJson.extensions.pureGraphManagerPlugin, packageJson.version);
   }
 
+  override getExtraPureGraphManagerExtensionBuilders(): PureGraphManagerExtensionBuilder[] {
+    return [DSLDataSpace_buildGraphManagerExtension];
+  }
+
   override getExtraPureGrammarParserNames(): string[] {
     return [PURE_GRAMMAR_DATA_SPACE_PARSER_NAME];
   }

package/src/graphManager/action/analytics/DataSpaceAnalysis.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { Diagram } from '@finos/legend-extension-dsl-diagram';
+import type {
+  Mapping,
+  PackageableRuntime,
+  PureModel,
+} from '@finos/legend-graph';
+import { uuid } from '@finos/legend-shared';
+import type { DataSpaceSupportInfo } from '../../../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+
+export class DataSpaceExecutionContextAnalysisResult {
+  name!: string;
+  description?: string | undefined;
+  mapping!: Mapping;
+  defaultRuntime!: PackageableRuntime;
+  compatibleRuntimes!: PackageableRuntime[];
+}
+
+export class DataSpaceTaggedValueInfo {
+  readonly _UUID = uuid();
+
+  profile!: string;
+  tag!: string;
+  value!: string;
+}
+
+export class DataSpaceStereotypeInfo {
+  readonly _UUID = uuid();
+
+  profile!: string;
+  value!: string;
+}
+
+export class DataSpaceAnalysisResult {
+  name!: string;
+  package!: string;
+  path!: string;
+  taggedValues: DataSpaceTaggedValueInfo[] = [];
+  stereotypes: DataSpaceStereotypeInfo[] = [];
+  title?: string | undefined;
+  description?: string | undefined;
+  supportInfo?: DataSpaceSupportInfo | undefined;
+
+  graph!: PureModel;
+
+  executionContextsIndex!: Map<string, DataSpaceExecutionContextAnalysisResult>;
+  defaultExecutionContext!: DataSpaceExecutionContextAnalysisResult;
+
+  featuredDiagrams: Diagram[] = [];
+}

package/src/graphManager/action/changeDetection/DSLDataSpace_ObserverHelper.ts

@@ -21,7 +21,7 @@ import {
   skipObserved,
 } from '@finos/legend-graph';
 import { makeObservable, override } from 'mobx';
-import type { DataSpace } from '../../../models/metamodels/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+import type { DataSpace } from '../../../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
 
 export const observe_DataSpace = skipObserved(
   (metamodel: DataSpace): DataSpace => {
@@ -31,6 +31,7 @@ export const observe_DataSpace = skipObserved(
       _elementHashCode: override,
     });
 
+    // TODO
     // metamodel.executionContexts.forEach(observe_DataSpaceExecutionContext);
     // observe_DataSpaceExecutionContext(metamodel.defaultExecutionContext);
     // if (metamodel.supportInfo) {

package/src/graphManager/protocol/pure/DSLDataSpace_PureGraphManagerExtension.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 AbstractPureGraphManager,
+  AbstractPureGraphManagerExtension,
+} from '@finos/legend-graph';
+import type { Entity } from '@finos/legend-storage';
+import { guaranteeNonNullable } from '@finos/legend-shared';
+import type { DataSpaceAnalysisResult } from '../../action/analytics/DataSpaceAnalysis.js';
+
+export abstract class DSLDataSpace_PureGraphManagerExtension extends AbstractPureGraphManagerExtension {
+  abstract analyzeDataSpace(
+    dataSpacePath: string,
+    entities: Entity[],
+    dependencyEntitiesIndex: Map<string, Entity[]>,
+  ): Promise<DataSpaceAnalysisResult>;
+}
+
+export const getDSLDataSpaceGraphManagerExtension = (
+  graphManager: AbstractPureGraphManager,
+): DSLDataSpace_PureGraphManagerExtension =>
+  guaranteeNonNullable(
+    graphManager.extensions.find(
+      (extension) =>
+        extension instanceof DSLDataSpace_PureGraphManagerExtension,
+    ),
+    `Can't find DSL Data Space Pure graph manager extension`,
+  ) as DSLDataSpace_PureGraphManagerExtension;

package/src/graphManager/protocol/pure/DSLDataSpace_PureGraphManagerExtensionBuilder.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 {
+  AbstractPureGraphManager,
+  AbstractPureGraphManagerExtension,
+} from '@finos/legend-graph';
+import { V1_DSLDataSpace_PureGraphManagerExtension } from './v1/V1_DSLDataSpace_PureGraphManagerExtension.js';
+
+export const DSLDataSpace_buildGraphManagerExtension = (
+  graphManager: AbstractPureGraphManager,
+): AbstractPureGraphManagerExtension =>
+  // NOTE: until we support more client versions, we always default to return V1
+  new V1_DSLDataSpace_PureGraphManagerExtension(graphManager);

package/src/{models/protocols → graphManager/protocol}/pure/DSLDataSpace_PureProtocolProcessorPlugin.ts

@@ -39,7 +39,7 @@ import {
   DataSpace,
   DataSpaceExecutionContext,
   DataSpaceSupportEmail,
-} from '../../metamodels/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
+} from '../../../graph/metamodel/pure/model/packageableElements/dataSpace/DSLDataSpace_DataSpace.js';
 import {
   type PackageableElement,
   type V1_ElementProtocolClassifierPathGetter,
@@ -147,6 +147,7 @@ export class DSLDataSpace_PureProtocolProcessorPlugin extends PureProtocolProces
             ),
             `Can't find default execution context '${elementProtocol.defaultExecutionContext}'`,
           );
+          element.title = elementProtocol.title;
           element.description = elementProtocol.description;
           if (elementProtocol.featuredDiagrams) {
             element.featuredDiagrams = elementProtocol.featuredDiagrams.map(
@@ -254,6 +255,7 @@ export class DSLDataSpace_PureProtocolProcessorPlugin extends PureProtocolProces
           );
           protocol.defaultExecutionContext =
             metamodel.defaultExecutionContext.name;
+          protocol.title = metamodel.title;
           protocol.description = metamodel.description;
           protocol.featuredDiagrams = metamodel.featuredDiagrams?.map(
             (diagramPath) =>