Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

3.3 KB
Raw Blame
/**
 * A Dialog/Sheet/Drawer locks page scrolling with `react-remove-scroll`, whose
 * document-level listener cancels wheel and touch-move events that reach it from
 * outside the locked subtree. Popover and hover-card content portals into an
 * overlay layer, i.e. always outside it, so these events must stay inside the
 * overlay — otherwise a scrollable list in a picker opened from a dialog freezes
 * for wheel and touch while keyboard navigation still works.
 */
import { fireEvent, render, screen, waitFor } from "@testing-library/react";
import { Combobox } from "@/src/components/ui/Combobox";
import {
  Popover,
  PopoverContent,
  PopoverTrigger,
} from "@/src/components/ui/popover";
import { ControlledHoverCard } from "@/src/components/design-system/ControlledHoverCard/ControlledHoverCard";
import { LayerProvider } from "@/src/context/LayerContext/LayerContext";

describe("overlay content keeps scroll events local", () => {
  beforeAll(() => {
    Element.prototype.scrollIntoView = vi.fn();
    vi.stubGlobal(
      "ResizeObserver",
      class {
        observe() {}
        unobserve() {}
        disconnect() {}
      },
    );
  });

  const atDocument: string[] = [];
  const record = (event: Event) => atDocument.push(event.type);

  beforeEach(() => {
    atDocument.length = 0;
    document.addEventListener("wheel", record);
    document.addEventListener("touchmove", record);
  });

  afterEach(() => {
    document.removeEventListener("wheel", record);
    document.removeEventListener("touchmove", record);
  });

  const scroll = (element: HTMLElement) => {
    fireEvent.wheel(element);
    fireEvent.touchMove(element);
  };

  it("popover: neither event reaches the document", () => {
    render(
      <Popover open>
        <PopoverTrigger>open</PopoverTrigger>
        <PopoverContent>
          <button>option</button>
        </PopoverContent>
      </Popover>,
    );

    scroll(screen.getByRole("button", { name: "option" }));

    expect(atDocument).toEqual([]);
  });

  it("hover card: neither event reaches the document", () => {
    render(
      <ControlledHoverCard
        open
        onOpenChange={vi.fn()}
        content={<pre>preview</pre>}
      >
        {({ getTriggerProps }) => <button {...getTriggerProps()}>hover</button>}
      </ControlledHoverCard>,
      { wrapper: LayerProvider },
    );

    scroll(screen.getByText("preview"));

    expect(atDocument).toEqual([]);
  });

  it("page content is untouched: both events reach the document", () => {
    render(<button>in the page</button>);

    scroll(screen.getByRole("button", { name: "in the page" }));

    expect(atDocument).toEqual(["wheel", "touchmove"]);
  });

  it("disabling a combobox suspends an already open portal", async () => {
    const onValueChange = vi.fn();
    const selector = (disabled: boolean) => (
      <Combobox
        options={[{ value: "one", label: "First option" }]}
        onValueChange={onValueChange}
        disabled={disabled}
      />
    );
    const { rerender } = render(selector(false));
    fireEvent.click(screen.getByRole("combobox"));
    expect(await screen.findByRole("option")).toHaveTextContent("First option");

    rerender(selector(true));
    await waitFor(() => expect(screen.queryByRole("option")).toBeNull());
    expect(onValueChange).not.toHaveBeenCalled();
  });
});