Snapshotting ProseMirror nodes with attributes

TeemuKoivisto · September 8, 2021, 9:03am

Hey,

so as I’m messing around with the snapshotting feature I noticed my node attributes are not persisted in the snapshot.

Use the @ symbol in the toolbar to toggle a “makeMeRed” attribute to either a paragraph or blockquote. I wonder what I’m doing wrong here. The code is basically the same as in the prosemirror-versions demo.

As I debugged this a little further, it seems that this line y-prosemirror/src/plugins/sync-plugin.js at master · yjs/y-prosemirror · GitHub retrieves the attributes but in my case nothing is returned. Ah, well to be exact when I’m using an object as an attribute it marks it as deleted and the YXmlElement getAttributes doesn’t return it (curiously it takes snapshot as a parameter but doesn’t use it).

I’ve added console.logs to yjs/y-prosemirror in the demo which shows ‘makeMeRed’ is retrieved but always the current value of the said node. I recall Kevin saying that snapshots are not finished so perhaps this is one of those parts? Having written all this, I’m pretty sure it’s about that snapshot parameter not being used to retrieve the current value of the node attribute?

(Also as a sidenote, it seems the renderSnapshot plays a bit weird with the paragraphs inside a blockquote)

lazlo · December 2, 2021, 3:20pm

Where able to shed anymore light on this issue? I am working with versioning with ProseMirror and have run into the same issue.

TeemuKoivisto · December 3, 2021, 6:48am

Not really. I guess I could open a bug issue but not sure exactly is this a yjs or y-prosemirror thing. Definitely would need this fixed at some point as I as well need those attributes shown. Somebody did take a stab at it Maybe a Bug in snapshots · Issue #82 · yjs/y-prosemirror · GitHub but their demo was a bit lackluster.

jamesirwin · January 22, 2024, 7:00pm

For anyone coming across this in the future, this was implemented in Nov 2023.

github.com/yjs/yjs

Node attributes not shown correctly when rendering snapshots

opened 08:21AM - 03 Jan 22 UTC

TeemuKoivisto

bug

Continuation of https://discuss.yjs.dev/t/snapshotting-prosemirror-nodes-with-at…tributes/732 and https://github.com/yjs/y-prosemirror/issues/82 Basically when rendering snapshots node attributes are not retrieved from the snapshot. **To Reproduce** 1. Go to https://teemukoivisto.github.io/pm-node-attrs-yjs-snapshots/ 2. Type 'a' and click '@' icon to make the first paragraph red by settings its `"makeMeRed"` attribute to `true` 3. Click `Snapshot` 4. Type 'b' and click '@' to revert the attribute change 5. Click `Snapshot` 6. Click `Inspect` to see the rendered snapshots. Notice the first snapshot does not have red background anymore 7. If you click `Stop inspecting` and then '@' you notice all the snapshots now display red background **Expected behavior** It seems node attributes are persisted to the snapshot but never retrieved with `renderSnapshot` which always shows the most recent value. Here https://github.com/yjs/yjs/blob/main/src/types/YXmlElement.js#L184 which calls https://github.com/yjs/yjs/blob/main/src/types/AbstractType.js#L862 it's clear that the snapshot parameter is never used. What I think needs to be done is adding a recursion of the snapshot to either Y.XmlElement.getAttributes or Y.AbstractType.typeMapGetAll to get the node attribute at the snapshot's point in time. **Environment Information** "y-prosemirror": "^1.0.14", "yjs": "^13.5.23"