Changed autosave handling for better editor performance

This changes how the editors interact with the parent page-editor
compontent, which handles auto-saving.
Instead of blasting the full editor content upon any change to that
parent compontent, the editors just alert of a change, without the
content. The parent compontent then requests the editor content from the
editor component when it needs that data for an autosave.

For #3981

diff --git a/resources/js/components/markdown-editor.js b/resources/js/components/markdown-editor.js
index 4c3de91f68cafff30c947edb4085a4898109cf9d..5cd92cae2bf1b7c556b2f947d5b0f2f360be3ba6 100644 (file)
--- a/resources/js/components/markdown-editor.js
+++ b/resources/js/components/markdown-editor.js
@@ -137,4 +137,13 @@ export class MarkdownEditor extends Component {
         return drawioAttrEl.getAttribute('drawio-url') || '';
     }
 
         return drawioAttrEl.getAttribute('drawio-url') || '';
     }
 

+    /**
+     * Get the content of this editor.
+     * Used by the parent page editor component.
+     * @return {{html: String, markdown: String}}
+     */
+    getContent() {
+        return this.editor.actions.getContent();
+    }
+

 }
 }

diff --git a/resources/js/components/page-editor.js b/resources/js/components/page-editor.js
index 950a5a3b3308ee928039e82a96eac859f20beb53..c58f45b66198544c4ffd0f8d21052d95a09ea1ae 100644 (file)
--- a/resources/js/components/page-editor.js
+++ b/resources/js/components/page-editor.js
@@ -33,12 +33,11 @@ export class PageEditor extends Component {
         this.setChangelogText = this.$opts.setChangelogText;
 
         // State data
         this.setChangelogText = this.$opts.setChangelogText;
 
         // State data

-        this.editorHTML = '';
-        this.editorMarkdown = '';

         this.autoSave = {
             interval: null,
             frequency: 30000,
             last: 0,
         this.autoSave = {
             interval: null,
             frequency: 30000,
             last: 0,

+            pendingChange: false,

         };
         this.shownWarningsCache = new Set();
 
         };
         this.shownWarningsCache = new Set();
 


@@ -59,12 +58,12 @@ export class PageEditor extends Component {
         window.$events.listen('editor-save-page', this.savePage.bind(this));
 
         // Listen to content changes from the editor
         window.$events.listen('editor-save-page', this.savePage.bind(this));
 
         // Listen to content changes from the editor

-        window.$events.listen('editor-html-change', html => {
-            this.editorHTML = html;
-        });
-        window.$events.listen('editor-markdown-change', markdown => {
-            this.editorMarkdown = markdown;
-        });
+        const onContentChange = () => this.autoSave.pendingChange = true;
+        window.$events.listen('editor-html-change', onContentChange);
+        window.$events.listen('editor-markdown-change', onContentChange);
+
+        // Listen to changes on the title input
+        this.titleElem.addEventListener('input', onContentChange);

 
         // Changelog controls
         const updateChangelogDebounced = debounce(this.updateChangelogDisplay.bind(this), 300, false);
 
         // Changelog controls
         const updateChangelogDebounced = debounce(this.updateChangelogDisplay.bind(this), 300, false);


@@ -89,18 +88,17 @@ export class PageEditor extends Component {
     }
 
     startAutoSave() {
     }
 
     startAutoSave() {

-        let lastContent = this.titleElem.value.trim() + '::' + this.editorHTML;
-        this.autoSaveInterval = window.setInterval(() => {
-            // Stop if manually saved recently to prevent bombarding the server
-            let savedRecently = (Date.now() - this.autoSave.last < (this.autoSave.frequency)/2);
-            if (savedRecently) return;
-            const newContent = this.titleElem.value.trim() + '::' + this.editorHTML;
-            if (newContent !== lastContent) {
-                lastContent = newContent;
-                this.saveDraft();
-            }
+        this.autoSave.interval = window.setInterval(this.runAutoSave.bind(this), this.autoSave.frequency);
+    }

 
 

-        }, this.autoSave.frequency);
+    runAutoSave() {
+        // Stop if manually saved recently to prevent bombarding the server
+        const savedRecently = (Date.now() - this.autoSave.last < (this.autoSave.frequency)/2);
+        if (savedRecently || !this.autoSave.pendingChange) {
+            return;
+        }
+
+        this.saveDraft()

     }
 
     savePage() {
     }
 
     savePage() {


@@ -108,14 +106,10 @@ export class PageEditor extends Component {
     }
 
     async saveDraft() {
     }
 
     async saveDraft() {

-        const data = {
-            name: this.titleElem.value.trim(),
-            html: this.editorHTML,
-        };
+        const data = {name: this.titleElem.value.trim()};

 
 

-        if (this.editorType === 'markdown') {
-            data.markdown = this.editorMarkdown;
-        }
+        const editorContent = this.getEditorComponent().getContent();
+        Object.assign(data, editorContent);

 
         let didSave = false;
         try {
 
         let didSave = false;
         try {


@@ -132,6 +126,7 @@ export class PageEditor extends Component {
             }
 
             didSave = true;
             }
 
             didSave = true;

+            this.autoSave.pendingChange = false;

         } catch (err) {
             // Save the editor content in LocalStorage as a last resort, just in case.
             try {
         } catch (err) {
             // Save the editor content in LocalStorage as a last resort, just in case.
             try {


@@ -207,4 +202,11 @@ export class PageEditor extends Component {
         }
     }
 
         }
     }
 

+    /**
+     * @return MarkdownEditor|WysiwygEditor
+     */
+    getEditorComponent() {
+        return window.$components.first('markdown-editor') || window.$components.first('wysiwyg-editor');
+    }
+

 }
 }

diff --git a/resources/js/components/wysiwyg-editor.js b/resources/js/components/wysiwyg-editor.js
index 976dba68f6eefc654f83495dc2d245d8eeb164bb..96731a0d9088d6b0009876140874a55768710ea5 100644 (file)
--- a/resources/js/components/wysiwyg-editor.js
+++ b/resources/js/components/wysiwyg-editor.js
@@ -25,7 +25,9 @@ export class WysiwygEditor extends Component {
         });
 
         window.$events.emitPublic(this.elem, 'editor-tinymce::pre-init', {config: this.tinyMceConfig});
         });
 
         window.$events.emitPublic(this.elem, 'editor-tinymce::pre-init', {config: this.tinyMceConfig});

