frontend-collective / react-sortable-tree

Drag-and-drop sortable component for nested data and hierarchies
https://frontend-collective.github.io/react-sortable-tree/
MIT License
4.9k stars 897 forks source link

fix: hover/drop race conditions #936

Open Hazantip opened 1 year ago

Hazantip commented 1 year ago

don't run hover animation frame after the drag has ended

Description:

It's a copy of PR: https://github.com/frontend-collective/react-sortable-tree/pull/841

I think I've found two race conditions where dragging nodes too quickly results in errors.

Case 1: Uncaught TypeError: Cannot read property 'path' of null at dnd-manager.js:240

How to reproduce:

Open the "Minimal implementation" storybook in Chrome (I have reproduced this in Firefox, too, but it's a lot trickier) Enable 6x slowdown CPU throttling from DevTools Drag-and-drop the nodes around, trying to keep each drag as quick as possible Eventually you'll get error (in DevTools console) "Uncaught TypeError: Cannot read property 'path' of null at dnd-manager.js:240" Apparently what happens is that the animation frame code gets called after the drag is already over, and monitor.getItem() returns null.

Case 2: Encountered two children with the same key warning from React

How to reproduce:

Open the "Callbacks" storybook (important: it has getNodeKey which uses ids) with Chrome Enable 6x slowdown CPU throttling from DevTools Drag-and-drop the nodes around, trying to keep each drag as quick as possible Eventually you'll get Warning: Encountered two children with the same key, 'nodeA'. from React It looks like drop has been called (so the dragged node has been added back to tree), but after the same animation frame code runs, "draggedNode" is set to the already-dropped node... which is then rendered again, and for a short duration (not visible), there are two nodes with same key in the tree...