Script ready state change (#672)

* Update how backend/frontend ready states are awaited and signaled

* Log errors on the search page

* Update action name
This commit is contained in:
toasted-nutbread 2020-07-18 17:11:38 -04:00 committed by GitHub
parent e696dc84a8
commit d7f78c23b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 69 additions and 51 deletions

View File

@ -85,7 +85,7 @@ class Backend {
this._logErrorLevel = null;
this._messageHandlers = new Map([
['yomichanCoreReady', {async: false, contentScript: true, handler: this._onApiYomichanCoreReady.bind(this)}],
['requestBackendReadySignal', {async: false, contentScript: true, handler: this._onApiRequestBackendReadySignal.bind(this)}],
['optionsSchemaGet', {async: false, contentScript: true, handler: this._onApiOptionsSchemaGet.bind(this)}],
['optionsGet', {async: false, contentScript: true, handler: this._onApiOptionsGet.bind(this)}],
['optionsGetFull', {async: false, contentScript: true, handler: this._onApiOptionsGetFull.bind(this)}],
@ -212,9 +212,9 @@ class Backend {
this._clipboardMonitor.on('change', this._onClipboardTextChange.bind(this));
this._sendMessageAllTabs('backendPrepared');
this._sendMessageAllTabs('backendReady');
const callback = () => this._checkLastError(chrome.runtime.lastError);
chrome.runtime.sendMessage({action: 'backendPrepared'}, callback);
chrome.runtime.sendMessage({action: 'backendReady'}, callback);
} catch (e) {
yomichan.logError(e);
throw e;
@ -361,10 +361,10 @@ class Backend {
// Message handlers
_onApiYomichanCoreReady(_params, sender) {
_onApiRequestBackendReadySignal(_params, sender) {
// tab ID isn't set in background (e.g. browser_action)
const callback = () => this._checkLastError(chrome.runtime.lastError);
const data = {action: 'backendPrepared'};
const data = {action: 'backendReady'};
if (typeof sender.tab === 'undefined') {
chrome.runtime.sendMessage(data, callback);
return false;
@ -1393,7 +1393,7 @@ class Backend {
sender.tab.id !== tabId ||
sender.frameId !== frameId ||
!isObject(message) ||
message.action !== 'yomichanCoreReady'
message.action !== 'yomichanReady'
) {
return;
}

View File

@ -76,7 +76,7 @@ async function setupOptions() {
(async () => {
api.forwardLogsToBackend();
await yomichan.ready();
await yomichan.backendReady();
const manifest = chrome.runtime.getManifest();
@ -87,4 +87,6 @@ async function setupOptions() {
setupButtonEvents('.action-open-search', 'search', chrome.runtime.getURL('/bg/search.html'));
setupButtonEvents('.action-open-options', 'options', chrome.runtime.getURL(manifest.options_ui.page));
setupButtonEvents('.action-open-help', 'help', 'https://foosoft.net/projects/yomichan/');
yomichan.ready();
})();

View File

@ -23,10 +23,12 @@
(async () => {
try {
api.forwardLogsToBackend();
await yomichan.ready();
await yomichan.backendReady();
const displaySearch = new DisplaySearch();
await displaySearch.prepare();
yomichan.ready();
} catch (e) {
yomichan.logError(e);
}

View File

@ -63,8 +63,9 @@ async function setupEnvironmentInfo() {
(async () => {
try {
api.forwardLogsToBackend();
await yomichan.ready();
await yomichan.backendReady();
setupEnvironmentInfo();
showExtensionInformation();
@ -104,4 +105,9 @@ async function setupEnvironmentInfo() {
const settingsBackup = new SettingsBackup(settingsController);
settingsBackup.prepare();
yomichan.ready();
} catch (e) {
yomichan.logError(e);
}
})();

View File

@ -24,7 +24,7 @@
(async () => {
try {
api.forwardLogsToBackend();
await yomichan.ready();
await yomichan.backendReady();
const {frameId} = await api.frameInformationGet();
if (typeof frameId !== 'number') {
@ -40,6 +40,8 @@
{}
);
await frontend.prepare();
yomichan.ready();
} catch (e) {
yomichan.logError(e);
}

View File

@ -23,10 +23,12 @@
(async () => {
try {
api.forwardLogsToBackend();
await yomichan.ready();
await yomichan.backendReady();
const display = new DisplayFloat();
await display.prepare();
yomichan.ready();
} catch (e) {
yomichan.logError(e);
}

View File

@ -51,12 +51,12 @@ const yomichan = (() => {
this._isReady = false;
const {promise, resolve} = deferPromise();
this._isBackendPreparedPromise = promise;
this._isBackendPreparedPromiseResolve = resolve;
this._isBackendReadyPromise = promise;
this._isBackendReadyPromiseResolve = resolve;
this._messageHandlers = new Map([
['isReady', {async: false, handler: this._onMessageIsReady.bind(this)}],
['backendPrepared', {async: false, handler: this._onMessageBackendPrepared.bind(this)}],
['backendReady', {async: false, handler: this._onMessageBackendReady.bind(this)}],
['getUrl', {async: false, handler: this._onMessageGetUrl.bind(this)}],
['optionsUpdated', {async: false, handler: this._onMessageOptionsUpdated.bind(this)}],
['zoomChanged', {async: false, handler: this._onMessageZoomChanged.bind(this)}]
@ -73,10 +73,14 @@ const yomichan = (() => {
chrome.runtime.onMessage.addListener(this._onMessage.bind(this));
}
backendReady() {
this.sendMessage({action: 'requestBackendReadySignal'});
return this._isBackendReadyPromise;
}
ready() {
this._isReady = true;
this.sendMessage({action: 'yomichanCoreReady'});
return this._isBackendPreparedPromise;
this.sendMessage({action: 'yomichanReady'});
}
generateId(length) {
@ -275,10 +279,10 @@ const yomichan = (() => {
return this._isReady;
}
_onMessageBackendPrepared() {
if (this._isBackendPreparedPromiseResolve === null) { return; }
this._isBackendPreparedPromiseResolve();
this._isBackendPreparedPromiseResolve = null;
_onMessageBackendReady() {
if (this._isBackendReadyPromiseResolve === null) { return; }
this._isBackendReadyPromiseResolve();
this._isBackendReadyPromiseResolve = null;
}
_onMessageGetUrl() {