feat(debug): Expose yjs debug function in editor API #6598
Conversation
Should make it easier to debug sync issues. Signed-off-by: Jonas <[email protected]>
| /** | ||
| * Helper method to debug yjs issues | ||
| */ | ||
| debugYjs() { |
There was a problem hiding this comment.
Do we have this somewhat accessible when text open in viewer so we can also ask people editing to dump the output when editing outside of collectives?
There was a problem hiding this comment.
Well, it's a bit complicated to expose this, as we don't know how many editor instances are instantiated in the browser. We could create an array OCA.Text.editors and add each editor along with the debugYjs function as a new item. This should probably be done in Editor.vue, as all editors that use a session and Yjs are created from here to my knowledge. I don't see any value in exposing the non-session editors from MarkdownContentEditor.vue and BaseReader.vue. What do you think?
There was a problem hiding this comment.
Having an array of editors sounds reasonable. We can add the filename maybe to the debug output so that the individual ones can be identified (e.g. a readme is open and a viewer instance).
I think we don't need to make it too complex, as long as we can somehow get the information and identify the relevant instance.
Should make it easier to debug sync issues.
Screenshot
🏁 Checklist
npm run lint/npm run stylelint/composer run cs:check)