How to trigger hotkeys from jest/test-library?

[warpdesign]

I am using hotkeys using HotkeysTarget2 in one of my component like this:

const hotkeys = [
        {
            global: true,
            combo: 'mod+l',
            label,
            onKeyDown: onFocus,
            group: 'group',
        },
    ]

return <HotkeysTarget2 hotkeys={hotkeys}>
...
</HotkeysTarget2>

This is working as intended. However, I am having trouble triggering the shortcut when testing my component with Jest/Testing-Library.

I first tried to generate a keyboard event with userEvent:

const user = userEvent.setup()
render(<Component />)
await user.keyboard('{Meta>}l{/Meta}')

While this correctly generates keyboard events, this won't trigger the onKeyDown on my hotkey.

I then looked at the HotkeysTarget2 source code and noticed it was using the deprecated which property, so I decided to fire a keyDown event with the which property set to the correct value:

const { container } = render(<Component />)
fireEvent.keyDown(container, {
   // which code for 'l' key
   which: 76,
   metaKey: true
})

Unfortunately it still doesn't fire the onKeyDown event handler.

Anyone has any idea on how to do fix the problem?

[warpdesign]

I found out why it wasn't working: the mod is converted to ctrlKey or metaKey by detecting the OS using navigator.platform (another deprecated prop... :/):

export const Aliases: IKeyMap = {
    cmd: "meta",
    command: "meta",
    escape: "esc",
    minus: "-",
    mod: isMac() ? "meta" : "ctrl",
    option: "alt",
    plus: "+",
    return: "enter",
    win: "meta",
};

function isMac(platformOverride?: string) {
    // HACKHACK: see https://github.com/palantir/blueprint/issues/5174
    // eslint-disable-next-line deprecation/deprecation
    const platform = platformOverride ?? (typeof navigator !== "undefined" ? navigator.platform : undefined);
    return platform === undefined ? false : /Mac|iPod|iPhone|iPad/.test(platform);
}

Since navigator.platform is an empty string in jest (JSDom) env, mod was translated as ctrlKey.

So in the end, this works as expected to trigger mod+l hotkey in jest:

const { container } = render(<Component />)
fireEvent.keyDown(container, {
   // which code for 'l' key
   which: 76,
   ctrlKey: true
})