@finos/legend-extension-dsl-data-space 9.1.4 → 9.1.6

package/src/application/studio/DSL_DataSpace_LegendStudioNavigation.ts

@@ -1,53 +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 {
-  generateExtensionUrlPattern,
-  generatePath,
-} from '@finos/legend-application';
-import { generateGAVCoordinates } from '@finos/legend-storage';
-
-export enum DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN {
-  GAV = 'gav',
-  DATA_SPACE_PATH = 'dataSpacePath',
-}
-
-export type DataSpacePreviewPathParams = {
-  [DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.GAV]: string;
-  [DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH]: string;
-};
-
-export const DATA_SPACE_STUDIO_ROUTE_PATTERN = Object.freeze({
-  PREVIEW: `/dataspace/preview/:${DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.GAV}/:${DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH}`,
-});
-
-export const generateDataSpacePreviewRoute = (
-  groupId: string,
-  artifactId: string,
-  versionId: string,
-  dataSpacePath: string,
-): string =>
-  generatePath(
-    generateExtensionUrlPattern(DATA_SPACE_STUDIO_ROUTE_PATTERN.PREVIEW),
-    {
-      [DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.GAV]: generateGAVCoordinates(
-        groupId,
-        artifactId,
-        versionId,
-      ),
-      [DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH]: dataSpacePath,
-    },
-  );

package/src/components/studio/DataSpacePreview.tsx

@@ -1,129 +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, useLocalObservable } from 'mobx-react-lite';
-import { useApplicationStore, useParams } from '@finos/legend-application';
-import { useDepotServerClient } from '@finos/legend-server-depot';
-import { parseGAVCoordinates } from '@finos/legend-storage';
-import { DataSpacePreviewStore } from '../../stores/studio/DataSpacePreviewStore.js';
-import { createContext, useContext, useEffect } from 'react';
-import { useLegendStudioApplicationStore } from '@finos/legend-application-studio';
-import {
-  DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN,
-  type DataSpacePreviewPathParams,
-} from '../../application/studio/DSL_DataSpace_LegendStudioNavigation.js';
-import { guaranteeNonNullable } from '@finos/legend-shared';
-import { flowResult } from 'mobx';
-import { DataSpaceViewer } from '../DataSpaceViewer.js';
-import {
-  BlankPanelContent,
-  PanelLoadingIndicator,
-  TimesCircleIcon,
-} from '@finos/legend-art';
-
-const DataSpacePreviewStoreContext = createContext<
-  DataSpacePreviewStore | undefined
->(undefined);
-
-const DataSpacePreviewStoreProvider: React.FC<{
-  children: React.ReactNode;
-  gav: string;
-  dataSpacePath: string;
-}> = ({ children, gav, dataSpacePath }) => {
-  const { groupId, artifactId, versionId } = parseGAVCoordinates(gav);
-  const applicationStore = useLegendStudioApplicationStore();
-  const depotServerClient = useDepotServerClient();
-  const store = useLocalObservable(
-    () =>
-      new DataSpacePreviewStore(
-        applicationStore,
-        depotServerClient,
-        groupId,
-        artifactId,
-        versionId,
-        dataSpacePath,
-      ),
-  );
-  return (
-    <DataSpacePreviewStoreContext.Provider value={store}>
-      {children}
-    </DataSpacePreviewStoreContext.Provider>
-  );
-};
-
-const useDataSpacePreviewStore = (): DataSpacePreviewStore =>
-  guaranteeNonNullable(
-    useContext(DataSpacePreviewStoreContext),
-    `Can't find data space preview store in context`,
-  );
-
-const DataSpacePreviewInner = observer(() => {
-  const previewStore = useDataSpacePreviewStore();
-  const applicationStore = useApplicationStore();
-
-  useEffect(() => {
-    flowResult(previewStore.initialize()).catch(
-      applicationStore.alertUnhandledError,
-    );
-  }, [applicationStore, previewStore]);
-
-  return (
-    <div className="data-space-preview">
-      <PanelLoadingIndicator
-        isLoading={previewStore.loadDataSpaceState.isInProgress}
-      />
-      {previewStore.dataSpaceViewerState && (
-        <DataSpaceViewer
-          dataSpaceViewerState={previewStore.dataSpaceViewerState}
-        />
-      )}
-      {!previewStore.dataSpaceViewerState && (
-        <>
-          {previewStore.loadDataSpaceState.isInProgress && (
-            <BlankPanelContent>
-              {previewStore.loadDataSpaceState.message}
-            </BlankPanelContent>
-          )}
-          {previewStore.loadDataSpaceState.hasFailed && (
-            <BlankPanelContent>
-              <div className="data-space-preview__failure">
-                <div className="data-space-preview__failure__icon">
-                  <TimesCircleIcon />
-                </div>
-                <div className="data-space-preview__failure__text">
-                  Can&apos;t load data space
-                </div>
-              </div>
-            </BlankPanelContent>
-          )}
-        </>
-      )}
-    </div>
-  );
-});
-
-export const DataSpacePreview = observer(() => {
-  const parameters = useParams<DataSpacePreviewPathParams>();
-  const gav = parameters[DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.GAV];
-  const dataSpacePath =
-    parameters[DATA_SPACE_STUDIO_ROUTE_PATTERN_TOKEN.DATA_SPACE_PATH];
-
-  return (
-    <DataSpacePreviewStoreProvider gav={gav} dataSpacePath={dataSpacePath}>
-      <DataSpacePreviewInner />
-    </DataSpacePreviewStoreProvider>
-  );
-});

