@finos/legend-extension-dsl-data-space 10.4.261 → 10.4.263

package/src/stores/DataSpaceViewerNavigation.ts

@@ -15,6 +15,9 @@
  */
 
 import { NAVIGATION_ZONE_SEPARATOR } from '@finos/legend-application';
+import { extractElementNameFromPath } from '@finos/legend-graph';
+import { LATEST_VERSION_ALIAS } from '@finos/legend-server-depot';
+import { isNonNullable } from '@finos/legend-shared';
 import type { DataSpaceExecutableAnalysisResult } from '../graph-manager/action/analytics/DataSpaceAnalysis.js';
 import type { DiagramAnalysisResult } from '@finos/legend-extension-dsl-diagram';
 
@@ -26,6 +29,7 @@ export enum DATA_SPACE_VIEWER_ACTIVITY_MODE {
   QUICK_START = 'quick-start',
   EXECUTION_CONTEXT = 'execution-context',
   DATA_ACCESS = 'data-access',
+  RELATED_DATA_SPACES = 'related-data-spaces',
 
   DATA_STORES = 'data-stores', // TODO: with test-data, also let user call TDS query on top of these
   DATA_AVAILABILITY = 'data-availability',
@@ -61,3 +65,72 @@ export const generateAnchorForDiagram = (
     DATA_SPACE_VIEWER_ACTIVITY_MODE.DIAGRAM_VIEWER,
     generateAnchorChunk(diagram.title),
   ].join(NAVIGATION_ZONE_SEPARATOR);
+
+const RELATED_DATA_SPACE_GAV_COORDINATE_SEPARATOR = ':';
+const RELATED_DATA_SPACE_GAV_PATH_SEPARATOR = '|';
+const RELATED_DATA_SPACE_ENTRY_SEPARATOR = ',';
+
+export type DataSpaceWikiRelatedDataSpace = {
+  name: string;
+  groupId: string;
+  artifactId: string;
+  versionId: string;
+  path: string;
+  isInvalid?: boolean | undefined;
+};
+
+export const encodeRelatedDataSpaceGAV = (entry: {
+  groupId: string;
+  artifactId: string;
+  versionId: string;
+  path: string;
+}): string =>
+  `${[entry.groupId, entry.artifactId, entry.versionId].join(
+    RELATED_DATA_SPACE_GAV_COORDINATE_SEPARATOR,
+  )}${RELATED_DATA_SPACE_GAV_PATH_SEPARATOR}${entry.path}`;
+
+export const generateRelatedDataSpaceRedirectPath = (
+  relatedDataSpace: DataSpaceWikiRelatedDataSpace,
+): string =>
+  `${relatedDataSpace.groupId}:${relatedDataSpace.artifactId}:${LATEST_VERSION_ALIAS}/${relatedDataSpace.path}`;
+
+export const parseRelatedDataSpaceGAV = (
+  value: string,
+): DataSpaceWikiRelatedDataSpace | undefined => {
+  const separatorIdx = value.indexOf(RELATED_DATA_SPACE_GAV_PATH_SEPARATOR);
+  if (separatorIdx === -1) {
+    return undefined;
+  }
+  const gavPart = value.slice(0, separatorIdx);
+  const path = value.slice(separatorIdx + 1);
+  const coordinates = gavPart.split(
+    RELATED_DATA_SPACE_GAV_COORDINATE_SEPARATOR,
+  );
+  if (coordinates.length !== 3) {
+    return undefined;
+  }
+  const [groupId, artifactId, versionId] = coordinates;
+  if (!groupId || !artifactId || !versionId || !path) {
+    return undefined;
+  }
+  return {
+    name: extractElementNameFromPath(path),
+    groupId,
+    artifactId,
+    versionId,
+    path,
+  };
+};
+
+export const splitRelatedDataSpaceEntries = (value: string): string[] =>
+  value
+    .split(RELATED_DATA_SPACE_ENTRY_SEPARATOR)
+    .map((entry) => entry.trim())
+    .filter((entry) => entry.length > 0);
+
+export const parseRelatedDataSpaceGAVs = (
+  value: string,
+): DataSpaceWikiRelatedDataSpace[] =>
+  splitRelatedDataSpaceEntries(value)
+    .map((entry) => parseRelatedDataSpaceGAV(entry))
+    .filter(isNonNullable);

package/src/stores/DataSpaceViewerState.ts

@@ -24,19 +24,27 @@ import {
   type GraphData,
   type GraphManagerState,
   type PackageableRuntime,
+  extractElementNameFromPath,
 } from '@finos/legend-graph';
-import { action, computed, flowResult, makeObservable, observable } from 'mobx';
+import {
+  action,
+  computed,
+  flow,
+  flowResult,
+  makeObservable,
+  observable,
+} from 'mobx';
 import {
   type DataSpaceAnalysisResult,
   type DataSpaceExecutionContextAnalysisResult,
   DataproductReferenceMetadata,
   LakehouseDataProductExecutableAccessorInfo,
 } from '../graph-manager/action/analytics/DataSpaceAnalysis.js';
-import { isSnapshotVersion } from '@finos/legend-server-depot';
 import {
-  PURE_DATA_SPACE_INFO_PROFILE_PATH,
-  PURE_DATA_SPACE_INFO_PROFILE_VERIFIED_STEREOTYPE,
-} from '../graph-manager/DSL_DataSpace_PureGraphManagerPlugin.js';
+  isSnapshotVersion,
+  resolveVersion,
+  type DepotServerClient,
+} from '@finos/legend-server-depot';
 import { DataSpaceViewerModelsDocumentationState } from './DataSpaceModelsDocumentationState.js';
 import { DataSpaceViewerDiagramViewerState } from './DataSpaceViewerDiagramViewerState.js';
 import {
@@ -44,8 +52,10 @@ import {
   DataSpaceLayoutState,
 } from './DataSpaceLayoutState.js';
 import {
+  type DataSpaceWikiRelatedDataSpace,
   DATA_SPACE_VIEWER_ACTIVITY_MODE,
   generateAnchorForActivity,
+  parseRelatedDataSpaceGAVs,
 } from './DataSpaceViewerNavigation.js';
 import { DataAccessState } from '@finos/legend-query-builder';
 import {
@@ -63,6 +73,14 @@ import {
   type DataSpaceQualityResult,
 } from './DataSpaceQualityState.js';
 import { BaseViewerState } from '@finos/legend-extension-dsl-data-product';
+import {
+  type GeneratorFn,
+  ActionState,
+  assertErrorThrown,
+  guaranteeNonNullable,
+  isString,
+} from '@finos/legend-shared';
+import { type Entity } from '@finos/legend-storage';
 
 export class DataSpaceViewerState extends BaseViewerState<
   DataSpaceAnalysisResult,
@@ -85,12 +103,14 @@ export class DataSpaceViewerState extends BaseViewerState<
   readonly viewDataProduct?:
     | ((dataProductPath: string, deploymentId: number) => void)
     | undefined;
+  readonly viewDataSpace?: ((gavPath: string) => void) | undefined;
   readonly mappingProviderAccessConfig?:
     | DataSpaceMappingProviderAccessConfig
     | undefined;
   readonly fetchDataSpaceQuality?:
     | (() => Promise<DataSpaceQualityResult>)
     | undefined;
+  readonly depotServerClient?: DepotServerClient | undefined;
 
   readonly diagramViewerState: DataSpaceViewerDiagramViewerState;
   readonly modelsDocumentationState: DataSpaceViewerModelsDocumentationState;
@@ -114,6 +134,9 @@ export class DataSpaceViewerState extends BaseViewerState<
    */
   dataProductAccessStates = new Map<string, DataSpaceDataProductAccessState>();
 
+  relatedDataSpaces: DataSpaceWikiRelatedDataSpace[] = [];
+  readonly fetchRelatedDataSpaceTitlesState = ActionState.create();
+
   constructor(
     applicationStore: GenericLegendApplicationStore,
     graphManagerState: GraphManagerState,
@@ -121,6 +144,7 @@ export class DataSpaceViewerState extends BaseViewerState<
     artifactId: string,
     versionId: string,
     dataSpaceAnalysisResult: DataSpaceAnalysisResult,
+    depotServerClient: DepotServerClient | undefined,
     actions: {
       retrieveGraphData: () => GraphData;
       queryDataSpace: (executionContextKey: string | undefined) => void;
@@ -135,6 +159,7 @@ export class DataSpaceViewerState extends BaseViewerState<
       viewDataProduct?:
         | ((dataProductPath: string, deploymentId: number) => void)
         | undefined;
+      viewDataSpace?: ((gavPath: string) => void) | undefined;
       mappingProviderAccessConfig?:
         | DataSpaceMappingProviderAccessConfig
         | undefined;
@@ -162,14 +187,15 @@ export class DataSpaceViewerState extends BaseViewerState<
       currentMappingProviderAccessState: computed,
       executableStates: observable,
       legendAIConfig: observable,
-      isVerified: computed,
       isDataAccessAvailable: computed,
       referencedDataProductPaths: computed,
+      relatedDataSpaces: observable,
       setCurrentActivity: action,
       setCurrentExecutionContext: action,
       setCurrentRuntime: action,
       refreshCurrentMappingProviderAccessState: action,
       refreshDataProductAccessState: action,
+      fetchRelatedDataSpaceTitles: flow,
     });
 
     this.graphManagerState = graphManagerState;
@@ -188,8 +214,10 @@ export class DataSpaceViewerState extends BaseViewerState<
     this.openServiceQuery = actions.openServiceQuery;
     this.onQuickStartTabChange = actions.onQuickStartTabChange;
     this.viewDataProduct = actions.viewDataProduct;
+    this.viewDataSpace = actions.viewDataSpace;
     this.mappingProviderAccessConfig = actions.mappingProviderAccessConfig;
     this.fetchDataSpaceQuality = actions.fetchDataSpaceQuality;
+    this.depotServerClient = depotServerClient;
 
     this.currentExecutionContext =
       dataSpaceAnalysisResult.defaultExecutionContext ??
@@ -241,16 +269,6 @@ export class DataSpaceViewerState extends BaseViewerState<
     );
   }
 
