Resetting a shortcut does not restore and enable the default if it wa…

…s modified (#16304) * Fix for shortcut disabled on reset * Added test
jupyterlab · May 9, 2024 · 66bc3b0 · 66bc3b0
1 parent 3c13610
commit 66bc3b0
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/packages/shortcuts-extension/src/components/ShortcutUI.tsx b/packages/shortcuts-extension/src/components/ShortcutUI.tsx
@@ -384,6 +384,12 @@ export class ShortcutUI
           });
         }
         found = true;
+      } else if (
+        keybinding &&
+        !JSONExt.deepEqual(keybinding.keys, shortcut.keys) &&
+        keys.length === 0
+      ) {
+        continue;
       } else {
         newUserShortcuts.push(shortcut);
       }

diff --git a/packages/shortcuts-extension/test/components/ShortcutUI.spec.ts b/packages/shortcuts-extension/test/components/ShortcutUI.spec.ts
@@ -288,6 +288,48 @@ describe('@jupyterlab/shortcut-extension', () => {
         expect(data.user.shortcuts).toHaveLength(0);
       });
 
+      it('should reset default overrides for given shortcut target', async () => {
+        const defaultKeybinding = {
+          keys: ['Ctrl A'],
+          isDefault: true
+        };
+
+        const replacedKeybinding = {
+          keys: ['Ctrl D'],
+          isDefault: false
+        };
+        const target = {
+          id: 'test-id',
+          command: 'test:command',
+          keybindings: [defaultKeybinding],
+          args: {},
+          selector: 'body',
+          category: 'test'
+        };
+        registerKeybinding(target, defaultKeybinding);
+        await shortcutUI.replaceKeybinding(target, defaultKeybinding, [
+          'Ctrl D'
+        ]);
+
+        //update the target to the new keybinding.
+        target.keybindings = [replacedKeybinding];
+
+        expect(data.user.shortcuts).toHaveLength(2);
+        expect(data.user.shortcuts[0]).toEqual({
+          command: 'test:command',
+          keys: ['Ctrl A'],
+          selector: 'body',
+          disabled: true
+        });
+        expect(data.user.shortcuts[1]).toEqual({
+          command: 'test:command',
+          keys: ['Ctrl D'],
+          selector: 'body'
+        });
+        await shortcutUI.resetKeybindings(target);
+        expect(data.user.shortcuts).toHaveLength(0);
+      });
+
       it('should clear defaults overrides for given shortcut target', async () => {
         const keybinding = {
           keys: ['Ctrl A'],