Copy the implementation of useMovable into useDraggable

.changeset/olive-rivers-eat.md

@@ -0,0 +1,5 @@
+---
+"@khanacademy/perseus": patch
+---
+
+Internal: copy Mafs' implementation of useMovable into our own useDraggable hook.

packages/perseus/package.json

@@ -46,6 +46,7 @@
         "@khanacademy/perseus-linter": "^0.4.0",
         "@khanacademy/pure-markdown": "^0.3.5",
         "@khanacademy/simple-markdown": "^0.12.0",
+        "@use-gesture/react": "^10.2.27",
         "mafs": "0.18.7"
     },
     "devDependencies": {

packages/perseus/src/widgets/interactive-graphs/graphs/use-draggable.test.tsx

@@ -0,0 +1,249 @@
+import {render, screen, fireEvent} from "@testing-library/react";
+import {userEvent as userEventLib} from "@testing-library/user-event";
+import {Mafs, Transform} from "mafs";
+import * as React from "react";
+import {useRef} from "react";
+
+import {useDraggable} from "./use-draggable";
+
+import type {vec, Interval} from "mafs";
+
+function TestDraggable(props: {
+    point: vec.Vector2;
+    constrain?: (point: vec.Vector2) => vec.Vector2;
+    onMove?: (point: vec.Vector2) => unknown;
+}) {
+    const {onMove = () => {}, constrain = (p) => p} = props;
+    const gestureTarget = useRef<HTMLButtonElement>(null);
+    const {dragging} = useDraggable({
+        ...props,
+        onMove,
+        constrain,
+        gestureTarget,
+    });
+    return (
+        <button ref={gestureTarget} tabIndex={0}>
+            dragging: {String(dragging)}
+        </button>
+    );
+}
+
+describe("useDraggable", () => {
+    let userEvent;
+    beforeEach(() => {
+        userEvent = userEventLib.setup({
+            advanceTimers: jest.advanceTimersByTime,
+        });
+    });
+
+    it("initially returns {dragging: false}", () => {
+        render(
+            <Mafs width={200} height={200}>
+                <TestDraggable point={[0, 0]} />
+            </Mafs>,
+        );
+
+        expect(screen.getByText("dragging: false")).toBeInTheDocument();
+    });
+
+    it("returns {dragging: true} when the mouse button is held down", async () => {
+        render(
+            <Mafs width={200} height={200}>
+                <TestDraggable point={[0, 0]} />
+            </Mafs>,
+        );
+        const dragHandle = screen.getByRole("button");
+
+        // Act
+        await userEvent.pointer({keys: "[MouseLeft>]", target: dragHandle});
+
+        // Assert
+        expect(screen.getByText("dragging: true")).toBeInTheDocument();
+    });
+
+    it("returns {dragging: false} when the mouse button is released", async () => {
+        render(
+            <Mafs width={200} height={200}>
+                <TestDraggable point={[0, 0]} />
+            </Mafs>,
+        );
+        const dragHandle = screen.getByRole("button");
+
+        // Act
+        await userEvent.pointer([
+            {keys: "[MouseLeft>]", target: dragHandle},
+            {keys: "[/MouseLeft]"},
+        ]);
+
+        // Assert
+        expect(screen.getByText("dragging: false")).toBeInTheDocument();
+    });
+
+    it("calls onMove with the destination point when the user drags", async () => {
+        // Arrange: a 200x200px graph with a 20-unit range in each dimension.
+        // One graph unit = 10px.
+        const mafsProps = {
+            width: 200,
+            height: 200,
+            viewBox: {
+                x: [-10, 10] as Interval,
+                y: [-10, 10] as Interval,
+                padding: 0,
+            },
+        };
+        const onMoveSpy = jest.fn();
+        render(
+            <Mafs {...mafsProps}>
+                <TestDraggable point={[0, 0]} onMove={onMoveSpy} />
+            </Mafs>,
+        );
+        const dragHandle = screen.getByRole("button");
+
+        // Act: click and hold the drag handle...
+        mouseDownAt(dragHandle, 0, 0);
+        // ...and then drag 10px right and 10px down
+        moveMouseTo(dragHandle, 10, 10);
+
+        // Assert: the draggable element was moved to (1, -1)
+        expect(onMoveSpy).toHaveBeenCalledWith([1, -1]);
+    });
+
+    it("constrains the destination point using the given constrain function", async () => {
+        // Arrange: a 200x200px graph with a 20-unit range in each dimension.
+        // One graph unit = 10px.
+        const mafsProps = {
+            width: 200,
+            height: 200,
+            viewBox: {
+                x: [-10, 10] as Interval,
+                y: [-10, 10] as Interval,
+                padding: 0,
+            },
+        };
+        const onMoveSpy = jest.fn();
+        render(
+            <Mafs {...mafsProps}>
+                <TestDraggable
+                    point={[0, 0]}
+                    onMove={onMoveSpy}
+                    constrain={(p) => [Math.round(p[0]), Math.round(p[1])]}
+                />
+            </Mafs>,
+        );
+        const dragHandle = screen.getByRole("button");
+
+        // Act: click and hold the drag handle...
+        mouseDownAt(dragHandle, 0, 0);
+        // ...and then drag 12px right and 13px down
+        moveMouseTo(dragHandle, 12, 13);
+
+        // Assert: the draggable element was moved to (1, -1) due to the
+        // constrain function. If you see (1.2, -1.3) instead, that means the
+        // constraint is not being applied.
+        expect(onMoveSpy).toHaveBeenCalledWith([1, -1]);
+    });
+
+    it("accounts for the user transform when measuring drag distance", async () => {
+        // See: https://mafs.dev/guides/custom-components/contexts
+
+        // Arrange: a 200x200px graph with a 20-unit range in each dimension.
+        // One graph unit = 10px.
+        const mafsProps = {
+            width: 200,
+            height: 200,
+            viewBox: {
+                x: [-10, 10] as Interval,
+                y: [-10, 10] as Interval,
+                padding: 0,
+            },
+        };
+        const onMoveSpy = jest.fn();
+        render(
+            <Mafs {...mafsProps}>
+                <Transform scale={2}>
+                    <TestDraggable point={[10, 10]} onMove={onMoveSpy} />
+                </Transform>
+            </Mafs>,
+        );
+        const dragHandle = screen.getByRole("button");
+
+        // Act: click and hold the drag handle...
+        mouseDownAt(dragHandle, 0, 0);
+        // ...and then drag 10px right and 10px down. Because of the
+        // <Transform scale={2}>, this movement actually represents the vector
+        // [0.5, -0.5] in graph coordinates.
+        moveMouseTo(dragHandle, 10, 10);
+
+        // Assert: the draggable element moved to (10.5, 9.5).
+        // If you see...
+        // - (5.5, 4.5), the userTransform was not applied to the pickupPoint.
+        // - (21, 19), the inverse user transform was not applied to the move.
+        // - (11, 9), neither userTransform nor the inverse was applied.
+        expect(onMoveSpy).toHaveBeenCalledWith([10.5, 9.5]);
+    });
+
+    it("moves a draggable element with the keyboard", async () => {
+        // Arrange: a 200x200px graph with a 20-unit range in each dimension.
+        // One graph unit = 10px.
+        const mafsProps = {
+            width: 200,
+            height: 200,
+            viewBox: {
+                x: [-10, 10] as Interval,
+                y: [-10, 10] as Interval,
+                padding: 0,
+            },
+        };
+        const onMoveSpy = jest.fn();
+        render(
+            <Mafs {...mafsProps}>
+                <TestDraggable
+                    point={[0, 0]}
+                    onMove={onMoveSpy}
+                    constrain={(point) => [
+                        Math.round(point[0]),
+                        Math.round(point[1]),
+                    ]}
+                />
+            </Mafs>,
+        );
+        // focus the draggable element
+        await userEvent.tab();
+        await userEvent.tab();
+
+        // Pre-assert: the draggable element is actually focused
+        expect(screen.getByRole("button")).toHaveFocus();
+
+        // Act:
+        await userEvent.keyboard("{arrowright>1}{arrowup>1}");
+
+        // Assert: the element moved one step to the right and then one step up
+        expect(onMoveSpy.mock.calls).toEqual([[[1, 0]], [[0, 1]]]);
+    });
+});
+
+function mouseDownAt(element: Element, clientX: number, clientY: number) {
+    // NOTE(benchristel): I could not figure out how to write these tests in
+    // terms of userEvent. The tests for @use-gesture/react use fireEvent, so
+    // I went with that approach.
+    // eslint-disable-next-line testing-library/prefer-user-event
+    fireEvent.mouseDown(element, {
+        pointerId: 1,
+        buttons: 1,
+        clientX,
+        clientY,
+    });
+}
+
+function moveMouseTo(element: Element, clientX: number, clientY: number) {
+    // NOTE(benchristel): I could not figure out how to write these tests in
+    // terms of userEvent. The tests for @use-gesture/react use fireEvent, so
+    // I went with that approach.
+    // eslint-disable-next-line testing-library/prefer-user-event
+    fireEvent.mouseMove(element, {
+        pointerId: 1,
+        buttons: 1,
+        clientX,
+        clientY,
+    });
+}