diff --git a/.changeset/icy-suits-lead.md b/.changeset/icy-suits-lead.md new file mode 100644 index 00000000000..5eed4cfc226 --- /dev/null +++ b/.changeset/icy-suits-lead.md @@ -0,0 +1,5 @@ +--- +"@primer/react": patch +--- + +ActionMenu: Fix a memory leak when opening and closing menus. diff --git a/packages/react/src/ActionMenu/ActionMenu.test.tsx b/packages/react/src/ActionMenu/ActionMenu.test.tsx index e0f641963bc..e438c205f3b 100644 --- a/packages/react/src/ActionMenu/ActionMenu.test.tsx +++ b/packages/react/src/ActionMenu/ActionMenu.test.tsx @@ -221,6 +221,39 @@ describe('ActionMenu', () => { expect(component.baseElement.querySelector('[data-component="AnchoredOverlay"]')).toBeNull() }) + it('removes the anchor keydown handler after repeated open and close cycles', async () => { + const component = HTMLRender() + const button = page.getByRole('button', {name: 'Toggle Menu', exact: true}) + const anchor = button.element() + const addEventListener = vi.spyOn(anchor, 'addEventListener') + const removeEventListener = vi.spyOn(anchor, 'removeEventListener') + + for (let index = 0; index < 3; index++) { + const addsBeforeOpen = addEventListener.mock.calls.length + await userEvent.click(button) + await expect.element(page.getByRole('menu')).toBeInTheDocument() + const keydownHandlersAdded = addEventListener.mock.calls + .slice(addsBeforeOpen) + .filter(([type]) => type === 'keydown') + .map(([, listener]) => listener) + expect(keydownHandlersAdded.length).toBeGreaterThan(0) + + const removalsBeforeClose = removeEventListener.mock.calls.length + await userEvent.click(button) + await expect.element(page.getByRole('menu')).not.toBeInTheDocument() + const keydownHandlersRemoved = removeEventListener.mock.calls + .slice(removalsBeforeClose) + .filter(([type]) => type === 'keydown') + .map(([, listener]) => listener) + + for (const listener of keydownHandlersAdded) { + expect(keydownHandlersRemoved).toContain(listener) + } + } + + component.unmount() + }) + it('should open Menu on MenuButton click', async () => { HTMLRender() const button = page.getByRole('button') diff --git a/packages/react/src/hooks/useMenuKeyboardNavigation.ts b/packages/react/src/hooks/useMenuKeyboardNavigation.ts index 16192f2e228..a732a9b99d0 100644 --- a/packages/react/src/hooks/useMenuKeyboardNavigation.ts +++ b/packages/react/src/hooks/useMenuKeyboardNavigation.ts @@ -109,6 +109,6 @@ const useMoveFocusToMenuItem = ( } anchor?.addEventListener('keydown', handler) - return () => anchor?.addEventListener('keydown', handler) + return () => anchor?.removeEventListener('keydown', handler) }, [open, containerRef, anchorRef]) }