refactor(monaco-editor): use action for 'jump to def' feature

This new monaco action is now part of apidom language
plugin. New language service is not instantiated anymore,
istead running apidom worker is used to get the data.

Author: char0n

package-lock.json

@@ -78,7 +78,7 @@
     "js-file-download": "^0.4.12",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
-    "monaco-editor": "^0.34.1",
+    "monaco-editor": "^0.36.1",
     "prop-types": "^15.8.1",
     "react": "^17.0.2",
     "react-collapse-pane": "^3.0.1",
@@ -92,7 +92,7 @@
     "short-unique-id": "^4.4.4",
     "styled-components": "^5.3.9",
     "swagger-ui-react": "^5.0.0-alpha.4",
-    "vscode": "npm:@codingame/monaco-vscode-api@~1.69.13",
+    "vscode": "npm:@codingame/monaco-vscode-api@~1.76.2",
     "vscode-languageclient": "^8.1.0",
     "vscode-languageserver-textdocument": "^1.0.8"
   },

package.json

@@ -99,6 +99,15 @@ export class ApiDOMWorker {
     return this._languageService.doDeref(document, dereferenceContext);
   }
 
+  async getJsonPointerPosition(uri, jsonPointer) {
+    const document = this._getTextDocument(uri);
+    if (!document) {
+      return [];
+    }
+
+    return this._languageService.getJsonPointerPosition(document, jsonPointer);
+  }
+
   _getTextDocument(uri) {
     const model = this._ctx.getMirrorModels().find((mm) => mm.uri.toString() === uri);
 

src/plugins/editor-monaco-language-apidom/language/ApiDOMWorker.js

@@ -1,11 +1,11 @@
 import { getWorker } from '../apidom-mode.js';
 
 const dereferenceActionDescriptor = {
-  id: 'apidom-dereference',
+  id: 'swagger.editor.apidomDereference',
   label: 'Resolve document',
   async run(editor) {
     const model = editor.getModel();
-    const worker = await getWorker()();
+    const worker = await getWorker()(model.uri);
     const dereferenced = await worker.doDeref(model.uri.toString(), {
       baseURI: globalThis.document.baseURI || globalThis.location.href,
     });

src/plugins/editor-monaco-language-apidom/language/actions/dereference.js

@@ -0,0 +1,23 @@
+import { getWorker } from '../apidom-mode.js';
+
+const jsonPointerPositionDescriptor = {
+  id: 'swagger.editor.jsonPointerPosition',
+  label: 'Translate JSON Pointer to editor position',
+  async run(editor, { jsonPointer, onSuccess, onFailure }) {
+    try {
+      const model = editor.getModel();
+      const worker = await getWorker()(model.uri);
+      const position = await worker.getJsonPointerPosition(model.uri.toString(), jsonPointer);
+
+      if (position) {
+        onSuccess({ startLineNumber: position.line, startColumn: position.character - 1 });
+      } else {
+        onFailure(new Error(`Failed to compute position from JSON Pointer "${jsonPointer}"`));
+      }
+    } catch (error) {
+      onFailure(error);
+    }
+  },
+};
+
+export default jsonPointerPositionDescriptor;

src/plugins/editor-monaco-language-apidom/language/actions/json-pointer-position.js

@@ -5,6 +5,7 @@ import { ModesRegistry } from 'monaco-editor/esm/vs/editor/common/languages/mode
 import * as apidom from './apidom.js';
 import { setupMode } from './apidom-mode.js';
 import dereferenceActionDescriptor from './actions/dereference.js';
+import jsonPointerPositionActionDescriptor from './actions/json-pointer-position.js';
 
 export { getWorker } from './apidom-mode.js';
 
@@ -97,9 +98,10 @@ const lazyMonacoContribution = ({ createData }) => {
     monaco.editor.onDidCreateEditor((editor) => {
       disposables.push(
         monaco.editor.onDidCreateModel(() => {
-          if (editor.getAction(dereferenceActionDescriptor.id)) return;
-
-          disposables.push(editor.addAction(dereferenceActionDescriptor));
+          if (!editor.getAction(dereferenceActionDescriptor.id)) {
+            disposables.push(editor.addAction(dereferenceActionDescriptor));
+          }
+          disposables.push(editor.addAction(jsonPointerPositionActionDescriptor));
         })
       );
     })

src/plugins/editor-monaco-language-apidom/language/monaco.contribution.js

@@ -5,7 +5,6 @@ import noop from 'lodash/noop.js';
 
 import seVsDarkTheme from '../../themes/se-vs-dark.js';
 import seVsLightTheme from '../../themes/se-vs-light.js';
-import { requestGetJsonPointerPosition } from '../../utils/monaco-jump-from-path-to-line.js';
 import { useMount, useUpdate, useSmoothResize } from './hooks.js';
 
 /**
@@ -150,26 +149,26 @@ const MonacoEditor = ({
   // given a jsonPointer, request jumping to its marker position
   useUpdate(
     () => {
-      async function findMarkerPosition() {
-        // via apidom-ls
-        const foundMarkerPosition = await requestGetJsonPointerPosition(
-          editorRef.current,
-          requestJumpToMarker.jsonPointer
-        );
-        if (foundMarkerPosition?.data) {
-          // set jumpToMarker in state, which will then call the useUpdate above
-          onSetRequestJumpToMarker(foundMarkerPosition.data);
-          // then clear the request itself
-          onClearRequestJumpToMarker();
-        } else {
-          // just clear the request anyway
-          onClearRequestJumpToMarker();
-        }
-      }
+      if (!requestJumpToMarker?.jsonPointer) return;
 
-      if (requestJumpToMarker?.jsonPointer && editorRef?.current?.getModel) {
-        // call the async/await function
-        findMarkerPosition();
+      /**
+       * In monaco-editor >= 0.37, triggering the action using `editor.trigger()`
+       * will pass the payload to the action. Currently, there is a pending bug in
+       * monaco-editor, and we have to call the action in this hacky way.
+       *
+       * More info in: https://stackoverflow.com/questions/75685974/open-find-widget-with-content-programatically-in-monaco
+       */
+      const action = editorRef.current.getAction('swagger.editor.jsonPointerPosition');
+      if (action) {
+        // eslint-disable-next-line no-underscore-dangle
+        action._run(editorRef.current, {
+          jsonPointer: requestJumpToMarker.jsonPointer,
+          onSuccess: (position) => {
+            onSetRequestJumpToMarker(position);
+            onClearRequestJumpToMarker();
+          },
+          onFailure: () => onClearRequestJumpToMarker(),
+        });
       }
     },
     [requestJumpToMarker, onSetRequestJumpToMarker, onClearRequestJumpToMarker],