@finos/legend-application-studio 22.3.7 → 22.4.0

package/src/components/editor/side-bar/ProjectOverview.tsx

@@ -56,6 +56,7 @@ import {
 import { useEditorStore } from '../EditorStoreProvider.js';
 import { useApplicationStore } from '@finos/legend-application';
 import { useLegendStudioApplicationStore } from '../../LegendStudioBaseStoreProvider.js';
+import { ProjectDependantsEditor } from './ProjectDependantsEditor.js';
 
 const ShareProjectModal = observer(
   (props: { open: boolean; closeModal: () => void }) => {
@@ -811,6 +812,7 @@ export const ProjectOverviewActivityBar = observer(() => {
       mode: PROJECT_OVERVIEW_ACTIVITY_MODE.RELEASE,
       title: 'Release',
     },
+    { mode: PROJECT_OVERVIEW_ACTIVITY_MODE.DEPENDANTS, title: 'Dependants' },
     { mode: PROJECT_OVERVIEW_ACTIVITY_MODE.VERSIONS, title: 'Versions' },
     { mode: PROJECT_OVERVIEW_ACTIVITY_MODE.WORKSPACES, title: 'Workspaces' },
   ].filter((activity): activity is ProjectOverviewActivityDisplay =>
@@ -861,6 +863,8 @@ export const ProjectOverview = observer(() => {
         return <OverviewViewer />;
       case PROJECT_OVERVIEW_ACTIVITY_MODE.RELEASE:
         return <ReleaseEditor />;
+      case PROJECT_OVERVIEW_ACTIVITY_MODE.DEPENDANTS:
+        return <ProjectDependantsEditor />;
       case PROJECT_OVERVIEW_ACTIVITY_MODE.VERSIONS:
         return <VersionsViewer />;
       case PROJECT_OVERVIEW_ACTIVITY_MODE.WORKSPACES:

package/src/stores/ExplorerTreeState.ts

@@ -78,6 +78,7 @@ export class ExplorerTreeState {
       dependencyTreeData: observable.ref,
       selectedNode: observable.ref,
       fileGenerationTreeData: observable.ref,
+      elementToRename: observable.ref,
       setTreeData: action,
       setGenerationTreeData: action,
       setSystemTreeData: action,

package/src/stores/LegendStudioRouter.ts

@@ -51,6 +51,8 @@ export const LEGEND_STUDIO_SDLC_BYPASSED_ROUTE_PATTERN = Object.freeze({
   VIEW_BY_GAV_ENTITY: `/view/archive/:${LEGEND_STUDIO_PATH_PARAM_TOKEN.GAV}/entity/:${LEGEND_STUDIO_PATH_PARAM_TOKEN.ENTITY_PATH}`,
 });
 
+export const LEGEND_DEPENDENCY_ROUTE_PATTERN = `/dependencies/:${LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID}?/:${LEGEND_STUDIO_PATH_PARAM_TOKEN.GAV}?/:testsBatchId?`;
+
 export interface ReviewPathParams {
   [LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID]: string;
   [LEGEND_STUDIO_PATH_PARAM_TOKEN.REVIEW_ID]: string;
@@ -229,3 +231,43 @@ export const generateViewRevisionRoute = (
         revisionId,
         entityPath,
       });
+
+const generateDependencyDashboardGavRoute = (
+  projectId: string,
+  groupId: string,
+  artifactId: string,
+  versionId?: string,
+  testsBatchId?: string | undefined,
+): string => {
+  if (testsBatchId) {
+    return generatePath(LEGEND_DEPENDENCY_ROUTE_PATTERN, {
+      projectId: projectId,
+      gav: generateGAVCoordinates(groupId, artifactId, versionId),
+      testsBatchId: testsBatchId,
+    });
+  }
+  return generatePath(LEGEND_DEPENDENCY_ROUTE_PATTERN, {
+    projectId: projectId,
+    gav: generateGAVCoordinates(groupId, artifactId, versionId),
+  });
+};
+
+export const generateDependencyDashboardRoute = (
+  projectId?: string | undefined,
+  groupId?: string | undefined,
+  artifactId?: string | undefined,
+  versionId?: string | undefined,
+  testsBatchId?: string | undefined,
+): string => {
+  if (groupId && artifactId && projectId) {
+    return generateDependencyDashboardGavRoute(
+      projectId,
+      groupId,
+      artifactId,
+      versionId,
+      testsBatchId ?? undefined,
+    );
+  } else {
+    return generatePath(LEGEND_DEPENDENCY_ROUTE_PATTERN);
+  }
+};

package/src/stores/editor-state/element-editor-state/service/ServiceExecutionState.ts

@@ -132,7 +132,7 @@ export class ServiceExecutionParameterState extends LambdaParametersState {
         flowResult(this.executionState.runQuery()).catch(
           this.executionState.editorStore.applicationStore.alertUnhandledError,
         ),
-      PARAMETER_SUBMIT_ACTION.EXECUTE,
+      PARAMETER_SUBMIT_ACTION.RUN,
     );
   }
 

package/src/stores/sidebar-state/ProjectDependantEditorState.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { EditorStore } from '../EditorStore.js';
+import { observable, makeObservable, action } from 'mobx';
+import { ActionState } from '@finos/legend-shared';
+import type { ProjectVersionPlatformDependency } from '@finos/legend-server-depot';
+import type { ProjectConfiguration } from '@finos/legend-server-sdlc';
+import type { ProjectOverviewState } from './ProjectOverviewState.js';
+
+export class ProjectDependantEditorState {
+  configState: ProjectOverviewState;
+  editorStore: EditorStore;
+  isReadOnly: boolean;
+  dependants: ProjectVersionPlatformDependency[] | undefined;
+  fetchingDependantInfoState = ActionState.create();
+
+  constructor(configState: ProjectOverviewState, editorStore: EditorStore) {
+    makeObservable(this, {
+      dependants: observable,
+      fetchingDependantInfoState: observable,
+      setDependants: action,
+    });
+    this.configState = configState;
+    this.editorStore = editorStore;
+    this.isReadOnly = editorStore.isInViewerMode;
+  }
+
+  get projectConfiguration(): ProjectConfiguration | undefined {
+    return this.editorStore.projectConfigurationEditorState
+      .projectConfiguration;
+  }
+
+  setDependants(value: ProjectVersionPlatformDependency[] | undefined): void {
+    this.dependants = value;
+  }
+}

package/src/stores/sidebar-state/ProjectOverviewState.ts

@@ -37,10 +37,17 @@ import {
   areWorkspacesEquivalent,
 } from '@finos/legend-server-sdlc';
 import { LEGEND_STUDIO_APP_EVENT } from '../LegendStudioAppEvent.js';
+import { ProjectDependantEditorState } from './ProjectDependantEditorState.js';
+import {
+  ProjectData,
+  ProjectVersionPlatformDependency,
+} from '@finos/legend-server-depot';
+import { compareSemVerVersions } from '@finos/legend-storage';
 
 export enum PROJECT_OVERVIEW_ACTIVITY_MODE {
   RELEASE = 'RELEASE',
   OVERVIEW = 'OVERVIEW',
+  DEPENDANTS = 'DEPENDANTS',
   VERSIONS = 'VERSIONS',
   WORKSPACES = 'WORKSPACES',
 }
@@ -54,6 +61,7 @@ export class ProjectOverviewState {
   latestProjectVersion?: Version | null; // `undefined` if API is not yet called, `null` if fetched but no version exists
   currentProjectRevision?: Revision | undefined;
   projectWorkspaces: Workspace[] = [];
+  projectDependantEditorState: ProjectDependantEditorState;
 
   isCreatingVersion = false;
   isFetchingProjectWorkspaces = false;
@@ -76,17 +84,23 @@ export class ProjectOverviewState {
       isUpdatingProject: observable,
       isFetchingLatestVersion: observable,
       isFetchingCurrentProjectRevision: observable,
+      projectDependantEditorState: observable,
       setActivityMode: action,
       fetchProjectWorkspaces: flow,
       deleteWorkspace: flow,
       updateProject: flow,
       fetchLatestProjectVersion: flow,
+      fetchDependants: flow,
       createVersion: flow,
     });
 
     this.editorStore = editorStore;
     this.sdlcState = sdlcState;
     this.releaseVersion = new CreateVersionCommand();
+    this.projectDependantEditorState = new ProjectDependantEditorState(
+      this,
+      this.editorStore,
+    );
   }
 
   setActivityMode(activityMode: PROJECT_OVERVIEW_ACTIVITY_MODE): void {
@@ -183,6 +197,80 @@ export class ProjectOverviewState {
     }
   }
 
+  *fetchDependants(): GeneratorFn<void> {
+    const groupId =
+      this.editorStore.projectConfigurationEditorState
+        .currentProjectConfiguration.groupId;
+    const artifactId =
+      this.editorStore.projectConfigurationEditorState
+        .currentProjectConfiguration.artifactId;
+    const version = this.editorStore.sdlcState.projectVersions[0]?.id.id;
+
+    if (!groupId || !artifactId || !version) {
+      return;
+    }
+
+    try {
+      this.projectDependantEditorState.fetchingDependantInfoState.inProgress();
+
+      const fetchedDependants = (
+        (yield this.editorStore.depotServerClient.getIndexedDependantProjects(
+          groupId,
+          artifactId,
+          version,
+        )) as PlainObject<ProjectVersionPlatformDependency>[]
+      )
+        .map((v) => ProjectVersionPlatformDependency.serialization.fromJson(v))
+        .sort(
+          (
+            a: { groupId: string; artifactId: string },
+            b: { groupId: string; artifactId: string },
+          ) => (a.groupId + a.artifactId > b.groupId + b.artifactId ? 1 : -1),
+        )
+        .sort((a: { versionId: string }, b: { versionId: string }) =>
+          compareSemVerVersions(a.versionId, b.versionId) > 0 ? 1 : -1,
+        )
+        .filter(
+          (filteredDependant: ProjectVersionPlatformDependency) =>
+            filteredDependant.versionId !== 'master-SNAPSHOT',
+        );
+
+      const uniqueProjects = [
+        ...new Map(
+          fetchedDependants.map((item: ProjectVersionPlatformDependency) => [
+            `${item.groupId}:${item.artifactId}`,
+            item,
+          ]),
+        ).values(),
+      ];
+
+      this.projectDependantEditorState.setDependants(uniqueProjects);
+      this.projectDependantEditorState.dependants?.map(
+        async (dependant: ProjectVersionPlatformDependency): Promise<void> => {
+          try {
+            const project = ProjectData.serialization.fromJson(
+              await this.editorStore.depotServerClient.getProject(
+                dependant.groupId,
+                dependant.artifactId,
+              ),
+            );
+            dependant.projectId = project.projectId;
+          } catch (error) {
+            assertErrorThrown(error);
+          }
+        },
+      );
+      this.projectDependantEditorState.fetchingDependantInfoState.complete();
+    } catch (error) {
+      assertErrorThrown(error);
+      this.projectDependantEditorState.fetchingDependantInfoState.fail();
+      this.editorStore.applicationStore.log.error(
+        LogEvent.create(LEGEND_STUDIO_APP_EVENT.DEPOT_MANAGER_FAILURE),
+        error,
+      );
+    }
+  }
+
   *fetchLatestProjectVersion(): GeneratorFn<void> {
     try {
       this.isFetchingLatestVersion = true;

package/tsconfig.json

@@ -141,6 +141,7 @@
     "./src/stores/shared/modifier/Testable_GraphModifierHelper.ts",
     "./src/stores/shared/testable/TestableUtils.ts",
     "./src/stores/sidebar-state/LocalChangesState.ts",
+    "./src/stores/sidebar-state/ProjectDependantEditorState.ts",
     "./src/stores/sidebar-state/ProjectOverviewState.ts",
     "./src/stores/sidebar-state/WorkflowManagerState.ts",
     "./src/stores/sidebar-state/WorkspaceReviewState.ts",
@@ -238,6 +239,7 @@
     "./src/components/editor/side-bar/CreateNewElementModal.tsx",
     "./src/components/editor/side-bar/Explorer.tsx",
     "./src/components/editor/side-bar/LocalChanges.tsx",
+    "./src/components/editor/side-bar/ProjectDependantsEditor.tsx",
     "./src/components/editor/side-bar/ProjectOverview.tsx",
     "./src/components/editor/side-bar/SideBar.tsx",
     "./src/components/editor/side-bar/WorkflowManager.tsx",