aboutsummaryrefslogtreecommitdiff
path: root/ext/js/background/backend.js
diff options
context:
space:
mode:
authorDarius Jahandarie <djahandarie@gmail.com>2023-11-18 02:49:37 +0000
committerGitHub <noreply@github.com>2023-11-18 02:49:37 +0000
commit106efbd88528d1d37e86fab0574f6ebf30d119c1 (patch)
treefa0e73f06de23f7f9bae095a89f37a556f694673 /ext/js/background/backend.js
parent017b87566c848d2a0a9be1b66fde7bde14092219 (diff)
parent6a7dfc0b50e7b5ba23cafb944a08950e93211911 (diff)
Merge pull request #325 from jbukl/offscreen-merge23.11.18.0
Move DB into offscreen (on Chrome) to avoid lookup delays caused by service worker startup lag
Diffstat (limited to 'ext/js/background/backend.js')
-rw-r--r--ext/js/background/backend.js163
1 files changed, 54 insertions, 109 deletions
diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
index e4186d02..bf4841f8 100644
--- a/ext/js/background/backend.js
+++ b/ext/js/background/backend.js
@@ -35,6 +35,7 @@ import {Translator} from '../language/translator.js';
import {AudioDownloader} from '../media/audio-downloader.js';
import {MediaUtil} from '../media/media-util.js';
import {yomitan} from '../yomitan.js';
+import {OffscreenProxy, DictionaryDatabaseProxy, TranslatorProxy, ClipboardReaderProxy} from './offscreen-proxy.js';
import {ProfileConditionsUtil} from './profile-conditions-util.js';
import {RequestBuilder} from './request-builder.js';
import {ScriptManager} from './script-manager.js';
@@ -50,15 +51,15 @@ export class Backend {
constructor() {
this._japaneseUtil = new JapaneseUtil(wanakana);
this._environment = new Environment();
- this._dictionaryDatabase = new DictionaryDatabase();
- this._translator = new Translator({
- japaneseUtil: this._japaneseUtil,
- database: this._dictionaryDatabase
- });
this._anki = new AnkiConnect();
this._mecab = new Mecab();
if (!chrome.offscreen) {
+ this._dictionaryDatabase = new DictionaryDatabase();
+ this._translator = new Translator({
+ japaneseUtil: this._japaneseUtil,
+ database: this._dictionaryDatabase
+ });
this._clipboardReader = new ClipboardReader({
// eslint-disable-next-line no-undef
document: (typeof document === 'object' && document !== null ? document : null),
@@ -66,10 +67,10 @@ export class Backend {
richContentPasteTargetSelector: '#clipboard-rich-content-paste-target'
});
} else {
- this._clipboardReader = {
- getText: this._getTextOffscreen.bind(this),
- getImage: this._getImageOffscreen.bind(this)
- };
+ this._offscreen = new OffscreenProxy();
+ this._dictionaryDatabase = new DictionaryDatabaseProxy(this._offscreen);
+ this._translator = new TranslatorProxy(this._offscreen);
+ this._clipboardReader = new ClipboardReaderProxy(this._offscreen);
}
this._clipboardMonitor = new ClipboardMonitor({
@@ -106,8 +107,6 @@ export class Backend {
this._permissions = null;
this._permissionsUtil = new PermissionsUtil();
- this._creatingOffscreen = null;
-
this._messageHandlers = new Map([
['requestBackendReadySignal', {async: false, contentScript: true, handler: this._onApiRequestBackendReadySignal.bind(this)}],
['optionsGet', {async: false, contentScript: true, handler: this._onApiOptionsGet.bind(this)}],
@@ -230,7 +229,7 @@ export class Backend {
await this._requestBuilder.prepare();
await this._environment.prepare();
if (chrome.offscreen) {
- await this._setupOffscreenDocument();
+ await this._offscreen.prepare();
}
this._clipboardReader.browser = this._environment.getInfo().browser;
@@ -754,6 +753,49 @@ export class Backend {
}
}
+ _onApiOpenCrossFramePort({targetTabId, targetFrameId}, sender) {
+ const sourceTabId = (sender && sender.tab ? sender.tab.id : null);
+ if (typeof sourceTabId !== 'number') {
+ throw new Error('Port does not have an associated tab ID');
+ }
+ const sourceFrameId = sender.frameId;
+ if (typeof sourceFrameId !== 'number') {
+ throw new Error('Port does not have an associated frame ID');
+ }
+
+ const sourceDetails = {
+ name: 'cross-frame-communication-port',
+ otherTabId: targetTabId,
+ otherFrameId: targetFrameId
+ };
+ const targetDetails = {
+ name: 'cross-frame-communication-port',
+ otherTabId: sourceTabId,
+ otherFrameId: sourceFrameId
+ };
+ let sourcePort = chrome.tabs.connect(sourceTabId, {frameId: sourceFrameId, name: JSON.stringify(sourceDetails)});
+ let targetPort = chrome.tabs.connect(targetTabId, {frameId: targetFrameId, name: JSON.stringify(targetDetails)});
+
+ const cleanup = () => {
+ this._checkLastError(chrome.runtime.lastError);
+ if (targetPort !== null) {
+ targetPort.disconnect();
+ targetPort = null;
+ }
+ if (sourcePort !== null) {
+ sourcePort.disconnect();
+ sourcePort = null;
+ }
+ };
+
+ sourcePort.onMessage.addListener((message) => { targetPort.postMessage(message); });
+ targetPort.onMessage.addListener((message) => { sourcePort.postMessage(message); });
+ sourcePort.onDisconnect.addListener(cleanup);
+ targetPort.onDisconnect.addListener(cleanup);
+
+ return {targetTabId, targetFrameId};
+ }
+
// Command handlers
async _onCommandOpenSearchPage(params) {
@@ -1624,20 +1666,6 @@ export class Backend {
return await (json ? response.json() : response.text());
}
- _sendMessagePromise(...args) {
- return new Promise((resolve, reject) => {
- const callback = (response) => {
- try {
- resolve(this._getMessageResponseResult(response));
- } catch (error) {
- reject(error);
- }
- };
-
- chrome.runtime.sendMessage(...args, callback);
- });
- }
-
_sendMessageIgnoreResponse(...args) {
const callback = () => this._checkLastError(chrome.runtime.lastError);
chrome.runtime.sendMessage(...args, callback);
@@ -2239,87 +2267,4 @@ export class Backend {
}
return results;
}
-
- async _getTextOffscreen(useRichText) {
- return this._sendMessagePromise({action: 'clipboardGetTextOffscreen', params: {useRichText}});
- }
-
- async _getImageOffscreen() {
- return this._sendMessagePromise({action: 'clipboardGetImageOffscreen'});
- }
-
- _onApiOpenCrossFramePort({targetTabId, targetFrameId}, sender) {
- const sourceTabId = (sender && sender.tab ? sender.tab.id : null);
- if (typeof sourceTabId !== 'number') {
- throw new Error('Port does not have an associated tab ID');
- }
- const sourceFrameId = sender.frameId;
- if (typeof sourceFrameId !== 'number') {
- throw new Error('Port does not have an associated frame ID');
- }
-
- const sourceDetails = {
- name: 'cross-frame-communication-port',
- otherTabId: targetTabId,
- otherFrameId: targetFrameId
- };
- const targetDetails = {
- name: 'cross-frame-communication-port',
- otherTabId: sourceTabId,
- otherFrameId: sourceFrameId
- };
- let sourcePort = chrome.tabs.connect(sourceTabId, {frameId: sourceFrameId, name: JSON.stringify(sourceDetails)});
- let targetPort = chrome.tabs.connect(targetTabId, {frameId: targetFrameId, name: JSON.stringify(targetDetails)});
-
- const cleanup = () => {
- this._checkLastError(chrome.runtime.lastError);
- if (targetPort !== null) {
- targetPort.disconnect();
- targetPort = null;
- }
- if (sourcePort !== null) {
- sourcePort.disconnect();
- sourcePort = null;
- }
- };
-
- sourcePort.onMessage.addListener((message) => { targetPort.postMessage(message); });
- targetPort.onMessage.addListener((message) => { sourcePort.postMessage(message); });
- sourcePort.onDisconnect.addListener(cleanup);
- targetPort.onDisconnect.addListener(cleanup);
-
- return {targetTabId, targetFrameId};
- }
-
- // https://developer.chrome.com/docs/extensions/reference/offscreen/
- async _setupOffscreenDocument() {
- if (await this._hasOffscreenDocument()) {
- return;
- }
- if (this._creatingOffscreen) {
- await this._creatingOffscreen;
- return;
- }
-
- this._creatingOffscreen = chrome.offscreen.createDocument({
- url: 'offscreen.html',
- reasons: ['CLIPBOARD'],
- justification: 'Access to the clipboard'
- });
- await this._creatingOffscreen;
- this._creatingOffscreen = null;
- }
- async _hasOffscreenDocument() {
- const offscreenUrl = chrome.runtime.getURL('offscreen.html');
- if (!chrome.runtime.getContexts) { // chrome version <116
- const matchedClients = await clients.matchAll();
- return await matchedClients.some((client) => client.url === offscreenUrl);
- }
-
- const contexts = await chrome.runtime.getContexts({
- contextTypes: ['OFFSCREEN_DOCUMENT'],
- documentUrls: [offscreenUrl]
- });
- return !!contexts.length;
- }
}