ZenBrowserMirrors/components
1
0
Fork 0
mirror of https://github.com/zen-browser/components.git synced 2025-07-08 04:09:59 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Refactor ZenKeyboardShortcuts to use async/await for initialization and handle potential error when retrieving active workspace from cache

Browse source
This commit is contained in:
mauro-balades 2024-09-22 22:13:15 +02:00
parent f6dbd40464
commit 06bff7da09
1 changed files with 31 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

45
src/ZenKeyboardShortcuts.mjs
View file

@ -168,7 +168,6 @@ const KEYCODE_MAP = {
BACKSPACE: 'VK_BACK', BACKSPACE: 'VK_BACK',
}; };
const SHORTCUTS_STORAGE_KEY = 'zen.keyboard.shortcuts';
const ZEN_SHORTCUTS_GROUP = 'zen'; const ZEN_SHORTCUTS_GROUP = 'zen';
const FIREFOX_SHORTCUTS_GROUP = 'firefox'; const FIREFOX_SHORTCUTS_GROUP = 'firefox';
const VALID_SHORTCUT_GROUPS = [ZEN_SHORTCUTS_GROUP, FIREFOX_SHORTCUTS_GROUP]; const VALID_SHORTCUT_GROUPS = [ZEN_SHORTCUTS_GROUP, FIREFOX_SHORTCUTS_GROUP];
@ -451,26 +450,44 @@ class KeyShortcut {
} }
} }
var gZenKeyboardShortcutsStorage = new class {
init() {}
get shortcutsFile() {
return PathUtils.join(PathUtils.profileDir, 'zen-keyboard-shortcuts.json');
}
async save(data) {
await IOUtils.writeJSON(this.shortcutsFile, {shortcuts: data});
}
async load() {
try {
return (await IOUtils.readJSON(this.shortcutsFile)).shortcuts;
} catch (e) {
console.error('Error loading shortcuts file', e);
return null;
}
}
}
var gZenKeyboardShortcutsManager = { var gZenKeyboardShortcutsManager = {
init() { async init() {
if (window.location.href == 'chrome://browser/content/browser.xhtml') { if (window.location.href == 'chrome://browser/content/browser.xhtml') {
console.info('Zen CKS: Initializing shortcuts'); console.info('Zen CKS: Initializing shortcuts');
this._currentShortcutList = []; this._currentShortcutList = await this._loadSaved();
this._saveShortcuts([]); // TODO Remove on release
this._currentShortcutList = this._loadSaved(); // TODO: add some sort of observer to listen for changes in the shortcuts file
Services.prefs.addObserver(SHORTCUTS_STORAGE_KEY, this._applyShortcuts.bind(this)); await this._saveShortcuts();
this._saveShortcuts();
console.info('Zen CKS: Initialized'); console.info('Zen CKS: Initialized');
} }
}, },
_loadSaved() { async _loadSaved() {
let data = JSON.parse(Services.prefs.getStringPref(SHORTCUTS_STORAGE_KEY)); let data = await gZenKeyboardShortcutsStorage.load();
if (!data || data.length == 0) { if (!data || data.length == 0) {
return this._loadDefaults(); return this._loadDefaults();
} }
@ -523,16 +540,16 @@ var gZenKeyboardShortcutsManager = {
console.debug('Shortcuts applied...'); console.debug('Shortcuts applied...');
}, },
_saveShortcuts() { async _saveShortcuts() {
let json = []; let json = [];
for (shortcut of this._currentShortcutList) { for (shortcut of this._currentShortcutList) {
json.push(shortcut.toJSONForm()); json.push(shortcut.toJSONForm());
} }
Services.prefs.setStringPref(SHORTCUTS_STORAGE_KEY, JSON.stringify(json)); await gZenKeyboardShortcutsStorage.save(json);
}, },
setShortcut(action, shortcut, modifiers) { async setShortcut(action, shortcut, modifiers) {
if (!action) { if (!action) {
throw new Error('Action cannot be null'); throw new Error('Action cannot be null');
} }
@ -554,7 +571,7 @@ var gZenKeyboardShortcutsManager = {
console.debug(this._currentShortcutList); console.debug(this._currentShortcutList);
this._saveShortcuts(); await this._saveShortcuts();
}, },
getModifiableShortcuts() { getModifiableShortcuts() {