@finos/legend-application-studio 28.21.4 → 28.21.6

package/src/stores/editor/sidebar-state/dev-metadata/DevMetadataState.ts

@@ -20,6 +20,7 @@ import {
   assertNonNullable,
   assertTrue,
   type GeneratorFn,
+  type PlainObject,
 } from '@finos/legend-shared';
 import type { EditorStore } from '../../EditorStore.js';
 import { action, flow, makeObservable, observable } from 'mobx';
@@ -27,14 +28,24 @@ import {
   type DeployProjectResponse,
   MetadataRequestOptions,
 } from '@finos/legend-graph';
+import type { Entity } from '@finos/legend-storage';
 import { LegendStudioTelemetryHelper } from '../../../../__lib__/LegendStudioTelemetryHelper.js';
 
+export const DEV_SNAPSHOT_VERSION = '1.0.0-SNAPSHOT';
+
 export class DevMetadataState {
   readonly editorStore: EditorStore;
   result: DeployProjectResponse | undefined;
   options: MetadataRequestOptions = new MetadataRequestOptions();
   pushState = ActionState.create();
 
+  // Compare-with-dev state
+  compareState = ActionState.create();
+  currentWorkspaceCode: string | undefined;
+  snapshotCode: string | undefined;
+  snapshotNotAvailable = false;
+  isCompareModalOpen = false;
+
   constructor(editorStore: EditorStore) {
     this.editorStore = editorStore;
 
@@ -43,6 +54,14 @@ export class DevMetadataState {
       push: flow,
       options: observable,
       setOptions: action,
+      compareState: observable,
+      currentWorkspaceCode: observable,
+      snapshotCode: observable,
+      snapshotNotAvailable: observable,
+      isCompareModalOpen: observable,
+      openCompareModal: action,
+      closeCompareModal: action,
+      compareWithSnapshot: flow,
     });
   }
 
@@ -50,6 +69,14 @@ export class DevMetadataState {
     this.options = options;
   }
 
