From 3e350bd563886e49fed309731d99f37e6f3ab320 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sat, 14 Aug 2021 11:46:26 -0400 Subject: Dictionary worker refactor (#1894) * Rename dictionary worker files * Rename classes * Rename file * Rename class * Generalize the _invoke method * Rename 'import' to 'importDictionary' * Improve DictionaryImporterMediaLoader usage * Refactor message handler * Generalize onProgress event --- ext/js/language/dictionary-database-modifier.js | 109 +++++++++++++++++++++ ext/js/language/dictionary-importer-threaded.js | 89 ----------------- ext/js/language/dictionary-importer-worker-main.js | 42 -------- .../dictionary-importer-worker-media-loader.js | 65 ------------ ext/js/language/dictionary-importer-worker.js | 83 ---------------- ext/js/language/dictionary-worker-main.js | 42 ++++++++ ext/js/language/dictionary-worker-media-loader.js | 65 ++++++++++++ ext/js/language/dictionary-worker.js | 83 ++++++++++++++++ .../pages/settings/dictionary-import-controller.js | 6 +- 9 files changed, 302 insertions(+), 282 deletions(-) create mode 100644 ext/js/language/dictionary-database-modifier.js delete mode 100644 ext/js/language/dictionary-importer-threaded.js delete mode 100644 ext/js/language/dictionary-importer-worker-main.js delete mode 100644 ext/js/language/dictionary-importer-worker-media-loader.js delete mode 100644 ext/js/language/dictionary-importer-worker.js create mode 100644 ext/js/language/dictionary-worker-main.js create mode 100644 ext/js/language/dictionary-worker-media-loader.js create mode 100644 ext/js/language/dictionary-worker.js (limited to 'ext/js') diff --git a/ext/js/language/dictionary-database-modifier.js b/ext/js/language/dictionary-database-modifier.js new file mode 100644 index 00000000..3b100fae --- /dev/null +++ b/ext/js/language/dictionary-database-modifier.js @@ -0,0 +1,109 @@ +/* + * Copyright (C) 2021 Yomichan 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 . + */ + +/* global + * DictionaryImporterMediaLoader + */ + +class DictionaryDatabaseModifier { + constructor() { + this._dictionaryImporterMediaLoader = new DictionaryImporterMediaLoader(); + } + + importDictionary(archiveContent, details, onProgress) { + return this._invoke('importDictionary', {details, archiveContent}, [archiveContent], onProgress); + } + + // Private + + _invoke(action, params, transfer, onProgress) { + return new Promise((resolve, reject) => { + const worker = new Worker('/js/language/dictionary-worker-main.js', {}); + const details = { + complete: false, + worker, + resolve, + reject, + onMessage: null, + onProgress + }; + const onMessage = this._onMessage.bind(this, details); + details.onMessage = onMessage; + worker.addEventListener('message', onMessage); + worker.postMessage({action, params}, transfer); + }); + } + + _onMessage(details, e) { + if (details.complete) { return; } + const {action, params} = e.data; + switch (action) { + case 'complete': + { + const {worker, resolve, reject, onMessage} = details; + details.complete = true; + details.worker = null; + details.resolve = null; + details.reject = null; + details.onMessage = null; + worker.removeEventListener('message', onMessage); + worker.terminate(); + this._onMessageComplete(params, resolve, reject); + } + break; + case 'progress': + this._onMessageProgress(params, details.onProgress); + break; + case 'getImageResolution': + this._onMessageGetImageResolution(params, details.worker); + break; + } + } + + _onMessageComplete(params, resolve, reject) { + const {error} = params; + if (typeof error !== 'undefined') { + reject(deserializeError(error)); + } else { + resolve(this._formatResult(params.result)); + } + } + + _onMessageProgress(params, onProgress) { + if (typeof onProgress !== 'function') { return; } + const {args} = params; + onProgress(...args); + } + + async _onMessageGetImageResolution(params, worker) { + const {id, mediaType, content} = params; + let response; + try { + const result = await this._dictionaryImporterMediaLoader.getImageResolution(mediaType, content); + response = {id, result}; + } catch (e) { + response = {id, error: serializeError(e)}; + } + worker.postMessage({action: 'getImageResolution.response', params: response}); + } + + _formatResult(data) { + const {result, errors} = data; + const errors2 = errors.map((error) => deserializeError(error)); + return {result, errors: errors2}; + } +} diff --git a/ext/js/language/dictionary-importer-threaded.js b/ext/js/language/dictionary-importer-threaded.js deleted file mode 100644 index c9b6fb24..00000000 --- a/ext/js/language/dictionary-importer-threaded.js +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright (C) 2021 Yomichan 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 . - */ - -/* global - * DictionaryImporterMediaLoader - */ - -class DictionaryImporterThreaded { - constructor(onProgress) { - this._onProgress = onProgress; - } - - importDictionary(archiveContent, details) { - return new Promise((resolve, reject) => { - const dictionaryImporterMediaLoader = new DictionaryImporterMediaLoader(); - const worker = new Worker('/js/language/dictionary-importer-worker-main.js', {}); - const onMessage = (e) => { - const {action, params} = e.data; - switch (action) { - case 'complete': - worker.removeEventListener('message', onMessage); - worker.terminate(); - this._onMessageComplete(params, resolve, reject); - break; - case 'progress': - this._onMessageProgress(params); - break; - case 'getImageResolution': - this._onMessageGetImageResolution(params, worker, dictionaryImporterMediaLoader); - break; - } - }; - worker.addEventListener('message', onMessage); - worker.postMessage({ - action: 'import', - params: {details, archiveContent} - }, [archiveContent]); - }); - } - - // Private - - _onMessageComplete(params, resolve, reject) { - const {error} = params; - if (typeof error !== 'undefined') { - reject(deserializeError(error)); - } else { - resolve(this._formatResult(params.result)); - } - } - - _onMessageProgress(params) { - if (typeof this._onProgress !== 'function') { return; } - const {args} = params; - this._onProgress(...args); - } - - async _onMessageGetImageResolution(params, worker, dictionaryImporterMediaLoader) { - const {id, mediaType, content} = params; - let response; - try { - const result = await dictionaryImporterMediaLoader.getImageResolution(mediaType, content); - response = {id, result}; - } catch (e) { - response = {id, error: serializeError(e)}; - } - worker.postMessage({action: 'getImageResolution.response', params: response}); - } - - _formatResult(data) { - const {result, errors} = data; - const errors2 = errors.map((error) => deserializeError(error)); - return {result, errors: errors2}; - } -} diff --git a/ext/js/language/dictionary-importer-worker-main.js b/ext/js/language/dictionary-importer-worker-main.js deleted file mode 100644 index 100bb4fb..00000000 --- a/ext/js/language/dictionary-importer-worker-main.js +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright (C) 2021 Yomichan 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 . - */ - -/* global - * DictionaryImporterWorker - */ - -self.importScripts( - '/lib/jszip.min.js', - '/js/core.js', - '/js/data/database.js', - '/js/data/json-schema.js', - '/js/general/cache-map.js', - '/js/language/dictionary-database.js', - '/js/language/dictionary-importer.js', - '/js/language/dictionary-importer-worker.js', - '/js/language/dictionary-importer-worker-media-loader.js', - '/js/media/media-util.js' -); - -(() => { - try { - const dictionaryImporterWorker = new DictionaryImporterWorker(); - dictionaryImporterWorker.prepare(); - } catch (e) { - log.error(e); - } -})(); diff --git a/ext/js/language/dictionary-importer-worker-media-loader.js b/ext/js/language/dictionary-importer-worker-media-loader.js deleted file mode 100644 index 5d5d3593..00000000 --- a/ext/js/language/dictionary-importer-worker-media-loader.js +++ /dev/null @@ -1,65 +0,0 @@ -/* - * Copyright (C) 2021 Yomichan 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 . - */ - -/** - * Class used for loading and validating media from a worker thread - * during the dictionary import process. - */ -class DictionaryImporterWorkerMediaLoader { - /** - * Creates a new instance of the media loader. - */ - constructor() { - this._requests = new Map(); - } - - /** - * Handles a response message posted to the worker thread. - * @param params Details of the response. - */ - handleMessage(params) { - const {id} = params; - const request = this._requests.get(id); - if (typeof request === 'undefined') { return; } - this._requests.delete(id); - const {error} = params; - if (typeof error !== 'undefined') { - request.reject(deserializeError(error)); - } else { - request.resolve(params.result); - } - } - - /** - * Attempts to load an image using a base64 encoded content and a media type - * and returns its resolution. - * @param mediaType The media type for the image content. - * @param content The binary content for the image, encoded in base64. - * @returns A Promise which resolves with {width, height} on success, - * otherwise an error is thrown. - */ - getImageResolution(mediaType, content) { - return new Promise((resolve, reject) => { - const id = generateId(16); - this._requests.set(id, {resolve, reject}); - self.postMessage({ - action: 'getImageResolution', - params: {id, mediaType, content} - }); - }); - } -} diff --git a/ext/js/language/dictionary-importer-worker.js b/ext/js/language/dictionary-importer-worker.js deleted file mode 100644 index 014b6542..00000000 --- a/ext/js/language/dictionary-importer-worker.js +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright (C) 2021 Yomichan 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 . - */ - -/* global - * DictionaryDatabase - * DictionaryImporter - * DictionaryImporterWorkerMediaLoader - */ - -class DictionaryImporterWorker { - constructor() { - this._mediaLoader = new DictionaryImporterWorkerMediaLoader(); - } - - prepare() { - self.addEventListener('message', this._onMessage.bind(this), false); - } - - // Private - - _onMessage(e) { - const {action, params} = e.data; - switch (action) { - case 'import': - this._onImport(params); - break; - case 'getImageResolution.response': - this._mediaLoader.handleMessage(params); - break; - } - } - - async _onImport({details, archiveContent}) { - const onProgress = (...args) => { - self.postMessage({ - action: 'progress', - params: {args} - }); - }; - let response; - try { - const result = await this._importDictionary(archiveContent, details, onProgress); - response = {result}; - } catch (e) { - response = {error: serializeError(e)}; - } - self.postMessage({action: 'complete', params: response}); - } - - async _importDictionary(archiveContent, importDetails, onProgress) { - const dictionaryDatabase = await this._getPreparedDictionaryDatabase(); - try { - const dictionaryImporter = new DictionaryImporter(this._mediaLoader, onProgress); - const {result, errors} = await dictionaryImporter.importDictionary(dictionaryDatabase, archiveContent, importDetails); - return { - result, - errors: errors.map((error) => serializeError(error)) - }; - } finally { - dictionaryDatabase.close(); - } - } - - async _getPreparedDictionaryDatabase() { - const dictionaryDatabase = new DictionaryDatabase(); - await dictionaryDatabase.prepare(); - return dictionaryDatabase; - } -} diff --git a/ext/js/language/dictionary-worker-main.js b/ext/js/language/dictionary-worker-main.js new file mode 100644 index 00000000..e113b568 --- /dev/null +++ b/ext/js/language/dictionary-worker-main.js @@ -0,0 +1,42 @@ +/* + * Copyright (C) 2021 Yomichan 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 . + */ + +/* global + * DictionaryWorker + */ + +self.importScripts( + '/lib/jszip.min.js', + '/js/core.js', + '/js/data/database.js', + '/js/data/json-schema.js', + '/js/general/cache-map.js', + '/js/language/dictionary-database.js', + '/js/language/dictionary-importer.js', + '/js/language/dictionary-worker.js', + '/js/language/dictionary-worker-media-loader.js', + '/js/media/media-util.js' +); + +(() => { + try { + const dictionaryImporterWorker = new DictionaryWorker(); + dictionaryImporterWorker.prepare(); + } catch (e) { + log.error(e); + } +})(); diff --git a/ext/js/language/dictionary-worker-media-loader.js b/ext/js/language/dictionary-worker-media-loader.js new file mode 100644 index 00000000..90ee513f --- /dev/null +++ b/ext/js/language/dictionary-worker-media-loader.js @@ -0,0 +1,65 @@ +/* + * Copyright (C) 2021 Yomichan 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 . + */ + +/** + * Class used for loading and validating media from a worker thread + * during the dictionary import process. + */ +class DictionaryWorkerMediaLoader { + /** + * Creates a new instance of the media loader. + */ + constructor() { + this._requests = new Map(); + } + + /** + * Handles a response message posted to the worker thread. + * @param params Details of the response. + */ + handleMessage(params) { + const {id} = params; + const request = this._requests.get(id); + if (typeof request === 'undefined') { return; } + this._requests.delete(id); + const {error} = params; + if (typeof error !== 'undefined') { + request.reject(deserializeError(error)); + } else { + request.resolve(params.result); + } + } + + /** + * Attempts to load an image using a base64 encoded content and a media type + * and returns its resolution. + * @param mediaType The media type for the image content. + * @param content The binary content for the image, encoded in base64. + * @returns A Promise which resolves with {width, height} on success, + * otherwise an error is thrown. + */ + getImageResolution(mediaType, content) { + return new Promise((resolve, reject) => { + const id = generateId(16); + this._requests.set(id, {resolve, reject}); + self.postMessage({ + action: 'getImageResolution', + params: {id, mediaType, content} + }); + }); + } +} diff --git a/ext/js/language/dictionary-worker.js b/ext/js/language/dictionary-worker.js new file mode 100644 index 00000000..5c482178 --- /dev/null +++ b/ext/js/language/dictionary-worker.js @@ -0,0 +1,83 @@ +/* + * Copyright (C) 2021 Yomichan 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 . + */ + +/* global + * DictionaryDatabase + * DictionaryImporter + * DictionaryWorkerMediaLoader + */ + +class DictionaryWorker { + constructor() { + this._mediaLoader = new DictionaryWorkerMediaLoader(); + } + + prepare() { + self.addEventListener('message', this._onMessage.bind(this), false); + } + + // Private + + _onMessage(e) { + const {action, params} = e.data; + switch (action) { + case 'importDictionary': + this._onImportDictionary(params); + break; + case 'getImageResolution.response': + this._mediaLoader.handleMessage(params); + break; + } + } + + async _onImportDictionary({details, archiveContent}) { + const onProgress = (...args) => { + self.postMessage({ + action: 'progress', + params: {args} + }); + }; + let response; + try { + const result = await this._importDictionary(archiveContent, details, onProgress); + response = {result}; + } catch (e) { + response = {error: serializeError(e)}; + } + self.postMessage({action: 'complete', params: response}); + } + + async _importDictionary(archiveContent, importDetails, onProgress) { + const dictionaryDatabase = await this._getPreparedDictionaryDatabase(); + try { + const dictionaryImporter = new DictionaryImporter(this._mediaLoader, onProgress); + const {result, errors} = await dictionaryImporter.importDictionary(dictionaryDatabase, archiveContent, importDetails); + return { + result, + errors: errors.map((error) => serializeError(error)) + }; + } finally { + dictionaryDatabase.close(); + } + } + + async _getPreparedDictionaryDatabase() { + const dictionaryDatabase = new DictionaryDatabase(); + await dictionaryDatabase.prepare(); + return dictionaryDatabase; + } +} diff --git a/ext/js/pages/settings/dictionary-import-controller.js b/ext/js/pages/settings/dictionary-import-controller.js index addba1fa..2716756d 100644 --- a/ext/js/pages/settings/dictionary-import-controller.js +++ b/ext/js/pages/settings/dictionary-import-controller.js @@ -17,7 +17,7 @@ /* global * DictionaryController - * DictionaryImporterThreaded + * DictionaryDatabaseModifier */ class DictionaryImportController { @@ -212,9 +212,9 @@ class DictionaryImportController { } async _importDictionary(file, importDetails, onProgress) { - const dictionaryImporter = new DictionaryImporterThreaded(onProgress); const archiveContent = await this._readFile(file); - const {result, errors} = await dictionaryImporter.importDictionary(archiveContent, importDetails); + const dictionaryDatabaseModifier = new DictionaryDatabaseModifier(); + const {result, errors} = await dictionaryDatabaseModifier.importDictionary(archiveContent, importDetails, onProgress); yomichan.api.triggerDatabaseUpdated('dictionary', 'import'); const errors2 = await this._addDictionarySettings(result.sequenced, result.title); -- cgit v1.2.3