From 8ba19adfa58c002614249f462c8fb88ce4a8ce3d Mon Sep 17 00:00:00 2001
From: Jonas <jonas@freesources.org>
Date: Mon, 4 Nov 2024 13:40:22 +0100
Subject: [PATCH] feat: Expose yjs debug function via OCA.Collectives

Should make it easier to debug sync issues.

Signed-off-by: Jonas <jonas@freesources.org>
---
 src/mixins/editorMixin.js | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/src/mixins/editorMixin.js b/src/mixins/editorMixin.js
index 20c66a9c7..288b34ea2 100644
--- a/src/mixins/editorMixin.js
+++ b/src/mixins/editorMixin.js
@@ -165,6 +165,7 @@ export default {
 					},
 				})
 				: null
+			this.setupEditorDebug()
 		},
 
 		updateEditorContent(markdown) {
@@ -187,5 +188,31 @@ export default {
 				this.hide('outline')
 			}
 		},
+
+		setupEditorDebug() {
+			window.OCA.Collectives.editorApi = this.editor
+			if (!window.OCA.Collectives.editorApi.debugYjs) {
+				window.OCA.Collectives.editorApi.debugYjs = () => {
+					const editorComponent = window.OCA.Collectives.editorApi.vm.$children[0]
+					const yjsData = {
+						clientId: editorComponent.$ydoc.clientID,
+						pendingStructs: editorComponent.$ydoc.store.pendingStructs,
+						clientVectors: [],
+						documentState: editorComponent.$syncService.getDocumentState(),
+					}
+					for (const client of editorComponent.$ydoc.store.clients.values()) {
+						yjsData.clientVectors.push(client.at(-1).id)
+					}
+
+					const intro = 'Editor Yjs debug data. Copy the object above that starts with "clientId".'
+					const introChrome = '- In Chrome, select "Copy" at the end of the line.'
+					const introFirefox = '- In Firefox, right-click on the object and select "Copy object".'
+					const styleBold = "font-weight: bold;"
+					const styleItalic = "font-weight: normal; font-style: italic;"
+					console.warn(JSON.stringify(yjsData, null, ' '))
+					console.warn('%c%s\n%c%s\n%s', styleBold, intro, styleItalic, introChrome, introFirefox)
+				}
+			}
+		},
 	},
 }