@finos/legend-application-pure-ide 6.2.21 → 6.2.23

package/src/components/editor/edit-panel/PureFileEditor.tsx

@@ -51,8 +51,14 @@ import {
   collectExtraInlineSnippetSuggestions,
   collectParserElementSnippetSuggestions,
   collectParserKeywordSuggestions,
+  getArrowFunctionSuggestions,
+  getAttributeSuggestions,
+  getCastingClassSuggestions,
+  getConstructorClassSuggestions,
   getCopyrightHeaderSuggestions,
-} from '../../../stores/FileEditorUtils.js';
+  getIdentifierSuggestions,
+  getIncompletePathSuggestions,
+} from '../../../stores/PureFileEditorUtils.js';
 import { guaranteeNonNullable } from '@finos/legend-shared';
 import { flowResult } from 'mobx';
 import { FileCoordinate } from '../../../server/models/File.js';
@@ -142,12 +148,15 @@ const RenameConceptPrompt = observer(
 export const PureFileEditor = observer(
   (props: { editorState: FileEditorState }) => {
     const { editorState } = props;
-    const suggestionProviderDisposer = useRef<IDisposable | undefined>(
-      undefined,
-    );
     const definitionProviderDisposer = useRef<IDisposable | undefined>(
       undefined,
     );
+    const pureConstructSuggestionProviderDisposer = useRef<
+      IDisposable | undefined
+    >(undefined);
+    const pureIdentifierSuggestionProviderDisposer = useRef<
+      IDisposable | undefined
+    >(undefined);
     const textInputRef = useRef<HTMLDivElement>(null);
     const [editor, setEditor] = useState<
       monacoEditorAPI.IStandaloneCodeEditor | undefined
@@ -155,7 +164,6 @@ export const PureFileEditor = observer(
     const [isContextMenuOpen, setIsContextMenuOpen] = useState(false);
     const editorStore = useEditorStore();
     const applicationStore = useApplicationStore();
-    const content = editorState.file.content;
     const { ref, width, height } = useResizeDetector<HTMLDivElement>();
 
     useEffect(() => {
@@ -294,6 +302,7 @@ export const PureFileEditor = observer(
         newEditor.onDidChangeCursorSelection(() => {
           editorState.textEditorState.notifyCursorObserver();
         });
+
         // Restore the editor model and view state
         newEditor.setModel(editorState.textEditorState.model);
         if (editorState.textEditorState.viewState) {
@@ -305,14 +314,6 @@ export const PureFileEditor = observer(
       }
     }, [editorStore, applicationStore, editorState, editor]);
 
-    if (editor) {
-      // Set the value of the editor
-      const currentValue = editor.getValue();
-      if (currentValue !== content) {
-        editor.setValue(content);
-      }
-    }
-
     const textTokens = editor
       ? monacoEditorAPI.tokenize(editor.getValue(), EDITOR_LANGUAGE.PURE)
       : [];
@@ -324,9 +325,10 @@ export const PureFileEditor = observer(
           // where sometimes, hovering the mouse on the right half of the last character of a definition token
           // and then hitting Ctrl/Cmd key will not be trigger definition provider. We're not quite sure what
           // to do with that for the time being.
-          const lineTokens = guaranteeNonNullable(
-            textTokens[position.lineNumber - 1],
-          );
+          const lineTokens = textTokens[position.lineNumber - 1];
+          if (!lineTokens) {
+            return [];
+          }
           let currentToken: Token | undefined = undefined;
           let currentTokenRange: IRange | undefined = undefined;
           for (let i = 1; i < lineTokens.length; ++i) {
@@ -369,47 +371,122 @@ export const PureFileEditor = observer(
         },
       });
 
-    // suggestion
-    suggestionProviderDisposer.current?.dispose();
-    suggestionProviderDisposer.current =
+    // suggestions
+    pureConstructSuggestionProviderDisposer.current?.dispose();
+    pureConstructSuggestionProviderDisposer.current =
+      monacoLanguagesAPI.registerCompletionItemProvider(EDITOR_LANGUAGE.PURE, {
+        triggerCharacters: ['#', ':', '>', '.', '@', '^'],
+        provideCompletionItems: async (model, position, context) => {
+          let suggestions: monacoLanguagesAPI.CompletionItem[] = [];
+
+          if (
+            context.triggerKind ===
+            monacoLanguagesAPI.CompletionTriggerKind.TriggerCharacter
+          ) {
+            switch (context.triggerCharacter) {
+              case '#': {
+                suggestions = suggestions.concat(
+                  getParserKeywordSuggestions(
+                    position,
+                    model,
+                    collectParserKeywordSuggestions(),
+                  ),
+                );
+                break;
+              }
+              case ':': {
+                suggestions = suggestions.concat(
+                  await getIncompletePathSuggestions(
+                    position,
+                    model,
+                    editorStore,
+                  ),
+                );
+                break;
+              }
+              case '>': {
+                suggestions = suggestions.concat(
+                  await getArrowFunctionSuggestions(
+                    position,
+                    model,
+                    editorStore,
+                  ),
+                );
+                break;
+              }
+              case '.': {
+                suggestions = suggestions.concat(
+                  await getAttributeSuggestions(position, model, editorStore),
+                );
+                break;
+              }
+              case '^': {
+                suggestions = suggestions.concat(
+                  await getConstructorClassSuggestions(
+                    position,
+                    model,
+                    editorStore,
+                  ),
+                );
+                break;
+              }
+              case '@': {
+                suggestions = suggestions.concat(
+                  await getCastingClassSuggestions(
+                    position,
+                    model,
+                    editorStore,
+                  ),
+                );
+                break;
+              }
+              default:
+                break;
+            }
+          }
+
+          return { suggestions };
+        },
+      });
+
+    pureIdentifierSuggestionProviderDisposer.current?.dispose();
+    pureIdentifierSuggestionProviderDisposer.current =
       monacoLanguagesAPI.registerCompletionItemProvider(EDITOR_LANGUAGE.PURE, {
-        // NOTE: we need to specify this to show suggestions for section
-        // because by default, only alphanumeric characters trigger completion item provider
-        // See https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.CompletionContext.html#triggerCharacter
-        // See https://github.com/microsoft/monaco-editor/issues/2530#issuecomment-861757198
-        triggerCharacters: ['#'],
-        provideCompletionItems: (model, position) => {
+        triggerCharacters: [],
+        provideCompletionItems: async (model, position, context) => {
           let suggestions: monacoLanguagesAPI.CompletionItem[] = [];
 
-          suggestions = suggestions.concat(getCopyrightHeaderSuggestions());
+          if (
+            context.triggerKind ===
+            monacoLanguagesAPI.CompletionTriggerKind.Invoke
+          ) {
+            // copyright header
+            suggestions = suggestions.concat(getCopyrightHeaderSuggestions());
 
-          // suggestions for parser keyword
-          suggestions = suggestions.concat(
-            getParserKeywordSuggestions(
-              position,
-              model,
-              collectParserKeywordSuggestions(),
-            ),
-          );
+            // suggestions for parser element snippets
+            suggestions = suggestions.concat(
+              getParserElementSnippetSuggestions(
+                position,
+                model,
+                (parserName: string) =>
+                  collectParserElementSnippetSuggestions(parserName),
+              ),
+            );
 
-          // suggestions for parser element snippets
-          suggestions = suggestions.concat(
-            getParserElementSnippetSuggestions(
-              position,
-              model,
-              (parserName: string) =>
-                collectParserElementSnippetSuggestions(parserName),
-            ),
-          );
+            // code snippet suggestions
+            suggestions = suggestions.concat(
+              getInlineSnippetSuggestions(
+                position,
+                model,
+                collectExtraInlineSnippetSuggestions(),
+              ),
+            );
 
-          // add inline code snippet suggestions
-          suggestions = suggestions.concat(
-            getInlineSnippetSuggestions(
-              position,
-              model,
-              collectExtraInlineSnippetSuggestions(),
-            ),
-          );
+            // identifier suggestions (fetched asynchronously)
+            suggestions = suggestions.concat(
+              await getIdentifierSuggestions(position, model, editorStore),
+            );
+          }
 
           return { suggestions };
         },
@@ -480,7 +557,9 @@ export const PureFileEditor = observer(
         }
 
         definitionProviderDisposer.current?.dispose();
-        suggestionProviderDisposer.current?.dispose();
+
+        pureConstructSuggestionProviderDisposer.current?.dispose();
+        pureIdentifierSuggestionProviderDisposer.current?.dispose();
       },
       [editorState, editor],
     );

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

@@ -39,6 +39,7 @@ import {
   CompressIcon,
   MenuContent,
   MenuContentItem,
+  MenuContentDivider,
 } from '@finos/legend-art';
 import { guaranteeType, isNonNullable } from '@finos/legend-shared';
 import { useDrag } from 'react-dnd';
@@ -57,7 +58,8 @@ const ConceptExplorerContextMenu = observer(
     }
   >(function ConceptExplorerContextMenu(props, ref) {
     const { node, viewConceptSource } = props;
-    const nodeType = node.data.li_attr.pureType;
+    const nodeAttribute = node.data.li_attr;
+    const nodeType = nodeAttribute.pureType;
     const editorStore = useEditorStore();
     const applicationStore = useApplicationStore();
     const renameConcept = (): void =>
@@ -70,7 +72,6 @@ const ConceptExplorerContextMenu = observer(
       );
     };
     const findUsages = (): void => {
-      const nodeAttribute = node.data.li_attr;
       if (
         nodeAttribute instanceof ElementConceptAttribute ||
         nodeAttribute instanceof PropertyConceptAttribute
@@ -87,32 +88,42 @@ const ConceptExplorerContextMenu = observer(
     const viewSource = (): void => viewConceptSource(node);
     const serviceJSON = (): void => {
       window.open(
-        `${editorStore.client.baseUrl}/execute?func=${node.data.li_attr.pureId}&mode=${editorStore.client.mode}`,
+        `${editorStore.client.baseUrl}/execute?func=${nodeAttribute.pureId}&mode=${editorStore.client.mode}`,
         '_blank',
       );
     };
+    const copyPath = (): void => {
+      applicationStore
+        .copyTextToClipboard(nodeAttribute.pureId)
+        .catch(applicationStore.alertUnhandledError);
+    };
 
     return (
       <MenuContent ref={ref}>
-        <MenuContentItem onClick={renameConcept}>Rename</MenuContentItem>
-        {node.data.li_attr instanceof ElementConceptAttribute && (
-          <MenuContentItem onClick={moveElement}>Move</MenuContentItem>
-        )}
+        {nodeAttribute.pureType !== ConceptType.PROPERTY &&
+          nodeAttribute.pureType !== ConceptType.QUALIFIED_PROPERTY && (
+            <MenuContentItem onClick={copyPath}>Copy Path</MenuContentItem>
+          )}
         {nodeType === ConceptType.PACKAGE && (
-          <MenuContentItem onClick={runTests}>Run tests</MenuContentItem>
+          <MenuContentItem onClick={runTests}>Run Tests</MenuContentItem>
         )}
         {nodeType === ConceptType.FUNCTION && (
           <MenuContentItem onClick={serviceJSON}>
             Service (JSON)
           </MenuContentItem>
         )}
-        {(node.data.li_attr instanceof PropertyConceptAttribute ||
-          node.data.li_attr instanceof ElementConceptAttribute) && (
+        {(nodeAttribute instanceof PropertyConceptAttribute ||
+          nodeAttribute instanceof ElementConceptAttribute) && (
           <MenuContentItem onClick={findUsages}>Find Usages</MenuContentItem>
         )}
         {nodeType !== ConceptType.PACKAGE && (
           <MenuContentItem onClick={viewSource}>View Source</MenuContentItem>
         )}
+        <MenuContentDivider />
+        <MenuContentItem onClick={renameConcept}>Rename</MenuContentItem>
+        {nodeAttribute instanceof ElementConceptAttribute && (
+          <MenuContentItem onClick={moveElement}>Move</MenuContentItem>
+        )}
       </MenuContent>
     );
   }),

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

@@ -40,6 +40,7 @@ import {
   WrenchIcon,
   MenuContent,
   MenuContentItem,
+  MenuContentDivider,
 } from '@finos/legend-art';
 import { isNonNullable } from '@finos/legend-shared';
 import {
@@ -76,9 +77,16 @@ const FileExplorerContextMenu = observer(
     };
     const renameFile = (): void =>
       editorStore.directoryTreeState.setNodeForRenameFile(node);
+    const copyPath = (): void => {
+      applicationStore
+        .copyTextToClipboard(node.data.li_attr.path)
+        .catch(applicationStore.alertUnhandledError);
+    };
 
     return (
       <MenuContent ref={ref}>
+        <MenuContentItem onClick={copyPath}>Copy Path</MenuContentItem>
+        <MenuContentDivider />
         {isDir && (
           <MenuContentItem onClick={createNewFile}>New File</MenuContentItem>
         )}

package/src/server/PureServerClient.ts

@@ -59,6 +59,11 @@ import type {
   ChildPackageableElementInfo,
   MovePackageableElementsInput,
 } from './models/MovePackageableElements.js';
+import type {
+  AttributeSuggestion,
+  ClassSuggestion,
+  ElementSuggestion,
+} from './models/Suggestion.js';
 
 export class PureClient {
   private networkClient: NetworkClient;
@@ -103,36 +108,6 @@ export class PureClient {
       },
     );
 
-  getFile = (path: string): Promise<PlainObject<File>> =>
-    this.networkClient.get(
-      `${this.baseUrl}/fileAsJson/${path}`,
-      undefined,
-      undefined,
-      {
-        sessionId: this.sessionId,
-        mode: this.mode,
-        fastCompile: this.compilerMode,
-      },
-    );
-
-  getDirectoryChildren = (
-    path?: string,
-  ): Promise<PlainObject<DirectoryNode>[]> =>
-    this.networkClient.get(`${this.baseUrl}/dir`, undefined, undefined, {
-      parameters: path ?? '/',
-      mode: this.mode,
-      sessionId: this.sessionId,
-    });
-
-  getConceptChildren = (path?: string): Promise<PlainObject<ConceptNode>[]> =>
-    this.networkClient.get(`${this.baseUrl}/execute`, undefined, undefined, {
-      func: 'meta::pure::ide::display_ide(String[1]):String[1]',
-      param: path ? `'${path}'` : "'::'",
-      format: 'raw',
-      mode: this.mode,
-      sessionId: this.sessionId,
-    });
-
   getConceptActivity = (): Promise<PlainObject<ConceptActivity>> =>
     this.networkClient.get(
       `${this.baseUrl}/conceptsActivity`,
@@ -173,6 +148,8 @@ export class PureClient {
       },
     );
 
+  // ------------------------------------------- Search -------------------------------------------
+
   findFiles = (searchText: string, isRegExp: boolean): Promise<string[]> =>
     this.networkClient.get(
       `${this.baseUrl}/findPureFiles`,
@@ -210,6 +187,8 @@ export class PureClient {
       coordinates,
     );
 
+  // ------------------------------------------- Test -------------------------------------------
+
   checkTestRunner = (
     testRunnerId: number,
   ): Promise<PlainObject<AbstractTestRunnerCheckResult>> =>
@@ -234,6 +213,17 @@ export class PureClient {
       },
     );
 
+  // ------------------------------------------- Concept -------------------------------------------
+
+  getConceptChildren = (path?: string): Promise<PlainObject<ConceptNode>[]> =>
+    this.networkClient.get(`${this.baseUrl}/execute`, undefined, undefined, {
+      func: 'meta::pure::ide::display_ide(String[1]):String[1]',
+      param: path ? `'${path}'` : "'::'",
+      format: 'raw',
+      mode: this.mode,
+      sessionId: this.sessionId,
+    });
+
   getConceptInfo = (
     file: string,
     line: number,
@@ -306,6 +296,29 @@ export class PureClient {
     );
   };
 
+  // ------------------------------------------- IO / File Management -------------------------------------------
+
+  getFile = (path: string): Promise<PlainObject<File>> =>
+    this.networkClient.get(
+      `${this.baseUrl}/fileAsJson/${path}`,
+      undefined,
+      undefined,
+      {
+        sessionId: this.sessionId,
+        mode: this.mode,
+        fastCompile: this.compilerMode,
+      },
+    );
+
+  getDirectoryChildren = (
+    path?: string,
+  ): Promise<PlainObject<DirectoryNode>[]> =>
+    this.networkClient.get(`${this.baseUrl}/dir`, undefined, undefined, {
+      parameters: path ?? '/',
+      mode: this.mode,
+      sessionId: this.sessionId,
+    });
+
   updateSource = (
     updateInputs: UpdateSourceInput[],
   ): Promise<PlainObject<SourceModificationResult>> =>
@@ -361,6 +374,8 @@ export class PureClient {
       },
     );
 
+  // ------------------------------------------- Diagram -------------------------------------------
+
   getDiagramInfo = async (
     diagramPath: string,
   ): Promise<PlainObject<DiagramInfo>> =>
@@ -390,4 +405,40 @@ export class PureClient {
         },
       ),
     );
+
+  // ------------------------------------------- Suggestion -------------------------------------------
+
+  getSuggestionsForIncompletePath = (
+    currentPackagePath: string,
+    types: string[],
+  ): Promise<PlainObject<ElementSuggestion>[]> =>
+    this.networkClient.post(`${this.baseUrl}/suggestion/incompletePath`, {
+      path: currentPackagePath,
+      types,
+    });
+
+  getSuggestionsForIdentifier = (
+    importPaths: string[],
+    types: string[],
+  ): Promise<PlainObject<ElementSuggestion>[]> =>
+    this.networkClient.post(`${this.baseUrl}/suggestion/identifier`, {
+      importPaths,
+      types,
+    });
+
+  getSuggestionsForAttribute = (
+    importPaths: string[],
+    path: string,
+  ): Promise<PlainObject<AttributeSuggestion>[]> =>
+    this.networkClient.post(`${this.baseUrl}/suggestion/attribute`, {
+      importPaths,
+      path,
+    });
+
+  getSuggestionsForClass = (
+    importPaths: string[],
+  ): Promise<PlainObject<ClassSuggestion>[]> =>
+    this.networkClient.post(`${this.baseUrl}/suggestion/class`, {
+      importPaths,
+    });
 }

package/src/server/models/ConceptTree.ts

@@ -30,6 +30,8 @@ export enum ConceptType {
   // PRIMITIVE = 'Primitive',
   PACKAGE = 'Package',
   PROFILE = 'Profile',
+  TAG = 'Tag',
+  STEREOTYPE = 'Stereotype',
   CLASS = 'Class',
   ASSOCIATION = 'Association',
   PROPERTY = 'Property',

package/src/server/models/Suggestion.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { createModelSchema, list, optional, primitive } from 'serializr';
+
+export class ElementSuggestion {
+  pureType!: string;
+  pureId!: string;
+  pureName!: string;
+  text!: string;
+  requiredClassProperties: string[] = [];
+}
+
+createModelSchema(ElementSuggestion, {
+  pureType: primitive(),
+  pureId: primitive(),
+  pureName: primitive(),
+  text: primitive(),
+  requiredClassProperties: optional(list(primitive())),
+});
+
+export class AttributeSuggestion {
+  pureType!: string;
+  pureName!: string;
+  owner!: string;
+  ownerPureType!: string;
+}
+
+createModelSchema(AttributeSuggestion, {
+  pureType: primitive(),
+  pureName: primitive(),
+  owner: primitive(),
+  ownerPureType: primitive(),
+});
+
+export class ClassSuggestion {
+  pureId!: string;
+  pureName!: string;
+  requiredClassProperties: string[] = [];
+}
+
+createModelSchema(ClassSuggestion, {
+  pureId: primitive(),
+  pureName: primitive(),
+  requiredClassProperties: optional(list(primitive())),
+});

package/src/stores/FileEditorState.ts

@@ -17,7 +17,6 @@
 import {
   type CommandRegistrar,
   EDITOR_LANGUAGE,
-  TAB_SIZE,
   type TabState,
 } from '@finos/legend-application';
 import {
@@ -118,7 +117,7 @@ class FileTextEditorState {
       fileEditorState.uuid,
       this.language,
     );
-    this.model.updateOptions({ tabSize: TAB_SIZE });
+    this.model.setValue(fileEditorState.file.content);
   }
 
   // trigger for the manual observer of editor cursor
@@ -235,6 +234,7 @@ export class FileEditorState
 
   setFile(val: File): void {
     this.file = val;
+    this.textEditorState.model.setValue(val.content);
   }
 
   setShowGoToLinePrompt(val: boolean): void {