Skip to content

CollaborationExtension registered at runtime installs no sync plugin, so edits never reach the Y.Doc #3175

Open

Description

@ifeulner

Version: BlockNote 0.55 (@blocknote/core, @blocknote/react)

What happens

Collaboration registered on an editor that already exists doesn't sync. The editor becomes editable, typing works locally, and nothing is written to the Y.XmlFragment, so edits are silently lost.

We create a read-only editor without collaboration (fed a static snapshot, no provider). When the user switches to editing, we attach collaboration to that same editor instead of remounting it, which keeps scroll position and node views stable.

Cause (from reading the source)

ExtensionManager.replaceExtension installs the ProseMirror plugins of the extension it is given, but not those of that extension's nested blockNoteExtensions. For CollaborationExtension, the nested ones carry the actual plugins: YSync, YCursor, YUndo and the rest. So none of them are installed.

Workaround

Registering the sub-extensions flat works, in this order (the cursor plugin reads the sync plugin's state in its init):

  • YSync
  • YCursor
  • YUndo
  • ForkYDoc
  • RelativePositionMapping
  • SchemaMigration

FixUpSchemaExtension is not exported, so it can't be registered that way.

Repro

  1. Create an editor without the collaboration option.
  2. Register CollaborationExtension at runtime, with a Y.XmlFragment and a provider.
  3. Type in the editor.
  4. The fragment stays empty, and other clients see nothing.

Expected

Either nested blockNoteExtensions are installed when an extension is registered at runtime, or registering an extension whose nested extensions can't be installed throws instead of failing silently. A documented way to attach collaboration to an existing editor would also help.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions