@finos/legend-application-studio 18.1.0 → 19.1.0

package/src/stores/project-viewer/ProjectViewerStore.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { action, flowResult, makeAutoObservable, observable } from 'mobx';
+import { computed, flow, flowResult, makeObservable, observable } from 'mobx';
 import type { EditorStore } from '../EditorStore.js';
 import {
   type GeneratorFn,
@@ -68,20 +68,32 @@ interface ProjectViewerGraphBuilderMaterial {
 }
 
 export class ProjectViewerStore {
-  editorStore: EditorStore;
+  readonly editorStore: EditorStore;
   currentRevision?: Revision | undefined;
   latestVersion?: Version | undefined;
   revision?: Revision | undefined;
   version?: Version | undefined;
-  elementPath?: string | undefined;
+  initialEntityPath?: string | undefined;
   projectGAVCoordinates?: ProjectGAVCoordinates | undefined;
   workflowManagerState: WorkflowManagerState | undefined;
 
   constructor(editorStore: EditorStore) {
-    makeAutoObservable(this, {
-      editorStore: false,
+    makeObservable<
+      ProjectViewerStore,
+      'initializeWithProjectInformation' | 'initializeWithGAV'
+    >(this, {
+      currentRevision: observable,
+      latestVersion: observable,
+      revision: observable,
+      version: observable,
       projectGAVCoordinates: observable.ref,
-      internalizeEntityPath: action,
+      workflowManagerState: observable.ref,
+      onLatestVersion: computed,
+      onCurrentRevision: computed,
+      initializeWithProjectInformation: flow,
+      initializeWithGAV: flow,
+      buildGraph: flow,
+      initialize: flow,
     });
 
     this.editorStore = editorStore;
@@ -92,6 +104,7 @@ export class ProjectViewerStore {
       this.latestVersion && this.version && this.latestVersion === this.version,
     );
   }
+
   get onCurrentRevision(): boolean {
     return Boolean(
       this.currentRevision &&
@@ -110,9 +123,9 @@ export class ProjectViewerStore {
   internalizeEntityPath(params: ViewerPathParams): void {
     const { gav, projectId, revisionId, versionId, entityPath } = params;
     if (entityPath) {
-      this.elementPath = entityPath;
+      this.initialEntityPath = entityPath;
       if (projectId) {
-        this.editorStore.applicationStore.navigator.goToLocation(
+        this.editorStore.applicationStore.navigator.updateCurrentLocation(
           versionId
             ? generateViewVersionRoute(projectId, versionId)
             : revisionId
@@ -125,35 +138,13 @@ export class ProjectViewerStore {
           artifactId,
           versionId: _versionId,
         } = parseGAVCoordinates(gav);
-        this.editorStore.applicationStore.navigator.goToLocation(
+        this.editorStore.applicationStore.navigator.updateCurrentLocation(
           generateViewProjectByGAVRoute(groupId, artifactId, _versionId),
         );
       }
     }
   }
 
-  private *initializeGraphManagerState(): GeneratorFn<void> {
-    // setup engine
-    yield this.editorStore.graphManagerState.graphManager.initialize(
-      {
-        env: this.editorStore.applicationStore.config.env,
-        tabSize: TAB_SIZE,
-        clientConfig: {
-          baseUrl: this.editorStore.applicationStore.config.engineServerUrl,
-          queryBaseUrl:
-            this.editorStore.applicationStore.config.engineQueryServerUrl,
-          enableCompression: true,
-        },
-      },
-      {
-        tracerService: this.editorStore.applicationStore.tracerService,
-      },
-    );
-
-    // initialize graph manager
-    yield this.editorStore.graphManagerState.initializeSystem();
-  }
-
   /**
    * Initialize the graph by fetching project information from the SDLC server.
    */
@@ -357,8 +348,23 @@ export class ProjectViewerStore {
     try {
       const stopWatch = new StopWatch();
 
-      // initialize system
-      yield flowResult(this.initializeGraphManagerState());
+      // initialize graph manager
+      yield this.editorStore.graphManagerState.graphManager.initialize(
+        {
+          env: this.editorStore.applicationStore.config.env,
+          tabSize: TAB_SIZE,
+          clientConfig: {
+            baseUrl: this.editorStore.applicationStore.config.engineServerUrl,
+            queryBaseUrl:
+              this.editorStore.applicationStore.config.engineQueryServerUrl,
+            enableCompression: true,
+          },
+        },
+        {
+          tracerService: this.editorStore.applicationStore.tracerService,
+        },
+      );
+      yield this.editorStore.graphManagerState.initializeSystem();
 
       // reset
       this.editorStore.graphManagerState.resetGraph();
@@ -549,22 +555,40 @@ export class ProjectViewerStore {
       if (
         this.editorStore.graphManagerState.graphBuildState.hasSucceeded &&
         this.editorStore.explorerTreeState.buildState.hasCompleted &&
-        this.elementPath
+        this.initialEntityPath
       ) {
         try {
-          const element = this.editorStore.graphManagerState.graph.getElement(
-            this.elementPath,
+          this.editorStore.openElement(
+            this.editorStore.graphManagerState.graph.getElement(
+              this.initialEntityPath,
+            ),
           );
-          this.editorStore.openElement(element);
         } catch {
-          const elementPath = this.elementPath;
-          this.elementPath = undefined;
+          const elementPath = this.initialEntityPath;
+          this.initialEntityPath = undefined;
           throw new AssertionError(
-            `Can't find element '${elementPath}' in project '${this.editorStore.sdlcState.activeProject.projectId}'`,
+            `Can't find element with path '${elementPath}'`,
           );
         }
       }
-      this.initWorkflowManagerState();
+
+      // initialize workflow manager
+      // NOTE: We will not show workflow viewer when `GAV` coordinates are provided
+      // as we don't know which sdlc instance to fetch from.
+      // Revision will be supported once `SDLC` adds the workflow apis.
+      if (this.version) {
+        this.workflowManagerState = new ProjectVersionWorkflowManagerState(
+          this.editorStore,
+          this.editorStore.sdlcState,
+          this.version,
+        );
+      } else if (!this.projectGAVCoordinates && !this.revision) {
+        this.workflowManagerState = new ProjectWorkflowManagerState(
+          this.editorStore,
+          this.editorStore.sdlcState,
+        );
+      }
+
       onLeave(true);
     } catch (error) {
       assertErrorThrown(error);
@@ -576,22 +600,4 @@ export class ProjectViewerStore {
       onLeave(false);
     }
   }
-
-  initWorkflowManagerState(): void {
-    // NOTE: We will not show workflow viewer when `GAV` coordinates are provided
-    // as we don't know which sdlc instance to fetch from.
-    // Revision will be supported once `SDLC` adds the workflow apis.
-    if (this.version) {
-      this.workflowManagerState = new ProjectVersionWorkflowManagerState(
-        this.editorStore,
-        this.editorStore.sdlcState,
-        this.version,
-      );
-    } else if (!this.projectGAVCoordinates && !this.revision) {
-      this.workflowManagerState = new ProjectWorkflowManagerState(
-        this.editorStore,
-        this.editorStore.sdlcState,
-      );
-    }
-  }
 }

package/src/stores/shared/MockDataUtils.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
-import { format, addDays } from 'date-fns';
 import {
+  addDays,
   assertErrorThrown,
+  formatDate,
   Randomizer,
   UnsupportedOperationError,
 } from '@finos/legend-shared';
@@ -54,7 +55,7 @@ export const createMockPrimitiveProperty = (
     // NOTE that `Date` is the umbrella type that comprises `StrictDate` and `DateTime`, but for simplicity, we will generate `Date` as `StrictDate`
     case PRIMITIVE_TYPE.DATE:
     case PRIMITIVE_TYPE.STRICTDATE:
-      return format(
+      return formatDate(
         randomizer.getRandomDate(
           new Date(Date.now()),
           addDays(Date.now(), 100),
@@ -62,7 +63,7 @@ export const createMockPrimitiveProperty = (
         DATE_FORMAT,
       );
     case PRIMITIVE_TYPE.DATETIME:
-      return format(
+      return formatDate(
         randomizer.getRandomDate(
           new Date(Date.now()),
           addDays(Date.now(), 100),

package/src/stores/shared/PackageTreeUtils.ts

@@ -40,6 +40,7 @@ import {
   FileGenerationSpecification,
   GenerationSpecification,
   DataElement,
+  generateFunctionPrettyName,
 } from '@finos/legend-graph';
 
 const getElementProjectExplorerDnDType = (
@@ -105,6 +106,14 @@ export const getSelectedPackageTreeNodePackage = (
       : node.packageableElement.package
     : undefined;
 
+export const generatePackageableElementTreeNodeDataLabel = (
+  element: PackageableElement,
+  node?: PackageTreeNodeData,
+): string =>
+  element instanceof ConcreteFunctionDefinition
+    ? generateFunctionPrettyName(element, false)
+    : node?.label ?? element.name;
+
 export const getPackableElementTreeNodeData = (
   editorStore: EditorStore,
   element: PackageableElement,
@@ -112,7 +121,7 @@ export const getPackableElementTreeNodeData = (
 ): PackageTreeNodeData => ({
   id: element.path,
   dndType: getElementProjectExplorerDnDType(editorStore, element),
-  label: element.name,
+  label: generatePackageableElementTreeNodeDataLabel(element),
   childrenIds:
     element instanceof Package
       ? element.children

package/src/stores/shared/testable/TestableUtils.ts

@@ -44,6 +44,7 @@ import {
   guaranteeNonEmptyString,
   isNonNullable,
   returnUndefOnError,
+  UnsupportedOperationError,
 } from '@finos/legend-shared';
 import { EmbeddedDataType } from '../../editor-state/ExternalFormatState.js';
 import type { EditorStore } from '../../EditorStore.js';
@@ -85,7 +86,7 @@ export class TEMPORARY_EmbeddedDataConnectionVisitor
   }
 
   visit_Connection(connection: Connection): EmbeddedData {
-    throw new Error('Method not implemented.');
+    throw new UnsupportedOperationError();
   }
   visit_ConnectionPointer(connection: ConnectionPointer): EmbeddedData {
     const packageableConnection =
@@ -93,7 +94,7 @@ export class TEMPORARY_EmbeddedDataConnectionVisitor
     return packageableConnection.accept_ConnectionVisitor(this);
   }
   visit_ModelChainConnection(connection: ModelChainConnection): EmbeddedData {
-    throw new Error('Method not implemented.');
+    throw new UnsupportedOperationError();
   }
   visit_JsonModelConnection(connection: JsonModelConnection): EmbeddedData {
     const _class = connection.class.value;
@@ -106,15 +107,15 @@ export class TEMPORARY_EmbeddedDataConnectionVisitor
     return data;
   }
   visit_XmlModelConnection(connection: XmlModelConnection): EmbeddedData {
-    throw new Error('Method not implemented.');
+    throw new UnsupportedOperationError();
   }
   visit_FlatDataConnection(connection: FlatDataConnection): EmbeddedData {
-    throw new Error('Method not implemented.');
+    throw new UnsupportedOperationError();
   }
   visit_RelationalDatabaseConnection(
     connection: RelationalDatabaseConnection,
   ): EmbeddedData {
-    throw new Error('Method not implemented.');
+    throw new UnsupportedOperationError();
   }
 }
 

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

@@ -15,7 +15,6 @@
  */
 
 import { action, makeAutoObservable, flowResult, flow } from 'mobx';
-import { format } from 'date-fns';
 import type { EditorStore } from '../EditorStore.js';
 import type { EditorSDLCState } from '../EditorSDLCState.js';
 import { CHANGE_DETECTION_EVENT } from '../ChangeDetectionEvent.js';
@@ -33,6 +32,7 @@ import {
   assertTrue,
   readFileAsText,
   ActionState,
+  formatDate,
 } from '@finos/legend-shared';
 import {
   TAB_SIZE,
@@ -193,12 +193,14 @@ export class LocalChangesState {
   openLocalChange(diff: EntityDiff): void {
     const fromEntityGetter = (
       entityPath: string | undefined,
-    ): Entity | undefined =>
-      entityPath
-        ? this.editorStore.changeDetectionState.workspaceLocalLatestRevisionState.entities.find(
-            (e) => e.path === entityPath,
-          )
-        : undefined;
+    ): Entity | undefined => {
+      if (entityPath) {
+        return this.editorStore.changeDetectionState.workspaceLocalLatestRevisionState.entities.find(
+          (e) => e.path === entityPath,
+        );
+      }
+      return undefined;
+    };
     const toEntityGetter = (
       entityPath: string | undefined,
     ): Entity | undefined => {
@@ -250,31 +252,23 @@ export class LocalChangesState {
     const fromEntityGetter = (
       entityPath: string | undefined,
     ): Entity | undefined => {
-      if (!entityPath) {
-        return undefined;
-      }
-      const element =
-        this.editorStore.graphManagerState.graph.getNullableElement(entityPath);
-      if (!element) {
-        return undefined;
-      }
-      const entity =
-        this.editorStore.graphManagerState.graphManager.elementToEntity(
-          element,
-          {
-            pruneSourceInformation: true,
-          },
+      if (entityPath) {
+        return this.editorStore.changeDetectionState.workspaceLocalLatestRevisionState.entities.find(
+          (e) => e.path === entityPath,
         );
-      return entity;
+      }
+      return undefined;
     };
     const toEntityGetter = (
       entityPath: string | undefined,
-    ): Entity | undefined =>
-      entityPath
-        ? this.editorStore.changeDetectionState.workspaceRemoteLatestRevisionState.entities.find(
-            (e) => e.path === entityPath,
-          )
-        : undefined;
+    ): Entity | undefined => {
+      if (entityPath) {
+        return this.editorStore.changeDetectionState.workspaceRemoteLatestRevisionState.entities.find(
+          (e) => e.path === entityPath,
+        );
+      }
+      return undefined;
+    };
     const fromEntity = EntityDiff.shouldOldEntityExist(diff)
       ? guaranteeNonNullable(
           fromEntityGetter(diff.getValidatedOldPath()),
@@ -442,7 +436,7 @@ export class LocalChangesState {
   downloadLocalChanges = (): void => {
     const fileName = `entityChanges_(${this.sdlcState.currentProject?.name}_${
       this.sdlcState.activeWorkspace.workspaceId
-    })_${format(new Date(Date.now()), DATE_TIME_FORMAT)}.json`;
+    })_${formatDate(new Date(Date.now()), DATE_TIME_FORMAT)}.json`;
     const content = JSON.stringify(
       {
         message: '', // TODO?
@@ -468,7 +462,7 @@ export class LocalChangesState {
         this.sdlcState.checkIfCurrentWorkspaceIsInConflictResolutionMode(),
       )) as boolean;
       if (isInConflictResolutionMode) {
-        this.editorStore.setBlockingAlert({
+        this.editorStore.applicationStore.setBlockingAlert({
           message: 'Workspace is in conflict resolution mode',
           prompt: 'Please refresh the application',
         });
@@ -518,12 +512,10 @@ export class LocalChangesState {
       yield flowResult(
         this.editorStore.changeDetectionState.computeAggregatedWorkspaceRemoteChanges(),
       );
-      this.editorStore.setActionAlertInfo({
+      this.editorStore.applicationStore.setActionAlertInfo({
         message: 'Local workspace is out-of-sync',
         prompt: 'Please pull remote changes before pushing your local changes',
         type: ActionAlertType.CAUTION,
-        onEnter: (): void => this.editorStore.setBlockGlobalHotkeys(true),
-        onClose: (): void => this.editorStore.setBlockGlobalHotkeys(false),
         actions: [
           {
             label: 'Pull remote changes',
@@ -623,13 +615,11 @@ export class LocalChangesState {
               error,
             );
           }
-          this.editorStore.setActionAlertInfo({
+          this.editorStore.applicationStore.setActionAlertInfo({
             message: `Change detection engine failed to build hashes index for workspace after syncing`,
             prompt:
               'To fix this, you can either try to keep refreshing local changes until success or trust and reuse current workspace hashes index',
             type: ActionAlertType.CAUTION,
-            onEnter: (): void => this.editorStore.setBlockGlobalHotkeys(true),
-            onClose: (): void => this.editorStore.setBlockGlobalHotkeys(false),
             actions: [
               {
                 label: 'Use local hashes index',
@@ -693,4 +683,28 @@ export class LocalChangesState {
       this.pushChangesState.complete();
     }
   }
+
+  alertUnsavedChanges(onProceed: () => void): void {
+    if (this.hasUnpushedChanges) {
+      this.editorStore.applicationStore.setActionAlertInfo({
+        message:
+          'Unsaved changes to your query will be lost if you continue. Do you still want to proceed?',
+        type: ActionAlertType.CAUTION,
+        actions: [
+          {
+            label: 'Proceed',
+            type: ActionAlertActionType.PROCEED_WITH_CAUTION,
+            handler: (): void => onProceed(),
+          },
+          {
+            label: 'Abort',
+            type: ActionAlertActionType.PROCEED,
+            default: true,
+          },
+        ],
+      });
+    } else {
+      onProceed();
+    }
+  }
 }

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

@@ -117,11 +117,13 @@ export class ProjectOverviewState {
         this.editorStore.applicationStore.notifyWarning(
           'Current workspace is deleted. Redirecting to workspace setup',
         );
-        this.editorStore.setIgnoreNavigationBlocking(true);
-        this.editorStore.applicationStore.navigator.reloadToLocation(
+        this.editorStore.applicationStore.navigator.goToLocation(
           generateSetupRoute(
             this.editorStore.sdlcState.activeProject.projectId,
           ),
+          {
+            ignoreBlocking: true,
+          },
         );
       }
     } catch (error) {

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

@@ -206,7 +206,7 @@ export class WorkspaceReviewState {
   *recreateWorkspaceAfterCommittingReview(): GeneratorFn<void> {
     try {
       this.isRecreatingWorkspaceAfterCommittingReview = true;
-      this.editorStore.setBlockingAlert({
+      this.editorStore.applicationStore.setBlockingAlert({
         message: 'Recreating workspace...',
         prompt: 'Please do not close the application',
         showLoading: true,
@@ -216,8 +216,9 @@ export class WorkspaceReviewState {
         this.sdlcState.activeWorkspace.workspaceId,
         this.sdlcState.activeWorkspace.workspaceType,
       );
-      this.editorStore.setIgnoreNavigationBlocking(true);
-      this.editorStore.applicationStore.navigator.reload();
+      this.editorStore.applicationStore.navigator.reload({
+        ignoreBlocking: true,
+      });
     } catch (error) {
       assertErrorThrown(error);
       this.editorStore.applicationStore.log.error(
@@ -226,7 +227,7 @@ export class WorkspaceReviewState {
       );
       this.editorStore.applicationStore.notifyError(error);
     } finally {
-      this.editorStore.setBlockingAlert(undefined);
+      this.editorStore.applicationStore.setBlockingAlert(undefined);
       this.isRecreatingWorkspaceAfterCommittingReview = false;
     }
   }
@@ -324,7 +325,7 @@ export class WorkspaceReviewState {
         this.sdlcState.checkIfCurrentWorkspaceIsInConflictResolutionMode(),
       )) as boolean;
       if (isInConflictResolutionMode) {
-        this.editorStore.setBlockingAlert({
+        this.editorStore.applicationStore.setBlockingAlert({
           message: 'Workspace is in conflict resolution mode',
           prompt: 'Please refresh the application',
         });
@@ -344,12 +345,10 @@ export class WorkspaceReviewState {
         review.id,
         { message: `${review.title} [review]` },
       );
-      this.editorStore.setActionAlertInfo({
+      this.editorStore.applicationStore.setActionAlertInfo({
         message: 'Committed review successfully',
         prompt:
           'You can create a new workspace with the same name or leave for the start page',
-        onEnter: (): void => this.editorStore.setBlockGlobalHotkeys(true),
-        onClose: (): void => this.editorStore.setBlockGlobalHotkeys(false),
         actions: [
           {
             label: 'Create new workspace',
@@ -362,11 +361,13 @@ export class WorkspaceReviewState {
             label: 'Leave',
             type: ActionAlertActionType.PROCEED,
             handler: (): void => {
-              this.editorStore.setIgnoreNavigationBlocking(true);
-              this.editorStore.applicationStore.navigator.reloadToLocation(
+              this.editorStore.applicationStore.navigator.goToLocation(
                 generateSetupRoute(
                   this.editorStore.sdlcState.activeProject.projectId,
                 ),
+                {
+                  ignoreBlocking: true,
+                },
               );
             },
             default: true,

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

@@ -434,7 +434,7 @@ export class WorkspaceSyncState {
   *pullChanges(): GeneratorFn<void> {
     try {
       assertTrue(this.sdlcState.isWorkspaceOutOfSync);
-      this.editorStore.setBlockingAlert({
+      this.editorStore.applicationStore.setBlockingAlert({
         message: `Pulling latest changes...`,
         showLoading: true,
       });
@@ -451,14 +451,12 @@ export class WorkspaceSyncState {
           this.editorStore.changeDetectionState.potentialWorkspacePullConflicts;
       }
       if (conflicts.length) {
-        this.editorStore.setBlockingAlert(undefined);
-        this.editorStore.setActionAlertInfo({
+        this.editorStore.applicationStore.setBlockingAlert(undefined);
+        this.editorStore.applicationStore.setActionAlertInfo({
           message: 'Conflicts found while pulling changes',
           prompt:
             'You can either force-pull (override local changes) or resolve these conflicts manually',
           type: ActionAlertType.CAUTION,
-          onEnter: (): void => this.editorStore.setBlockGlobalHotkeys(true),
-          onClose: (): void => this.editorStore.setBlockGlobalHotkeys(false),
           actions: [
             {
               label: 'Resolve merge conflicts',
@@ -550,13 +548,13 @@ export class WorkspaceSyncState {
         `Can't force-pull remote workspace changes. Error: ${error.message}`,
       );
     } finally {
-      this.editorStore.setBlockingAlert(undefined);
+      this.editorStore.applicationStore.setBlockingAlert(undefined);
     }
   }
 
   *applyResolutionChanges(): GeneratorFn<void> {
     try {
-      this.editorStore.setBlockingAlert({
+      this.editorStore.applicationStore.setBlockingAlert({
         message: `Applying resolutions and reloading graph...`,
         showLoading: true,
       });
@@ -572,7 +570,7 @@ export class WorkspaceSyncState {
         `Can't apply resolutions to local workspace. Error: ${error.message}`,
       );
     } finally {
-      this.editorStore.setBlockingAlert(undefined);
+      this.editorStore.applicationStore.setBlockingAlert(undefined);
     }
   }
 }