async'ify msg, don't throw for flow control (#1078)
This commit is contained in:
tophf
GitHub
parent
1a7b51be6b
commit
bf40fa81e8
|
|
@ -258,7 +258,7 @@ if (FIREFOX && browser.commands && browser.commands.update) {
|
|||
});
|
||||
}
|
||||
|
||||
msg.broadcastTab({method: 'backgroundReady'});
|
||||
msg.broadcast({method: 'backgroundReady'});
|
||||
|
||||
function webNavIframeHelperFF({tabId, frameId}) {
|
||||
if (!frameId) return;
|
||||
|
|
|
|||
|
|
@ -155,13 +155,10 @@ self.INJECTED !== 1 && (() => {
|
|||
break;
|
||||
|
||||
case 'backgroundReady':
|
||||
initializing
|
||||
.catch(err => {
|
||||
if (msg.RX_NO_RECEIVER.test(err.message)) {
|
||||
return init();
|
||||
}
|
||||
})
|
||||
.catch(console.error);
|
||||
initializing.catch(err =>
|
||||
msg.isIgnorableError(err)
|
||||
? init()
|
||||
: console.error(err));
|
||||
break;
|
||||
|
||||
case 'updateCount':
|
||||
|
|
|
|||
363
js/msg.js
363
js/msg.js
|
|
@ -1,258 +1,161 @@
|
|||
/* global promisifyChrome deepCopy */
|
||||
// deepCopy is only used if the script is executed in extension pages.
|
||||
/* global promisifyChrome */
|
||||
/* global deepCopy getOwnTab URLS */ // not used in content scripts
|
||||
'use strict';
|
||||
|
||||
self.msg = self.INJECTED === 1 ? self.msg : (() => {
|
||||
// eslint-disable-next-line no-unused-expressions
|
||||
window.INJECTED !== 1 && (() => {
|
||||
promisifyChrome({
|
||||
runtime: ['sendMessage'],
|
||||
runtime: ['sendMessage', 'getBackgroundPage'],
|
||||
tabs: ['sendMessage', 'query'],
|
||||
});
|
||||
const isBg = chrome.extension.getBackgroundPage && chrome.extension.getBackgroundPage() === window;
|
||||
if (isBg) {
|
||||
window._msg = {
|
||||
handler: null,
|
||||
clone: deepCopy
|
||||
const TARGETS = Object.assign(Object.create(null), {
|
||||
all: ['both', 'tab', 'extension'],
|
||||
extension: ['both', 'extension'],
|
||||
tab: ['both', 'tab'],
|
||||
});
|
||||
const NEEDS_TAB_IN_SENDER = [
|
||||
'getTabUrlPrefix',
|
||||
'updateIconBadge',
|
||||
'styleViaAPI',
|
||||
];
|
||||
const ERR_NO_RECEIVER = 'Receiving end does not exist';
|
||||
const ERR_PORT_CLOSED = 'The message port closed before';
|
||||
const handler = {
|
||||
both: new Set(),
|
||||
tab: new Set(),
|
||||
extension: new Set(),
|
||||
};
|
||||
|
||||
let bg = chrome.extension.getBackgroundPage && chrome.extension.getBackgroundPage();
|
||||
const isBg = bg === window;
|
||||
if (!isBg && (!bg || !bg.document || bg.document.readyState === 'loading')) {
|
||||
bg = null;
|
||||
}
|
||||
const bgReady = getBg();
|
||||
const EXTENSION_URL = chrome.runtime.getURL('');
|
||||
let handler;
|
||||
const RX_NO_RECEIVER = /Receiving end does not exist/;
|
||||
// typo in Chrome 49
|
||||
const RX_PORT_CLOSED = /The message port closed before a res?ponse was received/;
|
||||
return {
|
||||
send,
|
||||
sendTab,
|
||||
sendBg,
|
||||
broadcast,
|
||||
broadcastTab,
|
||||
broadcastExtension,
|
||||
ignoreError,
|
||||
on,
|
||||
onTab,
|
||||
onExtension,
|
||||
off,
|
||||
RX_NO_RECEIVER,
|
||||
RX_PORT_CLOSED,
|
||||
|
||||
// TODO: maybe move into polyfill.js and hook addListener + sendMessage so they wrap/unwrap automatically
|
||||
const wrapData = data => ({
|
||||
data,
|
||||
});
|
||||
const wrapError = error => ({
|
||||
error: Object.assign({
|
||||
message: error.message || `${error}`,
|
||||
stack: error.stack,
|
||||
}, error), // passing custom properties e.g. `error.index`
|
||||
});
|
||||
const unwrapResponse = ({data, error} = {error: {message: ERR_NO_RECEIVER}}) =>
|
||||
error
|
||||
? Promise.reject(Object.assign(new Error(error.message), error))
|
||||
: data;
|
||||
chrome.runtime.onMessage.addListener(({data, target}, sender, sendResponse) => {
|
||||
const res = window.msg._execute(TARGETS[target] || TARGETS.all, data, sender);
|
||||
if (res instanceof Promise) {
|
||||
res.then(wrapData, wrapError).then(sendResponse);
|
||||
return true;
|
||||
}
|
||||
if (res !== undefined) sendResponse(wrapData(res));
|
||||
});
|
||||
|
||||
// This direct assignment allows IDEs to provide autocomplete for msg methods automatically
|
||||
const msg = window.msg = {
|
||||
isBg,
|
||||
};
|
||||
|
||||
function getBg() {
|
||||
if (isBg) {
|
||||
return Promise.resolve(window);
|
||||
}
|
||||
// try using extension.getBackgroundPage because runtime.getBackgroundPage is too slow
|
||||
// https://github.com/openstyles/stylus/issues/771
|
||||
if (chrome.extension.getBackgroundPage) {
|
||||
const bg = chrome.extension.getBackgroundPage();
|
||||
if (bg && bg.document && bg.document.readyState !== 'loading') {
|
||||
return Promise.resolve(bg);
|
||||
}
|
||||
}
|
||||
if (chrome.runtime.getBackgroundPage) {
|
||||
promisifyChrome({
|
||||
runtime: ['getBackgroundPage'],
|
||||
});
|
||||
return browser.runtime.getBackgroundPage().catch(() => null);
|
||||
}
|
||||
return Promise.resolve(null);
|
||||
}
|
||||
|
||||
function send(data, target = 'extension') {
|
||||
const message = {data, target};
|
||||
return browser.runtime.sendMessage(message).then(unwrapData);
|
||||
}
|
||||
|
||||
function sendTab(tabId, data, options, target = 'tab') {
|
||||
return browser.tabs.sendMessage(tabId, {data, target}, options)
|
||||
.then(unwrapData);
|
||||
}
|
||||
|
||||
function sendBg(data) {
|
||||
return bgReady.then(bg => {
|
||||
if (bg) {
|
||||
if (!bg._msg.handler) {
|
||||
throw new Error('there is no bg handler');
|
||||
}
|
||||
const handlers = bg._msg.handler.extension.concat(bg._msg.handler.both);
|
||||
// in FF, the object would become a dead object when the window
|
||||
// is closed, so we have to clone the object into background.
|
||||
return Promise.resolve(executeCallbacks(handlers, bg._msg.clone(data), {url: location.href}))
|
||||
.then(deepCopy);
|
||||
}
|
||||
return send(data);
|
||||
});
|
||||
}
|
||||
|
||||
function ignoreError(err) {
|
||||
if (err.message && (
|
||||
RX_NO_RECEIVER.test(err.message) ||
|
||||
RX_PORT_CLOSED.test(err.message)
|
||||
)) {
|
||||
return;
|
||||
}
|
||||
console.warn(err);
|
||||
}
|
||||
|
||||
function broadcast(data, filter) {
|
||||
return Promise.all([
|
||||
send(data, 'both').catch(ignoreError),
|
||||
broadcastTab(data, filter, null, true, 'both')
|
||||
]);
|
||||
}
|
||||
|
||||
function broadcastTab(data, filter, options, ignoreExtension = false, target = 'tab') {
|
||||
return browser.tabs.query({})
|
||||
// TODO: send to activated tabs first?
|
||||
.then(tabs => {
|
||||
const requests = [];
|
||||
for (const tab of tabs) {
|
||||
const tabUrl = tab.pendingUrl || tab.url;
|
||||
const isExtension = tabUrl.startsWith(EXTENSION_URL);
|
||||
if (
|
||||
tab.discarded ||
|
||||
// FIXME: use `URLS.supported`?
|
||||
!/^(http|ftp|file)/.test(tabUrl) &&
|
||||
!tabUrl.startsWith('chrome://newtab/') &&
|
||||
!isExtension ||
|
||||
isExtension && ignoreExtension ||
|
||||
filter && !filter(tab)
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
const dataObj = typeof data === 'function' ? data(tab) : data;
|
||||
if (!dataObj) {
|
||||
continue;
|
||||
}
|
||||
const message = {data: dataObj, target};
|
||||
if (tab && tab.id) {
|
||||
requests.push(
|
||||
browser.tabs.sendMessage(tab.id, message, options)
|
||||
.then(unwrapData)
|
||||
.catch(ignoreError)
|
||||
);
|
||||
async broadcast(data) {
|
||||
const requests = [msg.send(data, 'both').catch(msg.ignoreError)];
|
||||
for (const tab of await browser.tabs.query({})) {
|
||||
const url = tab.pendingUrl || tab.url;
|
||||
if (!tab.discarded &&
|
||||
!url.startsWith(URLS.ownOrigin) &&
|
||||
URLS.supported(url)) {
|
||||
requests[tab.active ? 'unshift' : 'push'](
|
||||
msg.sendTab(tab.id, data, null, 'both').catch(msg.ignoreError));
|
||||
}
|
||||
}
|
||||
return Promise.all(requests);
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
function broadcastExtension(...args) {
|
||||
return send(...args).catch(ignoreError);
|
||||
}
|
||||
broadcastExtension(...args) {
|
||||
return msg.send(...args).catch(msg.ignoreError);
|
||||
},
|
||||
|
||||
function on(fn) {
|
||||
initHandler();
|
||||
handler.both.push(fn);
|
||||
}
|
||||
isIgnorableError(err) {
|
||||
const msg = `${err && err.message || err}`;
|
||||
return msg.includes(ERR_NO_RECEIVER) || msg.includes(ERR_PORT_CLOSED);
|
||||
},
|
||||
|
||||
function onTab(fn) {
|
||||
initHandler();
|
||||
handler.tab.push(fn);
|
||||
ignoreError(err) {
|
||||
if (!msg.isIgnorableError(err)) {
|
||||
console.warn(err);
|
||||
}
|
||||
},
|
||||
|
||||
function onExtension(fn) {
|
||||
initHandler();
|
||||
handler.extension.push(fn);
|
||||
}
|
||||
on(fn) {
|
||||
handler.both.add(fn);
|
||||
},
|
||||
|
||||
function off(fn) {
|
||||
for (const type of ['both', 'tab', 'extension']) {
|
||||
const index = handler[type].indexOf(fn);
|
||||
if (index >= 0) {
|
||||
handler[type].splice(index, 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
onTab(fn) {
|
||||
handler.tab.add(fn);
|
||||
},
|
||||
|
||||
function initHandler() {
|
||||
if (handler) {
|
||||
return;
|
||||
}
|
||||
handler = {
|
||||
both: [],
|
||||
tab: [],
|
||||
extension: []
|
||||
};
|
||||
if (isBg) {
|
||||
window._msg.handler = handler;
|
||||
}
|
||||
chrome.runtime.onMessage.addListener(handleMessage);
|
||||
}
|
||||
onExtension(fn) {
|
||||
handler.extension.add(fn);
|
||||
},
|
||||
|
||||
function executeCallbacks(callbacks, ...args) {
|
||||
off(fn) {
|
||||
for (const type of TARGETS.all) {
|
||||
handler[type].delete(fn);
|
||||
}
|
||||
},
|
||||
|
||||
send(data, target = 'extension') {
|
||||
return browser.runtime.sendMessage({data, target})
|
||||
.then(unwrapResponse);
|
||||
},
|
||||
|
||||
sendTab(tabId, data, options, target = 'tab') {
|
||||
return browser.tabs.sendMessage(tabId, {data, target}, options)
|
||||
.then(unwrapResponse);
|
||||
},
|
||||
|
||||
_execute(types, ...args) {
|
||||
let result;
|
||||
for (const fn of callbacks) {
|
||||
const data = withPromiseError(fn, ...args);
|
||||
if (data !== undefined && result === undefined) {
|
||||
result = data;
|
||||
for (const type of types) {
|
||||
for (const fn of handler[type]) {
|
||||
let res;
|
||||
try {
|
||||
res = fn(...args);
|
||||
} catch (err) {
|
||||
res = Promise.reject(err);
|
||||
}
|
||||
if (res !== undefined && result === undefined) {
|
||||
result = res;
|
||||
}
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
},
|
||||
};
|
||||
|
||||
function handleMessage(message, sender, sendResponse) {
|
||||
const handlers = message.target === 'tab' ?
|
||||
handler.tab.concat(handler.both) : message.target === 'extension' ?
|
||||
handler.extension.concat(handler.both) :
|
||||
handler.both.concat(handler.extension, handler.tab);
|
||||
if (!handlers.length) {
|
||||
return;
|
||||
window.API = new Proxy({}, {
|
||||
get(target, name) {
|
||||
// using a named function for convenience when debugging
|
||||
return async function invokeAPI(...args) {
|
||||
if (!bg && chrome.tabs) {
|
||||
bg = await browser.runtime.getBackgroundPage().catch(() => {});
|
||||
}
|
||||
const result = executeCallbacks(handlers, message.data, sender);
|
||||
if (result === undefined) {
|
||||
return;
|
||||
const message = {method: 'invokeAPI', name, args};
|
||||
// content scripts, frames and probably private tabs
|
||||
if (!bg || window !== parent) {
|
||||
return msg.send(message);
|
||||
}
|
||||
Promise.resolve(result)
|
||||
.then(
|
||||
data => ({
|
||||
error: false,
|
||||
data
|
||||
}),
|
||||
err => ({
|
||||
error: true,
|
||||
data: Object.assign({
|
||||
message: err.message || String(err),
|
||||
// FIXME: do we want to pass the entire stack?
|
||||
stack: err.stack
|
||||
}, err) // this allows us to pass custom properties e.g. `err.index`
|
||||
})
|
||||
)
|
||||
.then(sendResponse);
|
||||
return true;
|
||||
}
|
||||
|
||||
function withPromiseError(fn, ...args) {
|
||||
try {
|
||||
return fn(...args);
|
||||
} catch (err) {
|
||||
return Promise.reject(err);
|
||||
}
|
||||
}
|
||||
|
||||
// {type, error, data, id}
|
||||
function unwrapData(result) {
|
||||
if (result === undefined) {
|
||||
throw new Error('Receiving end does not exist');
|
||||
}
|
||||
if (result.error) {
|
||||
throw Object.assign(new Error(result.data.message), result.data);
|
||||
}
|
||||
return result.data;
|
||||
}
|
||||
})();
|
||||
|
||||
self.API = self.INJECTED === 1 ? self.API : new Proxy({
|
||||
// Handlers for these methods need sender.tab.id which is set by `send` as it uses messaging,
|
||||
// unlike `sendBg` which invokes the background page directly in our own extension tabs
|
||||
getTabUrlPrefix: true,
|
||||
updateIconBadge: true,
|
||||
styleViaAPI: true,
|
||||
}, {
|
||||
get: (target, name) =>
|
||||
(...args) => Promise.resolve(self.msg[target[name] ? 'send' : 'sendBg']({
|
||||
method: 'invokeAPI',
|
||||
name,
|
||||
args
|
||||
}))
|
||||
// in FF, the object would become a dead object when the window
|
||||
// is closed, so we have to clone the object into background.
|
||||
const res = bg.msg._execute(TARGETS.extension, bg.deepCopy(message), {
|
||||
frameId: 0,
|
||||
tab: NEEDS_TAB_IN_SENDER.includes(name) && await getOwnTab(),
|
||||
url: location.href,
|
||||
});
|
||||
return deepCopy(await res);
|
||||
};
|
||||
},
|
||||
});
|
||||
})();
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user