Provider triggers message before applying updates about hocuspocus HOT 5 CLOSED

@hanspagel just tested this and works well 😀 . I had a suspicion something wasn't working quite right I thought you made synced separate to onCreateDocument incase it was slow to create, didn't realise that was the bug!

from hocuspocus.

Oh, this appears to happen when the onCreateDocument takes "longer". I refactored the server to wait for all onCreateDocument hooks before sending the first sync step.

synced should now work for your use with the new version. Would you mind to try again? I’m doing a release now.

EDIT: Published new versions.

from hocuspocus.

Oh, good catch!

from hocuspocus.

The connect event is emitted, when the first message is received (and before it is applied). I think that’s what I’d expect.

And the synced event seems to be emitted when the update is applied already.

Tested in:
https://github.com/ueberdosis/hocuspocus/blob/main/tests/provider/onSynced.js#L75-L101

Or do I miss something?

from hocuspocus.

@hanspagel I didn't actually check the synced event as the document is not ready when synced is called if onCreateDocument needs to be called so can ignore that.

The issue I'm seeing is that the message event which carries my initial document (as returned from onCreateDocument in @hocuspocus/server) is fired before that update is actually applied to the document because of:

To show a loading state and remove it when the document is definitely received from the server I currently have to do the following:

const document = new Y.Doc();
const provider = new HocusPocus({ document, ... });

let timeout: number;
function checkIfLoaded() {
    // have to wrap this in setTimeout because the message event is fired before the update is applied to the document
    clearTimeout(timeout);
    timeout = setTimeout(() => {
        // checks if data actually exists in the document
        if (isLoaded(document)) {
            provider.off('synced', checkIfLoaded);
            provider.off('message', checkIfLoaded);
            onLoad();
        }
    }, 0);
}

// document may be empty after synced if it hits onCreateDocument in @hocuspocus/server
provider.on('synced', checkIfLoaded);
provider.on('message', checkIfLoaded);

from hocuspocus.