+  openCompareModal(): void {
+    this.isCompareModalOpen = true;
+  }
+
+  closeCompareModal(): void {
+    this.isCompareModalOpen = false;
+  }
+
   get projectGAV(): { groupId: string; artifactId: string } | undefined {
     const currentProjectConfiguration =
       this.editorStore.projectConfigurationEditorState.projectConfiguration;
@@ -62,6 +89,55 @@ export class DevMetadataState {
     return undefined;
   }
 
+  *compareWithSnapshot(): GeneratorFn<void> {
+    try {
+      this.compareState.inProgress();
+      this.snapshotNotAvailable = false;
+      this.currentWorkspaceCode = undefined;
+      this.snapshotCode = undefined;
+      const gav = this.projectGAV;
+      assertNonNullable(gav, 'Project configuration is required to compare');
+      const graphManager = this.editorStore.graphManagerState.graphManager;
+
+      // 1) Current workspace -> Pure code (same as toggling to text mode)
+      const currentCode = (yield graphManager.graphToPureCode(
+        this.editorStore.graphManagerState.graph,
+        { pretty: true, excludeUnknown: true },
+      )) as string;
+      this.currentWorkspaceCode = currentCode;
+
+      // 2) Snapshot from depot -> Pure code; if the call fails we treat
+      // it as "nothing deployed yet"
+      let snapshotEntities: Entity[] | undefined;
+      try {
+        const entitiesJson =
+          (yield this.editorStore.depotServerClient.getVersionEntities(
+            gav.groupId,
+            gav.artifactId,
+            DEV_SNAPSHOT_VERSION,
+          )) as PlainObject<Entity>[];
+        snapshotEntities = entitiesJson as unknown as Entity[];
+      } catch {
+        this.snapshotNotAvailable = true;
+        this.compareState.complete();
+        return;
+      }
+
+      const snapshotCode = (yield graphManager.entitiesToPureCode(
+        snapshotEntities,
+        { pretty: true },
+      )) as string;
+      this.snapshotCode = snapshotCode;
+      this.compareState.complete();
+    } catch (error) {
+      assertErrorThrown(error);
+      this.editorStore.applicationStore.notificationService.notifyError(
+        `Error comparing with dev snapshot: ${error.message}`,
+      );
+      this.compareState.fail();
+    }
+  }
+
   *push(): GeneratorFn<void> {
     try {
       this.result = undefined;
@@ -80,6 +156,13 @@ export class DevMetadataState {
         'Project Name required to push to dev mode',
       );
       this.pushState.inProgress();
+      LegendStudioTelemetryHelper.logEvent_DevMetadataPushLaunched(
+        this.editorStore.applicationStore.telemetryService,
+        this.editorStore.editorMode.getSourceInfo(),
+        currentProjectConfiguration.groupId,
+        currentProjectConfiguration.artifactId,
+        undefined,
+      );
       const result =
         (yield this.editorStore.graphManagerState.graphManager.pushToDevMetadata(
           currentProjectConfiguration.groupId,
@@ -89,7 +172,7 @@ export class DevMetadataState {
           this.editorStore.graphManagerState.graph,
         )) as DeployProjectResponse;
       this.result = result;
-      LegendStudioTelemetryHelper.logEvent_DevMetadataPushLaunched(
+      LegendStudioTelemetryHelper.logEvent_DevMetadataPushSucceeded(
         this.editorStore.applicationStore.telemetryService,
         this.editorStore.editorMode.getSourceInfo(),
         currentProjectConfiguration.groupId,

package/src/stores/project-reviewer/ProjectReviewerStore.ts

@@ -45,6 +45,7 @@ import {
   ReviewApproval,
 } from '@finos/legend-server-sdlc';
 import { LEGEND_STUDIO_APP_EVENT } from '../../__lib__/LegendStudioEvent.js';
+import { LegendStudioUserDataHelper } from '../../__lib__/LegendStudioUserDataHelper.js';
 import { DEFAULT_TAB_SIZE } from '@finos/legend-application';
 import type { Entity } from '@finos/legend-storage';
 import { EntityDiffViewState } from '../editor/editor-state/entity-diff-editor-state/EntityDiffViewState.js';
@@ -457,6 +458,20 @@ export class ProjectReviewerStore {
           { message: `${this.review.title} [review]` },
         )) as PlainObject<Review>,
       );
+      // Committing a review deletes its workspace on SDLC. Drop the
+      // matching entry from the local recents cache (no-op if it wasn't
+      // there, e.g., the reviewer isn't the workspace author). Patch
+      // workspaces are never cached.
+      if (this.patchReleaseVersionId === undefined) {
+        LegendStudioUserDataHelper.workspaceSetup_removeRecentWorkspace(
+          this.editorStore.applicationStore.userDataService,
+          {
+            projectId: this.projectId,
+            workspaceId: this.review.workspaceId,
+            workspaceType: this.review.workspaceType,
+          },
+        );
+      }
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.logService.error(

package/src/stores/workspace-setup/WorkspaceSetupStore.ts

@@ -51,6 +51,11 @@ import {
   ProjectConfigurationStatus,
 } from './ProjectConfigurationStatus.js';
 import { GraphManagerState } from '@finos/legend-graph';
+import {
+  LegendStudioUserDataHelper,
+  type RecentProjectEntry,
+  type RecentWorkspaceEntry,
+} from '../../__lib__/LegendStudioUserDataHelper.js';
 
 interface ImportProjectSuccessReport {
   projectId: string;
@@ -92,6 +97,12 @@ export class WorkspaceSetupStore {
 
   graphManagerState: GraphManagerState;
 
+  // Cached recents to make re-opening a project/workspace instantaneous.
+  // NOTE: patch-based workspaces are intentionally excluded from this cache.
+  recentProjects: RecentProjectEntry[] = [];
+  recentWorkspaces: RecentWorkspaceEntry[] = [];
+  selectRecentProjectState = ActionState.create();
+
   constructor(
     applicationStore: LegendStudioApplicationStore,
     sdlcServerClient: SDLCServerClient,
@@ -113,6 +124,8 @@ export class WorkspaceSetupStore {
       enginePromise: observable,
       sandboxModal: observable,
       hasSandboxAccess: observable,
+      recentProjects: observable,
+      recentWorkspaces: observable,
       setShowCreateProjectModal: action,
       setShowCreateWorkspaceModal: action,
       setShowAdvancedWorkspaceFilterOptions: action,
@@ -121,6 +134,9 @@ export class WorkspaceSetupStore {
       changeWorkspace: action,
       resetProject: action,
       resetWorkspace: action,
+      removeRecentProject: action,
+      removeRecentWorkspace: action,
+      clearRecents: action,
       initialize: flow,
       loadProjects: flow,
       loadSandboxProject: flow,
@@ -130,6 +146,7 @@ export class WorkspaceSetupStore {
       createSandboxProject: flow,
       createWorkspace: flow,
       initializeEngine: flow,
+      selectRecentProject: flow,
     });
 
     this.applicationStore = applicationStore;
@@ -138,6 +155,14 @@ export class WorkspaceSetupStore {
       applicationStore.pluginManager,
       applicationStore.logService,
     );
+    this.recentProjects =
+      LegendStudioUserDataHelper.workspaceSetup_getRecentProjects(
+        applicationStore.userDataService,
+      );
+    this.recentWorkspaces =
+      LegendStudioUserDataHelper.workspaceSetup_getRecentWorkspaces(
+        applicationStore.userDataService,
+      );
     if (this.supportsCreatingSandboxProject) {
       flowResult(this.initializeEngine()).catch(
         applicationStore.alertUnhandledError,
@@ -197,6 +222,67 @@ export class WorkspaceSetupStore {
     this.sandboxModal = val;
   }
 
+  // --- Recents -------------------------------------------------------------
+  // NOTE: writes to the recents cache happen from the editor (see
+  // `EditorStore.initialize`) at the moment a workspace is actually opened.
+  // This store only reads the cache (to seed dropdowns) and prunes entries
+  // that are discovered to be stale.
+
+  removeRecentProject(projectId: string): void {
+    const updated =
+      LegendStudioUserDataHelper.workspaceSetup_removeRecentProject(
+        this.applicationStore.userDataService,
+        projectId,
+      );
+    this.recentProjects = updated.projects;
+    this.recentWorkspaces = updated.workspaces;
+  }
+
+  removeRecentWorkspace(entry: {
+    projectId: string;
+    workspaceId: string;
+    workspaceType: WorkspaceType;
+  }): void {
+    this.recentWorkspaces =
+      LegendStudioUserDataHelper.workspaceSetup_removeRecentWorkspace(
+        this.applicationStore.userDataService,
+        entry,
+      );
+  }
+
+  clearRecents(): void {
+    LegendStudioUserDataHelper.workspaceSetup_clearRecents(
+      this.applicationStore.userDataService,
+    );
+    this.recentProjects = [];
+    this.recentWorkspaces = [];
+  }
+
+  /**
+   * Fetches a project by id (used when the user picks a cached "recent"
+   * project that may not be in the current search results) and switches to
+   * it. If the project no longer exists, the entry is pruned from recents.
+   */
+  *selectRecentProject(projectId: string): GeneratorFn<void> {
+    this.selectRecentProjectState.inProgress();
+    try {
+      const project = Project.serialization.fromJson(
+        (yield this.sdlcServerClient.getProject(
+          projectId,
+        )) as PlainObject<Project>,
+      );
+      yield flowResult(this.changeProject(project));
+      this.selectRecentProjectState.pass();
+    } catch (error) {
+      assertErrorThrown(error);
+      this.removeRecentProject(projectId);
+      this.applicationStore.notificationService.notifyWarning(
+        `Recent project could not be opened and was removed from recents`,
+      );
+      this.selectRecentProjectState.fail();
+    }
+  }
+
   *createSandboxProject(): GeneratorFn<void> {
     try {
       if (!this.hasSandboxAccess) {
@@ -277,6 +363,7 @@ export class WorkspaceSetupStore {
             )) as PlainObject<Project>,
           );
         } catch {
+          this.removeRecentProject(projectId);
           this.applicationStore.navigationService.navigator.updateCurrentLocation(
             generateSetupRoute(undefined, undefined),
           );
@@ -513,6 +600,12 @@ export class WorkspaceSetupStore {
         if (matchingWorkspace) {
           this.changeWorkspace(matchingWorkspace);
         } else {
+          // Workspace no longer exists — prune from recents.
+          this.removeRecentWorkspace({
+            projectId: project.projectId,
+            workspaceId: workspaceInfo.workspaceId,
+            workspaceType: workspaceInfo.workspaceType,
+          });
           this.applicationStore.navigationService.navigator.updateCurrentLocation(
             generateSetupRoute(project.projectId, undefined),
           );

package/tsconfig.json

@@ -374,6 +374,7 @@
     "./src/components/workspace-setup/CreateProjectModal.tsx",
     "./src/components/workspace-setup/CreateWorkspaceModal.tsx",
     "./src/components/workspace-setup/ProjectSelectorUtils.tsx",
+    "./src/components/workspace-setup/RecentWorkspacesPanel.tsx",
     "./src/components/workspace-setup/WorkspaceSelectorUtils.tsx",
     "./src/components/workspace-setup/WorkspaceSetup.tsx"
   ],