-        window.tinymce.init(this.tinyMceConfig);
+        window.tinymce.init(this.tinyMceConfig).then(editors => {
+            this.editor = editors[0];
+        });

     }
 
     getDrawIoUrl() {
     }
 
     getDrawIoUrl() {


@@ -36,4 +38,15 @@ export class WysiwygEditor extends Component {
         return '';
     }
 
         return '';
     }
 

+    /**
+     * Get the content of this editor.
+     * Used by the parent page editor component.
+     * @return {{html: String}}
+     */
+    getContent() {
+        return {
+            html: this.editor.getContent()
+        };
+    }
+

 }
\ No newline at end of file
 }
\ No newline at end of file

diff --git a/resources/js/markdown/actions.js b/resources/js/markdown/actions.js
index c2c3409a590cdc02ee68d11d326e7a246fe5ffca..9faf43de34143a69933e2aeeea5a2dbb333e2fb4 100644 (file)
--- a/resources/js/markdown/actions.js
+++ b/resources/js/markdown/actions.js
@@ -6,6 +6,10 @@ export class Actions {
      */
     constructor(editor) {
         this.editor = editor;
      */
     constructor(editor) {
         this.editor = editor;

+        this.lastContent = {
+            html: '',
+            markdown: '',
+        };

     }
 
     updateAndRender() {
     }
 
     updateAndRender() {


@@ -13,11 +17,17 @@ export class Actions {
         this.editor.config.inputEl.value = content;
 
         const html = this.editor.markdown.render(content);
         this.editor.config.inputEl.value = content;
 
         const html = this.editor.markdown.render(content);

-        window.$events.emit('editor-html-change', html);
-        window.$events.emit('editor-markdown-change', content);
+        window.$events.emit('editor-html-change', '');
+        window.$events.emit('editor-markdown-change', '');
+        this.lastContent.html = html;
+        this.lastContent.markdown = content;

         this.editor.display.patchWithHtml(html);
     }
 
         this.editor.display.patchWithHtml(html);
     }
 

+    getContent() {
+        return this.lastContent;
+    }
+

     insertImage() {
         const cursorPos = this.editor.cm.getCursor('from');
         /** @type {ImageManager} **/
     insertImage() {
         const cursorPos = this.editor.cm.getCursor('from');
         /** @type {ImageManager} **/

diff --git a/resources/js/wysiwyg/config.js b/resources/js/wysiwyg/config.js
index d5ec20e2631356ba2d09ed7e4f0b7cfd2521e7ca..85c1919d494e8bcd776dcbe9fd93ebebf5b61184 100644 (file)
--- a/resources/js/wysiwyg/config.js
+++ b/resources/js/wysiwyg/config.js
@@ -185,11 +185,10 @@ function getSetupCallback(options) {
         });
 
         function editorChange() {
         });
 
         function editorChange() {

-            const content = editor.getContent();

             if (options.darkMode) {
                 editor.contentDocument.documentElement.classList.add('dark-mode');
             }
             if (options.darkMode) {
                 editor.contentDocument.documentElement.classList.add('dark-mode');
             }

-            window.$events.emit('editor-html-change', content);
+            window.$events.emit('editor-html-change', '');

         }
 
         // Custom handler hook
         }
 
         // Custom handler hook