From 95ad1ae1ef4a53802c12eab4c9b1545af0333aa1 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sat, 16 Dec 2023 19:55:02 -0500 Subject: Safer query selector (#364) * Add querySelectorNotNull helper function * Use querySelectorNotNull * Updates * Update settings * Remove unused * Update * Update function calls * More updates * Update types * Remove obsolete code --- ext/js/dom/popup-menu.js | 5 +++-- ext/js/dom/query-selector.js | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 ext/js/dom/query-selector.js (limited to 'ext/js/dom') diff --git a/ext/js/dom/popup-menu.js b/ext/js/dom/popup-menu.js index 78394c93..33cdd1ae 100644 --- a/ext/js/dom/popup-menu.js +++ b/ext/js/dom/popup-menu.js @@ -17,6 +17,7 @@ */ import {EventDispatcher, EventListenerCollection} from '../core.js'; +import {querySelectorNotNull} from './query-selector.js'; /** * @augments EventDispatcher @@ -33,9 +34,9 @@ export class PopupMenu extends EventDispatcher { /** @type {HTMLElement} */ this._containerNode = containerNode; /** @type {HTMLElement} */ - this._node = /** @type {HTMLElement} */ (containerNode.querySelector('.popup-menu')); + this._node = querySelectorNotNull(containerNode, '.popup-menu'); /** @type {HTMLElement} */ - this._bodyNode = /** @type {HTMLElement} */ (containerNode.querySelector('.popup-menu-body')); + this._bodyNode = querySelectorNotNull(containerNode, '.popup-menu-body'); /** @type {boolean} */ this._isClosed = false; /** @type {EventListenerCollection} */ diff --git a/ext/js/dom/query-selector.js b/ext/js/dom/query-selector.js new file mode 100644 index 00000000..e881211d --- /dev/null +++ b/ext/js/dom/query-selector.js @@ -0,0 +1,43 @@ +/* + * Copyright (C) 2023 Yomitan Authors + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import {ExtensionError} from '../core/extension-error.js'; + +/** + * @param {Element|Document|DocumentFragment} element + * @param {string} selector + * @returns {ExtensionError} + */ +function createError(element, selector) { + const error = new ExtensionError(`Performing querySelectorNotNull(element, ${JSON.stringify(selector)}) returned null`); + error.data = {element, selector}; + return error; +} + +/** + * @template {Element} T + * @param {Element|Document|DocumentFragment} element + * @param {string} selector + * @returns {T} + * @throws {Error} + */ +export function querySelectorNotNull(element, selector) { + /** @type {?T} */ + const result = element.querySelector(selector); + if (result === null) { throw createError(element, selector); } + return result; +} -- cgit v1.2.3