package/src/stores/studio/DataSpacePreviewStore.ts

@@ -1,172 +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 {
-  retrieveProjectEntitiesWithDependencies,
-  type DepotServerClient,
-  ProjectData,
-} from '@finos/legend-server-depot';
-import type { LegendStudioApplicationStore } from '@finos/legend-application-studio';
-import {
-  ActionState,
-  assertErrorThrown,
-  type GeneratorFn,
-  type PlainObject,
-} from '@finos/legend-shared';
-import { flow, flowResult, makeObservable, observable } from 'mobx';
-import { DataSpaceViewerState } from '../DataSpaceViewerState.js';
-import { DSL_DataSpace_getGraphManagerExtension } from '../../graphManager/protocol/pure/DSL_DataSpace_PureGraphManagerExtension.js';
-import { BasicGraphManagerState } from '@finos/legend-graph';
-import { retrieveAnalyticsResultCache } from '../../graphManager/action/analytics/DataSpaceAnalysisHelper.js';
-import type { DataSpaceAnalysisResult } from '../../graphManager/action/analytics/DataSpaceAnalysis.js';
-import type { ClassView } from '@finos/legend-extension-dsl-diagram';
-import { TAB_SIZE } from '@finos/legend-application';
-
-export class DataSpacePreviewStore {
-  readonly applicationStore: LegendStudioApplicationStore;
-  readonly depotServerClient: DepotServerClient;
-  readonly graphManagerState: BasicGraphManagerState;
-
-  readonly groupId: string;
-  readonly artifactId: string;
-  readonly versionId: string;
-  readonly dataSpacePath: string;
-
-  readonly loadDataSpaceState = ActionState.create();
-  dataSpaceViewerState?: DataSpaceViewerState | undefined;
-
-  constructor(
-    applicationStore: LegendStudioApplicationStore,
-    depotServerClient: DepotServerClient,
-    groupId: string,
-    artifactId: string,
-    versionId: string,
-    dataSpacePath: string,
-  ) {
-    makeObservable(this, {
-      dataSpaceViewerState: observable,
-      initialize: flow,
-    });
-
-    this.applicationStore = applicationStore;
-    this.applicationStore.assistantService.setIsHidden(true);
-
-    this.depotServerClient = depotServerClient;
-    this.graphManagerState = new BasicGraphManagerState(
-      applicationStore.pluginManager,
-      applicationStore.logService,
-    );
-
-    this.groupId = groupId;
-    this.artifactId = artifactId;
-    this.versionId = versionId;
-    this.dataSpacePath = dataSpacePath;
-  }
-
-  *initialize(): GeneratorFn<void> {
-    this.loadDataSpaceState.inProgress();
-    this.loadDataSpaceState.setMessage(`Initializing...`);
-
-    try {
-      const groupId = this.groupId;
-      const artifactId = this.artifactId;
-      const versionId = this.versionId;
-
-      // initialize
-      yield this.graphManagerState.graphManager.initialize(
-        {
-          env: this.applicationStore.config.env,
-          tabSize: TAB_SIZE,
-          clientConfig: {
-            baseUrl: this.applicationStore.config.engineServerUrl,
-            queryBaseUrl: this.applicationStore.config.engineQueryServerUrl,
-            enableCompression: true,
-          },
-        },
-        {
-          tracerService: this.applicationStore.tracerService,
-        },
-      );
-
-      // fetch project
-      this.loadDataSpaceState.setMessage(`Fetching project...`);
-      const project = ProjectData.serialization.fromJson(
-        (yield flowResult(
-          this.depotServerClient.getProject(groupId, artifactId),
-        )) as PlainObject<ProjectData>,
-      );
-
-      // analyze data space
-      const analysisResult = (yield DSL_DataSpace_getGraphManagerExtension(
-        this.graphManagerState.graphManager,
-      ).analyzeDataSpace(
-        this.dataSpacePath,
-        () =>
-          retrieveProjectEntitiesWithDependencies(
-            project,
-            versionId,
-            this.depotServerClient,
-          ),
-        () =>
-          retrieveAnalyticsResultCache(
-            project,
-            versionId,
-            this.dataSpacePath,
-            this.depotServerClient,
-          ),
-        this.loadDataSpaceState,
-      )) as DataSpaceAnalysisResult;
-
-      this.dataSpaceViewerState = new DataSpaceViewerState(
-        this.applicationStore,
-        this.graphManagerState,
-        groupId,
-        artifactId,
-        versionId,
-        analysisResult,
-        {
-          viewProject: () => {
-            this.applicationStore.notificationService.notifyWarning(
-              'This feature is not supported in preview mode',
-            );
-          },
-          viewSDLCProject: async () => {
-            this.applicationStore.notificationService.notifyWarning(
-              'This feature is not supported in preview mode',
-            );
-          },
-          onDiagramClassDoubleClick: (classView: ClassView): void => {
-            this.applicationStore.notificationService.notifyWarning(
-              'This feature is not supported in preview mode',
-            );
-          },
-        },
-        {
-          HACKY__previewExperimentalFeatures:
-            this.applicationStore.config.options
-              .HACKY__previewExperimentalFeatures,
-        },
-      );
-      this.loadDataSpaceState.pass();
-    } catch (error) {
-      assertErrorThrown(error);
-      this.loadDataSpaceState.fail();
-      this.applicationStore.notificationService.notifyError(error);
-    } finally {
-      this.loadDataSpaceState.setMessage(undefined);
-    }
-  }
-}