-  get isVerified(): boolean {
-    return Boolean(
-      this.dataSpaceAnalysisResult.stereotypes.find(
-        (stereotype) =>
-          stereotype.profile === PURE_DATA_SPACE_INFO_PROFILE_PATH &&
-          stereotype.value === PURE_DATA_SPACE_INFO_PROFILE_VERIFIED_STEREOTYPE,
-      ),
-    );
-  }
-
   override get documentationUrl(): string | undefined {
     return this.dataSpaceAnalysisResult.supportInfo?.documentationUrl;
   }
@@ -390,6 +408,50 @@ export class DataSpaceViewerState extends BaseViewerState<
     return paths;
   }
 
+  *fetchRelatedDataSpaceTitles(): GeneratorFn<void> {
+    if (!this.fetchRelatedDataSpaceTitlesState.isInInitialState) {
+      return;
+    }
+    const relatedDataSpaces = (
+      this.dataSpaceAnalysisResult.info?.relatedDataSpaces ?? []
+    ).flatMap((entry) => parseRelatedDataSpaceGAVs(entry));
+    this.fetchRelatedDataSpaceTitlesState.inProgress();
+    if (!this.depotServerClient) {
+      this.relatedDataSpaces = relatedDataSpaces;
+      this.fetchRelatedDataSpaceTitlesState.pass();
+      return;
+    }
+    const depotServerClient = this.depotServerClient;
+    const results = (yield Promise.allSettled(
+      relatedDataSpaces.map(async (relatedDataSpace) => {
+        const entity = await depotServerClient.getVersionEntity(
+          relatedDataSpace.groupId,
+          relatedDataSpace.artifactId,
+          resolveVersion(relatedDataSpace.versionId),
+          relatedDataSpace.path,
+        );
+        const content = entity.content as Entity['content'];
+        return {
+          ...relatedDataSpace,
+          name: isString(content.title) ? content.title : relatedDataSpace.name,
+        };
+      }),
+    )) as PromiseSettledResult<DataSpaceWikiRelatedDataSpace>[];
+    this.relatedDataSpaces = results.map((result, idx) => {
+      if (result.status === 'fulfilled') {
+        return result.value;
+      }
+      const relatedDataSpace = guaranteeNonNullable(relatedDataSpaces[idx]);
+      assertErrorThrown(result.reason);
+      return {
+        ...relatedDataSpace,
+        name: extractElementNameFromPath(relatedDataSpace.path),
+        isInvalid: true,
+      };
+    });
+    this.fetchRelatedDataSpaceTitlesState.pass();
+  }
+
   /**
    * Looks up the initialized access state for a Data Product path (may still
    * be initializing). Used by executable renderers to grab the state for a

package/src/stores/query/DataSpaceAdvancedSearchState.ts

@@ -206,6 +206,7 @@ export class DataSpaceAdvancedSearchState {
         artifactId,
         versionId,
         analysisResult,
+        this.depotServerClient,
         {
           retrieveGraphData: () =>
             new GraphDataWithOrigin(

package/src/stores/shared/DataSpaceInfo.ts

@@ -17,6 +17,7 @@
 import {
   SNAPSHOT_VERSION_ALIAS,
   type StoredEntity,
+  type StoredSummaryEntity,
 } from '@finos/legend-server-depot';
 import { isString } from '@finos/legend-shared';
 import {
@@ -68,3 +69,18 @@ export const extractDataSpaceInfo = (
       ? storedEntity.entity.content.defaultExecutionContext
       : undefined,
   );
+
+export const extractDataSpaceInfoFromSummary = (
+  storedSummaryEntity: StoredSummaryEntity,
+): ResolvedDataSpaceEntityWithOrigin =>
+  new ResolvedDataSpaceEntityWithOrigin(
+    {
+      groupId: storedSummaryEntity.groupId,
+      artifactId: storedSummaryEntity.artifactId,
+      versionId: storedSummaryEntity.versionId,
+    },
+    undefined,
+    extractEntityNameFromPath(storedSummaryEntity.path),
+    storedSummaryEntity.path,
+    undefined,
+  );

package/tsconfig.json

@@ -109,6 +109,7 @@
     "./src/components/DataSpacePlaceholder.tsx",
     "./src/components/DataSpaceQualityEmote.tsx",
     "./src/components/DataSpaceQuickStart.tsx",
+    "./src/components/DataSpaceRelatedDataSpaces.tsx",
     "./src/components/DataSpaceSupportPanel.tsx",
     "./src/components/DataSpaceViewer.tsx",
     "./src/components/DataSpaceViewerActivityBar.tsx",