Document new WebsocketProvider usage vs WebsocketPolyfill

[georeith]

WebsocketPolyfill was previously used to pass a websocket polyfill for NodeJS. Now it seems to have been superseded by websocketProvider however this is undocumented.

Looking at the code I notice that url and parameters are now ignored by HocuspocusProvider when you pass a custom websocketProvider and should be passed directly to it.

Would be helpful to document the intended usage of websocketProvider, and perhaps consider bringing back the ability to polyfill Websocket without the additional configuration changes.

[janthurau]

hey @georeith, HocuspocusProvider will still accept url and parameters if there is no websocketProvider passed, but then it will just create its own HOcuspocusProviderWebsocket. I implemented this for easier migration.

If you want to pass a polyfill, you can just pass a websocketProvider to Hocuspocusprovider:

const socket = new HocuspocusProviderWebsocket({WebSocketPolyfill: polyfill})
const provider = new HocuspocusProvider({ providerWebsocket: socket})

All methods related to the connection itself have been moved to the websocket, so we can't just pass a polyfill to the provider.

[georeith]

hey @georeith, HocuspocusProvider will still accept url and parameters if there is no websocketProvider passed, but then it will just create its own HOcuspocusProviderWebsocket. I implemented this for easier migration.

If you want to pass a polyfill, you can just pass a websocketProvider to Hocuspocusprovider:

const socket = new HocuspocusProviderWebsocket({WebSocketPolyfill: polyfill})
const provider = new HocuspocusProvider({ providerWebsocket: socket})

All methods related to the connection itself have been moved to the websocket, so we can't just pass a polyfill to the provider.

Thanks @janthurau, I had worked out how to use it but think it should be documented that url and params need to be passed directly to it when you do as I had to reverse engineer the code to find that info.

[mnzaki]

Tripped up by this as well, following the docs from https://tiptap.dev/docs/hocuspocus/provider/configuration
Future readers note that the correct snippet should be something like:

const socket = new HocuspocusProviderWebsocket({WebSocketPolyfill: polyfill, url: '...' })
const provider = new HocuspocusProvider({ websocketProvider: socket})

websocketProvider instead of providerWebsocket and url in the socket config