Releases · ueberdosis/hocuspocus

Hocuspocus 2.0.0 Release

After the stable release in January 2023, Hocuspocus gets its first major version update with the new core feature called “Multiplexing”.
Multiplexing allows you to synchronize multiple documents over the same websocket connection. This is especially useful when working with multiple documents at the same time and will make this experience even faster.

Please note that you need to update both the provider and the server, versions cannot be mixed

The client/server protocol has been changed, so if you are handling messages directly, you might have to adjust something. Otherwise, if you don't want to use multiplexing, you don't need to change anything.

Before:
[HocuspocusMessageType][YjsMessageType][yjs binary]

After:
[documentName][HocuspocusMessageType][YjsMessageType][yjs binary]

Using multiplexing

See this example on how to use multiplexing (more docs will follow):

const socket = new HocuspocusProviderWebsocket({
  url: 'ws://127.0.0.1:1234',
})

const provider = new HocuspocusProvider({
  websocketProvider: socket,
  name: 'hocuspocus-demo',
  broadcast: false,
})

const anotherProvider = new HocuspocusProvider({
  websocketProvider: socket,
  name: 'hocuspocus-demo2',
  broadcast: false,
})

TiptapCollab

TiptapCollab runs Hocuspocus 2, so it fully supports multiplexing

This is the first alpha release introducing multiplexing support.

The status is still a bit early, but I already wanted to gather as much feedback as possible and find potential testers in the community. I currently do not have a bigger project where I can test this, so if you can use multiplexing in your project and are willing to give the current implementation a try, this would be much appreciated and helps to get this merged soon.

On the frontend side, all connection logic has been split to a new ‘HocuspocusProviderWebsocket’, which needs to be passed to your HocuspocusProvider(s). So if you want to synchronize three documents, you’ll create one HocuspocusProviderWebsocket and three HocuspocusProvider, which gets passed the websocket (webSocket param). Authentication works per document, so the URL has to be passed to the HocuspocusProviderWebsocket, tokens to the provider related with the document. A working example can be found in playground/frontend/src/pages/Index.vue. Provider events are filtered by documentName, so the frontend shouldnt require further changes. Same on the backend, note that internally we’re spawning different Connection instances that each handle one document connection (through the same websocket). If you are somehow parsing the websocket messages yourself, please note that the protocol has changed and now includes the documentName at the first segment of the message.

You can find the PR here for details: #484

If you need any help, feel free to ping me (@janthurau) on Discord or send me a direct message.