Choose summon keybinding #1494

mholtzman · 2023-03-21T15:46:52Z

Allowing users to choose the summon keybinding. Key presses are detected and mapped to an accelerator which is registered using the globalShortcut API. We are still using the experimental keyboard API getLayoutMap to better represent shortcut keys to users with different keyboard layouts (though this does not work in all cases)

https://www.w3.org/TR/uievents-code/#code-value-tables
https://www.electronjs.org/docs/latest/api/accelerator
https://www.electronjs.org/docs/latest/api/global-shortcut
https://developer.mozilla.org/en-US/docs/Web/API/Keyboard/getLayoutMap
https://tkainrad.dev/posts/why-keyboard-shortcuts-dont-work-on-non-us-keyboard-layouts-and-how-to-fix-it

Limitations

Only one shortcutKey per binding
- (e.g. CTRL + ALT + D works because multiple modifierKeys are allowed but CTRL + A + D is not possible due to two shortcutKeys) - this is an Electron limitation, accelerators are defined as such
Certain OS-bound keys won't be captured, depending on OS and settings
Some keys have issues - see [Bug]: globalShortcut won't register single quote or back quote correctly on different keyboard layouts (Windows 10) electron/electron#28900 (comment)

Testing

102 key UK keyboard (all platforms) & Macbook Pro UK keyboard (Mac)
Layouts - EN (US), EN (UK), ES (Spain), FR (France), DE (Germany)

Whitelisted Keys

Modifiers - Ctrl, Alt, Meta, Command
Letters - KeyA - KeyZ
Numbers - Digit0 - Digit9
Arrow keys
Punctuation - limited to Comma, Period, Slash as most of these keys are problematic across different layouts.
Function keys - apart from F12 because it doesn't work on Windows.
Numpad keys - apart from Numlock & NumpadEnter, which don't work.
Escape
Space
Enter

TODO:

socket-security · 2023-03-21T15:49:07Z

Socket Security Pull Request Report

👍 No new dependency issues detected in pull request

Pull request report summary

Issue	Status
Install scripts	✅ 0 issues
Native code	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

Ignoring: core-js@3.29.1

Powered by socket.dev

goosewobbler · 2023-03-21T15:49:52Z

@SocketSecurity ignore core-js@3.29.1

app/dash/Settings/index.js

package.json

resources/app/index.js

resources/Components/KeyboardShortcutConfigurator/index.js

package.json

resources/Components/KeyboardShortcutConfigurator/index.js

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

michaelni · 2023-04-07T16:46:22Z

Just wanted to confirm that this (0.6.2-canary.2) allows selecting a working summon key on linux. The alt+- default previously did not work for me (nor does alt+- work now if choosen). Didnt investigate why alt+- didnt work. But thanks for fixing this!

