Markdown Live preview for Source Editor

What does this MR do?

Introduces the Live Preview functionality for the markdown extension of Source Editor. At the moment, the extension is only used when editing markdown files in a repository (single-file editor). Live Preview for WebIDE will be added as a separate MR.

Screenshots or Screencasts (strongly suggested)

How to setup and validate locally (strongly suggested)

1. Open a file in a project
2. Click "Edit" (not WebIDE or Gitpod)
3. You will get the regular instance of Source editor at this moment
4. While focused in the editor do one of the following:
   • right-click and select "Preview Markdown", or
   • press SHIFT + Command + P (Shift + Ctrl + P on Windows)
5. This will open the live preview panel to the right of the editor

Does this MR meet the acceptance criteria?

Conformity

• I have included changelog trailers, or none are needed. (Does this MR need a changelog?)
• I have added/updated documentation, or it's not needed. (Is documentation required?)
• I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?)
• I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?)
• I have self-reviewed this MR per code review guidelines.
• This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines)
• I have followed the style guides.
• This change is backwards compatible across updates, or this does not apply.

Availability and Testing

• I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.)
• I have tested this MR in all supported browsers, or it's not needed.
• I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

• Label as security and @ mention @gitlab-com/gl-security/appsec
• The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
• Security reports checked/validated by a reviewer from the AppSec team

Related to #280798 (closed)

app/assets/javascripts/editor/extensions/source_editor_markdown_ext.js

@@ -9,6 +9,7 @@ import {
   EXTENSION_MARKDOWN_PREVIEW_PANEL_CLASS,
   EXTENSION_MARKDOWN_PREVIEW_ACTION_ID,
   EXTENSION_MARKDOWN_PREVIEW_PANEL_WIDTH,
+  EXTENSION_MARKDOWN_PREVIEW_PANEL_PARENT_CLASS,
 } from '../constants';
 import { SourceEditorExtension } from './source_editor_extension_base';
 
@@ -30,63 +31,76 @@ const getPreview = (text, projectPath = '') => {
     });
 };
 
