Skip to content

Commit

Permalink
fix: hover/drop race conditions
Browse files Browse the repository at this point in the history
don't run hover animation frame after the drag has ended

Description: 

It's a copy of PR: frontend-collective#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...
  • Loading branch information
Hazantip authored Dec 8, 2022
1 parent 52f0bcf commit 23cc131
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/utils/dnd-manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,14 @@ export default class DndManager {
// throttle `dragHover` work to available animation frames
cancelAnimationFrame(this.rafId);
this.rafId = requestAnimationFrame(() => {
const item = monitor.getItem();
// skip if drag already ended before the animation frame
if (!item || !monitor.isOver()) {
return;
}
this.dragHover({
node: draggedNode,
path: monitor.getItem().path,
path: item.path,
minimumTreeIndex: dropTargetProps.listIndex,
depth: targetDepth,
});
Expand Down

0 comments on commit 23cc131

Please sign in to comment.