Skip to content

Commit

Permalink
Changed autosave handling for better editor performance
Browse files Browse the repository at this point in the history
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
  • Loading branch information
ssddanbrown committed Feb 23, 2023
1 parent 3149575 commit 6545afa
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 31 deletions.
9 changes: 9 additions & 0 deletions resources/js/components/markdown-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,13 @@ export class MarkdownEditor extends Component {
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();
}

}
54 changes: 28 additions & 26 deletions resources/js/components/page-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,11 @@ export class PageEditor extends Component {
this.setChangelogText = this.$opts.setChangelogText;

// State data
this.editorHTML = '';
this.editorMarkdown = '';
this.autoSave = {
interval: null,
frequency: 30000,
last: 0,
pendingChange: false,
};
this.shownWarningsCache = new Set();

Expand All @@ -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-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);
Expand All @@ -89,33 +88,28 @@ export class PageEditor extends Component {
}

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() {
this.container.closest('form').submit();
}

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 {
Expand All @@ -132,6 +126,7 @@ export class PageEditor extends Component {
}

didSave = true;
this.autoSave.pendingChange = false;
} catch (err) {
// Save the editor content in LocalStorage as a last resort, just in case.
try {
Expand Down Expand Up @@ -207,4 +202,11 @@ export class PageEditor extends Component {
}
}

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

}
15 changes: 14 additions & 1 deletion resources/js/components/wysiwyg-editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ export class WysiwygEditor extends Component {
});

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() {
Expand All @@ -36,4 +38,15 @@ export class WysiwygEditor extends Component {
return '';
}

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

}
14 changes: 12 additions & 2 deletions resources/js/markdown/actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,28 @@ export class Actions {
*/
constructor(editor) {
this.editor = editor;
this.lastContent = {
html: '',
markdown: '',
};
}

updateAndRender() {
const content = this.editor.cm.getValue();
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);
}

getContent() {
return this.lastContent;
}

insertImage() {
const cursorPos = this.editor.cm.getCursor('from');
/** @type {ImageManager} **/
Expand Down
3 changes: 1 addition & 2 deletions resources/js/wysiwyg/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,10 @@ function getSetupCallback(options) {
});

function editorChange() {
const content = editor.getContent();
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
Expand Down

0 comments on commit 6545afa

Please sign in to comment.