use editor.sharedRoot in connect/disconnect

[zarv1k]

Hi!

First of all I wanna thank you for the great library!

That PR fixes subscribing for events on actual editor.sharedRoot that could be replaced/overwritten by developers in their own plugins.

In some use cases there should be possible to replace/overwrite editor.sharedRoot in your own plugins, e.g. to be able to initialize Y.Doc/sharedRoot in your own plugins (lazily in sync or even async way), e.g. custom plugin that fetches initial StateVector from backend and after that to call editor.connect() . But when I overwrite editor.sharedRoot in my own plugin and call editor.connect() it continue subscribing to initial sharedRoot from withYjs plugin argument.

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 27d39ddc3cf79797a878d0540f8b2605fcf38988

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

| Name | Type | | -------------------------- | ----- | | @slate-yjs/core | Patch | | @slate-yjs/example-backend | Patch | | @slate-yjs/example | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[codecov[bot]]

Codecov Report

Merging #358 (551368b) into main (576b809) will not change coverage. The diff coverage is 50.00%.

:exclamation: Current head 551368b differs from pull request most recent head 27d39dd. Consider uploading reports for the commit 27d39dd to get more accurate results

@@           Coverage Diff           @@
##             main     #358   +/-   ##
=======================================
  Coverage   71.31%   71.31%           
=======================================
  Files          30       30           
  Lines        2301     2301           
  Branches      297      297           
=======================================
  Hits         1641     1641           
  Misses        660      660           

Impacted Files	Coverage Δ
packages/core/src/plugins/withYjs.ts	81.07% <50.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[BitPhinix]

Thanks for this PR! Just released a new version with the change. I'd be curious to see the details of what exactly you are doing though, sounds interesting 😅

[zarv1k]

@BitPhinix Thank you for such a lightning reply and release!

If you asked about some details, I'll try to explain my needs in short: I believe that there could be different approaches to how to initialize your editor. I need all the stuff related to slate for collaborative needs encapsulated in different plugins. I need my editor to be able to work in poor network, so I need to sync as with backend (via websocket async provider but getting initial update (diffUpdate by local stateVector) via REST) as with local YDoc provider (e.g. custom indexeddb async provider). I need to turn off local provider or even backend sync plugin just by removing detaching plugin which is responsible for it.

So in my setup I split my collaboration functionalities by plugins:

• withYDoc(options: {docId: string, fetchInitialUpdate: () => Promise<UInt8Array>}) - it just responsible for creating YDoc instance, getting initialUpdate (diffUpdate) from any promise API and nothing else. It holds editor.yDoc instance and provides some methods like editor.yLoadDoc() editor.yCreateDoc() etc. that could be overwritten by next plugins. Also it fires (just calls) async method e.onYDocInit(doc: Y.Doc)) just after YDoc editor is created and initialized (initial diffUpdate from any storage applied) by this plugin (by default) or by next yDoc-related plugins;
• withYIndexedDb - this is a custom plugin that implements support for offline editing and persists state (I save diffUpdate update messages) and prevents user to loose some info that added into slate editor during no connection. YDoc diff updates live in indexed DB, API of which is async. I need initialize my YDoc for user as soon as possible, either from backend or from local provider to provide my user to see his local changes even the have not delivered to backend yet, so this plugin overrides method editor.yDocInit introduces by withYDoc plugin and here we are able to init YDoc from one more different storage (from both storages actually).
• withCustomYjs - returns result of withYjs(editor, null)(from @slate-js/core). I can't paste initialized sharedRoot before createEditor(), I need to initialize it later in sync/async way in my plugins. So here in this plugin we override editor.onYDocInit method that called by withYDoc after YDoc has been initialized from somewhere in previous plugins and add editor.sharedRoot = YDoc.get('content', Y.XmlText) And finally we call editor.connect() only here.
• withYSyncProtocol({onMsg, sendMsg}) - plugin that uses editor.yDoc and responsible for implementation of y-protocols/sync protocol.

Such an approach allows me to disable some features on demand. With such a set of plugins, I can have either only offline editor, or only online one, or both way. And most important here is that I can implement and add any other plugins next (or in the middle) to add different transport like webRTC.

Hope it's clear for now. Feel free to ask me questions if left.

Actually, current version of withYHistory in package also makes it hard to work with lazily initialized YDoc by plugins, coz. it now instantiates Y.UndoManager that requires already initialized e.sharedRoot before all plugins applied and editor created.