* Choose summon keybinding (#1494) Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com> * remove schema files, update test * add default shortcuts state * edit shortcut clarity (#1514) --------- Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com> Co-authored-by: Jordan Muir <jordan@frame.sh>

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

* Integrate pylon evm (#1478) * bump version * remove infura and alchemy presets, use pylon * update package lock * remove gnosis chain preset * fix chain name * move migrations to separate files, use TS (#1482) * add Zod validation of state chain objects, infer types (#1485) * add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing * Choose summon keybinding (#1494) Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com> * re-order migrations * convert hot signers to TS, make tests run reliably * more commits * update comment * remove unneeded assignment * make worker interaction more typesafe * remove unused code * remove unused interface * fix tests * revert weird test change * try revert file * try move * decouple worker controller and launch script, write controller tests * fix worker exit in tests * remove double cast * rename some files * remove ignore * clean up worker interface * last cleanup, fix typed data * more type safety * rebase, add bip39 type * remove ts-ignores * remove rebase artifact * remove migration files * update package lock --------- Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

* Integrate pylon evm (#1478) * bump version * remove infura and alchemy presets, use pylon * update package lock * remove gnosis chain preset * fix chain name * move migrations to separate files, use TS (#1482) * add Zod validation of state chain objects, infer types (#1485) * add Zod validation of state chain objects, infer types * move state files to TS, add more inferred types * fix persist mock for tests * add types to main state * update test * add mute notification schema * move type export to state main * move legacy file to TS * try new migration format * update legacy migrations and tests * fix gas fees type * fix gas type * move legacy mapping * final migration prototype * finish migration poc * finish cleaning up migrations * test cleanup * fix compilation error * fix state parsing * Choose summon keybinding (#1494) Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com> * re-order migrations * convert hot signers to TS, make tests run reliably * more commits * update comment * remove unneeded assignment * make worker interaction more typesafe * remove unused code * remove unused interface * fix tests * revert weird test change * try revert file * try move * decouple worker controller and launch script, write controller tests * fix worker exit in tests * remove double cast * rename some files * remove ignore * clean up worker interface * last cleanup, fix typed data * more type safety * rebase, add bip39 type * remove ts-ignores * remove rebase artifact * remove migration files * update package lock --------- Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

goosewobbler mentioned this pull request Mar 21, 2023

Choose Summon keybinding #1489

Closed

12 tasks

goosewobbler and others added 25 commits March 21, 2023 14:14

first pass

2b817ef

remove debounce & key exemptions

13969c2

explicitly add all keys requiring mapping

34c6251

disable during config, enable after

9dad863

fix onboard slide

b0a0219

update meta key display

4a07c26

add event log

de081bf

merge commit

72cf9dd

linux update

4c4933b

merge lock

869057e

windows update

4d4f0e4

linux update

ae78222

more-linux-updates

87caf7e

windows update

a860e4f

remove logs

5513856

address UX

2e4685c

update migration

d5f79c8

add migration, update package lock

b491386

make migration work for now

67167e9

update state version

7e890fa

use keycode for migration

0074ccc

whitelist first pass

58ff374

add v37 schema

b37258b

update tests

243a4ea

extract component

872f360

mholtzman force-pushed the keybinding branch from 3ed44ce to 872f360 Compare March 21, 2023 18:15

move to resources

11deb5c

goosewobbler removed the WIP PRs that are still in progress and not ready for review or merging label Mar 22, 2023

mholtzman commented Mar 22, 2023

View reviewed changes

app/dash/Settings/index.js Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

resources/app/index.js Outdated Show resolved Hide resolved

resources/Components/KeyboardShortcutConfigurator/index.js Outdated Show resolved Hide resolved

fix hotkeys

e38d6d7

mholtzman commented Mar 22, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

goosewobbler added 2 commits March 22, 2023 15:48

remove buffer

7c498aa

remove local state

1d963a2

mholtzman commented Mar 22, 2023

View reviewed changes

resources/Components/KeyboardShortcutConfigurator/index.js Outdated Show resolved Hide resolved

goosewobbler and others added 7 commits March 22, 2023 17:01

move unbind to top level

8a6ab73

unbind when removing effect

3a38844

use TS

5a4e9cc

stronger typing

724e697

typing for modifier keys

e8aa32d

clean up duplicated logic

18fa584

capitalize letters only

04a571c

goosewobbler approved these changes Mar 22, 2023

View reviewed changes

goosewobbler merged commit f7702e8 into canary Mar 22, 2023

goosewobbler deleted the keybinding branch March 22, 2023 18:41

mholtzman added a commit that referenced this pull request Mar 22, 2023

Choose summon keybinding (#1494)

aa962b5

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

goosewobbler mentioned this pull request Mar 23, 2023

Linux show/hide shortcut doesn't work #566

Closed

mholtzman added a commit that referenced this pull request Apr 5, 2023

Choose summon keybinding (#1494)

29646be

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

mholtzman added a commit that referenced this pull request Apr 18, 2023

Choose summon keybinding (#1494)

677832a

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

mholtzman added a commit that referenced this pull request Apr 19, 2023

Choose summon keybinding (#1494)

20fb88f

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

mholtzman added a commit that referenced this pull request Apr 19, 2023

Choose summon keybinding (#1494)

138a410

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

mholtzman added a commit that referenced this pull request Apr 19, 2023

Choose summon keybinding (#1494)

a193cf2

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

mholtzman added a commit that referenced this pull request Jun 23, 2023

Choose summon keybinding (#1494)

e8298ef

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

mholtzman added a commit that referenced this pull request Jul 26, 2023

Choose summon keybinding (#1494)

20a6393

Co-authored-by: goosewobbler <goosewobbler@pm.me> Co-authored-by: goosewobbler <goosewobbler@protonmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Choose summon keybinding #1494

Choose summon keybinding #1494

mholtzman commented Mar 21, 2023 •

edited by goosewobbler

Loading

socket-security bot commented Mar 21, 2023 •

edited

Loading

goosewobbler commented Mar 21, 2023

michaelni commented Apr 7, 2023

Choose summon keybinding #1494

Choose summon keybinding #1494

Conversation

mholtzman commented Mar 21, 2023 • edited by goosewobbler Loading

Limitations

Testing

Whitelisted Keys

socket-security bot commented Mar 21, 2023 • edited Loading

Socket Security Pull Request Report

goosewobbler commented Mar 21, 2023

michaelni commented Apr 7, 2023

mholtzman commented Mar 21, 2023 •

edited by goosewobbler

Loading

socket-security bot commented Mar 21, 2023 •

edited

Loading