tiptap: [Bug]: Performance issue with large documents migrating from vue 2 to vue 3
Which packages did you experience the bug in?
What Tiptap version are you using?
2.2.4
What’s the bug you are facing?
Hello everyone,
In my company, we’re fervent Tiptap users, and Tiptap pro subscribers. Today we’re experiencing a blocking performance issue with tiptap/vue-3.
Since migrating from tiptap/vue-2 to tiptap/vue-3, we’ve noticed a slowdown on documents with a large number of nodes that need to be rendered in Vue.
A look at the thread on tiptap-vue3 implementation](https://github.com/ueberdosis/tiptap/issues/1166#issuecomment-777792156) mentions the breaking changes between vue-2 and vue-3, and the use of Teleport to add elements to the DOM, which may explain this drop in performance.
To demonstrate the bug, you need content with at least 1500 nodes.
The loading time increases quadratically with the number of nodes.
The repository below reproduces the bug 👇
What browser are you using?
Chrome
Code example
What did you expect to happen?
We are a knowledge management software company, and our applications are particularly dependent on tiptap for the user experience.
We are in the process of migrating our stack from Vue 2 to Vue 3 and as a result are looking to adopt tiptap/vue-3. The current performance issue is blocking our migration to Vue3.
Anything to add? (optional)
Let us know if we can be of any help to reproduce this bug or contribute a fix to it.
Did you update your dependencies?
- Yes, I’ve updated my dependencies to use the latest version of all packages.
Are you sponsoring us?
- Yes, I’m a sponsor. 💖
About this issue
- Original URL
- State: closed
- Created 3 years ago
- Reactions: 5
- Comments: 30 (14 by maintainers)
Hello everyone,
Thank you all for your feedback on this issue, which helps move things forward.
@bdbch thanks for the review. I took a closer look at the error test for the Drawing example and it turns out that the component needs to rerender at each line to be able to take update props into account.
I therefore revised my proposal, removing the use of
Teleportand the need to rerender the app for each node. I took my inspiration from the vue-2 package to enable each component to be rendered as a unit and added to tiptap. https://github.com/ueberdosis/tiptap/pull/5206According to my tests, I’ve noticed a clear improvement in performance for content with a lot of nodes to be rendered by Vue.
I’m interested in your feedback to see if you’re seeing the same thing as me or if there’s still room for improvement.
Hello, tried to build tiptap with pr from @Rirax and to add it to our project that uses a lot of VueNodeViewRenderer components, unfortunately didn’t work for us, the tab just crashes, though it worked almost flawless with vue2 😕 (we use tiptap for big articles, about 2-6mb of json content) The project itself has almost no getters/watchers, even when I removed them all - the browser tab just freezes. Anyway, thanks everyone for their hard work, I hope this issue will be resolved sooner or later, since it’s a major blocker for transitioning to vue 3.
Hi everyone, I failed to mention that we have released @Rirax’s fix to our beta v2.5.0-beta.4
Please try it out & let us know if you run into any issues.
I’ve re-released this with 2.5.5
Please let me know if you run into anymore issues
@Rirax, we made a few pre-tests with json content of ~6mb, works perfectly for us, big thanks!
Hi! I’ve also stumbled upon this issue, unfortunately, vue2 performance was much better, it’s a major blocker for us also. Hope there is some kind of solution, thank you for all your hard work!
I see many problems similar to mine, but I decided to share anyway. A couple of days ago we completed the migration of the project to Vue 3 and started getting tab crashes when there was a large amount of content
Maybe there is some intermediate solution for us? Tried to make a build from pr above, but it did not fix the issue.
Hi @bdbch, it’s been a month since this thread has been opened and it seems to be a critical issue for several tiptap users for transitioning from vue2 to vue3
Any news on the timeline ? Thanks in advance for your work
Hello, I also tried integrating Tiptap with the PR from @Rirax into our Vue 3 project and faced similar issues with the browser tab crashing, despite it working well with Vue 2
Hi! Thanks @Rirax for writing about this problem. We also use tiptap in our company, and we started having the same problem since move from vue2 to vue3. Performance on large documents began to suffer greatly, some simply stopped opening because of this. I hope for a fix soon and thanks everyone for your work!
Yep, same here. Were using it on vue2 and got those issues with vue3. Tried to solve it by myself but no luck for now. Honestly still hope for an update. Thanks for the work again!
Hi @nperez0111
my colleague has now investigated the issue and it seems the tiptap-code is ok and working good. The issue we experienced stemmed from a slighty changed invocation order of a watched field we had in our vuex-store and how the editors updated their internal state.
Before the fix you mentioned, the watcher fired after the editor state was already updated, now they fire before that has happend. This is the causes the invalid update of the selection.
We wrapped the offending piece of code within the watcher with a
$nextTickand are fine now. Thanks for your help!Hi @nperez0111
the ticket you linked looks promising, though i don’t know yet if it will work when using the newly introduced
beforeTransaction-hook. Currently I am occupied with another thing. A colleague will try it out tomorrow and will inform you.Attached is the actual replication code that syncs the editors. Maybe this helps anyway in pinpointing it down. If not then there will be a possbility for me or my colleague to create a minimal example in the next days, hopefully on Stackblitz
This is called in ‘onTransaction’ with the editor that was updated providing the
sourceEditorEditorView and the editor receiving the update providing thetargetEditorEditorView.transactionis the Transaction as received by theonTransactionevent hook.Yea I opened another branch with the vue fixes. I need to test them a bit more carefully as some vue users ran into issues with it.
Probably on the order of a week you can expect an official release back into 2.5 minor
Hi @nperez0111, thank you for the release !
Hi @Rirax, we’ve found another issue - when deleting vue nodes via deleteNode editor doesn’t delete the node, we are investigating, but no luck yet. // upd found the problem, it was on our side, we were deleting component in onBeforeUnmount, but it’s already handled now
Hello everyone, I’m facing the same issue at my company when moving from tiptap/vue2 to tiptap/vue3. Thanks for the investigation @Rirax and for the PR. I hope this will get fixed soon so we can complete our migration, is there still no timeline defined @bdbch ? Thanks everyone and have a good weekend
No timeline yet – @Rirax send in a PR which I’ll check asap when I find time to see if it improves rendering performance and doesn’t break anything – after that we’ll see to release it in a new minor if everything is working fine.
But can’t give a time estimate rn.
We are also using tiptap (vue2) in my company and we are starting the process of migrating to vue3. Thank you @Rirax for highlighting this performance issue ! I’m posting to follow this thread, but this could potentially be a hard blocker for us because we currently have clients with several thousand lines documents…
@bdbch Any clues regarding the timeline of this fix ? 🙏
Thanks in advance for your work