Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/icy-suits-lead.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": patch
---

ActionMenu: Fix a memory leak when opening and closing menus.
33 changes: 33 additions & 0 deletions packages/react/src/ActionMenu/ActionMenu.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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(<Example />)
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(<Example />)
const button = page.getByRole('button')
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/hooks/useMenuKeyboardNavigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,6 @@ const useMoveFocusToMenuItem = (
}

anchor?.addEventListener('keydown', handler)
return () => anchor?.addEventListener('keydown', handler)
return () => anchor?.removeEventListener('keydown', handler)
}, [open, containerRef, anchorRef])
}
Loading