Repository navigation
fix(keybindings): enforce one command per combo in the keymap store #23151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
benceruleanlu
wants to merge
4
commits into
main
Choose a base branch
from
bl/atomic-keymap-changes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3f5e684
fix(keybindings): make user keymap changes all-or-nothing
benceruleanlu ce9e490
fix(keybindings): take a combo back when overwriting onto an unset de…
benceruleanlu 460d33d
fix(keybindings): keep saved shortcuts when restored settings clash
benceruleanlu 6f1caed
fix(keybindings): keep saved shortcuts when a saved entry is malformed
benceruleanlu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
src/platform/keybindings/components/EditKeybindingFooter.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| import userEvent from '@testing-library/user-event' | ||
| import { render, screen } from '@testing-library/vue' | ||
| import { describe, expect, it, vi } from 'vitest' | ||
| import { reactive } from 'vue' | ||
|
|
||
| import { KeyComboImpl } from '@comfyorg/keybindings/keyCombo' | ||
| import { KeybindingImpl } from '@comfyorg/keybindings/keybinding' | ||
| import { useKeybindingStore } from '@comfyorg/keybindings/keybindingStore' | ||
| import { useSettingStore } from '@/platform/settings/settingStore' | ||
| import { useDialogStore } from '@/stores/dialogStore' | ||
| import { testI18n } from '@/utils/__tests__/testI18n' | ||
|
|
||
| import EditKeybindingFooter from './EditKeybindingFooter.vue' | ||
| import { EDIT_KEYBINDING_DIALOG_KEY } from './editKeybindingDialogState' | ||
| import type { EditKeybindingDialogState } from './editKeybindingDialogState' | ||
|
|
||
| const ctrlK = { key: 'k', ctrl: true } | ||
|
|
||
| function renderFooter(existingKeybindingOnCombo: KeybindingImpl | null) { | ||
| const dialogState = reactive<EditKeybindingDialogState>({ | ||
| commandId: 'test.incoming', | ||
| newCombo: new KeyComboImpl(ctrlK), | ||
| currentCombo: null, | ||
| mode: 'add', | ||
| existingBinding: null | ||
| }) | ||
| return render(EditKeybindingFooter, { | ||
| props: { dialogState, existingKeybindingOnCombo }, | ||
| global: { plugins: [testI18n] } | ||
| }) | ||
| } | ||
|
|
||
| describe('EditKeybindingFooter', () => { | ||
| it('replaces the holder and persists when Overwrite is confirmed', async () => { | ||
| const settingStore = useSettingStore() | ||
| vi.mocked(settingStore.setMany).mockResolvedValue(undefined) | ||
| const store = useKeybindingStore() | ||
| const holder = new KeybindingImpl({ | ||
| commandId: 'test.holder', | ||
| combo: ctrlK | ||
| }) | ||
| store.addDefaultKeybinding(holder) | ||
| renderFooter(holder) | ||
|
|
||
| await userEvent.click(screen.getByRole('button', { name: 'Overwrite' })) | ||
|
|
||
| expect(store.getKeybinding(holder.combo)?.commandId).toBe('test.incoming') | ||
| expect(store.getKeybindingsByCommandId('test.holder')).toEqual([]) | ||
| expect(settingStore.setMany).toHaveBeenCalledOnce() | ||
| expect(useDialogStore().closeDialog).toHaveBeenCalledWith({ | ||
| key: EDIT_KEYBINDING_DIALOG_KEY | ||
| }) | ||
| }) | ||
|
|
||
| it('stays open and persists nothing when the combo became occupied after the dialog offered Save', async () => { | ||
| const settingStore = useSettingStore() | ||
| const store = useKeybindingStore() | ||
| const holder = new KeybindingImpl({ | ||
| commandId: 'test.holder', | ||
| combo: ctrlK | ||
| }) | ||
| store.addDefaultKeybinding(holder) | ||
| renderFooter(null) | ||
|
|
||
| await userEvent.click(screen.getByRole('button', { name: 'Save' })) | ||
|
|
||
| expect(store.getKeybinding(holder.combo)).toEqual(holder) | ||
| expect(settingStore.setMany).not.toHaveBeenCalled() | ||
| expect(useDialogStore().closeDialog).not.toHaveBeenCalled() | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.