π OpenHands: AI-Driven Development
fix(backends): keep phone backend modals open on Escape over the drawer (#18591)
Engel Nystcabc0b574b64
diff --git a/.pr/phone-escape-backend-modals/after-phone-drawer-add-escape.png b/.pr/phone-escape-backend-modals/after-phone-drawer-add-escape.pngnew file mode 100644index 0000000000..08d2247ebcBinary files /dev/null and b/.pr/phone-escape-backend-modals/after-phone-drawer-add-escape.png differdiff --git a/.pr/phone-escape-backend-modals/after-phone-edit-escape.png b/.pr/phone-escape-backend-modals/after-phone-edit-escape.pngnew file mode 100644index 0000000000..70937d2728Binary files /dev/null and b/.pr/phone-escape-backend-modals/after-phone-edit-escape.png differdiff --git a/.pr/phone-escape-backend-modals/after-phone-manage-add-escape.png b/.pr/phone-escape-backend-modals/after-phone-manage-add-escape.pngnew file mode 100644index 0000000000..1897dd01e2Binary files /dev/null and b/.pr/phone-escape-backend-modals/after-phone-manage-add-escape.png differdiff --git a/.pr/phone-escape-backend-modals/before-phone-after-escape.png b/.pr/phone-escape-backend-modals/before-phone-after-escape.pngnew file mode 100644index 0000000000..5059548511Binary files /dev/null and b/.pr/phone-escape-backend-modals/before-phone-after-escape.png differdiff --git a/.pr/phone-escape-backend-modals/before-phone-edit-open.png b/.pr/phone-escape-backend-modals/before-phone-edit-open.pngnew file mode 100644index 0000000000..fa62a79746Binary files /dev/null and b/.pr/phone-escape-backend-modals/before-phone-edit-open.png differdiff --git a/__tests__/components/shared/modals/modal-backdrop.test.tsx b/__tests__/components/shared/modals/modal-backdrop.test.tsxindex 3698a0d906..4569489d72 100644--- a/__tests__/components/shared/modals/modal-backdrop.test.tsx+++ b/__tests__/components/shared/modals/modal-backdrop.test.tsx@@ -6,6 +6,7 @@ import userEvent from "@testing-library/user-event";import { ConfirmationModal } from "#/components/shared/modals/confirmation-modal";import { ModalBackdrop } from "#/components/shared/modals/modal-backdrop";+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";describe("ModalBackdrop", () => {it("portals out of a transformed ancestor so position: fixed resolves against the viewport", () => {@@ -337,3 +338,72 @@ describe("ModalBackdrop focus management", () => {expect(screen.getByRole("button", { name: "outer first" })).toHaveFocus();});});++describe("ModalBackdrop Escape layering", () => {+ function EscapeLayer({ onClose }: { onClose: () => void }) {+ useCloseOnEscape(true, onClose);+ return null;+ }++ function DrawerWithDialog({+ isDialogOpen,+ closeOnEscape,+ onCloseDrawer,+ onCloseDialog,+ }: {+ isDialogOpen: boolean;+ closeOnEscape: boolean;+ onCloseDrawer: () => void;+ onCloseDialog: () => void;+ }) {+ return (+ <>+ <EscapeLayer onClose={onCloseDrawer} />+ {isDialogOpen ? (+ <ModalBackdrop onClose={onCloseDialog} closeOnEscape={closeOnEscape}>+ <p>dialog content</p>+ </ModalBackdrop>+ ) : null}+ </>+ );+ }++ it.each([+ { closeOnEscape: false, dialogCloses: 0 },+ { closeOnEscape: true, dialogCloses: 1 },+ ])(+ "keeps Escape from a drawer opened under it (closeOnEscape: $closeOnEscape)",+ async ({ closeOnEscape, dialogCloses }) => {+ // Arrange: the drawer is open first, then a dialog opens over it.+ const user = userEvent.setup();+ const onCloseDrawer = vi.fn();+ const onCloseDialog = vi.fn();+ const props = { closeOnEscape, onCloseDrawer, onCloseDialog };+ const { rerender } = render(+ <DrawerWithDialog {...props} isDialogOpen={false} />,+ );+ rerender(<DrawerWithDialog {...props} isDialogOpen />);++ // Act+ await user.keyboard("{Escape}");++ // Assert+ expect(onCloseDrawer).not.toHaveBeenCalled();+ expect(onCloseDialog).toHaveBeenCalledTimes(dialogCloses);+ },+ );++ it("lets a menu that is open inside the dialog take Escape", async () => {+ const user = userEvent.setup();+ const onCloseMenu = vi.fn();+ render(+ <ModalBackdrop onClose={vi.fn()} closeOnEscape={false}>+ <EscapeLayer onClose={onCloseMenu} />+ </ModalBackdrop>,+ );++ await user.keyboard("{Escape}");++ expect(onCloseMenu).toHaveBeenCalledTimes(1);+ });+});diff --git a/src/components/shared/modals/modal-backdrop.tsx b/src/components/shared/modals/modal-backdrop.tsxindex d2b671eed0..6f3cf16134 100644--- a/src/components/shared/modals/modal-backdrop.tsx+++ b/src/components/shared/modals/modal-backdrop.tsx@@ -1,5 +1,6 @@import React from "react";import { createPortal } from "react-dom";+import { useEscapeBoundary } from "#/hooks/use-close-on-escape";import { useModalFocus } from "./use-modal-focus";interface ModalBackdropProps {@@ -25,6 +26,9 @@ export function ModalBackdrop({"aria-label": ariaLabel,}: ModalBackdropProps) {const focus = useModalFocus({ elevated });+ // The dialog is on top: menus and drawers opened before it never take its+ // Escape, whether or not it closes on Escape itself.+ useEscapeBoundary(true);React.useEffect(() => {if (!closeOnEscape) return undefined;diff --git a/src/hooks/use-close-on-escape.ts b/src/hooks/use-close-on-escape.tsindex 2752ed12fe..a4849083aa 100644--- a/src/hooks/use-close-on-escape.ts+++ b/src/hooks/use-close-on-escape.ts@@ -73,3 +73,21 @@ export const useCloseOnEscape = (return () => removeLayer(layer);}, [isOpen]);};++/**+ * Keep Escape from reaching layers opened before this one while it is active,+ * for a dialog that handles Escape itself or deliberately ignores it. Without+ * it, a drawer under the dialog (the phone sidebar drawer that hosts the+ * backend modals) would take Escape, close, and unmount the dialog with it.+ * A layout effect registers the boundary before the passive effects of+ * anything the dialog renders, so a menu inside the dialog still sits above it.+ */+export const useEscapeBoundary = (isActive: boolean) => {+ React.useLayoutEffect(() => {+ if (!isActive) return undefined;++ const layer: EscapeLayer = { close: () => {} };+ pushLayer(layer);+ return () => removeLayer(layer);+ }, [isActive]);+};