-export class EditorMarkdownExtension extends SourceEditorExtension {
-  constructor({ instance, ...args } = {}) {
-    super({ instance, ...args });
-    EditorMarkdownExtension.setupLivePreview(instance);
+const setupDomElement = ({ injectToEl = null } = {}) => {
+  const previewEl = document.createElement('div');
+  previewEl.classList.add(EXTENSION_MARKDOWN_PREVIEW_PANEL_CLASS);
+  previewEl.style.display = 'none';
+  if (injectToEl) {
+    injectToEl.appendChild(previewEl);
   }
+  return previewEl;
+};
 
-  static setupPanelElement(injectToEl = null) {
-    const previewEl = document.createElement('div');
-    previewEl.classList.add(EXTENSION_MARKDOWN_PREVIEW_PANEL_CLASS);
-    previewEl.style.display = 'none';
-    if (injectToEl) {
-      injectToEl.appendChild(previewEl);
-    }
-    return previewEl;
+export class EditorMarkdownExtension extends SourceEditorExtension {
+  constructor({ instance, projectPath, ...args } = {}) {
+    super({ instance, ...args });
+    Object.assign(instance, {
+      projectPath,
+      preview: {
+        el: undefined,
+        action: undefined,
+        shown: false,
+      },
+    });
+    this.setupPreviewAction.call(instance);
   }
 
-  static togglePreviewLayout(editor) {
-    const currentLayout = editor.getLayoutInfo();
-    const width = editor.preview
-      ? currentLayout.width / EXTENSION_MARKDOWN_PREVIEW_PANEL_WIDTH
-      : currentLayout.width * EXTENSION_MARKDOWN_PREVIEW_PANEL_WIDTH;
-    editor.layout({ width, height: currentLayout.height });
+  static togglePreviewLayout() {
+    const { width, height } = this.getLayoutInfo();
+    const newWidth = this.preview.shown
+      ? width / EXTENSION_MARKDOWN_PREVIEW_PANEL_WIDTH
+      : width * EXTENSION_MARKDOWN_PREVIEW_PANEL_WIDTH;
+    this.layout({ width: newWidth, height });
   }
 
-  static togglePreviewPanel(editor) {
-    const parentEl = editor.getDomNode().parentElement;
-    const { previewEl } = editor;
-    parentEl.classList.toggle('source-editor-preview');
+  static togglePreviewPanel() {
+    const parentEl = this.getDomNode().parentElement;
+    const { el: previewEl } = this.preview;
+    parentEl.classList.toggle(EXTENSION_MARKDOWN_PREVIEW_PANEL_PARENT_CLASS);
 
     if (previewEl.style.display === 'none') {
       // Show the preview panel
-      const fetchPreview = () => {
-        getPreview(editor.getValue(), editor.projectPath)
-          .then((data) => {
-            previewEl.innerHTML = sanitize(data);
-            syntaxHighlight(previewEl.querySelectorAll('.js-syntax-highlight'));
-            previewEl.style.display = 'block';
-          })
-          .catch(() => createFlash(BLOB_PREVIEW_ERROR));
-      };
-      fetchPreview();
-      Object.assign(editor, {
-        modelChangeListener: editor.onDidChangeModelContent(
-          debounce(fetchPreview.bind(editor), 250),
-        ),
-      });
+      this.fetchPreview();
     } else {
       // Hide the preview panel
       previewEl.style.display = 'none';
-      editor.modelChangeListener.dispose();
     }
   }
 
-  static setupLivePreview(instance) {
-    if (!instance || instance.getAction(EXTENSION_MARKDOWN_PREVIEW_ACTION_ID)) return;
+  cleanup() {
+    this.preview.action.dispose();
+    if(this.preview.shown) {
+      EditorMarkdownExtension.togglePreviewPanel.call(this);
+      EditorMarkdownExtension.togglePreviewLayout.call(this);
+    }
+    this.preview.shown = false;
+  }
+
+  fetchPreview() {
+    const { el: previewEl } = this.preview;
+    getPreview(this.getValue(), this.projectPath)
+      .then((data) => {
+        previewEl.innerHTML = sanitize(data);
+        syntaxHighlight(previewEl.querySelectorAll('.js-syntax-highlight'));
+        previewEl.style.display = 'block';
+      })
+      .catch(() => createFlash(BLOB_PREVIEW_ERROR));
+  }
+
+  setupPreviewAction() {
+    if (this.getAction(EXTENSION_MARKDOWN_PREVIEW_ACTION_ID)) return;
 
-    instance.addAction({
+    this.preview.action = this.addAction({
       id: EXTENSION_MARKDOWN_PREVIEW_ACTION_ID,
       label: __('Preview Markdown'),
       keybindings: [
@@ -98,19 +112,36 @@ export class EditorMarkdownExtension extends SourceEditorExtension {
 
       // Method that will be executed when the action is triggered.
       // @param ed The editor instance is passed in as a convenience
-      run(e) {
-        e.togglePreview();
+      run(instance) {
+        instance.togglePreview();
       },
     });
   }
 
   togglePreview() {
-    if (!this.previewEl) {
-      this.previewEl = EditorMarkdownExtension.setupPanelElement(this.getDomNode().parentElement);
+    if (!this.preview?.el) {
+      this.preview.el = setupDomElement({ injectToEl: this.getDomNode().parentElement });
+    }
+    EditorMarkdownExtension.togglePreviewLayout.call(this);
+    EditorMarkdownExtension.togglePreviewPanel.call(this);
+
+    if (!this.preview?.shown) {
+      this.modelChangeListener = this.onDidChangeModelContent(
+        debounce(this.fetchPreview.bind(this), 250),
+      );
+    } else {
+      this.modelChangeListener.dispose();
     }
-    EditorMarkdownExtension.togglePreviewLayout(this);
-    EditorMarkdownExtension.togglePreviewPanel(this);
-    this.preview = !this.preview;
+
+    this.preview.shown = !this.preview?.shown;
+
+    this.getModel().onDidChangeLanguage(({ newLanguage, oldLanguage } = {}) => {
+      if (newLanguage === 'markdown' && oldLanguage !== newLanguage) {
+        this.setupPreviewAction();
+      } else {
+        this.cleanup();
+      }
+    });
   }
 
   getSelectedText(selection = this.getSelection()) {