@finos/legend-application-studio 13.1.1 → 15.0.0

package/src/components/editor/edit-panel/uml-editor/AssociationEditor.tsx

@@ -74,7 +74,6 @@ import {
   stub_Stereotype,
   getFirstAssociatedProperty,
   getSecondAssociatedProperty,
-  getOtherAssociatedProperty,
 } from '@finos/legend-graph';
 import {
   property_setName,
@@ -120,12 +119,7 @@ const AssociationPropertyBasicEditor = observer(
     // Generic Type
     const [isEditingType, setIsEditingType] = useState(false);
     // TODO: make this so that association can only refer to classes from the same graph space
-    const propertyTypeOptions = editorStore.classOptions.filter(
-      (classOption) =>
-        classOption.value !==
-        getOtherAssociatedProperty(association, property).genericType.value
-          .rawType,
-    );
+    const propertyTypeOptions = editorStore.classOptions;
     const propertyType = property.genericType.value.rawType;
     const propertyTypeName = getClassPropertyType(propertyType);
     const filterOption = createFilter({

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

@@ -483,8 +483,8 @@ const ExplorerDropdownMenu = observer(() => {
 const ExplorerTrees = observer(() => {
   const editorStore = useEditorStore();
   const { isInGrammarTextMode, isInViewerMode } = editorStore;
-  const openModelLoader = (): void =>
-    editorStore.openSingletonEditorState(editorStore.modelLoaderState);
+  const openModelImport = (): void =>
+    editorStore.openSingletonEditorState(editorStore.modelImporterState);
   const graph = editorStore.graphManagerState.graph;
   // Explorer tree
   const treeData = editorStore.explorerTreeState.getTreeData();
@@ -661,9 +661,9 @@ const ExplorerTrees = observer(() => {
               </div>
               <button
                 className="btn--dark explorer__content--empty__btn"
-                onClick={openModelLoader}
+                onClick={openModelImport}
               >
-                Open Model Loader
+                Open Model Importer
               </button>
             </div>
           )}
@@ -688,8 +688,8 @@ const ProjectExplorerActionPanel = observer((props: { disabled: boolean }) => {
     });
     editorStore.explorerTreeState.setTreeData({ ...treeData });
   };
-  const showModelLoader = (): void =>
-    editorStore.openState(editorStore.modelLoaderState);
+  const showModelImporter = (): void =>
+    editorStore.openState(editorStore.modelImporterState);
 
   return (
     <div className="panel__header__actions">
@@ -697,8 +697,8 @@ const ProjectExplorerActionPanel = observer((props: { disabled: boolean }) => {
         <button
           className="panel__header__action"
           disabled={disabled}
-          title="Open Model Loader (F2)"
-          onClick={showModelLoader}
+          title="Open Model Importer (F2)"
+          onClick={showModelImporter}
         >
           <FileImportIcon />
         </button>

package/src/index.ts

@@ -26,6 +26,11 @@ export * from './stores/LegendStudioAppEvent.js';
 export * from './stores/LegendStudioApplicationPlugin.js';
 export * from './stores/EditorStore.js';
 export * from './stores/EditorConfig.js';
+export {
+  ExtensionModelImportRendererState,
+  ExtensionModelImporterEditorState,
+  ModelImporterEditorState,
+} from './stores/editor-state/ModelImporterState.js';
 export { ClassEditorState } from './stores/editor-state/element-editor-state/ClassEditorState.js';
 export { ElementEditorState } from './stores/editor-state/element-editor-state/ElementEditorState.js';
 export { UnsupportedElementEditorState } from './stores/editor-state/UnsupportedElementEditorState.js';

package/src/stores/EditorGraphState.ts

@@ -35,7 +35,7 @@ import {
 import type { EditorStore } from './EditorStore.js';
 import { ElementEditorState } from './editor-state/element-editor-state/ElementEditorState.js';
 import { GraphGenerationState } from './editor-state/GraphGenerationState.js';
-import { MODEL_UPDATER_INPUT_TYPE } from './editor-state/ModelLoaderState.js';
+import { MODEL_IMPORT_NATIVE_INPUT_TYPE } from './editor-state/ModelImporterState.js';
 import type { DSL_LegendStudioApplicationPlugin_Extension } from './LegendStudioApplicationPlugin.js';
 import type { Entity } from '@finos/legend-storage';
 import {
@@ -303,8 +303,8 @@ export class EditorGraphState {
         );
         this.editorStore.setCurrentEditorState(projectConfigurationEditorState);
       } else if (error instanceof GraphDataDeserializationError) {
-        // if something goes wrong with de-serialization, redirect to model loader to fix
-        this.redirectToModelLoaderForDebugging(error);
+        // if something goes wrong with de-serialization, redirect to model importer to fix
+        this.redirectToModelImporterForDebugging(error);
       } else if (error instanceof NetworkClientError) {
         this.editorStore.graphManagerState.graphBuildState.fail();
         this.editorStore.applicationStore.notifyWarning(
@@ -332,8 +332,8 @@ export class EditorGraphState {
             error2,
           );
           if (error2 instanceof NetworkClientError) {
-            // in case the server cannot even transform the JSON due to corrupted protocol, we can redirect to model loader
-            this.redirectToModelLoaderForDebugging(error2);
+            // in case the server cannot even transform the JSON due to corrupted protocol, we can redirect to model importer
+            this.redirectToModelImporterForDebugging(error2);
             return {
               status: GraphBuilderStatus.FAILED,
               error: error2,
@@ -361,7 +361,7 @@ export class EditorGraphState {
     }
   }
 
-  private redirectToModelLoaderForDebugging(error: Error): void {
+  private redirectToModelImporterForDebugging(error: Error): void {
     if (this.editorStore.isInConflictResolutionMode) {
       this.editorStore.setBlockingAlert({
         message: `Can't de-serialize graph model from entities`,
@@ -370,14 +370,15 @@ export class EditorGraphState {
       return;
     }
     this.editorStore.applicationStore.notifyWarning(
-      `Can't de-serialize graph model from entities. Redirected to model loader for debugging. Error: ${error.message}`,
-    );
-    this.editorStore.modelLoaderState.setCurrentModelLoadType(
-      MODEL_UPDATER_INPUT_TYPE.ENTITIES,
+      `Can't de-serialize graph model from entities. Redirected to model importer for debugging. Error: ${error.message}`,
     );
+    const nativeImporterState =
+      this.editorStore.modelImporterState.setNativeImportType(
+        MODEL_IMPORT_NATIVE_INPUT_TYPE.ENTITIES,
+      );
     // Making an async call
-    this.editorStore.modelLoaderState.loadCurrentProjectEntities();
-    this.editorStore.openState(this.editorStore.modelLoaderState);
+    nativeImporterState.loadCurrentProjectEntities();
+    this.editorStore.openState(this.editorStore.modelImporterState);
   }
 
   /**

package/src/stores/EditorStore.ts

@@ -59,7 +59,7 @@ import {
 import { UMLEditorState } from './editor-state/element-editor-state/UMLEditorState.js';
 import { ServiceEditorState } from './editor-state/element-editor-state/service/ServiceEditorState.js';
 import { EditorSDLCState } from './EditorSDLCState.js';
-import { ModelLoaderState } from './editor-state/ModelLoaderState.js';
+import { ModelImporterState } from './editor-state/ModelImporterState.js';
 import type { EditorState } from './editor-state/EditorState.js';
 import { EntityDiffViewState } from './editor-state/entity-diff-editor-state/EntityDiffViewState.js';
 import { FunctionEditorState } from './editor-state/element-editor-state/FunctionEditorState.js';
@@ -186,7 +186,7 @@ export class EditorStore {
   graphManagerState: GraphManagerState;
   changeDetectionState: ChangeDetectionState;
   grammarTextEditorState: GrammarTextEditorState;
-  modelLoaderState: ModelLoaderState;
+  modelImporterState: ModelImporterState;
   projectConfigurationEditorState: ProjectConfigurationEditorState;
   projectOverviewState: ProjectOverviewState;
   workspaceWorkflowManagerState: WorkspaceWorkflowManagerState;
@@ -315,7 +315,7 @@ export class EditorStore {
     this.newElementState = new NewElementState(this);
     // special (singleton) editors
     this.grammarTextEditorState = new GrammarTextEditorState(this);
-    this.modelLoaderState = new ModelLoaderState(this);
+    this.modelImporterState = new ModelImporterState(this);
     this.projectConfigurationEditorState = new ProjectConfigurationEditorState(
       this,
       this.sdlcState,
@@ -375,7 +375,7 @@ export class EditorStore {
         LEGEND_STUDIO_HOTKEY.TOGGLE_MODEL_LOADER,
         [LEGEND_STUDIO_HOTKEY_MAP.TOGGLE_MODEL_LOADER],
         this.createGlobalHotKeyAction(() =>
-          this.openState(this.modelLoaderState),
+          this.openState(this.modelImporterState),
         ),
       ),
       new HotkeyConfiguration(
@@ -736,7 +736,6 @@ export class EditorStore {
       this.projectConfigurationEditorState.fetchLatestProjectStructureVersion(),
       this.graphState.graphGenerationState.fetchAvailableFileGenerationDescriptions(),
       this.graphState.graphGenerationState.externalFormatState.fetchExternalFormatsDescriptions(),
-      this.modelLoaderState.fetchAvailableModelImportDescriptions(),
       this.sdlcState.fetchProjectVersions(),
     ]);
   }
@@ -775,7 +774,6 @@ export class EditorStore {
       this.projectConfigurationEditorState.fetchLatestProjectStructureVersion(),
       this.graphState.graphGenerationState.fetchAvailableFileGenerationDescriptions(),
       this.graphState.graphGenerationState.externalFormatState.fetchExternalFormatsDescriptions(),
-      this.modelLoaderState.fetchAvailableModelImportDescriptions(),
       this.sdlcState.fetchProjectVersions(),
     ]);
   }
@@ -959,8 +957,8 @@ export class EditorStore {
       this.openEntityChangeConflict(editorState);
     } else if (editorState instanceof FileGenerationViewerState) {
       this.openGeneratedFile(editorState.generatedFile);
-    } else if (editorState === this.modelLoaderState) {
-      this.openSingletonEditorState(this.modelLoaderState);
+    } else if (editorState === this.modelImporterState) {
+      this.openSingletonEditorState(this.modelImporterState);
     } else if (editorState === this.projectConfigurationEditorState) {
       this.openSingletonEditorState(this.projectConfigurationEditorState);
     } else {
@@ -1008,7 +1006,7 @@ export class EditorStore {
    * This method helps open editor that only exists one instance at at time such as model-loader, project config, settings ...
    */
   openSingletonEditorState(
-    singularEditorState: ModelLoaderState | ProjectConfigurationEditorState,
+    singularEditorState: ModelImporterState | ProjectConfigurationEditorState,
   ): void {
     const existingEditorState = this.openedEditorStates.find(
       (e) => e === singularEditorState,

package/src/stores/LegendStudioApplicationPlugin.ts

@@ -27,6 +27,10 @@ import {
   LegendApplicationPlugin,
 } from '@finos/legend-application';
 import type { TestableMetadata } from './sidebar-state/testable/GlobalTestRunnerState.js';
+import type {
+  ExtensionModelImportRendererState,
+  ModelImporterState,
+} from './editor-state/ModelImporterState.js';
 
 export type ExplorerContextMenuItemRendererConfiguration = {
   key: string;
@@ -49,14 +53,19 @@ export type ClassPreviewRenderer = (
   _class: Class,
 ) => React.ReactNode | undefined;
 
-export type ModelLoaderExtensionConfiguration = {
+export type ModelImporterExtensionConfiguration = {
   key: string;
   label?: string | undefined;
   allowHardReplace?: boolean;
-  // TODO: document about this behavior better, right now the behavior is not well
-  // structured yet, also, model loader seems rather fragmented at the moment
-  load: (editorStore: EditorStore) => Promise<void>;
-  renderer: (editorStore: EditorStore) => React.ReactNode | undefined;
+  getExtensionModelImportRendererStateCreator: (
+    modelImporterState: ModelImporterState,
+  ) => ExtensionModelImportRendererState;
+  renderer: (
+    rendererState: ExtensionModelImportRendererState,
+  ) => React.ReactNode | undefined;
+  loadModel: (
+    rendererState: ExtensionModelImportRendererState,
+  ) => Promise<void>;
 };
 
 export type TestableMetadataGetter = (
@@ -98,9 +107,9 @@ export abstract class LegendStudioApplicationPlugin extends LegendApplicationPlu
   getExtraEditorExtensionComponentRendererConfigurations?(): EditorExtensionComponentRendererConfiguration[];
 
   /**
-   * Get the list of extension configurations for model loader.
+   * Get the list of extension configurations for model importer.
    */
-  getExtraModelLoaderExtensionConfigurations?(): ModelLoaderExtensionConfiguration[];
+  getExtraModelImporterExtensionConfigurations?(): ModelImporterExtensionConfiguration[];
 
   /**
    * Get the list of extension for testables

package/src/stores/LegendStudioBaseStore.ts

@@ -14,14 +14,31 @@
  * limitations under the License.
  */
 
-import { type GeneratorFn, ActionState } from '@finos/legend-shared';
+import {
+  type GeneratorFn,
+  type PlainObject,
+  HttpStatus,
+  NetworkClientError,
+  ActionState,
+  LogEvent,
+  assertErrorThrown,
+} from '@finos/legend-shared';
 import {
   type ApplicationStore,
+  ActionAlertActionType,
+  ActionAlertType,
   ApplicationTelemetry,
-  LegendApplicationSDLCSetupState,
 } from '@finos/legend-application';
-import { flow, flowResult, makeObservable } from 'mobx';
-import type { SDLCServerClient } from '@finos/legend-server-sdlc';
+import {
+  action,
+  computed,
+  flow,
+  flowResult,
+  makeObservable,
+  observable,
+} from 'mobx';
+import { User, SDLCServerClient } from '@finos/legend-server-sdlc';
+import { LEGEND_STUDIO_APP_EVENT } from './LegendStudioAppEvent.js';
 import type { DepotServerClient } from '@finos/legend-server-depot';
 import type { LegendStudioPluginManager } from '../application/LegendStudioPluginManager.js';
 import type { LegendStudioApplicationConfig } from '../application/LegendStudioApplicationConfig.js';
@@ -37,11 +54,14 @@ export type LegendStudioApplicationStore = ApplicationStore<
 
 export class LegendStudioBaseStore {
   applicationStore: LegendStudioApplicationStore;
+  sdlcServerClient: SDLCServerClient;
   depotServerClient: DepotServerClient;
   pluginManager: LegendStudioPluginManager;
 
   initState = ActionState.create();
-  applicationSDLCSetupState: LegendApplicationSDLCSetupState;
+
+  isSDLCAuthorized = false;
+  SDLCServerTermsOfServicesUrlsToView: string[] = [];
 
   constructor(
     applicationStore: LegendStudioApplicationStore,
@@ -49,23 +69,23 @@ export class LegendStudioBaseStore {
     depotServerClient: DepotServerClient,
     pluginManager: LegendStudioPluginManager,
   ) {
-    makeObservable(this, {
+    makeObservable<LegendStudioBaseStore, 'initializeSDLCServerClient'>(this, {
+      isSDLCAuthorized: observable,
+      SDLCServerTermsOfServicesUrlsToView: observable,
+      needsToAcceptSDLCServerTermsOfServices: computed,
       initialize: flow,
+      initializeSDLCServerClient: flow,
+      dismissSDLCServerTermsOfServicesAlert: action,
     });
 
     this.applicationStore = applicationStore;
-    this.applicationSDLCSetupState = new LegendApplicationSDLCSetupState(
-      applicationStore,
-      sdlcServerClient,
-    );
+    this.sdlcServerClient = sdlcServerClient;
     this.depotServerClient = depotServerClient;
 
     this.pluginManager = pluginManager;
 
     // Register plugins
-    this.applicationSDLCSetupState.sdlcServerClient.setTracerService(
-      this.applicationStore.tracerService,
-    );
+    this.sdlcServerClient.setTracerService(this.applicationStore.tracerService);
     this.depotServerClient.setTracerService(
       this.applicationStore.tracerService,
     );
@@ -81,15 +101,26 @@ export class LegendStudioBaseStore {
     this.initState.inProgress();
 
     // setup SDLC server client
-    yield flowResult(
-      this.applicationSDLCSetupState.initializeSDLCServerClient(),
-    );
+    yield flowResult(this.initializeSDLCServerClient());
+
+    let currentUserID = UNKNOWN_USER_ID;
+    try {
+      const currentUser = User.serialization.fromJson(
+        (yield this.sdlcServerClient.getCurrentUser()) as PlainObject<User>,
+      );
+      this.sdlcServerClient.setCurrentUser(currentUser);
+      currentUserID = currentUser.userId;
+    } catch (error) {
+      assertErrorThrown(error);
+      this.applicationStore.log.error(
+        LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
+        error,
+      );
+      this.applicationStore.notifyWarning(error.message);
+    }
 
     // setup telemetry service
-    this.applicationStore.telemetryService.setUserId(
-      this.applicationSDLCSetupState.sdlcServerClient.currentUser?.userId ??
-        UNKNOWN_USER_ID,
-    );
+    this.applicationStore.telemetryService.setUserId(currentUserID);
 
     ApplicationTelemetry.logEvent_ApplicationInitialized(
       this.applicationStore.telemetryService,
@@ -109,4 +140,100 @@ export class LegendStudioBaseStore {
 
     this.initState.complete();
   }
+
+  private *initializeSDLCServerClient(): GeneratorFn<void> {
+    try {
+      this.isSDLCAuthorized =
+        (yield this.sdlcServerClient.isAuthorized()) as boolean;
+      if (!this.isSDLCAuthorized) {
+        this.applicationStore.navigator.jumpTo(
+          SDLCServerClient.authorizeCallbackUrl(
+            this.applicationStore.config.sdlcServerUrl,
+            this.applicationStore.navigator.getCurrentLocation(),
+          ),
+        );
+      } else {
+        // Only proceed intialization after passing authorization check
+
+        // check terms of service agreement status
+        this.SDLCServerTermsOfServicesUrlsToView =
+          (yield this.sdlcServerClient.hasAcceptedTermsOfService()) as string[];
+        if (this.SDLCServerTermsOfServicesUrlsToView.length) {
+          this.applicationStore.setActionAlertInfo({
+            message: `Please read and accept the SDLC servers' terms of service`,
+            prompt: `Click 'Done' when you have accepted all the terms`,
+            type: ActionAlertType.CAUTION,
+            actions: [
+              {
+                label: 'See terms of services',
+                default: true,
+                handler: (): void =>
+                  this.SDLCServerTermsOfServicesUrlsToView.forEach((url) =>
+                    this.applicationStore.navigator.openNewWindow(url),
+                  ),
+                type: ActionAlertActionType.PROCEED,
+              },
+              {
+                label: 'Done',
+                type: ActionAlertActionType.PROCEED_WITH_CAUTION,
+                handler: (): void => {
+                  this.dismissSDLCServerTermsOfServicesAlert();
+                  this.applicationStore.navigator.reload();
+                },
+              },
+            ],
+          });
+        }
+
+        // fetch server features config
+        yield this.sdlcServerClient.fetchServerFeaturesConfiguration();
+      }
+    } catch (error) {
+      assertErrorThrown(error);
+      if (
+        // eslint-disable-next-line no-process-env
+        process.env.NODE_ENV === 'development' &&
+        error instanceof NetworkClientError &&
+        error.response.status === HttpStatus.UNAUTHORIZED
+      ) {
+        this.applicationStore.setActionAlertInfo({
+          message:
+            'The first time the application starts in development mode, the developer would need to authenticate using SDLC server. Please do so then manually reload the app',
+          type: ActionAlertType.STANDARD,
+          actions: [
+            {
+              label: 'Authenticate using SDLC',
+              type: ActionAlertActionType.PROCEED,
+              default: true,
+              handler: (): void => {
+                this.applicationStore.navigator.openNewWindow(
+                  this.sdlcServerClient.currentUserUrl,
+                );
+                this.applicationStore.setBlockingAlert({
+                  message:
+                    'Waiting for the developer to authenticate using SDLC server',
+                  prompt:
+                    'Please manually reload the application after authentication',
+                });
+              },
+            },
+          ],
+        });
+      } else {
+        this.applicationStore.log.error(
+          LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE),
+          error,
+        );
+        this.applicationStore.notifyError(error);
+      }
+    }
+  }
+
+  get needsToAcceptSDLCServerTermsOfServices(): boolean {
+    return Boolean(this.SDLCServerTermsOfServicesUrlsToView.length);
+  }
+
+  dismissSDLCServerTermsOfServicesAlert(): void {
+    this.SDLCServerTermsOfServicesUrlsToView = [];
+  }
 }

package/src/stores/editor/NewElementState.ts

@@ -190,7 +190,7 @@ export class NewPackageableRuntimeDriver extends NewElementDriver<PackageableRun
       isValid: computed,
     });
 
-    const mappings = this.editorStore.graphManagerState.graph.ownMappings;
+    const mappings = this.editorStore.graphManagerState.graph.mappings;
     if (mappings.length) {
       this.mapping = mappings[0];
     }
@@ -240,7 +240,7 @@ export class NewPureModelConnectionDriver extends NewConnectionValueDriver<PureM
       isValid: computed,
     });
 
-    const classes = this.editorStore.graphManagerState.graph.ownClasses;
+    const classes = this.editorStore.graphManagerState.graph.classes;
     if (classes.length) {
       this.class = classes[0];
     }
@@ -302,7 +302,7 @@ export class NewRelationalDatabaseConnectionDriver extends NewConnectionValueDri
     if (store instanceof Database) {
       selectedStore = store;
     } else {
-      const dbs = this.editorStore.graphManagerState.graph.ownDatabases;
+      const dbs = this.editorStore.graphManagerState.graph.databases;
       selectedStore = dbs.length ? (dbs[0] as Database) : stub_Database();
     }
     return new RelationalDatabaseConnection(
@@ -533,6 +533,7 @@ export class NewGenerationSpecificationDriver extends NewElementDriver<Generatio
   }
 
   get isValid(): boolean {
+    // only one generation specification should exist
     return !this.editorStore.graphManagerState.graph.ownGenerationSpecifications
       .length;
   }

package/src/stores/editor-state/ExternalFormatState.ts

@@ -18,7 +18,6 @@ import type { ExternalFormatDescription } from '@finos/legend-graph';
 import {
   type GeneratorFn,
   assertErrorThrown,
-  guaranteeNonNullable,
   LogEvent,
   ActionState,
 } from '@finos/legend-shared';
@@ -58,12 +57,22 @@ export class ExternalFormatState {
   }
 
   get formatTypeOptions(): ExternalFormatTypeOption[] {
-    return this.externalFormatsDescriptions.map((e) => ({
-      value: e.name,
-      label: e.name,
+    return this.externalFormatsDescriptions.map((types) => ({
+      value: types.name,
+      label: types.name,
     }));
   }
 
+  get formatContentTypes(): string[] {
+    return this.externalFormatsDescriptions.map((e) => e.contentTypes).flat();
+  }
+
+  get externalFormatDescriptionsWithModelGenerationSupport(): ExternalFormatDescription[] {
+    return this.externalFormatsDescriptions.filter(
+      (d) => d.supportsModelGeneration,
+    );
+  }
+
   getFormatTypeForContentType(contentType: string): string | undefined {
     return this.externalFormatsDescriptions.find(
       (externalFormatDescription) =>
@@ -71,10 +80,6 @@ export class ExternalFormatState {
     )?.name;
   }
 
-  get formatContentTypes(): string[] {
-    return this.externalFormatsDescriptions.map((e) => e.contentTypes).flat();
-  }
-
   setExternalFormatsDescriptions(
     externalFormatsDescriptions: ExternalFormatDescription[],
   ): void {
@@ -99,9 +104,7 @@ export class ExternalFormatState {
     }
   }
 
-  getTypeDescription(type: string): ExternalFormatDescription {
-    return guaranteeNonNullable(
-      this.externalFormatsDescriptions.find((e) => e.name === type),
-    );
+  getTypeDescription(type: string): ExternalFormatDescription | undefined {
+    return this.externalFormatsDescriptions.find((e) => e.name === type);
   }
 }