Compare commits
2 Commits
a9c4080422
...
fix/issue-
| Author | SHA1 | Date | |
|---|---|---|---|
| 34c1b00710 | |||
| 9dcd875dd4 |
93
README.md
93
README.md
@@ -243,10 +243,18 @@ and this suite exists because exactly that class of bug shipped twice.
|
|||||||
|
|
||||||
`make test-e2e-firefox` builds `dist/firefox/` and drives the **real popup in a
|
`make test-e2e-firefox` builds `dist/firefox/` and drives the **real popup in a
|
||||||
real Firefox**, installed as an unpacked MV2 temporary add-on via geckodriver.
|
real Firefox**, installed as an unpacked MV2 temporary add-on via geckodriver.
|
||||||
It covers popup load, wallet creation through the UI, and the Add Token screen.
|
It covers popup load, wallet creation through the UI, the Add Token screen, and
|
||||||
The suite lives in `tests/e2e/firefox/` and has **no npm dependencies at all**:
|
the four dApp round trips — `eth_requestAccounts`, `personal_sign`,
|
||||||
it is a small WebDriver client built on global `fetch` and `child_process`
|
`eth_sendTransaction`, and a closed approval window rejecting with EIP-1193 4001
|
||||||
against geckodriver's HTTP API.
|
— driven through the real content script, background page and approval windows.
|
||||||
|
|
||||||
|
The suite lives in `tests/e2e/firefox/`. Its WebDriver client (`driver.js`) has
|
||||||
|
**no npm dependencies at all**: it is built on global `fetch` and
|
||||||
|
`child_process` against geckodriver's HTTP API. The dApp fixture (`dapp.js`) and
|
||||||
|
the assertions do use `ethers`, and have to — a signature is recovered in the
|
||||||
|
runner rather than believed from the extension, and the stub node has to answer
|
||||||
|
`eth_sendRawTransaction` with the hash `ethers` computes for the artifact it
|
||||||
|
sent, or `provider.broadcastTransaction()` refuses the answer.
|
||||||
|
|
||||||
Unlike the Chrome suite it builds its own container image rather than pulling a
|
Unlike the Chrome suite it builds its own container image rather than pulling a
|
||||||
published one, because no published image carries both a pinned Firefox and a
|
published one, because no published image carries both a pinned Firefox and a
|
||||||
@@ -268,20 +276,30 @@ because BiDi's `browsingContext.navigate` refuses `moz-extension://` outright.
|
|||||||
**Any uncaught error from a `moz-extension://` source fails the run**, including
|
**Any uncaught error from a `moz-extension://` source fails the run**, including
|
||||||
errors from the background page, which the suite never navigates to: a `throw`
|
errors from the background page, which the suite never navigates to: a `throw`
|
||||||
at the top of `src/background/index.js` kills the background page and fails
|
at the top of `src/background/index.js` kills the background page and fails
|
||||||
step 1. Content-script errors should arrive by the same route, but this suite
|
step 1. Content scripts **are** exercised now — the dApp steps drive a page
|
||||||
does not exercise it and does not claim it — with `--network none` there is no
|
served from loopback, which survives `--network none` — but the _capture_ of a
|
||||||
`http://` page for a content script to be injected into. Errors from add-on
|
content-script error by this route is still unproven: no probe has forced a
|
||||||
install and background startup are folded into step 1 rather than discarded.
|
throw inside one and watched it fail the run, so it remains an expectation
|
||||||
Errors are read from the privileged `nsIConsoleService` in Marionette's chrome
|
rather than a demonstrated fact. Errors from add-on install and background
|
||||||
context and filtered to non-warning entries whose `sourceName` is the extension
|
startup are folded into step 1 rather than discarded.
|
||||||
origin. That mechanism is not a stylistic choice. WebDriver BiDi's
|
|
||||||
`log.entryAdded` delivers **nothing** for extension pages: on a plain `http://`
|
One error is tolerated rather than fatal, listed in `ALLOWED_ERRORS` in
|
||||||
page it reports uncaught errors with stack traces, and on the `moz-extension://`
|
`tests/e2e/firefox/run.js` with the issue that will delete it, and printed on
|
||||||
popup it reports zero events, because Firefox's remote agent excludes extension
|
every occurrence so the concession stays visible in the run output. It is
|
||||||
browsing contexts from BiDi observation. Any harness built on Playwright-BiDi or
|
Firefox reporting the site-approval popup's unawaited `sendMessage` settling
|
||||||
Puppeteer-BiDi would therefore see nothing and report success, which is exactly
|
after `window.close()` unloaded the context — the same teardown ordering as
|
||||||
the vacuous check this repo has already shipped twice. Do not migrate this suite
|
[#275](https://git.eeqj.de/sneak/AutistMask/issues/275), and unsuppressable from
|
||||||
to BiDi.
|
the calling code, because `BaseContext.wrapPromise` reports it whether or not a
|
||||||
|
handler is attached. Errors are read from the privileged `nsIConsoleService` in
|
||||||
|
Marionette's chrome context and filtered to non-warning entries whose
|
||||||
|
`sourceName` is the extension origin. That mechanism is not a stylistic choice.
|
||||||
|
WebDriver BiDi's `log.entryAdded` delivers **nothing** for extension pages: on a
|
||||||
|
plain `http://` page it reports uncaught errors with stack traces, and on the
|
||||||
|
`moz-extension://` popup it reports zero events, because Firefox's remote agent
|
||||||
|
excludes extension browsing contexts from BiDi observation. Any harness built on
|
||||||
|
Playwright-BiDi or Puppeteer-BiDi would therefore see nothing and report
|
||||||
|
success, which is exactly the vacuous check this repo has already shipped twice.
|
||||||
|
Do not migrate this suite to BiDi.
|
||||||
|
|
||||||
Two limits are worth knowing, both real differences from the Chrome suite:
|
Two limits are worth knowing, both real differences from the Chrome suite:
|
||||||
|
|
||||||
@@ -305,17 +323,19 @@ Two limits are worth knowing, both real differences from the Chrome suite:
|
|||||||
but a step that logs heavily could evict unread errors. What poll-based costs
|
but a step that logs heavily could evict unread errors. What poll-based costs
|
||||||
is location, not coverage: an error cannot be placed within a step the way the
|
is location, not coverage: an error cannot be placed within a step the way the
|
||||||
Chrome suite's `pageerror` events place it.
|
Chrome suite's `pageerror` events place it.
|
||||||
- **Nothing is stubbed, which inverts the coverage of network-dependent code.**
|
- **Almost nothing is stubbed, which inverts the coverage of network-dependent
|
||||||
There is no fixture layer; the container runs with `--network none` instead,
|
code.** The container still runs with `--network none`, so the run is offline
|
||||||
so the run is offline and deterministic and no request can escape. The
|
and no request can escape. The one thing it can reach is the loopback fixture
|
||||||
extension swallows its own fetch failures, so the flows are unaffected — but
|
in `tests/e2e/firefox/dapp.js`, which serves the dApp page and a JSON-RPC node
|
||||||
every network call fails, so only the _failure_ branches of code that depends
|
and which the extension's `rpcUrl` is pointed at for the dApp steps; a
|
||||||
on one are ever executed. A `ReferenceError` in the success path of
|
JSON-RPC method that fixture does not model fails the run rather than
|
||||||
`renderTransactions`, or of price or balance rendering, passes this suite
|
answering `null`. Everything else — Blockscout, the price feed, the phishing
|
||||||
green. The offline run is also weaker than the Chrome suite's interception: it
|
blocklist — has no fixture and simply fails, and the extension swallows its
|
||||||
proves nothing got out, but it cannot report which requests were attempted.
|
own fetch failures, so only the _failure_ branches of that code are ever
|
||||||
Closing that gap needs a fixture layer, deliberately out of scope for this
|
executed. A `ReferenceError` in the success path of `renderTransactions`, or
|
||||||
harness.
|
of price rendering, passes this suite green. The offline run is also weaker
|
||||||
|
than the Chrome suite's interception for those calls: it proves nothing got
|
||||||
|
out, but it cannot report which requests were attempted.
|
||||||
|
|
||||||
Neither `make test-e2e` nor `make test-e2e-firefox` is part of `make check` or
|
Neither `make test-e2e` nor `make test-e2e-firefox` is part of `make check` or
|
||||||
`make test`. `REPO_POLICIES.md` caps `make test` at 20 seconds and a browser
|
`make test`. `REPO_POLICIES.md` caps `make test` at 20 seconds and a browser
|
||||||
@@ -638,21 +658,6 @@ ExportPrivKey and ShowRecoveryPhrase — are deliberately absent from that list,
|
|||||||
so the popup can never reopen onto one of them with no password prompt in front
|
so the popup can never reopen onto one of them with no password prompt in front
|
||||||
of it.
|
of it.
|
||||||
|
|
||||||
A reopened popup renders the wallet list and the one screen it restores onto,
|
|
||||||
and nothing else, so every screen on the stack behind that one is still the
|
|
||||||
blank template from `index.html`. "Back" therefore renders its target rather
|
|
||||||
than only unhiding it, through the same dispatch and data guards as the restore
|
|
||||||
(`src/popup/viewRouter.js`), and falls back to Home when the state the target
|
|
||||||
would render is gone.
|
|
||||||
|
|
||||||
It renders only a screen this page load has not rendered yet. Forward navigation
|
|
||||||
renders as it goes, and `viewRouter.js` records every screen that reaches
|
|
||||||
`showView()`, so "Back" onto a screen already on the page unhides it and nothing
|
|
||||||
more — rendering it a second time would re-fetch and overwrite what it holds,
|
|
||||||
such as an edit typed into Settings and not yet saved. Home is the one screen
|
|
||||||
"Back" always re-renders, so the wallet list reflects anything that changed
|
|
||||||
while the user was away from it.
|
|
||||||
|
|
||||||
Every screen that holds secret material in the page registers a cleanup with
|
Every screen that holds secret material in the page registers a cleanup with
|
||||||
`onViewLeave()` (`src/popup/views/helpers.js`), which `showView()` runs on every
|
`onViewLeave()` (`src/popup/views/helpers.js`), which `showView()` runs on every
|
||||||
exit from that screen rather than only on its "Back" button, so nothing secret
|
exit from that screen rather than only on its "Back" button, so nothing secret
|
||||||
|
|||||||
44
TODO.md
44
TODO.md
@@ -45,23 +45,33 @@ undefined identifiers, which is how
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-12: "Back" now renders the screen it lands on instead of only unhiding
|
- 2026-08-12: One shared extension-API module,
|
||||||
it. A reopened popup renders the wallet list and the one screen it restores
|
[`src/shared/browserApi.js`](src/shared/browserApi.js), is the only place in
|
||||||
onto, so every screen further down the stack was still the blank template from
|
the tree that names `browser` or `chrome`. Every call site returns a promise;
|
||||||
`index.html`, and Back walked straight onto it — an empty address, no
|
`runtime.lastError` is gone. The same commit gives the Firefox suite the four
|
||||||
balances, no QR code. The Back path now goes through the same per-view
|
dApp round trips — `eth_requestAccounts`, `personal_sign`,
|
||||||
dispatch and data guards as the restore (`src/popup/viewRouter.js`, shared
|
`eth_sendTransaction` and a closed approval window rejecting with EIP-1193
|
||||||
with `restoreView()`), falling back to Home when the state the target would
|
4001 — against a page and a JSON-RPC node served from loopback, which survives
|
||||||
render is gone. It renders only a view this page load has not rendered yet:
|
`--network none`. **The premise of
|
||||||
`viewRouter.js` records every view that reaches `showView()`, which is where
|
[#153](https://git.eeqj.de/sneak/AutistMask/issues/153) does not survive that
|
||||||
forward navigation and the restore both end, so Back onto a view already on
|
harness**: Firefox's `browser.*` honours a trailing Chrome-style callback and
|
||||||
the page unhides it and nothing more. That is what keeps a second render from
|
populates `runtime.lastError`, both measured directly on Firefox 153.0.3, and
|
||||||
re-fetching and overwriting what the view holds — an unsaved edit in Settings,
|
all four flows pass against the unconverted code. What landed is a uniformity
|
||||||
a transaction list already loaded. Home is the exception and is always
|
and coverage change, not a repair of a broken target.
|
||||||
re-rendered, as it was before. Covered by unit tests on the real `goBack()`
|
- 2026-08-12: EIP-1193 error codes now reach the page. `src/content/inpage.js`
|
||||||
and by three end-to-end cases against the real popup, each demonstrated
|
rebuilt every failure as `new Error(error.message)`, so the code the
|
||||||
failing on the unfixed build
|
background produced and the content script relayed intact was dropped in the
|
||||||
([#268](https://git.eeqj.de/sneak/AutistMask/issues/268)).
|
last hop and a dApp checking `err.code === 4001` saw `undefined` — a wallet
|
||||||
|
the user deliberately declined was indistinguishable from one that broke. The
|
||||||
|
provider now rejects with a `ProviderRpcError` carrying `code` and, where the
|
||||||
|
boundary sent one, `data`, passed through verbatim rather than matched against
|
||||||
|
a list, so 4001, 4100 and 4902 all arrive and a future code needs no edit
|
||||||
|
here. An error the background sent with no code stays a plain `Error` with no
|
||||||
|
`code` property, and `message` is unchanged in every case. All four request
|
||||||
|
entry points (`request`, `enable`, `send`, `sendAsync`) are covered by
|
||||||
|
`tests/inpageErrors.test.js`, and the e2e probe that printed the missing code
|
||||||
|
now requires it on the page's Error as well as on the wire, for all four
|
||||||
|
rejected flows ([#274](https://git.eeqj.de/sneak/AutistMask/issues/274)).
|
||||||
- 2026-08-12: `KNOWN_SYMBOLS` now maps a symbol to the set of contract addresses
|
- 2026-08-12: `KNOWN_SYMBOLS` now maps a symbol to the set of contract addresses
|
||||||
that bear it, not to one of them. A ticker is not unique: seven of the 512
|
that bear it, not to one of them. A ticker is not unique: seven of the 512
|
||||||
bundled tokens — `FRAX`, `REUSD`, `TON`, `EURE`, `MSUSD`, `MUSD` and `JPYC` —
|
bundled tokens — `FRAX`, `REUSD`, `TON`, `EURE`, `MSUSD`, `MUSD` and `JPYC` —
|
||||||
|
|||||||
@@ -39,17 +39,21 @@ const {
|
|||||||
registerAlarmHandlers,
|
registerAlarmHandlers,
|
||||||
} = require("../shared/alarms");
|
} = require("../shared/alarms");
|
||||||
|
|
||||||
const storageApi =
|
const {
|
||||||
typeof browser !== "undefined"
|
actionApi,
|
||||||
? browser.storage.local
|
runtimeApi,
|
||||||
: chrome.storage.local;
|
storageGet,
|
||||||
const runtime =
|
tabsQuery,
|
||||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
tabsSendMessage,
|
||||||
const windowsApi =
|
windowsApi,
|
||||||
typeof browser !== "undefined" ? browser.windows : chrome.windows;
|
windowsCreate,
|
||||||
const tabsApi = typeof browser !== "undefined" ? browser.tabs : chrome.tabs;
|
windowsGetLastFocused,
|
||||||
const actionApi =
|
windowsRemove,
|
||||||
typeof browser !== "undefined" ? browser.browserAction : chrome.action;
|
} = require("../shared/browserApi");
|
||||||
|
|
||||||
|
const runtime = runtimeApi();
|
||||||
|
const windowsNs = windowsApi();
|
||||||
|
const actionNs = actionApi();
|
||||||
|
|
||||||
// Connected sites (in-memory, non-persisted): { "origin:address": true }
|
// Connected sites (in-memory, non-persisted): { "origin:address": true }
|
||||||
const connectedSites = {};
|
const connectedSites = {};
|
||||||
@@ -58,7 +62,7 @@ const connectedSites = {};
|
|||||||
const pendingApprovals = {};
|
const pendingApprovals = {};
|
||||||
|
|
||||||
async function getState() {
|
async function getState() {
|
||||||
const result = await storageApi.get("autistmask");
|
const result = await storageGet("autistmask");
|
||||||
return (
|
return (
|
||||||
result.autistmask || {
|
result.autistmask || {
|
||||||
wallets: [],
|
wallets: [],
|
||||||
@@ -122,8 +126,8 @@ async function proxyRpc(method, params) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function resetPopupUrl() {
|
function resetPopupUrl() {
|
||||||
if (actionApi && typeof actionApi.setPopup === "function") {
|
if (actionNs && typeof actionNs.setPopup === "function") {
|
||||||
actionApi.setPopup({ popup: "src/popup/index.html" });
|
actionNs.setPopup({ popup: "src/popup/index.html" });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -179,32 +183,55 @@ function releaseApproval(approval) {
|
|||||||
// Open approval in a separate popup window.
|
// Open approval in a separate popup window.
|
||||||
// This is the primary mechanism for tx/sign approvals (triggered programmatically,
|
// This is the primary mechanism for tx/sign approvals (triggered programmatically,
|
||||||
// not from a user gesture) and the fallback for site-connection approvals.
|
// not from a user gesture) and the fallback for site-connection approvals.
|
||||||
function openApprovalWindow(id) {
|
// Never rejects. Its callers raise it from inside a Promise executor and drop
|
||||||
|
// the result on the floor, so a rejection here would be unhandled.
|
||||||
|
async function openApprovalWindow(id) {
|
||||||
const popupUrl = runtime.getURL("src/popup/index.html?approval=" + id);
|
const popupUrl = runtime.getURL("src/popup/index.html?approval=" + id);
|
||||||
const popupWidth = 360;
|
const popupWidth = 360;
|
||||||
const popupHeight = 600;
|
const popupHeight = 600;
|
||||||
|
|
||||||
windowsApi.getLastFocused((currentWin) => {
|
let currentWin = null;
|
||||||
const opts = {
|
try {
|
||||||
url: popupUrl,
|
currentWin = await windowsGetLastFocused();
|
||||||
type: "popup",
|
} catch {
|
||||||
width: popupWidth,
|
// Nothing focused to centre on. The window still opens, at whatever
|
||||||
height: popupHeight,
|
// position the browser picks.
|
||||||
};
|
}
|
||||||
if (currentWin) {
|
|
||||||
opts.left = Math.round(
|
const opts = {
|
||||||
currentWin.left + (currentWin.width - popupWidth) / 2,
|
url: popupUrl,
|
||||||
);
|
type: "popup",
|
||||||
opts.top = Math.round(
|
width: popupWidth,
|
||||||
currentWin.top + (currentWin.height - popupHeight) / 2,
|
height: popupHeight,
|
||||||
);
|
};
|
||||||
}
|
if (currentWin) {
|
||||||
windowsApi.create(opts, (win) => {
|
opts.left = Math.round(
|
||||||
if (win) {
|
currentWin.left + (currentWin.width - popupWidth) / 2,
|
||||||
pendingApprovals[id].windowId = win.id;
|
);
|
||||||
}
|
opts.top = Math.round(
|
||||||
});
|
currentWin.top + (currentWin.height - popupHeight) / 2,
|
||||||
});
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let win = null;
|
||||||
|
try {
|
||||||
|
win = await windowsCreate(opts);
|
||||||
|
} catch (e) {
|
||||||
|
// No window means no approval screen and no way for the user to
|
||||||
|
// answer. The request stays pending rather than being settled behind
|
||||||
|
// their back; say so rather than failing silently.
|
||||||
|
log.errorf("could not open the approval window:", e);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The id the onRemoved listener matches on to turn a closed window into a
|
||||||
|
// rejection. Guarded because the create() above is a real await now: an
|
||||||
|
// address switch can settle and remove the approval while the window is
|
||||||
|
// opening, and writing the id back would resurrect a bare entry that
|
||||||
|
// nothing would ever resolve.
|
||||||
|
if (win && pendingApprovals[id]) {
|
||||||
|
pendingApprovals[id].windowId = win.id;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Open an approval popup and return a promise that resolves with the user decision.
|
// Open an approval popup and return a promise that resolves with the user decision.
|
||||||
@@ -214,12 +241,12 @@ function requestApproval(origin, hostname) {
|
|||||||
const id = crypto.randomUUID();
|
const id = crypto.randomUUID();
|
||||||
pendingApprovals[id] = { origin, hostname, resolve };
|
pendingApprovals[id] = { origin, hostname, resolve };
|
||||||
|
|
||||||
if (actionApi && typeof actionApi.openPopup === "function") {
|
if (actionNs && typeof actionNs.openPopup === "function") {
|
||||||
actionApi.setPopup({
|
actionNs.setPopup({
|
||||||
popup: "src/popup/index.html?approval=" + id,
|
popup: "src/popup/index.html?approval=" + id,
|
||||||
});
|
});
|
||||||
try {
|
try {
|
||||||
const result = actionApi.openPopup();
|
const result = actionNs.openPopup();
|
||||||
if (result && typeof result.catch === "function") {
|
if (result && typeof result.catch === "function") {
|
||||||
result.catch(() => openApprovalWindow(id));
|
result.catch(() => openApprovalWindow(id));
|
||||||
}
|
}
|
||||||
@@ -281,7 +308,7 @@ function requestSignApproval(origin, hostname, signParams, approvedFrom) {
|
|||||||
|
|
||||||
// Detect when an approval popup (browser-action) closes without a response.
|
// Detect when an approval popup (browser-action) closes without a response.
|
||||||
// TX and sign approvals now use windows.create() and are handled by the
|
// TX and sign approvals now use windows.create() and are handled by the
|
||||||
// windowsApi.onRemoved listener below, but we still handle site-connection
|
// windows.onRemoved listener below, but we still handle site-connection
|
||||||
// approval disconnects here.
|
// approval disconnects here.
|
||||||
runtime.onConnect.addListener((port) => {
|
runtime.onConnect.addListener((port) => {
|
||||||
if (port.name.startsWith("approval:")) {
|
if (port.name.startsWith("approval:")) {
|
||||||
@@ -663,24 +690,26 @@ async function handleRpc(method, params, origin) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Broadcast chainChanged to all tabs when the network is switched.
|
// Broadcast chainChanged to all tabs when the network is switched.
|
||||||
function broadcastChainChanged(chainId) {
|
//
|
||||||
tabsApi.query({}, (tabs) => {
|
// Never rejects: its caller is an RPC handler that must answer the page
|
||||||
for (const tab of tabs) {
|
// whatever the browser made of the broadcast.
|
||||||
tabsApi.sendMessage(
|
async function broadcastChainChanged(chainId) {
|
||||||
tab.id,
|
let tabs;
|
||||||
{
|
try {
|
||||||
type: "AUTISTMASK_EVENT",
|
tabs = await tabsQuery({});
|
||||||
eventName: "chainChanged",
|
} catch {
|
||||||
data: chainId,
|
return;
|
||||||
},
|
}
|
||||||
() => {
|
for (const tab of tabs) {
|
||||||
if (runtime.lastError) {
|
// A tab with no content script has no receiver, and that is the
|
||||||
// expected for tabs without our content script
|
// ordinary case rather than a fault. The rejection it produces is the
|
||||||
}
|
// promise-shaped form of the runtime.lastError this used to read.
|
||||||
},
|
tabsSendMessage(tab.id, {
|
||||||
);
|
type: "AUTISTMASK_EVENT",
|
||||||
}
|
eventName: "chainChanged",
|
||||||
});
|
data: chainId,
|
||||||
|
}).catch(() => {});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Broadcast accountsChanged to all tabs, respecting per-address permissions
|
// Broadcast accountsChanged to all tabs, respecting per-address permissions
|
||||||
@@ -705,41 +734,36 @@ async function broadcastAccountsChanged() {
|
|||||||
: { approved: false, remember: false };
|
: { approved: false, remember: false };
|
||||||
if (!settleApproval(id, rejection)) continue;
|
if (!settleApproval(id, rejection)) continue;
|
||||||
if (approval.windowId) {
|
if (approval.windowId) {
|
||||||
windowsApi.remove(approval.windowId, () => {
|
// Rejects when the window has already gone, which is a race the
|
||||||
if (runtime.lastError) {
|
// user wins routinely by closing it themselves.
|
||||||
// window already closed
|
windowsRemove(approval.windowId).catch(() => {});
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
resetPopupUrl();
|
resetPopupUrl();
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const activeAddress = await getActiveAddress();
|
const activeAddress = await getActiveAddress();
|
||||||
const allowed = activeAddress ? s.allowedSites[activeAddress] || [] : [];
|
const allowed = activeAddress ? s.allowedSites[activeAddress] || [] : [];
|
||||||
tabsApi.query({}, (tabs) => {
|
let tabs;
|
||||||
for (const tab of tabs) {
|
try {
|
||||||
const origin = tab.url ? new URL(tab.url).origin : "";
|
tabs = await tabsQuery({});
|
||||||
const hostname = extractHostname(origin);
|
} catch {
|
||||||
const hasPermission =
|
return;
|
||||||
activeAddress &&
|
}
|
||||||
(allowed.includes(hostname) ||
|
for (const tab of tabs) {
|
||||||
connectedSites[origin + ":" + activeAddress]);
|
const origin = tab.url ? new URL(tab.url).origin : "";
|
||||||
tabsApi.sendMessage(
|
const hostname = extractHostname(origin);
|
||||||
tab.id,
|
const hasPermission =
|
||||||
{
|
activeAddress &&
|
||||||
type: "AUTISTMASK_EVENT",
|
(allowed.includes(hostname) ||
|
||||||
eventName: "accountsChanged",
|
connectedSites[origin + ":" + activeAddress]);
|
||||||
data: hasPermission ? [activeAddress] : [],
|
// Same as chainChanged above: a tab without our content script
|
||||||
},
|
// rejects, and that is expected rather than a fault.
|
||||||
() => {
|
tabsSendMessage(tab.id, {
|
||||||
// Ignore errors for tabs without content script
|
type: "AUTISTMASK_EVENT",
|
||||||
if (runtime.lastError) {
|
eventName: "accountsChanged",
|
||||||
// expected for tabs without our content script
|
data: hasPermission ? [activeAddress] : [],
|
||||||
}
|
}).catch(() => {});
|
||||||
},
|
}
|
||||||
);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Background balance refresh: every 60 seconds when the popup isn't open.
|
// Background balance refresh: every 60 seconds when the popup isn't open.
|
||||||
@@ -832,8 +856,8 @@ startBackgroundJobs();
|
|||||||
// window is an ordinary event with an attempt already in flight behind it.
|
// window is an ordinary event with an attempt already in flight behind it.
|
||||||
// settleApproval() refuses those, which leaves the attempt to report its real
|
// settleApproval() refuses those, which leaves the attempt to report its real
|
||||||
// outcome to the page.
|
// outcome to the page.
|
||||||
if (windowsApi && windowsApi.onRemoved) {
|
if (windowsNs && windowsNs.onRemoved) {
|
||||||
windowsApi.onRemoved.addListener((windowId) => {
|
windowsNs.onRemoved.addListener((windowId) => {
|
||||||
for (const [id, approval] of Object.entries(pendingApprovals)) {
|
for (const [id, approval] of Object.entries(pendingApprovals)) {
|
||||||
if (approval.windowId !== windowId) continue;
|
if (approval.windowId !== windowId) continue;
|
||||||
const rejection =
|
const rejection =
|
||||||
|
|||||||
@@ -1,12 +1,20 @@
|
|||||||
// AutistMask content script — bridges between inpage (window.ethereum)
|
// AutistMask content script — bridges between inpage (window.ethereum)
|
||||||
// and the background service worker via extension messaging.
|
// and the background service worker via extension messaging.
|
||||||
|
|
||||||
|
const {
|
||||||
|
hasBrowserNamespace,
|
||||||
|
runtimeApi,
|
||||||
|
sendMessage,
|
||||||
|
storageGet,
|
||||||
|
storageSet,
|
||||||
|
} = require("../shared/browserApi");
|
||||||
|
|
||||||
// In Chrome (MV3), inpage.js runs as a MAIN-world content script declared
|
// In Chrome (MV3), inpage.js runs as a MAIN-world content script declared
|
||||||
// in the manifest, so no injection is needed here. In Firefox (MV2), the
|
// in the manifest, so no injection is needed here. In Firefox (MV2), the
|
||||||
// "world" key is not supported, so we inject via a <script> tag.
|
// "world" key is not supported, so we inject via a <script> tag.
|
||||||
if (typeof browser !== "undefined") {
|
if (hasBrowserNamespace()) {
|
||||||
const script = document.createElement("script");
|
const script = document.createElement("script");
|
||||||
script.src = browser.runtime.getURL("src/content/inpage.js");
|
script.src = runtimeApi().getURL("src/content/inpage.js");
|
||||||
script.onload = function () {
|
script.onload = function () {
|
||||||
this.remove();
|
this.remove();
|
||||||
};
|
};
|
||||||
@@ -14,23 +22,27 @@ if (typeof browser !== "undefined") {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Send the persisted EIP-6963 provider UUID to the inpage script.
|
// Send the persisted EIP-6963 provider UUID to the inpage script.
|
||||||
// Generated once at install time and stored in chrome.storage.local.
|
// Generated once at install time and stored in extension storage.
|
||||||
(function sendProviderUuid() {
|
(async function sendProviderUuid() {
|
||||||
const storage =
|
let uuid = null;
|
||||||
typeof browser !== "undefined"
|
try {
|
||||||
? browser.storage.local
|
const items = await storageGet("eip6963Uuid");
|
||||||
: chrome.storage.local;
|
uuid = items?.eip6963Uuid;
|
||||||
storage.get("eip6963Uuid", (items) => {
|
|
||||||
let uuid = items?.eip6963Uuid;
|
|
||||||
if (!uuid) {
|
if (!uuid) {
|
||||||
uuid = crypto.randomUUID();
|
uuid = crypto.randomUUID();
|
||||||
storage.set({ eip6963Uuid: uuid });
|
await storageSet({ eip6963Uuid: uuid });
|
||||||
}
|
}
|
||||||
window.postMessage(
|
} catch {
|
||||||
{ type: "AUTISTMASK_PROVIDER_UUID", uuid },
|
// Storage was unavailable or refused the write. The announcement
|
||||||
location.origin,
|
// still has to go out — a provider that never announces is invisible
|
||||||
);
|
// to every EIP-6963 dApp — so it goes under a fresh uuid that this
|
||||||
});
|
// page load will not outlive.
|
||||||
|
if (!uuid) uuid = crypto.randomUUID();
|
||||||
|
}
|
||||||
|
window.postMessage(
|
||||||
|
{ type: "AUTISTMASK_PROVIDER_UUID", uuid },
|
||||||
|
location.origin,
|
||||||
|
);
|
||||||
})();
|
})();
|
||||||
|
|
||||||
// Relay requests from the page to the background script
|
// Relay requests from the page to the background script
|
||||||
@@ -39,27 +51,31 @@ window.addEventListener("message", (event) => {
|
|||||||
if (event.data?.type !== "AUTISTMASK_REQUEST") return;
|
if (event.data?.type !== "AUTISTMASK_REQUEST") return;
|
||||||
const { id, method, params } = event.data;
|
const { id, method, params } = event.data;
|
||||||
|
|
||||||
const runtime =
|
sendMessage({
|
||||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
type: "AUTISTMASK_RPC",
|
||||||
|
id,
|
||||||
runtime.sendMessage(
|
method,
|
||||||
{ type: "AUTISTMASK_RPC", id, method, params, origin: location.origin },
|
params,
|
||||||
(response) => {
|
origin: location.origin,
|
||||||
|
})
|
||||||
|
.then((response) => {
|
||||||
if (response) {
|
if (response) {
|
||||||
window.postMessage(
|
window.postMessage(
|
||||||
{ type: "AUTISTMASK_RESPONSE", id, ...response },
|
{ type: "AUTISTMASK_RESPONSE", id, ...response },
|
||||||
"*",
|
"*",
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
},
|
})
|
||||||
);
|
.catch(() => {
|
||||||
|
// No receiver: the background context is gone. The page's promise
|
||||||
|
// stays pending, which is what it did before this was a promise
|
||||||
|
// at all; turning it into a rejection here is a change to what
|
||||||
|
// dApps see and belongs to its own issue.
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// Listen for events pushed from the background (e.g. accountsChanged)
|
// Listen for events pushed from the background (e.g. accountsChanged)
|
||||||
const runtime =
|
runtimeApi().onMessage.addListener((msg) => {
|
||||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
|
||||||
|
|
||||||
runtime.onMessage.addListener((msg) => {
|
|
||||||
if (msg.type === "AUTISTMASK_EVENT") {
|
if (msg.type === "AUTISTMASK_EVENT") {
|
||||||
window.postMessage(
|
window.postMessage(
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -11,6 +11,39 @@
|
|||||||
let nextId = 1;
|
let nextId = 1;
|
||||||
const pending = {};
|
const pending = {};
|
||||||
|
|
||||||
|
// EIP-1193 ProviderRpcError: `code`, `message`, optional `data`. A class
|
||||||
|
// rather than properties bolted onto an Error because this object crosses
|
||||||
|
// no boundary after construction — it is built in the page's own realm and
|
||||||
|
// handed straight to the caller's catch — so the prototype survives and
|
||||||
|
// `error.name` is a stable thing for a dApp to see.
|
||||||
|
class ProviderRpcError extends Error {
|
||||||
|
constructor(code, message, data) {
|
||||||
|
super(message);
|
||||||
|
this.name = "ProviderRpcError";
|
||||||
|
this.code = code;
|
||||||
|
if (data !== undefined) this.data = data;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rebuild a boundary error as the error the page catches, carrying the
|
||||||
|
// code (and data) the extension reported. Without this a dApp cannot tell
|
||||||
|
// a user's refusal (4001) from a wallet that broke, and retries or shows
|
||||||
|
// an error instead of accepting the refusal.
|
||||||
|
//
|
||||||
|
// Whatever code arrived is passed through verbatim rather than being
|
||||||
|
// matched against a list: the extension emits 4001, 4100 and 4902 today,
|
||||||
|
// and a code this file has never heard of is still the truth about what
|
||||||
|
// happened. An error reported with no code at all stays a plain Error —
|
||||||
|
// a ProviderRpcError whose `code` is undefined would advertise a
|
||||||
|
// conformance it does not have. `message` is untouched in every case.
|
||||||
|
function toPageError(error) {
|
||||||
|
const message = (error && error.message) || "Request failed";
|
||||||
|
if (error && error.code !== undefined && error.code !== null) {
|
||||||
|
return new ProviderRpcError(error.code, message, error.data);
|
||||||
|
}
|
||||||
|
return new Error(message);
|
||||||
|
}
|
||||||
|
|
||||||
// Listen for responses from the content script
|
// Listen for responses from the content script
|
||||||
window.addEventListener("message", function onUuid(event) {
|
window.addEventListener("message", function onUuid(event) {
|
||||||
if (event.source !== window) return;
|
if (event.source !== window) return;
|
||||||
@@ -20,7 +53,7 @@
|
|||||||
if (!p) return;
|
if (!p) return;
|
||||||
delete pending[id];
|
delete pending[id];
|
||||||
if (error) {
|
if (error) {
|
||||||
p.reject(new Error(error.message || "Request failed"));
|
p.reject(toPageError(error));
|
||||||
} else {
|
} else {
|
||||||
p.resolve(result);
|
p.resolve(result);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,17 +9,16 @@ const {
|
|||||||
$,
|
$,
|
||||||
showView,
|
showView,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
setBackRenderer,
|
setRenderMain,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
goBack,
|
goBack,
|
||||||
clearViewStack,
|
clearViewStack,
|
||||||
} = require("./views/helpers");
|
} = require("./views/helpers");
|
||||||
const { applyTheme } = require("./theme");
|
const { applyTheme } = require("./theme");
|
||||||
// Renders a view the popup lands on without having navigated to it forward:
|
// Views that can be fully re-rendered from persisted state. All others fall
|
||||||
// on restore here, and on Back. Only the views that can be fully re-rendered
|
// back to the nearest restorable parent; see the module for why the
|
||||||
// from persisted state (RESTORABLE_VIEWS, src/popup/restorableViews.js) go
|
// secret-bearing views are absent.
|
||||||
// through it; anything else falls back to the nearest restorable parent.
|
const { RESTORABLE_VIEWS } = require("./restorableViews");
|
||||||
const { renderView, makeBackRenderer } = require("./viewRouter");
|
|
||||||
|
|
||||||
const home = require("./views/home");
|
const home = require("./views/home");
|
||||||
const welcome = require("./views/welcome");
|
const welcome = require("./views/welcome");
|
||||||
@@ -109,22 +108,91 @@ const ctx = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
// The view modules the router renders through, keyed as it expects them.
|
function needsAddress(view) {
|
||||||
const viewModules = {
|
return (
|
||||||
main: { show: () => fallbackView() },
|
view === "address" ||
|
||||||
addressDetail,
|
view === "address-token" ||
|
||||||
addressToken,
|
view === "receive" ||
|
||||||
receive,
|
view === "transaction"
|
||||||
settings,
|
);
|
||||||
settingsAddToken,
|
}
|
||||||
confirmTx,
|
|
||||||
transactionDetail,
|
function hasValidAddress() {
|
||||||
txStatus,
|
return (
|
||||||
};
|
state.selectedWallet !== null &&
|
||||||
|
state.selectedAddress !== null &&
|
||||||
|
state.wallets[state.selectedWallet] &&
|
||||||
|
state.wallets[state.selectedWallet].addresses[state.selectedAddress]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
function restoreView() {
|
function restoreView() {
|
||||||
if (!renderView(state.currentView, state, viewModules)) {
|
const view = state.currentView;
|
||||||
fallbackView();
|
if (!view || !RESTORABLE_VIEWS.has(view)) {
|
||||||
|
return fallbackView();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (needsAddress(view) && !hasValidAddress()) {
|
||||||
|
return fallbackView();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (view === "address-token" && !state.selectedToken) {
|
||||||
|
return fallbackView();
|
||||||
|
}
|
||||||
|
|
||||||
|
switch (view) {
|
||||||
|
case "address":
|
||||||
|
addressDetail.show();
|
||||||
|
break;
|
||||||
|
case "address-token":
|
||||||
|
addressToken.show();
|
||||||
|
break;
|
||||||
|
case "receive":
|
||||||
|
receive.show();
|
||||||
|
break;
|
||||||
|
case "settings":
|
||||||
|
settings.show();
|
||||||
|
break;
|
||||||
|
case "settings-addtoken":
|
||||||
|
settingsAddToken.show();
|
||||||
|
break;
|
||||||
|
case "confirm-tx":
|
||||||
|
if (state.viewData && state.viewData.pendingTx) {
|
||||||
|
confirmTx.restore();
|
||||||
|
} else {
|
||||||
|
fallbackView();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "transaction":
|
||||||
|
if (state.viewData && state.viewData.tx) {
|
||||||
|
transactionDetail.render();
|
||||||
|
} else {
|
||||||
|
fallbackView();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "wait-tx":
|
||||||
|
// Resumes the receipt poll from the persisted broadcast time.
|
||||||
|
if (!txStatus.restoreWait()) {
|
||||||
|
fallbackView();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "success-tx":
|
||||||
|
if (state.viewData && state.viewData.hash) {
|
||||||
|
txStatus.renderSuccess();
|
||||||
|
} else {
|
||||||
|
fallbackView();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "error-tx":
|
||||||
|
if (state.viewData && state.viewData.message) {
|
||||||
|
txStatus.renderError();
|
||||||
|
} else {
|
||||||
|
fallbackView();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
fallbackView();
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -179,7 +247,7 @@ async function init() {
|
|||||||
settings.show();
|
settings.show();
|
||||||
});
|
});
|
||||||
|
|
||||||
setBackRenderer(makeBackRenderer(state, viewModules));
|
setRenderMain(renderWalletList);
|
||||||
|
|
||||||
welcome.init(ctx);
|
welcome.init(ctx);
|
||||||
addWallet.init(ctx);
|
addWallet.init(ctx);
|
||||||
|
|||||||
@@ -1,167 +0,0 @@
|
|||||||
// Rendering a view the popup lands on without having navigated to it
|
|
||||||
// forward: on restore, and on Back. In both cases the view may never have
|
|
||||||
// been rendered in this page load — a reopened popup renders only the
|
|
||||||
// wallet list and the view it restores onto, so every other view is still
|
|
||||||
// the blank static template from index.html — so unhiding it is not enough.
|
|
||||||
//
|
|
||||||
// Forward navigation renders as it goes and must NOT come through here:
|
|
||||||
// rendering a second time would re-fetch and clobber whatever the view has
|
|
||||||
// in flight.
|
|
||||||
//
|
|
||||||
// The view modules are injected and nothing here touches the DOM, so the
|
|
||||||
// dispatch and its data guards can be tested directly; src/popup/index.js
|
|
||||||
// cannot be required outside a browser.
|
|
||||||
|
|
||||||
const { RESTORABLE_VIEWS } = require("./restorableViews");
|
|
||||||
|
|
||||||
// The views this page load has rendered.
|
|
||||||
//
|
|
||||||
// The Back path cannot otherwise tell its two cases apart. A view the popup
|
|
||||||
// never rendered is still the blank template from index.html and has to be
|
|
||||||
// rendered; a view already on the page must NOT be rendered again, because
|
|
||||||
// a second render re-fetches and overwrites whatever the user has typed
|
|
||||||
// into it and not yet saved.
|
|
||||||
//
|
|
||||||
// Registration is showView() in views/helpers.js, which is the last thing
|
|
||||||
// every render path runs — restoreView()'s, the Back path's, and every
|
|
||||||
// forward show(). That is the point of putting it there rather than in the
|
|
||||||
// individual views: a view added later registers itself with no one having
|
|
||||||
// to remember it, so this cannot decay.
|
|
||||||
//
|
|
||||||
// Module scope is page-load scope: the popup loads this module once per
|
|
||||||
// page load, and a reopened popup gets a fresh, empty set — which is
|
|
||||||
// exactly the state that makes the Back path render.
|
|
||||||
const renderedViews = new Set();
|
|
||||||
|
|
||||||
function markViewRendered(view) {
|
|
||||||
if (view) renderedViews.add(view);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Begin a fresh page-load scope. The popup gets one by being loaded; the
|
|
||||||
// unit tests, which simulate several page loads against one module
|
|
||||||
// instance, ask for one.
|
|
||||||
function resetRenderedViews() {
|
|
||||||
renderedViews.clear();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Home is the exception: Back re-renders it every time, which is what the
|
|
||||||
// popup did before this router existed (index.js registered
|
|
||||||
// renderWalletList() as setRenderMain(), and goBack() called it on every
|
|
||||||
// Back onto "main"). It must stay that way — the wallet list has to reflect
|
|
||||||
// what changed while the user was away from it, such as a wallet renamed or
|
|
||||||
// an address removed in Settings — and Home holds no unsaved input to lose.
|
|
||||||
const ALWAYS_RENDER_ON_BACK = new Set(["main"]);
|
|
||||||
|
|
||||||
// Views that render an address the user picked and cannot be rendered
|
|
||||||
// without one.
|
|
||||||
const ADDRESS_VIEWS = new Set([
|
|
||||||
"address",
|
|
||||||
"address-token",
|
|
||||||
"receive",
|
|
||||||
"transaction",
|
|
||||||
]);
|
|
||||||
|
|
||||||
function needsAddress(view) {
|
|
||||||
return ADDRESS_VIEWS.has(view);
|
|
||||||
}
|
|
||||||
|
|
||||||
function hasValidAddress(state) {
|
|
||||||
return Boolean(
|
|
||||||
state.selectedWallet !== null &&
|
|
||||||
state.selectedAddress !== null &&
|
|
||||||
state.wallets[state.selectedWallet] &&
|
|
||||||
state.wallets[state.selectedWallet].addresses[state.selectedAddress],
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Render `view` from persisted state. Each view module shows itself, so a
|
|
||||||
// true return means the view is both rendered and on screen.
|
|
||||||
//
|
|
||||||
// Returns false when the view is not one the popup renders from state, or
|
|
||||||
// when the state it would render is gone — a token no longer selected, a
|
|
||||||
// transaction no longer persisted. The caller falls back rather than
|
|
||||||
// putting an empty template on screen.
|
|
||||||
function renderView(view, state, views) {
|
|
||||||
if (!view || !RESTORABLE_VIEWS.has(view)) return false;
|
|
||||||
if (needsAddress(view) && !hasValidAddress(state)) return false;
|
|
||||||
if (view === "address-token" && !state.selectedToken) return false;
|
|
||||||
|
|
||||||
const data = state.viewData || {};
|
|
||||||
switch (view) {
|
|
||||||
case "main":
|
|
||||||
views.main.show();
|
|
||||||
return true;
|
|
||||||
case "address":
|
|
||||||
views.addressDetail.show();
|
|
||||||
return true;
|
|
||||||
case "address-token":
|
|
||||||
views.addressToken.show();
|
|
||||||
return true;
|
|
||||||
case "receive":
|
|
||||||
views.receive.show();
|
|
||||||
return true;
|
|
||||||
case "settings":
|
|
||||||
views.settings.show();
|
|
||||||
return true;
|
|
||||||
case "settings-addtoken":
|
|
||||||
views.settingsAddToken.show();
|
|
||||||
return true;
|
|
||||||
case "confirm-tx":
|
|
||||||
if (!data.pendingTx) return false;
|
|
||||||
views.confirmTx.restore();
|
|
||||||
return true;
|
|
||||||
case "transaction":
|
|
||||||
if (!data.tx) return false;
|
|
||||||
views.transactionDetail.render();
|
|
||||||
return true;
|
|
||||||
case "wait-tx":
|
|
||||||
// Resumes the receipt poll from the persisted broadcast time,
|
|
||||||
// and answers false when there is nothing resumable left.
|
|
||||||
return Boolean(views.txStatus.restoreWait());
|
|
||||||
case "success-tx":
|
|
||||||
if (!data.hash) return false;
|
|
||||||
views.txStatus.renderSuccess();
|
|
||||||
return true;
|
|
||||||
case "error-tx":
|
|
||||||
if (!data.message) return false;
|
|
||||||
views.txStatus.renderError();
|
|
||||||
return true;
|
|
||||||
default:
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The Back-path renderer, registered with setBackRenderer() in
|
|
||||||
// views/helpers.js.
|
|
||||||
//
|
|
||||||
// Returns false — leaving goBack() to unhide the view, as it always did —
|
|
||||||
// in the two cases where the view is known to be on the page already:
|
|
||||||
//
|
|
||||||
// - It is not one the popup renders from persisted state. The restored
|
|
||||||
// stack is filtered against RESTORABLE_VIEWS, so such a view can only
|
|
||||||
// be on the stack from this page load, where forward navigation
|
|
||||||
// rendered it on the way in.
|
|
||||||
// - This page load has rendered it. Re-rendering would re-fetch and
|
|
||||||
// clobber what it holds; Home is rendered anyway, see above.
|
|
||||||
//
|
|
||||||
// What is left is the case the router exists for: a view on the stack that
|
|
||||||
// this page load has never rendered, whose template is still blank.
|
|
||||||
function makeBackRenderer(state, views) {
|
|
||||||
return function renderBack(view) {
|
|
||||||
if (!RESTORABLE_VIEWS.has(view)) return false;
|
|
||||||
if (renderedViews.has(view) && !ALWAYS_RENDER_ON_BACK.has(view)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
if (!renderView(view, state, views)) {
|
|
||||||
views.main.show();
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
renderView,
|
|
||||||
makeBackRenderer,
|
|
||||||
markViewRendered,
|
|
||||||
resetRenderedViews,
|
|
||||||
};
|
|
||||||
@@ -27,8 +27,7 @@ const { walletDefect } = require("../../shared/walletDefects");
|
|||||||
const { describeSigningFailure } = require("../../shared/approvalVerify");
|
const { describeSigningFailure } = require("../../shared/approvalVerify");
|
||||||
const txStatus = require("./txStatus");
|
const txStatus = require("./txStatus");
|
||||||
const uniswap = require("../../shared/uniswap");
|
const uniswap = require("../../shared/uniswap");
|
||||||
const runtime =
|
const { notify, runtimeApi, sendMessage } = require("../../shared/browserApi");
|
||||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
|
||||||
|
|
||||||
const erc20Iface = new Interface(ERC20_ABI);
|
const erc20Iface = new Interface(ERC20_ABI);
|
||||||
|
|
||||||
@@ -439,34 +438,41 @@ function showSignApproval(details) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function show(id) {
|
// Awaited by nobody: the popup entry point calls this and moves on. It
|
||||||
|
// therefore has to absorb its own failure, and a background that cannot
|
||||||
|
// describe the approval is the same outcome as an approval that is gone.
|
||||||
|
async function show(id) {
|
||||||
approvalId = id;
|
approvalId = id;
|
||||||
runtime.connect({ name: "approval:" + id });
|
runtimeApi().connect({ name: "approval:" + id });
|
||||||
runtime.sendMessage({ type: "AUTISTMASK_GET_APPROVAL", id }, (details) => {
|
|
||||||
if (!details) {
|
let details = null;
|
||||||
window.close();
|
try {
|
||||||
return;
|
details = await sendMessage({ type: "AUTISTMASK_GET_APPROVAL", id });
|
||||||
}
|
} catch {
|
||||||
if (details.type === "tx") {
|
details = null;
|
||||||
showTxApproval(details);
|
}
|
||||||
return;
|
|
||||||
}
|
if (!details) {
|
||||||
if (details.type === "sign") {
|
window.close();
|
||||||
showSignApproval(details);
|
return;
|
||||||
return;
|
}
|
||||||
}
|
if (details.type === "tx") {
|
||||||
// Site connection approval
|
showTxApproval(details);
|
||||||
showPhishingWarning(
|
return;
|
||||||
"approve-site-phishing-warning",
|
}
|
||||||
details.isPhishingDomain,
|
if (details.type === "sign") {
|
||||||
);
|
showSignApproval(details);
|
||||||
$("approve-hostname").textContent = details.hostname;
|
return;
|
||||||
$("approve-address").innerHTML = approvalAddressHtml(
|
}
|
||||||
state.activeAddress,
|
// Site connection approval
|
||||||
);
|
showPhishingWarning(
|
||||||
attachCopyHandlers("view-approve-site");
|
"approve-site-phishing-warning",
|
||||||
$("approve-remember").checked = state.rememberSiteChoice;
|
details.isPhishingDomain,
|
||||||
});
|
);
|
||||||
|
$("approve-hostname").textContent = details.hostname;
|
||||||
|
$("approve-address").innerHTML = approvalAddressHtml(state.activeAddress);
|
||||||
|
attachCopyHandlers("view-approve-site");
|
||||||
|
$("approve-remember").checked = state.rememberSiteChoice;
|
||||||
}
|
}
|
||||||
|
|
||||||
let approvalId = null;
|
let approvalId = null;
|
||||||
@@ -548,7 +554,7 @@ function init(ctx) {
|
|||||||
|
|
||||||
$("btn-approve").addEventListener("click", () => {
|
$("btn-approve").addEventListener("click", () => {
|
||||||
const remember = $("approve-remember").checked;
|
const remember = $("approve-remember").checked;
|
||||||
runtime.sendMessage({
|
notify({
|
||||||
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: true,
|
approved: true,
|
||||||
@@ -559,7 +565,7 @@ function init(ctx) {
|
|||||||
|
|
||||||
$("btn-reject").addEventListener("click", () => {
|
$("btn-reject").addEventListener("click", () => {
|
||||||
const remember = $("approve-remember").checked;
|
const remember = $("approve-remember").checked;
|
||||||
runtime.sendMessage({
|
notify({
|
||||||
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
type: "AUTISTMASK_APPROVAL_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: false,
|
approved: false,
|
||||||
@@ -648,29 +654,37 @@ function init(ctx) {
|
|||||||
decryptedSecret = null;
|
decryptedSecret = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
runtime.sendMessage(payload, (response) => {
|
// A send that never reaches the background is reported to the user
|
||||||
if (response && response.txHash) {
|
// the same way a background that refused it is: describeSigningFailure
|
||||||
txStatus.showWait(pendingTxDetails, response.txHash);
|
// turns a null response into the generic message below.
|
||||||
return;
|
let response = null;
|
||||||
}
|
try {
|
||||||
// A retryable failure leaves the approval pending in the
|
response = await sendMessage(payload);
|
||||||
// background, so stay on this screen with a live button rather
|
} catch {
|
||||||
// than sending the user to a dead end.
|
response = null;
|
||||||
const outcome = describeSigningFailure(
|
}
|
||||||
response,
|
|
||||||
"The transaction could not be sent.",
|
if (response && response.txHash) {
|
||||||
);
|
txStatus.showWait(pendingTxDetails, response.txHash);
|
||||||
if (outcome.retryable) {
|
return;
|
||||||
showError("approve-tx-error", outcome.message);
|
}
|
||||||
setTxButtonBusy(false);
|
// A retryable failure leaves the approval pending in the
|
||||||
} else {
|
// background, so stay on this screen with a live button rather
|
||||||
txStatus.showError(pendingTxDetails, null, outcome.message);
|
// than sending the user to a dead end.
|
||||||
}
|
const outcome = describeSigningFailure(
|
||||||
});
|
response,
|
||||||
|
"The transaction could not be sent.",
|
||||||
|
);
|
||||||
|
if (outcome.retryable) {
|
||||||
|
showError("approve-tx-error", outcome.message);
|
||||||
|
setTxButtonBusy(false);
|
||||||
|
} else {
|
||||||
|
txStatus.showError(pendingTxDetails, null, outcome.message);
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
$("btn-reject-tx").addEventListener("click", () => {
|
$("btn-reject-tx").addEventListener("click", () => {
|
||||||
runtime.sendMessage({
|
notify({
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
type: "AUTISTMASK_TX_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: false,
|
approved: false,
|
||||||
@@ -764,26 +778,31 @@ function init(ctx) {
|
|||||||
decryptedSecret = null;
|
decryptedSecret = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
runtime.sendMessage(payload, (response) => {
|
let response = null;
|
||||||
if (response && response.signature) {
|
try {
|
||||||
window.close();
|
response = await sendMessage(payload);
|
||||||
return;
|
} catch {
|
||||||
}
|
response = null;
|
||||||
// The button comes back only when the approval is still pending in
|
}
|
||||||
// the background; otherwise it stays disabled and the message says
|
|
||||||
// why, because a control that cannot succeed must not look like it
|
if (response && response.signature) {
|
||||||
// can.
|
window.close();
|
||||||
const outcome = describeSigningFailure(
|
return;
|
||||||
response,
|
}
|
||||||
"The message could not be signed.",
|
// The button comes back only when the approval is still pending in
|
||||||
);
|
// the background; otherwise it stays disabled and the message says
|
||||||
showError("approve-sign-error", outcome.message);
|
// why, because a control that cannot succeed must not look like it
|
||||||
if (outcome.retryable) setSignButtonBusy(false);
|
// can.
|
||||||
});
|
const outcome = describeSigningFailure(
|
||||||
|
response,
|
||||||
|
"The message could not be signed.",
|
||||||
|
);
|
||||||
|
showError("approve-sign-error", outcome.message);
|
||||||
|
if (outcome.retryable) setSignButtonBusy(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
$("btn-reject-sign").addEventListener("click", () => {
|
$("btn-reject-sign").addEventListener("click", () => {
|
||||||
runtime.sendMessage({
|
notify({
|
||||||
type: "AUTISTMASK_SIGN_RESPONSE",
|
type: "AUTISTMASK_SIGN_RESPONSE",
|
||||||
id: approvalId,
|
id: approvalId,
|
||||||
approved: false,
|
approved: false,
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ const {
|
|||||||
getAddressValueUsd,
|
getAddressValueUsd,
|
||||||
} = require("../../shared/prices");
|
} = require("../../shared/prices");
|
||||||
const { state, saveState, currentNetwork } = require("../../shared/state");
|
const { state, saveState, currentNetwork } = require("../../shared/state");
|
||||||
const { markViewRendered } = require("../viewRouter");
|
|
||||||
|
|
||||||
// When views are added, removed, or transitions between them change,
|
// When views are added, removed, or transitions between them change,
|
||||||
// update the view-navigation documentation in README.md to match.
|
// update the view-navigation documentation in README.md to match.
|
||||||
@@ -77,10 +76,6 @@ function showView(name) {
|
|||||||
}
|
}
|
||||||
clearFlash();
|
clearFlash();
|
||||||
state.currentView = name;
|
state.currentView = name;
|
||||||
// A view's show() ends here, so this is where the Back path learns the
|
|
||||||
// view is no longer the blank template from index.html and must not be
|
|
||||||
// rendered a second time. See viewRouter.js.
|
|
||||||
markViewRendered(name);
|
|
||||||
saveState();
|
saveState();
|
||||||
updateDebugBanner(name);
|
updateDebugBanner(name);
|
||||||
}
|
}
|
||||||
@@ -116,19 +111,12 @@ function updateDebugBanner(viewName) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Callback that renders a view being navigated BACK onto. Set once by
|
// Callback to re-render the main/home view when navigating back to it.
|
||||||
// index.js via setBackRenderer(), which routes the view through the same
|
// Set once by index.js via setRenderMain().
|
||||||
// per-view render and data guards restoreView() uses.
|
let _renderMain = null;
|
||||||
//
|
|
||||||
// It answers true when it took the navigation — the view is rendered and
|
|
||||||
// shown, or its backing data was gone and it fell back — and false for a
|
|
||||||
// view the popup does not render from persisted state. Those can only be
|
|
||||||
// on the stack from this page load, because the stack is filtered on load,
|
|
||||||
// so they have already been rendered and only need unhiding.
|
|
||||||
let _renderBack = null;
|
|
||||||
|
|
||||||
function setBackRenderer(fn) {
|
function setRenderMain(fn) {
|
||||||
_renderBack = fn;
|
_renderMain = fn;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Push the current view onto the navigation stack so goBack() can
|
// Push the current view onto the navigation stack so goBack() can
|
||||||
@@ -148,11 +136,9 @@ function goBack() {
|
|||||||
} else {
|
} else {
|
||||||
target = "main";
|
target = "main";
|
||||||
}
|
}
|
||||||
// A popped view is landed on, not navigated to. If the popup has been
|
if (target === "main" && _renderMain) {
|
||||||
// closed and reopened since the view was pushed, nothing has ever
|
_renderMain();
|
||||||
// rendered it in this page load and its template is still blank, so it
|
}
|
||||||
// has to be rendered here rather than merely unhidden.
|
|
||||||
if (_renderBack && _renderBack(target)) return;
|
|
||||||
showView(target);
|
showView(target);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -484,7 +470,7 @@ module.exports = {
|
|||||||
showView,
|
showView,
|
||||||
onViewLeave,
|
onViewLeave,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
setBackRenderer,
|
setRenderMain,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
goBack,
|
goBack,
|
||||||
clearViewStack,
|
clearViewStack,
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ const {
|
|||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
} = require("./helpers");
|
} = require("./helpers");
|
||||||
const { state, saveState, currentAddress } = require("../../shared/state");
|
const { state, saveState, currentAddress } = require("../../shared/state");
|
||||||
|
const { notify } = require("../../shared/browserApi");
|
||||||
const {
|
const {
|
||||||
updateSendBalance,
|
updateSendBalance,
|
||||||
renderSendTokenSelect,
|
renderSendTokenSelect,
|
||||||
@@ -293,11 +294,7 @@ function render(ctx) {
|
|||||||
state.activeAddress = addr;
|
state.activeAddress = addr;
|
||||||
await saveState();
|
await saveState();
|
||||||
render(ctx);
|
render(ctx);
|
||||||
const runtime =
|
notify({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
||||||
typeof browser !== "undefined"
|
|
||||||
? browser.runtime
|
|
||||||
: chrome.runtime;
|
|
||||||
runtime.sendMessage({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -29,8 +29,7 @@ const {
|
|||||||
GITEA_COMMIT_URL,
|
GITEA_COMMIT_URL,
|
||||||
} = require("../../shared/buildInfo");
|
} = require("../../shared/buildInfo");
|
||||||
|
|
||||||
const runtime =
|
const { notify } = require("../../shared/browserApi");
|
||||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
|
||||||
|
|
||||||
let versionClickCount = 0;
|
let versionClickCount = 0;
|
||||||
let versionClickTimer = null;
|
let versionClickTimer = null;
|
||||||
@@ -61,7 +60,7 @@ function renderSiteList(containerId, siteMap, stateKey) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
await saveState();
|
await saveState();
|
||||||
runtime.sendMessage({ type: "AUTISTMASK_REMOVE_SITE" });
|
notify({ type: "AUTISTMASK_REMOVE_SITE" });
|
||||||
renderSiteList(containerId, state[key], key);
|
renderSiteList(containerId, state[key], key);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -19,6 +19,8 @@
|
|||||||
// be bypassed on the scheduled tick — see backgroundRefresh() in
|
// be bypassed on the scheduled tick — see backgroundRefresh() in
|
||||||
// src/background/index.js and updatePhishingList() in shared/phishingDomains.js.
|
// src/background/index.js and updatePhishingList() in shared/phishingDomains.js.
|
||||||
|
|
||||||
|
const { alarmsApi } = require("./browserApi");
|
||||||
|
|
||||||
const BALANCE_REFRESH_ALARM = "autistmask-balance-refresh";
|
const BALANCE_REFRESH_ALARM = "autistmask-balance-refresh";
|
||||||
const PHISHING_REFRESH_ALARM = "autistmask-phishing-refresh";
|
const PHISHING_REFRESH_ALARM = "autistmask-phishing-refresh";
|
||||||
|
|
||||||
@@ -26,14 +28,10 @@ const MIN_ALARM_PERIOD_MINUTES = 1;
|
|||||||
const BALANCE_REFRESH_PERIOD_MINUTES = 1;
|
const BALANCE_REFRESH_PERIOD_MINUTES = 1;
|
||||||
const PHISHING_REFRESH_PERIOD_MINUTES = 24 * 60;
|
const PHISHING_REFRESH_PERIOD_MINUTES = 24 * 60;
|
||||||
|
|
||||||
// Resolved on use rather than captured at module load: the worker is torn
|
// alarmsApi() resolves on use rather than at module load: the worker is torn
|
||||||
// down and re-evaluated repeatedly, and tests install a stub after requiring
|
// down and re-evaluated repeatedly, and tests install a stub after requiring
|
||||||
// the module.
|
// this module. It returns null where the API is absent, which is why every
|
||||||
function alarmsApi() {
|
// entry point below degrades instead of throwing.
|
||||||
if (typeof browser !== "undefined" && browser.alarms) return browser.alarms;
|
|
||||||
if (typeof chrome !== "undefined" && chrome.alarms) return chrome.alarms;
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create an alarm unless one with the requested period already exists.
|
* Create an alarm unless one with the requested period already exists.
|
||||||
|
|||||||
245
src/shared/browserApi.js
Normal file
245
src/shared/browserApi.js
Normal file
@@ -0,0 +1,245 @@
|
|||||||
|
// The one place in this tree that names `browser` or `chrome`.
|
||||||
|
//
|
||||||
|
// The two targets do not agree on either the namespace or the call shape.
|
||||||
|
// Chrome MV3 exposes `chrome.*`, where tabs, windows and messaging take a
|
||||||
|
// trailing callback and report failure through the global
|
||||||
|
// `chrome.runtime.lastError`. Firefox MV2 exposes `browser.*`, where those
|
||||||
|
// same methods return promises and take no callback at all — a function
|
||||||
|
// passed where an options argument is expected is simply never invoked, so
|
||||||
|
// the call looks like it succeeded and silently never completes. Resolving
|
||||||
|
// the namespace with a ternary and then calling it Chrome-style, which is
|
||||||
|
// what this codebase used to do, is broken on Firefox in exactly that way:
|
||||||
|
// see https://git.eeqj.de/sneak/AutistMask/issues/153.
|
||||||
|
//
|
||||||
|
// The strategy is promises out, everywhere. Callers `await`; nothing outside
|
||||||
|
// this file has to know which browser it is running on.
|
||||||
|
//
|
||||||
|
// Two deliberate asymmetries, because they are what the browsers actually do
|
||||||
|
// rather than what a uniform-looking shim would pretend:
|
||||||
|
//
|
||||||
|
// - Storage is called in its PROMISE form on both namespaces.
|
||||||
|
// `chrome.storage.local.get()` returns a promise on MV3 and the popup
|
||||||
|
// already depends on that — src/shared/state.js has always awaited it, and
|
||||||
|
// that is precisely why the Firefox popup flows work today while
|
||||||
|
// everything in the issue above does not. Wrapping it in a callback here
|
||||||
|
// would be a change, not a fix.
|
||||||
|
// - notify() sends without a callback. It is for a message whose answer
|
||||||
|
// nobody reads; appending a callback would only manufacture a
|
||||||
|
// lastError/rejection for a receiver that was never expected to reply.
|
||||||
|
//
|
||||||
|
// Everything is resolved on use rather than captured at module load. The MV3
|
||||||
|
// service worker is torn down and re-evaluated repeatedly, and the unit
|
||||||
|
// suite installs its stubs on `global.chrome` around a require().
|
||||||
|
|
||||||
|
// The extension API namespace, preferring `browser.*` where it exists.
|
||||||
|
//
|
||||||
|
// Whole-namespace, never per-method: mixing `browser.tabs` with
|
||||||
|
// `chrome.windows` would also mix promise and callback semantics inside a
|
||||||
|
// single call path, which is the bug this module exists to remove.
|
||||||
|
function extensionApi() {
|
||||||
|
if (typeof browser !== "undefined" && browser) return browser;
|
||||||
|
if (typeof chrome !== "undefined" && chrome) return chrome;
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// True when the resolved namespace is the promise-flavoured one.
|
||||||
|
//
|
||||||
|
// It doubles as "this is the Gecko/MV2 build", which is a second question
|
||||||
|
// with the same answer and one real caller: src/content/index.js has to
|
||||||
|
// inject the inpage provider itself there, because MV2 has no
|
||||||
|
// `"world": "MAIN"` for a manifest-declared content script.
|
||||||
|
function hasBrowserNamespace() {
|
||||||
|
return typeof browser !== "undefined" && !!browser;
|
||||||
|
}
|
||||||
|
|
||||||
|
function namespaceMember(name) {
|
||||||
|
const api = extensionApi();
|
||||||
|
return (api && api[name]) || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function runtimeApi() {
|
||||||
|
return namespaceMember("runtime");
|
||||||
|
}
|
||||||
|
|
||||||
|
function tabsApi() {
|
||||||
|
return namespaceMember("tabs");
|
||||||
|
}
|
||||||
|
|
||||||
|
function windowsApi() {
|
||||||
|
return namespaceMember("windows");
|
||||||
|
}
|
||||||
|
|
||||||
|
function alarmsApi() {
|
||||||
|
return namespaceMember("alarms");
|
||||||
|
}
|
||||||
|
|
||||||
|
// The toolbar button. MV3 calls it `action`, MV2 calls it `browserAction`.
|
||||||
|
function actionApi() {
|
||||||
|
const api = extensionApi();
|
||||||
|
if (!api) return null;
|
||||||
|
return api.action || api.browserAction || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// `storage.local`, or null in a context that has no storage permission. Null
|
||||||
|
// rather than a throw because two callers degrade rather than fail on it.
|
||||||
|
function storageLocal() {
|
||||||
|
const storage = namespaceMember("storage");
|
||||||
|
return (storage && storage.local) || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The Chrome-only error channel. Never populated for a `browser.*` call,
|
||||||
|
// which is why the checks that used to guard callbacks in the background are
|
||||||
|
// gone: on this side it becomes a rejection, and on the other side there was
|
||||||
|
// never anything to read.
|
||||||
|
function lastError() {
|
||||||
|
const runtime = runtimeApi();
|
||||||
|
return (runtime && runtime.lastError) || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Call `owner[method](...args)` and return a promise for its result.
|
||||||
|
//
|
||||||
|
// On the promise namespace the method already returns one. On the callback
|
||||||
|
// namespace the callback is appended here and lastError becomes a rejection,
|
||||||
|
// because a caller holding a promise has nowhere to check a global flag.
|
||||||
|
function invoke(owner, method, ...args) {
|
||||||
|
if (!owner || typeof owner[method] !== "function") {
|
||||||
|
return Promise.reject(
|
||||||
|
new Error(
|
||||||
|
"extension API " +
|
||||||
|
method +
|
||||||
|
"() is not available in this context",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (hasBrowserNamespace()) {
|
||||||
|
try {
|
||||||
|
return Promise.resolve(owner[method](...args));
|
||||||
|
} catch (e) {
|
||||||
|
return Promise.reject(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
owner[method](...args, (result) => {
|
||||||
|
const err = lastError();
|
||||||
|
if (err) reject(new Error(err.message || String(err)));
|
||||||
|
else resolve(result);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to the extension's own contexts and resolve with the reply.
|
||||||
|
*
|
||||||
|
* Rejects when nothing is listening, on both browsers. A caller that does not
|
||||||
|
* care must say so — see notify().
|
||||||
|
*
|
||||||
|
* @param {Object} message
|
||||||
|
* @returns {Promise<*>} the receiver's response.
|
||||||
|
*/
|
||||||
|
function sendMessage(message) {
|
||||||
|
return invoke(runtimeApi(), "sendMessage", message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message nobody is expected to answer, and swallow the fact that
|
||||||
|
* nobody did.
|
||||||
|
*
|
||||||
|
* @param {Object} message
|
||||||
|
* @returns {void}
|
||||||
|
*/
|
||||||
|
function notify(message) {
|
||||||
|
const runtime = runtimeApi();
|
||||||
|
if (!runtime || typeof runtime.sendMessage !== "function") return;
|
||||||
|
const result = runtime.sendMessage(message);
|
||||||
|
// MV3 hands back a promise for a one-argument send, and it rejects when
|
||||||
|
// the background is not listening. Unhandled, that surfaces as an error
|
||||||
|
// the e2e suites fail the run on.
|
||||||
|
if (result && typeof result.catch === "function") result.catch(() => {});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string|string[]|Object} keys
|
||||||
|
* @returns {Promise<Object>} the stored items, or {} where storage is absent.
|
||||||
|
*/
|
||||||
|
function storageGet(keys) {
|
||||||
|
const storage = storageLocal();
|
||||||
|
if (!storage) return Promise.resolve({});
|
||||||
|
return Promise.resolve(storage.get(keys));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Object} items
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
function storageSet(items) {
|
||||||
|
const storage = storageLocal();
|
||||||
|
if (!storage) return Promise.resolve();
|
||||||
|
return Promise.resolve(storage.set(items));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Object} queryInfo
|
||||||
|
* @returns {Promise<Array>} the matching tabs.
|
||||||
|
*/
|
||||||
|
function tabsQuery(queryInfo) {
|
||||||
|
return invoke(tabsApi(), "query", queryInfo);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to one tab's content script.
|
||||||
|
*
|
||||||
|
* Rejects for a tab that has no receiver, which is most of them. That
|
||||||
|
* rejection is the promise-shaped replacement for the runtime.lastError
|
||||||
|
* checks the broadcast helpers used to make, and callers ignore it the same
|
||||||
|
* way.
|
||||||
|
*
|
||||||
|
* @param {number} tabId
|
||||||
|
* @param {Object} message
|
||||||
|
* @returns {Promise<*>}
|
||||||
|
*/
|
||||||
|
function tabsSendMessage(tabId, message) {
|
||||||
|
return invoke(tabsApi(), "sendMessage", tabId, message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Object} createData
|
||||||
|
* @returns {Promise<Object>} the created window.
|
||||||
|
*/
|
||||||
|
function windowsCreate(createData) {
|
||||||
|
return invoke(windowsApi(), "create", createData);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns {Promise<Object>} the last focused window.
|
||||||
|
*/
|
||||||
|
function windowsGetLastFocused() {
|
||||||
|
return invoke(windowsApi(), "getLastFocused");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {number} windowId
|
||||||
|
* @returns {Promise<void>}
|
||||||
|
*/
|
||||||
|
function windowsRemove(windowId) {
|
||||||
|
return invoke(windowsApi(), "remove", windowId);
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
actionApi,
|
||||||
|
alarmsApi,
|
||||||
|
extensionApi,
|
||||||
|
hasBrowserNamespace,
|
||||||
|
notify,
|
||||||
|
runtimeApi,
|
||||||
|
sendMessage,
|
||||||
|
storageGet,
|
||||||
|
storageLocal,
|
||||||
|
storageSet,
|
||||||
|
tabsApi,
|
||||||
|
tabsQuery,
|
||||||
|
tabsSendMessage,
|
||||||
|
windowsApi,
|
||||||
|
windowsCreate,
|
||||||
|
windowsGetLastFocused,
|
||||||
|
windowsRemove,
|
||||||
|
};
|
||||||
@@ -18,6 +18,7 @@
|
|||||||
// its own refresh — see updatePhishingList().
|
// its own refresh — see updatePhishingList().
|
||||||
|
|
||||||
const vendoredConfig = require("./phishingBlocklist.json");
|
const vendoredConfig = require("./phishingBlocklist.json");
|
||||||
|
const { storageLocal } = require("./browserApi");
|
||||||
|
|
||||||
const BLOCKLIST_URL =
|
const BLOCKLIST_URL =
|
||||||
"https://raw.githubusercontent.com/MetaMask/eth-phishing-detect/main/src/config.json";
|
"https://raw.githubusercontent.com/MetaMask/eth-phishing-detect/main/src/config.json";
|
||||||
@@ -46,18 +47,10 @@ let lastAttemptTime = 0;
|
|||||||
let fetchPromise = null;
|
let fetchPromise = null;
|
||||||
let loadPromise = null;
|
let loadPromise = null;
|
||||||
|
|
||||||
// Resolved on use rather than captured at module load, so a test can install
|
// storageLocal() resolves on use rather than at module load, so a test can
|
||||||
// a stub after requiring the module and so the popup — which has no reason to
|
// install a stub after requiring this module, and it returns null where the
|
||||||
// touch the delta — does not fail to load where the API is absent.
|
// API is absent — which is why the popup, with no reason to touch the delta,
|
||||||
function storageApi() {
|
// loads fine without it.
|
||||||
if (typeof browser !== "undefined" && browser.storage) {
|
|
||||||
return browser.storage.local;
|
|
||||||
}
|
|
||||||
if (typeof chrome !== "undefined" && chrome.storage) {
|
|
||||||
return chrome.storage.local;
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sanitise a timestamp read back from storage.
|
* Sanitise a timestamp read back from storage.
|
||||||
@@ -86,7 +79,7 @@ function sanitizeTimestamp(value) {
|
|||||||
* @returns {Promise<void>}
|
* @returns {Promise<void>}
|
||||||
*/
|
*/
|
||||||
async function loadDeltaFromStorage() {
|
async function loadDeltaFromStorage() {
|
||||||
const storage = storageApi();
|
const storage = storageLocal();
|
||||||
if (!storage) return;
|
if (!storage) return;
|
||||||
try {
|
try {
|
||||||
const result = await storage.get(DELTA_STORAGE_KEY);
|
const result = await storage.get(DELTA_STORAGE_KEY);
|
||||||
@@ -122,7 +115,7 @@ function ensureDeltaLoaded() {
|
|||||||
* @returns {Promise<void>}
|
* @returns {Promise<void>}
|
||||||
*/
|
*/
|
||||||
async function saveDeltaToStorage() {
|
async function saveDeltaToStorage() {
|
||||||
const storage = storageApi();
|
const storage = storageLocal();
|
||||||
if (!storage) return;
|
if (!storage) return;
|
||||||
try {
|
try {
|
||||||
const data = {
|
const data = {
|
||||||
|
|||||||
@@ -5,10 +5,7 @@ const { networkById } = require("./networks");
|
|||||||
// Dependency-free constant module; safe to pull into a background bundle.
|
// Dependency-free constant module; safe to pull into a background bundle.
|
||||||
const { RESTORABLE_VIEWS } = require("../popup/restorableViews");
|
const { RESTORABLE_VIEWS } = require("../popup/restorableViews");
|
||||||
|
|
||||||
const storageApi =
|
const { storageGet, storageSet } = require("./browserApi");
|
||||||
typeof browser !== "undefined"
|
|
||||||
? browser.storage.local
|
|
||||||
: chrome.storage.local;
|
|
||||||
|
|
||||||
const DEFAULT_STATE = {
|
const DEFAULT_STATE = {
|
||||||
hasWallet: false,
|
hasWallet: false,
|
||||||
@@ -114,11 +111,11 @@ async function saveState() {
|
|||||||
viewData: state.viewData,
|
viewData: state.viewData,
|
||||||
viewStack: state.viewStack,
|
viewStack: state.viewStack,
|
||||||
};
|
};
|
||||||
await storageApi.set({ autistmask: persisted });
|
await storageSet({ autistmask: persisted });
|
||||||
}
|
}
|
||||||
|
|
||||||
async function loadState() {
|
async function loadState() {
|
||||||
const result = await storageApi.get("autistmask");
|
const result = await storageGet("autistmask");
|
||||||
if (result.autistmask) {
|
if (result.autistmask) {
|
||||||
const saved = result.autistmask;
|
const saved = result.autistmask;
|
||||||
state.wallets = saved.wallets || [];
|
state.wallets = saved.wallets || [];
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
// Wallet and address deletion state transitions, kept out of the views so the
|
// Wallet and address deletion state transitions, kept out of the views so the
|
||||||
// selection and broadcast rules are testable without a DOM.
|
// selection and broadcast rules are testable without a DOM.
|
||||||
|
|
||||||
|
const { notify } = require("./browserApi");
|
||||||
|
|
||||||
// Two records of the same address can be stored in different cases, so
|
// Two records of the same address can be stored in different cases, so
|
||||||
// address equality is never a literal string comparison.
|
// address equality is never a literal string comparison.
|
||||||
function sameAddress(a, b) {
|
function sameAddress(a, b) {
|
||||||
@@ -144,9 +146,7 @@ function removeAddressFromState(state, walletIdx, addrIdx) {
|
|||||||
// accountsChanged to connected sites. Same call shape as the address
|
// accountsChanged to connected sites. Same call shape as the address
|
||||||
// switch in the home view.
|
// switch in the home view.
|
||||||
function broadcastActiveChanged() {
|
function broadcastActiveChanged() {
|
||||||
const runtime =
|
notify({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
||||||
typeof browser !== "undefined" ? browser.runtime : chrome.runtime;
|
|
||||||
runtime.sendMessage({ type: "AUTISTMASK_ACTIVE_CHANGED" });
|
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
|||||||
@@ -1,329 +0,0 @@
|
|||||||
// Back after reopening the popup (#268).
|
|
||||||
//
|
|
||||||
// A reopened popup renders the wallet list and the one view it restores
|
|
||||||
// onto; every other view is still the blank static template from
|
|
||||||
// index.html. goBack() used to only unhide its target, so Back landed on
|
|
||||||
// that blank template for any view the popup had not rendered in this page
|
|
||||||
// load. These tests drive the real goBack() with the real router wired to
|
|
||||||
// recording view modules, so what is asserted is which view render ran —
|
|
||||||
// the thing that was missing.
|
|
||||||
//
|
|
||||||
// The rendering itself is asserted against the real popup in a real
|
|
||||||
// browser by tests/e2e/run.js; here the DOM is a stub, because goBack()
|
|
||||||
// only needs showView() to work.
|
|
||||||
|
|
||||||
const els = new Map();
|
|
||||||
|
|
||||||
function fakeEl() {
|
|
||||||
return {
|
|
||||||
textContent: "",
|
|
||||||
innerHTML: "",
|
|
||||||
classList: {
|
|
||||||
toggle() {},
|
|
||||||
add() {},
|
|
||||||
remove() {},
|
|
||||||
contains: () => false,
|
|
||||||
},
|
|
||||||
remove() {},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
globalThis.document = {
|
|
||||||
getElementById(id) {
|
|
||||||
if (!els.has(id)) els.set(id, fakeEl());
|
|
||||||
return els.get(id);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// helpers.js pulls in state.js, which reads chrome.storage.local at load.
|
|
||||||
globalThis.chrome = {
|
|
||||||
storage: { local: { get: async () => ({}), set: async () => {} } },
|
|
||||||
};
|
|
||||||
|
|
||||||
const {
|
|
||||||
showView,
|
|
||||||
goBack,
|
|
||||||
setBackRenderer,
|
|
||||||
pushCurrentView,
|
|
||||||
} = require("../src/popup/views/helpers");
|
|
||||||
const {
|
|
||||||
makeBackRenderer,
|
|
||||||
markViewRendered,
|
|
||||||
resetRenderedViews,
|
|
||||||
} = require("../src/popup/viewRouter");
|
|
||||||
const { state } = require("../src/shared/state");
|
|
||||||
|
|
||||||
const ADDRESS = "0x1111111111111111111111111111111111111111";
|
|
||||||
const TOKEN = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
|
|
||||||
|
|
||||||
let calls;
|
|
||||||
|
|
||||||
// Stand-ins for the view modules. Each records itself and then shows its
|
|
||||||
// view, which is what every real view render ends with — so the assertions
|
|
||||||
// can tell "rendered and shown" apart from "merely unhidden".
|
|
||||||
function recorder(name, view) {
|
|
||||||
return () => {
|
|
||||||
calls.push(name);
|
|
||||||
showView(view);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function makeViews() {
|
|
||||||
return {
|
|
||||||
main: { show: recorder("main", "main") },
|
|
||||||
addressDetail: { show: recorder("addressDetail", "address") },
|
|
||||||
addressToken: { show: recorder("addressToken", "address-token") },
|
|
||||||
receive: { show: recorder("receive", "receive") },
|
|
||||||
settings: { show: recorder("settings", "settings") },
|
|
||||||
settingsAddToken: {
|
|
||||||
show: recorder("settingsAddToken", "settings-addtoken"),
|
|
||||||
},
|
|
||||||
confirmTx: { restore: recorder("confirmTx", "confirm-tx") },
|
|
||||||
transactionDetail: {
|
|
||||||
render: recorder("transactionDetail", "transaction"),
|
|
||||||
},
|
|
||||||
txStatus: {
|
|
||||||
restoreWait: () => {
|
|
||||||
calls.push("waitTx");
|
|
||||||
showView("wait-tx");
|
|
||||||
return true;
|
|
||||||
},
|
|
||||||
renderSuccess: recorder("successTx", "success-tx"),
|
|
||||||
renderError: recorder("errorTx", "error-tx"),
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// The popup as it stands just after a reopen: one wallet with one address,
|
|
||||||
// the view the popup restored onto, and the stack behind it.
|
|
||||||
//
|
|
||||||
// A reopen is a fresh page load, so the record of what has been rendered
|
|
||||||
// starts empty — that emptiness is what makes the Back path render at all.
|
|
||||||
// Returns the view modules so a test can drive forward navigation through
|
|
||||||
// the same recorders the router renders through.
|
|
||||||
function reopenedOn(view, stack, extra) {
|
|
||||||
calls = [];
|
|
||||||
resetRenderedViews();
|
|
||||||
state.wallets = [
|
|
||||||
{
|
|
||||||
name: "Wallet 1",
|
|
||||||
addresses: [{ address: ADDRESS, balance: "0", tokenBalances: [] }],
|
|
||||||
},
|
|
||||||
];
|
|
||||||
state.selectedWallet = 0;
|
|
||||||
state.selectedAddress = 0;
|
|
||||||
state.selectedToken = null;
|
|
||||||
state.viewData = null;
|
|
||||||
state.currentView = view;
|
|
||||||
state.viewStack = stack.slice();
|
|
||||||
Object.assign(state, extra || {});
|
|
||||||
// Restoring onto a view renders it, so the reopened popup has that one
|
|
||||||
// view on the page and nothing else.
|
|
||||||
markViewRendered(view);
|
|
||||||
const views = makeViews();
|
|
||||||
setBackRenderer(makeBackRenderer(state, views));
|
|
||||||
return views;
|
|
||||||
}
|
|
||||||
|
|
||||||
// The reproduction from the issue, step for step.
|
|
||||||
describe("Back onto a view the reopened popup never rendered", () => {
|
|
||||||
test("Back from settings renders the address detail underneath", () => {
|
|
||||||
reopenedOn("settings", ["main", "address"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["addressDetail"]);
|
|
||||||
expect(state.currentView).toBe("address");
|
|
||||||
expect(state.viewStack).toEqual(["main"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto the token detail renders it", () => {
|
|
||||||
reopenedOn("settings", ["main", "address", "address-token"], {
|
|
||||||
selectedToken: TOKEN,
|
|
||||||
});
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["addressToken"]);
|
|
||||||
expect(state.currentView).toBe("address-token");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto Receive renders it", () => {
|
|
||||||
reopenedOn("settings", ["main", "address", "receive"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["receive"]);
|
|
||||||
expect(state.currentView).toBe("receive");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto the transaction detail renders it", () => {
|
|
||||||
reopenedOn("settings", ["main", "transaction"], {
|
|
||||||
viewData: { tx: { hash: "0xdead" } },
|
|
||||||
});
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["transactionDetail"]);
|
|
||||||
expect(state.currentView).toBe("transaction");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto the transaction confirmation restores it", () => {
|
|
||||||
reopenedOn("settings", ["main", "confirm-tx"], {
|
|
||||||
viewData: { pendingTx: { to: ADDRESS, amount: "1" } },
|
|
||||||
});
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["confirmTx"]);
|
|
||||||
expect(state.currentView).toBe("confirm-tx");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto the success screen renders it", () => {
|
|
||||||
reopenedOn("settings", ["main", "success-tx"], {
|
|
||||||
viewData: { hash: "0xdead" },
|
|
||||||
});
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["successTx"]);
|
|
||||||
expect(state.currentView).toBe("success-tx");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto the failure screen renders it", () => {
|
|
||||||
reopenedOn("settings", ["main", "error-tx"], {
|
|
||||||
viewData: { message: "execution reverted" },
|
|
||||||
});
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["errorTx"]);
|
|
||||||
expect(state.currentView).toBe("error-tx");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto Home renders the wallet list", () => {
|
|
||||||
reopenedOn("settings", ["main"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back with an empty stack renders Home", () => {
|
|
||||||
reopenedOn("settings", []);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// The guards are restoreView()'s, so a popped view whose backing data is
|
|
||||||
// gone lands on Home rather than on an empty template.
|
|
||||||
describe("Back onto a view whose backing data is gone", () => {
|
|
||||||
test("the token detail with no token selected falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "address-token"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the transaction detail with no transaction falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "transaction"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the confirmation with no pending transaction falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "confirm-tx"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an address view with no address selected falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "receive"], {
|
|
||||||
selectedAddress: null,
|
|
||||||
});
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the success screen with no transaction hash falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "success-tx"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the failure screen with no message falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "error-tx"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a wait that can no longer be resumed falls back to Home", () => {
|
|
||||||
reopenedOn("settings", ["main", "wait-tx"]);
|
|
||||||
const views = makeViews();
|
|
||||||
views.txStatus.restoreWait = () => false;
|
|
||||||
setBackRenderer(makeBackRenderer(state, views));
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// Forward navigation renders as it goes, and a second render would re-fetch
|
|
||||||
// and clobber whatever the view holds — an unsaved edit, a request in
|
|
||||||
// flight. So the Back path renders only a view this page load has never
|
|
||||||
// rendered, and merely unhides every other one: the views it does not
|
|
||||||
// render from persisted state, and the views already on the page.
|
|
||||||
describe("what the Back path leaves alone", () => {
|
|
||||||
test("forward navigation renders nothing by itself", () => {
|
|
||||||
reopenedOn("address", ["main"]);
|
|
||||||
pushCurrentView();
|
|
||||||
showView("send");
|
|
||||||
expect(calls).toEqual([]);
|
|
||||||
expect(state.viewStack).toEqual(["main", "address"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto a live-session view only unhides it", () => {
|
|
||||||
reopenedOn("confirm-tx", ["main", "address", "send"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual([]);
|
|
||||||
expect(state.currentView).toBe("send");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back renders its target exactly once", () => {
|
|
||||||
reopenedOn("settings", ["main", "address"]);
|
|
||||||
goBack();
|
|
||||||
expect(calls.filter((c) => c === "addressDetail")).toHaveLength(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("Back onto a view this page load already rendered only unhides it", () => {
|
|
||||||
const views = reopenedOn("main", []);
|
|
||||||
pushCurrentView();
|
|
||||||
views.addressDetail.show();
|
|
||||||
pushCurrentView();
|
|
||||||
views.settings.show();
|
|
||||||
calls = [];
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual([]);
|
|
||||||
expect(state.currentView).toBe("address");
|
|
||||||
});
|
|
||||||
|
|
||||||
// The unit mirror of the regression the browser suite pins: Settings
|
|
||||||
// reassigns its fields from persisted state on every render, so a
|
|
||||||
// re-render on the way back discards an edit the user has not saved.
|
|
||||||
test("Back onto Settings visited earlier in this page load does not re-render it", () => {
|
|
||||||
const views = reopenedOn("main", []);
|
|
||||||
pushCurrentView();
|
|
||||||
views.settings.show();
|
|
||||||
pushCurrentView();
|
|
||||||
views.settingsAddToken.show();
|
|
||||||
calls = [];
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual([]);
|
|
||||||
expect(state.currentView).toBe("settings");
|
|
||||||
});
|
|
||||||
|
|
||||||
// Home is the deliberate exception, unchanged from the popup's
|
|
||||||
// behaviour before the router existed: it re-renders on every Back so
|
|
||||||
// the wallet list reflects what changed while the user was away.
|
|
||||||
test("Back onto Home renders it again even when it is already on the page", () => {
|
|
||||||
const views = reopenedOn("main", []);
|
|
||||||
pushCurrentView();
|
|
||||||
views.addressDetail.show();
|
|
||||||
calls = [];
|
|
||||||
goBack();
|
|
||||||
expect(calls).toEqual(["main"]);
|
|
||||||
expect(state.currentView).toBe("main");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
238
tests/e2e/firefox/dapp.js
Normal file
238
tests/e2e/firefox/dapp.js
Normal file
@@ -0,0 +1,238 @@
|
|||||||
|
// A loopback dApp origin and stub Ethereum node for the Firefox suite.
|
||||||
|
//
|
||||||
|
// The Firefox container runs with --network none, and the harness note in
|
||||||
|
// driver.js records the consequence: with no http:// origin in reach, no
|
||||||
|
// content script was ever injected, so content-script behaviour was
|
||||||
|
// UNVERIFIED and the dApp flows could not be driven at all.
|
||||||
|
//
|
||||||
|
// --network none removes every interface except loopback, and loopback is
|
||||||
|
// enough. This serves the page and the JSON-RPC endpoint from 127.0.0.1
|
||||||
|
// inside the same container Firefox runs in, so the dApp round trips execute
|
||||||
|
// against a real http:// origin and the run stays as offline as it was: the
|
||||||
|
// only reachable peer is this process.
|
||||||
|
//
|
||||||
|
// The page itself is not written twice. DAPP_HTML comes from the Chrome
|
||||||
|
// suite's fixture, so both harnesses drive the same __dapp API and the same
|
||||||
|
// message log.
|
||||||
|
//
|
||||||
|
// Unlike driver.js this file does use ethers, and it has to: the node has to
|
||||||
|
// answer eth_sendRawTransaction with the hash ethers computes for the
|
||||||
|
// artifact it was handed, or provider.broadcastTransaction() refuses the
|
||||||
|
// answer, and the suite recovers signatures itself rather than believing the
|
||||||
|
// extension's own verdict.
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
const http = require("http");
|
||||||
|
|
||||||
|
const { Transaction } = require("ethers");
|
||||||
|
|
||||||
|
const { DAPP_HTML } = require("../network");
|
||||||
|
|
||||||
|
// The same fee shape the Chrome suite uses, for the same reason: it has to
|
||||||
|
// pass the ceilings in src/shared/approvalVerify.js and it has to leave the
|
||||||
|
// reserve and the estimate distinguishable.
|
||||||
|
const GAS_LIMIT = 21000n;
|
||||||
|
const BASE_FEE_WEI = 100000000000n; // 100 gwei
|
||||||
|
const PRIORITY_FEE_WEI = 1000000000n; // 1 gwei
|
||||||
|
const GAS_PRICE_WEI = BASE_FEE_WEI + PRIORITY_FEE_WEI;
|
||||||
|
|
||||||
|
const STUB_BLOCK_NUMBER = 21000000;
|
||||||
|
|
||||||
|
// A 32-byte zero word, returned for every eth_call. It is what makes ethers'
|
||||||
|
// ENS reverse lookup resolve to "no resolver set" instead of throwing, and a
|
||||||
|
// throw there reaches the console through src/shared/log.js, which fails the
|
||||||
|
// run on its own.
|
||||||
|
const ZERO_WORD = "0x" + "0".repeat(64);
|
||||||
|
|
||||||
|
// One ETH, so the popup's balance lines render something and the wallet does
|
||||||
|
// not look empty on the approval screen.
|
||||||
|
const STUB_BALANCE_WEI = 10n ** 18n;
|
||||||
|
|
||||||
|
function hex(value) {
|
||||||
|
return "0x" + BigInt(value).toString(16);
|
||||||
|
}
|
||||||
|
|
||||||
|
function latestBlock() {
|
||||||
|
return {
|
||||||
|
hash: "0x" + "11".repeat(32),
|
||||||
|
parentHash: "0x" + "22".repeat(32),
|
||||||
|
number: hex(STUB_BLOCK_NUMBER),
|
||||||
|
timestamp: hex(1767326645),
|
||||||
|
nonce: "0x0000000000000000",
|
||||||
|
difficulty: "0x0",
|
||||||
|
gasLimit: "0x1c9c380",
|
||||||
|
gasUsed: "0xf4240",
|
||||||
|
miner: "0xc0ffee0000000000000000000000000000c0ffee",
|
||||||
|
extraData: "0x",
|
||||||
|
baseFeePerGas: hex(BASE_FEE_WEI),
|
||||||
|
transactions: [],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const RPC_RESULTS = {
|
||||||
|
eth_chainId: "0x1",
|
||||||
|
net_version: "1",
|
||||||
|
eth_blockNumber: hex(STUB_BLOCK_NUMBER),
|
||||||
|
eth_getBalance: hex(STUB_BALANCE_WEI),
|
||||||
|
eth_call: ZERO_WORD,
|
||||||
|
eth_getCode: "0x",
|
||||||
|
eth_gasPrice: hex(GAS_PRICE_WEI),
|
||||||
|
eth_estimateGas: hex(GAS_LIMIT),
|
||||||
|
eth_getTransactionCount: "0x0",
|
||||||
|
eth_maxPriorityFeePerGas: hex(PRIORITY_FEE_WEI),
|
||||||
|
// "accepted but not mined", which is what a node says about a transaction
|
||||||
|
// it has only just taken. The wait screen the approval hands off to polls
|
||||||
|
// this for the rest of the run.
|
||||||
|
eth_getTransactionReceipt: null,
|
||||||
|
web3_clientVersion: "autistmask-e2e-firefox/0",
|
||||||
|
};
|
||||||
|
|
||||||
|
// Answer one JSON-RPC call. `broadcast` collects every raw transaction that
|
||||||
|
// reached this node, which is what the transaction assertions are made
|
||||||
|
// against — the artifact as the node saw it, never as the extension described
|
||||||
|
// it.
|
||||||
|
function rpcResult(req, state) {
|
||||||
|
const method = req.method;
|
||||||
|
|
||||||
|
if (method === "eth_sendRawTransaction") {
|
||||||
|
const raw = req.params && req.params[0];
|
||||||
|
state.broadcast.push(raw);
|
||||||
|
// ethers checks the hash it is given against the hash it computes for
|
||||||
|
// the artifact it sent, so this cannot be a fixed string.
|
||||||
|
return Transaction.from(raw).hash;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (method === "eth_getBlockByNumber" || method === "eth_getBlockByHash") {
|
||||||
|
return latestBlock();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Object.prototype.hasOwnProperty.call(RPC_RESULTS, method)) {
|
||||||
|
return RPC_RESULTS[method];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Never a silent default. An unstubbed method answered with null looks
|
||||||
|
// like a working node returning nothing, and the assertion downstream
|
||||||
|
// fails somewhere unrelated.
|
||||||
|
state.unstubbed.push(method);
|
||||||
|
throw new Error("no fixture for JSON-RPC method " + method);
|
||||||
|
}
|
||||||
|
|
||||||
|
function readBody(req) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
let body = "";
|
||||||
|
req.on("data", (chunk) => {
|
||||||
|
body += chunk;
|
||||||
|
});
|
||||||
|
req.on("end", () => resolve(body));
|
||||||
|
req.on("error", reject);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleRpcBody(body, state) {
|
||||||
|
const parsed = JSON.parse(body);
|
||||||
|
const answer = (req) => {
|
||||||
|
try {
|
||||||
|
return {
|
||||||
|
jsonrpc: "2.0",
|
||||||
|
id: req.id,
|
||||||
|
result: rpcResult(req, state),
|
||||||
|
};
|
||||||
|
} catch (e) {
|
||||||
|
return {
|
||||||
|
jsonrpc: "2.0",
|
||||||
|
id: req.id,
|
||||||
|
error: { code: -32601, message: e.message },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
return Array.isArray(parsed) ? parsed.map(answer) : answer(parsed);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Serve the dApp page and the stub node on loopback.
|
||||||
|
*
|
||||||
|
* @returns {Promise<Object>} the running fixture: `url` and `origin` of the
|
||||||
|
* page, `rpcUrl` for the extension's rpcUrl setting, `broadcast` (the raw
|
||||||
|
* transactions the node received, in order), `unstubbed` (JSON-RPC methods
|
||||||
|
* nothing answered) and `close()`.
|
||||||
|
*/
|
||||||
|
async function startDappServer() {
|
||||||
|
const state = { broadcast: [], unstubbed: [], requests: [] };
|
||||||
|
|
||||||
|
const server = http.createServer((req, res) => {
|
||||||
|
const url = new URL(req.url, "http://127.0.0.1");
|
||||||
|
state.requests.push(req.method + " " + url.pathname);
|
||||||
|
|
||||||
|
if (url.pathname === "/rpc" && req.method === "POST") {
|
||||||
|
readBody(req)
|
||||||
|
.then((body) => {
|
||||||
|
const payload = JSON.stringify(handleRpcBody(body, state));
|
||||||
|
res.writeHead(200, {
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
// The extension fetches this from its background
|
||||||
|
// page, whose origin is moz-extension://. Without CORS
|
||||||
|
// the fetch fails and every transaction assertion
|
||||||
|
// fails for a reason that has nothing to do with the
|
||||||
|
// wallet.
|
||||||
|
"Access-Control-Allow-Origin": "*",
|
||||||
|
});
|
||||||
|
res.end(payload);
|
||||||
|
})
|
||||||
|
.catch((e) => {
|
||||||
|
res.writeHead(500, { "Content-Type": "text/plain" });
|
||||||
|
res.end(String(e && e.message));
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url.pathname === "/") {
|
||||||
|
res.writeHead(200, { "Content-Type": "text/html; charset=utf-8" });
|
||||||
|
res.end(DAPP_HTML);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// An empty favicon rather than a 404: a 404 is a page error in
|
||||||
|
// Firefox's console under some settings, and the suite fails the run
|
||||||
|
// on those.
|
||||||
|
if (url.pathname === "/favicon.ico") {
|
||||||
|
res.writeHead(200, { "Content-Type": "image/x-icon" });
|
||||||
|
res.end("");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
res.writeHead(404, { "Content-Type": "text/plain" });
|
||||||
|
res.end("not found");
|
||||||
|
});
|
||||||
|
|
||||||
|
await new Promise((resolve, reject) => {
|
||||||
|
server.on("error", reject);
|
||||||
|
// Port 0: this host runs many sessions at once, and a fixed port is a
|
||||||
|
// guaranteed collision rather than a possible one.
|
||||||
|
server.listen(0, "127.0.0.1", resolve);
|
||||||
|
});
|
||||||
|
|
||||||
|
const { port } = server.address();
|
||||||
|
const origin = "http://127.0.0.1:" + port;
|
||||||
|
|
||||||
|
return {
|
||||||
|
origin,
|
||||||
|
url: origin + "/",
|
||||||
|
rpcUrl: origin + "/rpc",
|
||||||
|
broadcast: state.broadcast,
|
||||||
|
unstubbed: state.unstubbed,
|
||||||
|
requests: state.requests,
|
||||||
|
close: () =>
|
||||||
|
new Promise((resolve) => {
|
||||||
|
server.closeAllConnections();
|
||||||
|
server.close(() => resolve());
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
GAS_LIMIT,
|
||||||
|
GAS_PRICE_WEI,
|
||||||
|
STUB_BALANCE_WEI,
|
||||||
|
startDappServer,
|
||||||
|
};
|
||||||
@@ -110,6 +110,26 @@ class Driver {
|
|||||||
"extensions.webextensions.uuids": JSON.stringify({
|
"extensions.webextensions.uuids": JSON.stringify({
|
||||||
[EXTENSION_ID]: EXTENSION_UUID,
|
[EXTENSION_ID]: EXTENSION_UUID,
|
||||||
}),
|
}),
|
||||||
|
// The container has loopback and nothing else. Firefox's own
|
||||||
|
// link-status detection can read that as "offline" and then
|
||||||
|
// refuse every request, including the ones to the loopback dApp
|
||||||
|
// origin the suite serves; this takes the decision away from it.
|
||||||
|
"network.manage-offline-status": false,
|
||||||
|
// Force the site-connection prompt down its windows.create()
|
||||||
|
// fallback.
|
||||||
|
//
|
||||||
|
// src/background/index.js prefers the toolbar-anchored popup for
|
||||||
|
// that one approval and opens a real window only when
|
||||||
|
// openPopup() refuses. A panel is not a top-level browsing
|
||||||
|
// context, so WebDriver cannot see it, list it or click in it —
|
||||||
|
// the same blind spot the Chrome harness documents. Leaving this
|
||||||
|
// at its default would make which path runs depend on whether a
|
||||||
|
// headless Firefox counts as having had a user gesture, which is
|
||||||
|
// not a thing to leave to chance in a suite that has to be able
|
||||||
|
// to fail. The window path is shipped code and the same approval
|
||||||
|
// id, so what is driven is real; what is NOT covered either way
|
||||||
|
// is the panel presentation itself.
|
||||||
|
"extensions.openPopupWithoutUserGesture.enabled": false,
|
||||||
};
|
};
|
||||||
|
|
||||||
const value = await this.send("POST", "/session", {
|
const value = await this.send("POST", "/session", {
|
||||||
@@ -179,6 +199,16 @@ class Driver {
|
|||||||
return this.session("POST", "/execute/sync", { script, args });
|
return this.session("POST", "/execute/sync", { script, args });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The asynchronous form: the script is handed a resolve callback as its
|
||||||
|
// last argument and the call settles when that is invoked. Everything
|
||||||
|
// interesting about an extension page is promise-shaped — storage reads,
|
||||||
|
// the provider's own request() — and /execute/sync cannot wait for any
|
||||||
|
// of it.
|
||||||
|
async executeAsync(script, args = []) {
|
||||||
|
await this.setContext("content");
|
||||||
|
return this.session("POST", "/execute/async", { script, args });
|
||||||
|
}
|
||||||
|
|
||||||
// Runs in the privileged chrome scope, where Services and Ci exist.
|
// Runs in the privileged chrome scope, where Services and Ci exist.
|
||||||
async executeChrome(script, args = []) {
|
async executeChrome(script, args = []) {
|
||||||
await this.setContext("chrome");
|
await this.setContext("chrome");
|
||||||
@@ -329,6 +359,63 @@ class Driver {
|
|||||||
[selector],
|
[selector],
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ------------------------------------------------------------ windows
|
||||||
|
//
|
||||||
|
// The approval prompts this suite drives are separate top-level windows
|
||||||
|
// the extension opens itself, so every one of them is a window handle
|
||||||
|
// here and the suite has to move between them explicitly.
|
||||||
|
|
||||||
|
async windowHandles() {
|
||||||
|
return this.session("GET", "/window/handles");
|
||||||
|
}
|
||||||
|
|
||||||
|
async currentWindow() {
|
||||||
|
return this.session("GET", "/window");
|
||||||
|
}
|
||||||
|
|
||||||
|
async switchToWindow(handle) {
|
||||||
|
await this.setContext("content");
|
||||||
|
await this.session("POST", "/window", { handle });
|
||||||
|
}
|
||||||
|
|
||||||
|
async newWindow(type = "window") {
|
||||||
|
await this.setContext("content");
|
||||||
|
const value = await this.session("POST", "/window/new", { type });
|
||||||
|
return value.handle;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Closes the current window and leaves the session on `fallback`, because
|
||||||
|
// a session whose current window is gone fails every subsequent command
|
||||||
|
// with "no such window" rather than with anything diagnosable.
|
||||||
|
async closeWindow(fallback) {
|
||||||
|
await this.setContext("content");
|
||||||
|
await this.session("DELETE", "/window");
|
||||||
|
if (fallback) await this.switchToWindow(fallback);
|
||||||
|
}
|
||||||
|
|
||||||
|
async url() {
|
||||||
|
return this.session("GET", "/url");
|
||||||
|
}
|
||||||
|
|
||||||
|
// The handle of the first window whose URL matches, or null. Restores the
|
||||||
|
// window that was current before the search either way: a probe that
|
||||||
|
// silently relocates the session is a trap for the step after it.
|
||||||
|
async findWindow(predicate) {
|
||||||
|
const origin = await this.currentWindow();
|
||||||
|
try {
|
||||||
|
for (const handle of await this.windowHandles()) {
|
||||||
|
await this.switchToWindow(handle);
|
||||||
|
if (predicate(await this.url())) return handle;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
} finally {
|
||||||
|
// Tolerated: the window the search started from may have been the
|
||||||
|
// one that just closed, and a throw in here would replace the
|
||||||
|
// real result with "no such window".
|
||||||
|
await this.switchToWindow(origin).catch(() => {});
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ------------------------------------------------------- error capture
|
// ------------------------------------------------------- error capture
|
||||||
@@ -349,10 +436,15 @@ class Driver {
|
|||||||
// background page, which BiDi would not have covered even if it worked.
|
// background page, which BiDi would not have covered even if it worked.
|
||||||
// Background-page capture is verified by probe — a throw at the top of
|
// Background-page capture is verified by probe — a throw at the top of
|
||||||
// src/background/index.js, which kills the background page outright, fails
|
// src/background/index.js, which kills the background page outright, fails
|
||||||
// the run. Content-script errors should arrive by the same route, but that
|
// the run.
|
||||||
// is UNVERIFIED here and must not be claimed: the container runs with
|
//
|
||||||
// --network none, so there is no http:// page for a content script to be
|
// Content scripts ARE now exercised: tests/e2e/firefox/dapp.js serves a page
|
||||||
// injected into and this suite never exercises one.
|
// from loopback, which survives --network none, and the suite drives the
|
||||||
|
// EIP-1193 round trips through the content script injected into it. What is
|
||||||
|
// still unproven is the CAPTURE, not the execution — no probe has forced a
|
||||||
|
// throw from inside a content script and watched it fail the run, so an
|
||||||
|
// uncaught content-script error arriving by this route remains an
|
||||||
|
// expectation rather than a demonstrated fact. Do not claim otherwise.
|
||||||
//
|
//
|
||||||
// Warnings are excluded so the semantics match Playwright's pageerror:
|
// Warnings are excluded so the semantics match Playwright's pageerror:
|
||||||
// uncaught errors only.
|
// uncaught errors only.
|
||||||
|
|||||||
@@ -15,8 +15,15 @@
|
|||||||
// UI steps below are written twice on purpose. Chrome runs on Playwright,
|
// UI steps below are written twice on purpose. Chrome runs on Playwright,
|
||||||
// which cannot see extension-page errors in Firefox at all (see the BiDi
|
// which cannot see extension-page errors in Firefox at all (see the BiDi
|
||||||
// note in driver.js), so the two backends have no common substrate to
|
// note in driver.js), so the two backends have no common substrate to
|
||||||
// abstract over. Three duplicated steps do not pay for a shim; revisit if
|
// abstract over. Duplicated steps do not pay for a shim; revisit if this
|
||||||
// this suite grows to where they do.
|
// suite grows to where they do. What IS shared is the dApp page fixture
|
||||||
|
// itself — DAPP_HTML, served here from loopback by dapp.js — so an assertion
|
||||||
|
// about the __dapp API means the same thing on both browsers.
|
||||||
|
//
|
||||||
|
// The dApp steps need an http:// origin, which --network none was thought to
|
||||||
|
// rule out. It does not: loopback survives it, so the page and the stub node
|
||||||
|
// are served from 127.0.0.1 inside the container and the run reaches nothing
|
||||||
|
// but this process. See tests/e2e/firefox/dapp.js.
|
||||||
//
|
//
|
||||||
// LIMITATION, and the difference from the Chrome suite worth knowing: error
|
// LIMITATION, and the difference from the Chrome suite worth knowing: error
|
||||||
// capture here is POLL-BASED, not event-streamed. The console service is
|
// capture here is POLL-BASED, not event-streamed. The console service is
|
||||||
@@ -40,7 +47,21 @@
|
|||||||
const fs = require("fs");
|
const fs = require("fs");
|
||||||
const path = require("path");
|
const path = require("path");
|
||||||
|
|
||||||
|
const {
|
||||||
|
Transaction,
|
||||||
|
formatEther,
|
||||||
|
getAddress,
|
||||||
|
getBytes,
|
||||||
|
hexlify,
|
||||||
|
parseEther,
|
||||||
|
toQuantity,
|
||||||
|
toUtf8Bytes,
|
||||||
|
verifyMessage,
|
||||||
|
} = require("ethers");
|
||||||
|
|
||||||
const { ConsoleErrors, EXTENSION_ORIGIN, start, sleep } = require("./driver");
|
const { ConsoleErrors, EXTENSION_ORIGIN, start, sleep } = require("./driver");
|
||||||
|
const { startDappServer } = require("./dapp");
|
||||||
|
const { STUB_COUNTERPARTY } = require("../network");
|
||||||
|
|
||||||
const REPO_ROOT = path.resolve(__dirname, "..", "..", "..");
|
const REPO_ROOT = path.resolve(__dirname, "..", "..", "..");
|
||||||
const POPUP_URL = EXTENSION_ORIGIN + "/src/popup/index.html";
|
const POPUP_URL = EXTENSION_ORIGIN + "/src/popup/index.html";
|
||||||
@@ -137,8 +158,596 @@ step("add token screen opens from address detail", async (env) => {
|
|||||||
assert(picks > 0, "no common-token quick-pick buttons rendered");
|
assert(picks > 0, "no common-token quick-pick buttons rendered");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// ------------------------------------------------- the dApp round trips
|
||||||
|
//
|
||||||
|
// Everything above drives the popup on its own. From here the page, the
|
||||||
|
// content script, the inpage provider, the background page and the approval
|
||||||
|
// window all have to work together, which on Firefox is exactly the seam
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/153 is about: every one of
|
||||||
|
// these paths used to hand a Chrome-style callback to the promise-only
|
||||||
|
// browser.* namespace and simply never complete.
|
||||||
|
//
|
||||||
|
// The shape is the Chrome suite's (tests/e2e/run.js, the #183 section) and
|
||||||
|
// the assertions mean the same things:
|
||||||
|
//
|
||||||
|
// - the signature is recovered here, in the runner, from the artifact the
|
||||||
|
// extension produced, and compared against the address read out of
|
||||||
|
// extension storage. The background verifies too; these assertions do not
|
||||||
|
// lean on that, because a test that trusted the wallet's own verdict would
|
||||||
|
// pass against a wallet that verified nothing.
|
||||||
|
// - the transaction is asserted against the raw signed transaction that
|
||||||
|
// reached the stub node, not against anything the extension reported.
|
||||||
|
//
|
||||||
|
// What this does NOT cover: a real dApp with real funds against a real
|
||||||
|
// network. The node is a fixture on loopback.
|
||||||
|
|
||||||
|
const SIGN_TEXT = "AutistMask e2e round trip: personal_sign";
|
||||||
|
const SIGN_HEX = hexlify(toUtf8Bytes(SIGN_TEXT));
|
||||||
|
|
||||||
|
const TX_VALUE_ETH = "0.0123";
|
||||||
|
const TX_VALUE_WEI = parseEther(TX_VALUE_ETH);
|
||||||
|
// Call data that decodes as nothing, so the screen assertion compares the
|
||||||
|
// calldata itself rather than a decoder's summary of it.
|
||||||
|
const TX_DATA = "0xdeadbeef" + "01".repeat(28);
|
||||||
|
|
||||||
|
const USER_REJECTION_MESSAGE = "User rejected the request.";
|
||||||
|
|
||||||
|
// Read the extension's persisted state, point its rpcUrl at the loopback stub
|
||||||
|
// node, and hand back the active address. Runs on the popup page, which is
|
||||||
|
// the one moz-extension:// document the suite has open and therefore the only
|
||||||
|
// place the storage API is reachable from.
|
||||||
|
async function pointAtStubNode(d, rpcUrl) {
|
||||||
|
const outcome = await d.executeAsync(
|
||||||
|
`const done = arguments[arguments.length - 1];
|
||||||
|
const rpcUrl = arguments[0];
|
||||||
|
const api = typeof browser !== "undefined" ? browser : chrome;
|
||||||
|
Promise.resolve(api.storage.local.get("autistmask"))
|
||||||
|
.then((r) => {
|
||||||
|
const s = r.autistmask;
|
||||||
|
if (!s) throw new Error("the extension has no persisted state");
|
||||||
|
s.rpcUrl = rpcUrl;
|
||||||
|
const w = s.wallets && s.wallets[0];
|
||||||
|
const first = w && w.addresses && w.addresses[0];
|
||||||
|
const address = s.activeAddress || (first && first.address);
|
||||||
|
if (!address) throw new Error("the extension holds no address");
|
||||||
|
return Promise.resolve(api.storage.local.set({ autistmask: s }))
|
||||||
|
.then(() => done({ address: address }));
|
||||||
|
})
|
||||||
|
.catch((e) => done({ error: String((e && e.message) || e) }));`,
|
||||||
|
[rpcUrl],
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome && !outcome.error,
|
||||||
|
"could not point the extension at the stub node: " +
|
||||||
|
(outcome && outcome.error),
|
||||||
|
);
|
||||||
|
return getAddress(outcome.address);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The approval window the background opened. Approvals are raised from an RPC
|
||||||
|
// call rather than from a user gesture, so the extension opens a real window
|
||||||
|
// for them, which is an ordinary window handle here.
|
||||||
|
async function waitForApprovalWindow(d, timeout = 30000) {
|
||||||
|
const deadline = Date.now() + timeout;
|
||||||
|
for (;;) {
|
||||||
|
const handle = await d.findWindow((u) => u.includes("?approval="));
|
||||||
|
if (handle) return handle;
|
||||||
|
if (Date.now() > deadline) {
|
||||||
|
throw new Error(
|
||||||
|
"the extension opened no approval window within " +
|
||||||
|
timeout +
|
||||||
|
"ms",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
await sleep(100);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function startRequest(d, key, method, params) {
|
||||||
|
return d.execute(
|
||||||
|
"window.__dapp.start(arguments[0], arguments[1], arguments[2]);" +
|
||||||
|
" return true;",
|
||||||
|
[key, method, params],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The settled outcome of a parked request, or {settled:"pending"} if it is
|
||||||
|
// still outstanding. A bounded wait rather than a bare await: "returns a
|
||||||
|
// rejection rather than hanging" is one of the things under test, and an
|
||||||
|
// await would report a hang as a step timeout with no indication of which
|
||||||
|
// call never settled.
|
||||||
|
function settleRequest(d, key, timeout = 45000) {
|
||||||
|
return d.executeAsync(
|
||||||
|
`const done = arguments[arguments.length - 1];
|
||||||
|
const key = arguments[0];
|
||||||
|
const timeout = arguments[1];
|
||||||
|
Promise.race([
|
||||||
|
window.__dapp.settle(key),
|
||||||
|
new Promise((r) => setTimeout(() => r({ settled: "pending" }), timeout)),
|
||||||
|
]).then(done, (e) => done({ settled: "error", message: String(e) }));`,
|
||||||
|
[key, timeout],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every AUTISTMASK_* message that has crossed between the page and the
|
||||||
|
// content script. This is the boundary half of the rejection assertion: the
|
||||||
|
// code has to be on the wire as well as on the Error the page catches, so a
|
||||||
|
// pass cannot come from the provider inventing one.
|
||||||
|
function dappMessages(d, type) {
|
||||||
|
return d.execute(
|
||||||
|
// `want` is bound outside the callback deliberately: inside it,
|
||||||
|
// arguments[0] is the message being tested, not the script argument,
|
||||||
|
// and the filter silently matches nothing.
|
||||||
|
"var want = arguments[0];" +
|
||||||
|
" return window.__dapp.messages.filter(function (m) {" +
|
||||||
|
" return !want || m.type === want; });",
|
||||||
|
[type || null],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function lastResponseError(d) {
|
||||||
|
const responses = await dappMessages(d, "AUTISTMASK_RESPONSE");
|
||||||
|
const last = responses[responses.length - 1];
|
||||||
|
assert(last, "the page received no AUTISTMASK_RESPONSE at all");
|
||||||
|
return last.error || null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A rejected prompt, asserted at both ends: the page's promise rejected
|
||||||
|
// rather than hanging or resolving, and the response that crossed the
|
||||||
|
// boundary carried EIP-1193 code 4001.
|
||||||
|
async function assertUserRejection(d, key, label) {
|
||||||
|
const outcome = await settleRequest(d, key);
|
||||||
|
assert(
|
||||||
|
outcome.settled !== "pending",
|
||||||
|
label + " never settled: the rejected prompt left the page hanging",
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.settled === "rejected",
|
||||||
|
label + " resolved instead of rejecting: " + JSON.stringify(outcome),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.message === USER_REJECTION_MESSAGE,
|
||||||
|
label + " rejected with the wrong message: " + outcome.message,
|
||||||
|
);
|
||||||
|
const error = await lastResponseError(d);
|
||||||
|
assert(
|
||||||
|
error && error.code === 4001,
|
||||||
|
label +
|
||||||
|
" did not carry EIP-1193 code 4001 across the boundary: " +
|
||||||
|
JSON.stringify(error),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.hasCode,
|
||||||
|
label +
|
||||||
|
" reached the page as an error with no code property at all, so a " +
|
||||||
|
"dApp cannot tell the user's refusal from a failure: " +
|
||||||
|
JSON.stringify(outcome),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.code === 4001,
|
||||||
|
label +
|
||||||
|
" reached the page with code " +
|
||||||
|
JSON.stringify(outcome.code) +
|
||||||
|
" rather than EIP-1193 4001",
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.name === "ProviderRpcError",
|
||||||
|
label +
|
||||||
|
" reached the page as " +
|
||||||
|
JSON.stringify(outcome.name) +
|
||||||
|
" rather than an EIP-1193 ProviderRpcError",
|
||||||
|
);
|
||||||
|
console.log(
|
||||||
|
"# " +
|
||||||
|
label +
|
||||||
|
": code 4001 on the wire and on the page's " +
|
||||||
|
outcome.name,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
step("the loopback dApp page gets the real inpage provider", async (env) => {
|
||||||
|
const d = env.driver;
|
||||||
|
|
||||||
|
// The popup is still the current window; point the extension at the stub
|
||||||
|
// node from there, then reload it so its in-memory copy of the state
|
||||||
|
// carries the new rpcUrl and cannot save the old one back over it.
|
||||||
|
env.address = await pointAtStubNode(d, env.server.rpcUrl);
|
||||||
|
await d.navigate(POPUP_URL);
|
||||||
|
await d.waitVisible("#view-main", STEP_TIMEOUT_MS);
|
||||||
|
env.popupWindow = await d.currentWindow();
|
||||||
|
|
||||||
|
env.dappWindow = await d.newWindow("tab");
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
await d.navigate(env.server.url);
|
||||||
|
|
||||||
|
// window.ethereum is not the fixture's doing — it is the shipped content
|
||||||
|
// script, injected into a real http:// origin. Waiting for it is waiting
|
||||||
|
// for the real provider to have installed itself.
|
||||||
|
await d.waitFor(
|
||||||
|
"the injected EIP-1193 provider and the test page API",
|
||||||
|
"return !!window.ethereum && !!window.__dapp;",
|
||||||
|
[],
|
||||||
|
STEP_TIMEOUT_MS,
|
||||||
|
);
|
||||||
|
|
||||||
|
// EIP-6963, asked of the provider itself. The announcement carries the
|
||||||
|
// uuid src/content/index.js reads out of extension storage — call site 1
|
||||||
|
// in the issue — and it has to name this extension and hand back the very
|
||||||
|
// object on window.ethereum.
|
||||||
|
const announced = await d.executeAsync(
|
||||||
|
`const done = arguments[arguments.length - 1];
|
||||||
|
const onAnnounce = (e) => {
|
||||||
|
window.removeEventListener("eip6963:announceProvider", onAnnounce);
|
||||||
|
done({
|
||||||
|
rdns: e.detail.info.rdns,
|
||||||
|
uuid: e.detail.info.uuid,
|
||||||
|
isWindowEthereum: e.detail.provider === window.ethereum,
|
||||||
|
});
|
||||||
|
};
|
||||||
|
window.addEventListener("eip6963:announceProvider", onAnnounce);
|
||||||
|
window.dispatchEvent(new Event("eip6963:requestProvider"));
|
||||||
|
setTimeout(() => done(null), 15000);`,
|
||||||
|
);
|
||||||
|
assert(announced, "the provider announced itself to no EIP-6963 request");
|
||||||
|
assert(
|
||||||
|
announced.rdns === "berlin.sneak.autistmask",
|
||||||
|
"the announced provider is not this extension: " +
|
||||||
|
JSON.stringify(announced),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
announced.isWindowEthereum,
|
||||||
|
"the announced provider is not the object on window.ethereum",
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
typeof announced.uuid === "string" && announced.uuid.length === 36,
|
||||||
|
"the announcement carries no stored provider uuid: " +
|
||||||
|
JSON.stringify(announced.uuid),
|
||||||
|
);
|
||||||
|
|
||||||
|
// A full page -> content script -> background round trip that needs no
|
||||||
|
// approval, so the relay is proven before any prompt is driven. This is
|
||||||
|
// call site 2, the one that used to fail for every window.ethereum
|
||||||
|
// request a dApp made.
|
||||||
|
const chainId = await d.executeAsync(
|
||||||
|
`const done = arguments[arguments.length - 1];
|
||||||
|
window.ethereum.request({ method: "eth_chainId" }).then(
|
||||||
|
(r) => done({ ok: r }),
|
||||||
|
(e) => done({ err: String((e && e.message) || e) }),
|
||||||
|
);`,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
chainId && chainId.ok === "0x1",
|
||||||
|
"eth_chainId did not round trip through the extension: " +
|
||||||
|
JSON.stringify(chainId),
|
||||||
|
);
|
||||||
|
console.log(
|
||||||
|
"# dapp origin " + env.server.origin + " active address " + env.address,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
step(
|
||||||
|
"eth_requestAccounts approved returns the selected address",
|
||||||
|
async (env) => {
|
||||||
|
const d = env.driver;
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
await startRequest(d, "accounts", "eth_requestAccounts", []);
|
||||||
|
|
||||||
|
const popup = await waitForApprovalWindow(d);
|
||||||
|
await d.switchToWindow(popup);
|
||||||
|
await d.waitVisible("#view-approve-site");
|
||||||
|
|
||||||
|
const hostname = await d.text("#approve-hostname");
|
||||||
|
assert(
|
||||||
|
hostname === "127.0.0.1",
|
||||||
|
"the site prompt names the wrong origin: " +
|
||||||
|
JSON.stringify(hostname),
|
||||||
|
);
|
||||||
|
const shown = await d.text("#approve-address");
|
||||||
|
assert(
|
||||||
|
shown.toLowerCase().includes(env.address.toLowerCase()),
|
||||||
|
"the site prompt shows the wrong address: " + JSON.stringify(shown),
|
||||||
|
);
|
||||||
|
|
||||||
|
// Remembered, so the origin stays authorized for the sign and transaction
|
||||||
|
// steps below.
|
||||||
|
const checked = await d.execute(
|
||||||
|
'return document.getElementById("approve-remember").checked;',
|
||||||
|
);
|
||||||
|
if (!checked) await d.click("#approve-remember");
|
||||||
|
await d.click("#btn-approve");
|
||||||
|
|
||||||
|
// The approve button closes its own window, so get off it before asking
|
||||||
|
// the page anything.
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
const outcome = await settleRequest(d, "accounts");
|
||||||
|
assert(
|
||||||
|
outcome.settled === "resolved",
|
||||||
|
"eth_requestAccounts did not resolve: " + JSON.stringify(outcome),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
Array.isArray(outcome.result) && outcome.result.length === 1,
|
||||||
|
"eth_requestAccounts returned no single account: " +
|
||||||
|
JSON.stringify(outcome.result),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
getAddress(outcome.result[0]) === env.address,
|
||||||
|
"eth_requestAccounts returned " +
|
||||||
|
outcome.result[0] +
|
||||||
|
", not the selected address " +
|
||||||
|
env.address,
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
step(
|
||||||
|
"personal_sign returns a signature that recovers to the address",
|
||||||
|
async (env) => {
|
||||||
|
const d = env.driver;
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
await startRequest(d, "sign", "personal_sign", [SIGN_HEX, env.address]);
|
||||||
|
|
||||||
|
const popup = await waitForApprovalWindow(d);
|
||||||
|
await d.switchToWindow(popup);
|
||||||
|
await d.waitVisible("#view-approve-sign");
|
||||||
|
|
||||||
|
const screen = await d.execute(
|
||||||
|
`return {
|
||||||
|
hostname: document.getElementById("approve-sign-hostname").textContent,
|
||||||
|
type: document.getElementById("approve-sign-type").textContent,
|
||||||
|
message: document.getElementById("approve-sign-message").textContent,
|
||||||
|
from: document.getElementById("approve-sign-from").textContent,
|
||||||
|
};`,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.hostname === "127.0.0.1",
|
||||||
|
"the sign prompt names the wrong origin: " +
|
||||||
|
JSON.stringify(screen.hostname),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.type === "Personal message",
|
||||||
|
"the sign prompt reports the wrong type: " +
|
||||||
|
JSON.stringify(screen.type),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.message === SIGN_TEXT,
|
||||||
|
"the sign prompt shows the wrong message: " +
|
||||||
|
JSON.stringify(screen.message),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.from.toLowerCase().includes(env.address.toLowerCase()),
|
||||||
|
"the sign prompt shows the wrong signing address: " +
|
||||||
|
JSON.stringify(screen.from),
|
||||||
|
);
|
||||||
|
|
||||||
|
await d.fill("#approve-sign-password", PASSWORD);
|
||||||
|
await d.click("#btn-approve-sign");
|
||||||
|
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
const outcome = await settleRequest(d, "sign");
|
||||||
|
assert(
|
||||||
|
outcome.settled === "resolved",
|
||||||
|
"personal_sign did not resolve: " + JSON.stringify(outcome),
|
||||||
|
);
|
||||||
|
const recovered = getAddress(
|
||||||
|
verifyMessage(getBytes(SIGN_HEX), outcome.result),
|
||||||
|
);
|
||||||
|
console.log(
|
||||||
|
"# personal_sign: recovered=" +
|
||||||
|
recovered +
|
||||||
|
" expected=" +
|
||||||
|
env.address,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
recovered === env.address,
|
||||||
|
"the personal_sign signature recovers to " +
|
||||||
|
recovered +
|
||||||
|
", not to the approved address " +
|
||||||
|
env.address,
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
step(
|
||||||
|
"eth_sendTransaction shows the transaction and returns its hash",
|
||||||
|
async (env) => {
|
||||||
|
const d = env.driver;
|
||||||
|
const before = env.server.broadcast.length;
|
||||||
|
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
await startRequest(d, "tx", "eth_sendTransaction", [
|
||||||
|
{
|
||||||
|
from: env.address,
|
||||||
|
to: STUB_COUNTERPARTY,
|
||||||
|
value: toQuantity(TX_VALUE_WEI),
|
||||||
|
data: TX_DATA,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
|
||||||
|
const popup = await waitForApprovalWindow(d);
|
||||||
|
await d.switchToWindow(popup);
|
||||||
|
await d.waitVisible("#view-approve-tx");
|
||||||
|
|
||||||
|
const screen = await d.execute(
|
||||||
|
`return {
|
||||||
|
hostname: document.getElementById("approve-tx-hostname").textContent,
|
||||||
|
from: document.getElementById("approve-tx-from").textContent,
|
||||||
|
to: document.getElementById("approve-tx-to").textContent,
|
||||||
|
value: document.getElementById("approve-tx-value").textContent,
|
||||||
|
data: document.getElementById("approve-tx-data").textContent,
|
||||||
|
dataShown: !document
|
||||||
|
.getElementById("approve-tx-data-section")
|
||||||
|
.classList.contains("hidden"),
|
||||||
|
};`,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.hostname === "127.0.0.1",
|
||||||
|
"the transaction prompt names the wrong origin: " +
|
||||||
|
JSON.stringify(screen.hostname),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.from.toLowerCase().includes(env.address.toLowerCase()),
|
||||||
|
"the transaction prompt shows the wrong sender: " +
|
||||||
|
JSON.stringify(screen.from),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.to.toLowerCase().includes(STUB_COUNTERPARTY.toLowerCase()),
|
||||||
|
"the transaction prompt shows the wrong recipient: " +
|
||||||
|
JSON.stringify(screen.to),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.value.startsWith(TX_VALUE_ETH + " ETH"),
|
||||||
|
"the transaction prompt shows the wrong value: " +
|
||||||
|
JSON.stringify(screen.value),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
screen.dataShown && screen.data === TX_DATA,
|
||||||
|
"the transaction prompt does not show the approved call data: " +
|
||||||
|
JSON.stringify(screen.data),
|
||||||
|
);
|
||||||
|
|
||||||
|
await d.fill("#approve-tx-password", PASSWORD);
|
||||||
|
await d.click("#btn-approve-tx");
|
||||||
|
|
||||||
|
// The approval window hands off to the wait screen rather than closing,
|
||||||
|
// and the hash it shows is asserted before it is retired: left open it
|
||||||
|
// polls the stub node for a receipt for the rest of the run.
|
||||||
|
await d.waitVisible("#view-wait-tx", STEP_TIMEOUT_MS);
|
||||||
|
const waitHash = await d.text("#wait-tx-hash");
|
||||||
|
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
const outcome = await settleRequest(d, "tx");
|
||||||
|
assert(
|
||||||
|
outcome.settled === "resolved",
|
||||||
|
"eth_sendTransaction did not resolve: " + JSON.stringify(outcome),
|
||||||
|
);
|
||||||
|
|
||||||
|
// The artifact as the node saw it, not as the extension described it.
|
||||||
|
assert(
|
||||||
|
env.server.broadcast.length === before + 1,
|
||||||
|
"expected exactly one raw transaction to reach the node, got " +
|
||||||
|
(env.server.broadcast.length - before),
|
||||||
|
);
|
||||||
|
const signed = Transaction.from(
|
||||||
|
env.server.broadcast[env.server.broadcast.length - 1],
|
||||||
|
);
|
||||||
|
console.log(
|
||||||
|
"# eth_sendTransaction: signer=" +
|
||||||
|
getAddress(signed.from) +
|
||||||
|
" to=" +
|
||||||
|
getAddress(signed.to) +
|
||||||
|
" value=" +
|
||||||
|
formatEther(signed.value) +
|
||||||
|
" chainId=" +
|
||||||
|
signed.chainId,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
getAddress(signed.from) === env.address,
|
||||||
|
"the broadcast transaction was signed by " +
|
||||||
|
getAddress(signed.from) +
|
||||||
|
", not by the approved address " +
|
||||||
|
env.address,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
getAddress(signed.to) === getAddress(STUB_COUNTERPARTY),
|
||||||
|
"the broadcast transaction goes to " + signed.to,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
signed.value === TX_VALUE_WEI,
|
||||||
|
"the broadcast transaction carries " +
|
||||||
|
formatEther(signed.value) +
|
||||||
|
" ETH, not the approved " +
|
||||||
|
TX_VALUE_ETH,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
signed.data === TX_DATA,
|
||||||
|
"the broadcast transaction carries different call data: " +
|
||||||
|
signed.data,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
signed.chainId === 1n,
|
||||||
|
"the broadcast transaction is for chain " + signed.chainId,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.result === signed.hash,
|
||||||
|
"the page received " +
|
||||||
|
outcome.result +
|
||||||
|
", not the hash of the broadcast transaction " +
|
||||||
|
signed.hash,
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
waitHash.includes(signed.hash),
|
||||||
|
"the wait screen shows a different hash: " +
|
||||||
|
JSON.stringify(waitHash),
|
||||||
|
);
|
||||||
|
|
||||||
|
await d.switchToWindow(popup);
|
||||||
|
await d.closeWindow(env.dappWindow);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
step(
|
||||||
|
"closing an approval window rejects the request with 4001",
|
||||||
|
async (env) => {
|
||||||
|
const d = env.driver;
|
||||||
|
const before = env.server.broadcast.length;
|
||||||
|
|
||||||
|
await d.switchToWindow(env.dappWindow);
|
||||||
|
await startRequest(d, "sign-closed", "personal_sign", [
|
||||||
|
SIGN_HEX,
|
||||||
|
env.address,
|
||||||
|
]);
|
||||||
|
|
||||||
|
const popup = await waitForApprovalWindow(d);
|
||||||
|
await d.switchToWindow(popup);
|
||||||
|
await d.waitVisible("#view-approve-sign");
|
||||||
|
|
||||||
|
// Closed, not rejected: this is the windows.onRemoved path, which can
|
||||||
|
// only fire if windows.create() handed back a window id for the approval
|
||||||
|
// to be matched against — call site 4 in the issue, where the id used to
|
||||||
|
// be assigned from a callback the browser.* namespace never invoked.
|
||||||
|
await d.closeWindow(env.dappWindow);
|
||||||
|
|
||||||
|
await assertUserRejection(d, "sign-closed", "a closed approval window");
|
||||||
|
assert(
|
||||||
|
env.server.broadcast.length === before,
|
||||||
|
"a closed approval window still put a transaction on the node",
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
// ------------------------------------------------------------- runner
|
// ------------------------------------------------------------- runner
|
||||||
|
|
||||||
|
// Uncaught extension errors that are known, tracked and deliberately
|
||||||
|
// tolerated, in the same spirit as ALLOWED_ERRORS in tests/e2e/harness.js:
|
||||||
|
// every entry names the issue that will delete it, and every occurrence is
|
||||||
|
// still printed, so tolerating one is visible in the log rather than silent.
|
||||||
|
// This is the only concession in an otherwise zero-tolerance policy.
|
||||||
|
const ALLOWED_ERRORS = [
|
||||||
|
{
|
||||||
|
// The site-connection buttons in src/popup/views/approval.js send
|
||||||
|
// their decision and call window.close() on the next line. Firefox's
|
||||||
|
// BaseContext.wrapPromise reports, through Cu.reportError, any
|
||||||
|
// extension-API promise that settles after its context unloaded —
|
||||||
|
// whether or not the caller attached a handler, so notify()'s catch
|
||||||
|
// cannot suppress it.
|
||||||
|
//
|
||||||
|
// Pre-existing, and not introduced by the promise shim: the send was
|
||||||
|
// already unawaited, and this suite is merely the first thing to
|
||||||
|
// drive that window on Firefox. It is the same teardown ordering as
|
||||||
|
// the issue below, whose fix — making the outcome independent of when
|
||||||
|
// the popup closes — removes this entry with it.
|
||||||
|
pattern: /Promise (?:resolved|rejected) after context unloaded/,
|
||||||
|
source: /\/src\/popup\/index\.js$/,
|
||||||
|
issue: "https://git.eeqj.de/sneak/AutistMask/issues/275",
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
function allowedFor(e) {
|
||||||
|
return ALLOWED_ERRORS.find(
|
||||||
|
(a) => a.pattern.test(e.msg) && a.source.test(e.src),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
function formatError(e) {
|
function formatError(e) {
|
||||||
return (
|
return (
|
||||||
e.msg + " (" + e.src + ":" + e.line + (e.cat ? ", " + e.cat : "") + ")"
|
e.msg + " (" + e.src + ":" + e.line + (e.cat ? ", " + e.cat : "") + ")"
|
||||||
@@ -165,6 +774,21 @@ async function main() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Loopback survives --network none, so this is the http:// origin the
|
||||||
|
// dApp steps need and the node they talk to. Started before the browser
|
||||||
|
// so its url is available to the first step that asks for it.
|
||||||
|
let server;
|
||||||
|
try {
|
||||||
|
server = await startDappServer();
|
||||||
|
} catch (e) {
|
||||||
|
console.error(
|
||||||
|
"e2e-firefox: cannot serve the dApp fixture: " + e.message,
|
||||||
|
);
|
||||||
|
process.exitCode = 1;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.log("# dapp fixture: " + server.url + " rpc " + server.rpcUrl);
|
||||||
|
|
||||||
let driver;
|
let driver;
|
||||||
try {
|
try {
|
||||||
driver = await start();
|
driver = await start();
|
||||||
@@ -175,12 +799,20 @@ async function main() {
|
|||||||
// absent suite. Never skip and report success.
|
// absent suite. Never skip and report success.
|
||||||
console.error("e2e-firefox: cannot run the suite: " + e.message);
|
console.error("e2e-firefox: cannot run the suite: " + e.message);
|
||||||
if (driver) await driver.quit().catch(() => {});
|
if (driver) await driver.quit().catch(() => {});
|
||||||
|
await server.close();
|
||||||
process.exitCode = 1;
|
process.exitCode = 1;
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const errors = new ConsoleErrors(driver, EXTENSION_ORIGIN);
|
const errors = new ConsoleErrors(driver, EXTENSION_ORIGIN);
|
||||||
const env = { driver, phrase: null };
|
const env = {
|
||||||
|
driver,
|
||||||
|
server,
|
||||||
|
phrase: null,
|
||||||
|
address: null,
|
||||||
|
dappWindow: null,
|
||||||
|
popupWindow: null,
|
||||||
|
};
|
||||||
|
|
||||||
console.log("# extension origin: " + EXTENSION_ORIGIN);
|
console.log("# extension origin: " + EXTENSION_ORIGIN);
|
||||||
console.log("1.." + steps.length);
|
console.log("1.." + steps.length);
|
||||||
@@ -232,6 +864,20 @@ async function main() {
|
|||||||
installFailure = null;
|
installFailure = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Tolerated errors are set aside, never dropped: each one is
|
||||||
|
// printed with the issue that keeps it on the list, so the
|
||||||
|
// concession stays in the run output.
|
||||||
|
const tolerated = found.filter((e) => allowedFor(e));
|
||||||
|
found = found.filter((e) => !allowedFor(e));
|
||||||
|
for (const e of tolerated) {
|
||||||
|
console.log(
|
||||||
|
"# tolerated (" +
|
||||||
|
allowedFor(e).issue +
|
||||||
|
"): " +
|
||||||
|
formatError(e),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
// Any uncaught error from an extension source fails the step
|
// Any uncaught error from an extension source fails the step
|
||||||
// that provoked it, whether or not its assertions passed.
|
// that provoked it, whether or not its assertions passed.
|
||||||
if (!failure && found.length > 0) {
|
if (!failure && found.length > 0) {
|
||||||
@@ -256,7 +902,13 @@ async function main() {
|
|||||||
// blamed on any one step, but they are still reported and they
|
// blamed on any one step, but they are still reported and they
|
||||||
// still fail the run.
|
// still fail the run.
|
||||||
await sleep(1000);
|
await sleep(1000);
|
||||||
const trailing = await errors.take();
|
const trailingAll = await errors.take();
|
||||||
|
for (const e of trailingAll.filter((x) => allowedFor(x))) {
|
||||||
|
console.log(
|
||||||
|
"# tolerated (" + allowedFor(e).issue + "): " + formatError(e),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const trailing = trailingAll.filter((e) => !allowedFor(e));
|
||||||
console.log(
|
console.log(
|
||||||
"# " +
|
"# " +
|
||||||
(steps.length - failed) +
|
(steps.length - failed) +
|
||||||
@@ -273,12 +925,25 @@ async function main() {
|
|||||||
);
|
);
|
||||||
for (const e of trailing) console.log("# " + formatError(e));
|
for (const e of trailing) console.log("# " + formatError(e));
|
||||||
}
|
}
|
||||||
|
// A JSON-RPC method nothing answered means the extension asked the
|
||||||
|
// node something this fixture does not model, and whatever depended
|
||||||
|
// on the answer took the error branch instead. That is a hole in the
|
||||||
|
// fixture, not a pass.
|
||||||
|
if (server.unstubbed.length > 0) {
|
||||||
|
console.log(
|
||||||
|
"# FAILED: no fixture for JSON-RPC method(s) " +
|
||||||
|
[...new Set(server.unstubbed)].join(", "),
|
||||||
|
);
|
||||||
|
process.exitCode = 1;
|
||||||
|
}
|
||||||
|
|
||||||
if (failed > 0 || trailing.length > 0) {
|
if (failed > 0 || trailing.length > 0) {
|
||||||
console.log("# FAILED");
|
console.log("# FAILED");
|
||||||
process.exitCode = 1;
|
process.exitCode = 1;
|
||||||
}
|
}
|
||||||
} finally {
|
} finally {
|
||||||
await driver.quit().catch(() => {});
|
await driver.quit().catch(() => {});
|
||||||
|
await server.close();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -78,6 +78,13 @@ function word(value) {
|
|||||||
// is put there by the shipped manifest's MAIN-world content script, exactly
|
// is put there by the shipped manifest's MAIN-world content script, exactly
|
||||||
// as it is on any http(s) page a user visits, so what these tests speak to
|
// as it is on any http(s) page a user visits, so what these tests speak to
|
||||||
// is the real inpage provider and not a copy the harness wired up.
|
// is the real inpage provider and not a copy the harness wired up.
|
||||||
|
//
|
||||||
|
// DAPP_HTML below is exported and served verbatim by the Firefox suite too
|
||||||
|
// (tests/e2e/firefox/dapp.js), from a loopback origin rather than through a
|
||||||
|
// route handler. The two suites drive different browsers over different
|
||||||
|
// protocols, but the page they drive — the __dapp API, the message log — is
|
||||||
|
// one fixture, so an assertion written against it means the same thing on
|
||||||
|
// both.
|
||||||
const DAPP_ORIGIN = "https://dapp.e2e.test";
|
const DAPP_ORIGIN = "https://dapp.e2e.test";
|
||||||
const DAPP_URL = DAPP_ORIGIN + "/";
|
const DAPP_URL = DAPP_ORIGIN + "/";
|
||||||
|
|
||||||
@@ -86,9 +93,11 @@ const DAPP_URL = DAPP_ORIGIN + "/";
|
|||||||
// never drive the popup that has to settle it; start() files the promise
|
// never drive the popup that has to settle it; start() files the promise
|
||||||
// under a key and settle() collects it once the prompt has been dealt with.
|
// under a key and settle() collects it once the prompt has been dealt with.
|
||||||
//
|
//
|
||||||
// The rejection branch records `code` as it arrives. EIP-1193 says a user
|
// The rejection branch records the whole observable shape of the error as it
|
||||||
// rejection is a ProviderRpcError carrying code 4001; what the page can
|
// arrives — name, message, and whether a `code` is present at all as distinct
|
||||||
// actually see is recorded here rather than assumed, and asserted in run.js.
|
// from its value. EIP-1193 says a user rejection is a ProviderRpcError
|
||||||
|
// carrying code 4001; what the page can actually see is recorded here rather
|
||||||
|
// than assumed, and asserted in run.js.
|
||||||
//
|
//
|
||||||
// The message log is the page's half of the boundary observation: every
|
// The message log is the page's half of the boundary observation: every
|
||||||
// AUTISTMASK_* message that crosses between this page and the content
|
// AUTISTMASK_* message that crosses between this page and the content
|
||||||
@@ -120,6 +129,7 @@ const DAPP_HTML = [
|
|||||||
" return {",
|
" return {",
|
||||||
" settled: 'rejected',",
|
" settled: 'rejected',",
|
||||||
" message: String((error && error.message) || error),",
|
" message: String((error && error.message) || error),",
|
||||||
|
" name: error ? error.name : undefined,",
|
||||||
" hasCode: !!error && 'code' in Object(error),",
|
" hasCode: !!error && 'code' in Object(error),",
|
||||||
" code: error ? error.code : undefined,",
|
" code: error ? error.code : undefined,",
|
||||||
" };",
|
" };",
|
||||||
@@ -632,6 +642,7 @@ async function installNetworkStubs(ctx, opts) {
|
|||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
installNetworkStubs,
|
installNetworkStubs,
|
||||||
|
DAPP_HTML,
|
||||||
DAPP_ORIGIN,
|
DAPP_ORIGIN,
|
||||||
DAPP_URL,
|
DAPP_URL,
|
||||||
FEE_ESTIMATE_WEI,
|
FEE_ESTIMATE_WEI,
|
||||||
|
|||||||
210
tests/e2e/run.js
210
tests/e2e/run.js
@@ -419,172 +419,6 @@ test("reopening the popup never lands on the phrase screen (#161)", async (env)
|
|||||||
assertWiped(st, env.phrase, "after reopening the popup");
|
assertWiped(st, env.phrase, "after reopening the popup");
|
||||||
});
|
});
|
||||||
|
|
||||||
// ------------------------------- Back after reopening the popup (#268)
|
|
||||||
|
|
||||||
// A reopened popup renders the wallet list and the view it restores onto,
|
|
||||||
// and nothing else: every other screen is still the blank static template
|
|
||||||
// from index.html. Back used to only unhide its target, which is why these
|
|
||||||
// have to run against the real popup — the template is present and
|
|
||||||
// well-formed, so only its emptiness distinguishes the defect, and only a
|
|
||||||
// real reopen produces it.
|
|
||||||
|
|
||||||
// Everything the address screen must have on it, read out of the DOM.
|
|
||||||
function addressScreenState(page) {
|
|
||||||
return page.evaluate(() => {
|
|
||||||
const line = document.getElementById("address-line");
|
|
||||||
const balances = document.getElementById("address-balances");
|
|
||||||
return {
|
|
||||||
hidden: document
|
|
||||||
.getElementById("view-address")
|
|
||||||
.classList.contains("hidden"),
|
|
||||||
line: line ? line.innerText.trim() : "",
|
|
||||||
balances: balances ? balances.innerText.trim() : "",
|
|
||||||
};
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Close and reopen the page rather than reload it: that is what the toolbar
|
|
||||||
// popup does, and it is the only thing that produces the unrendered views.
|
|
||||||
async function reopenPopup(env, restoredView) {
|
|
||||||
await env.page.close();
|
|
||||||
env.page = await openPopup(env.ctx, env.popupUrl);
|
|
||||||
await visible(env.page, restoredView);
|
|
||||||
}
|
|
||||||
|
|
||||||
// The reproduction from the issue, step for step.
|
|
||||||
test("Back after reopening the popup renders the address screen (#268)", async (env) => {
|
|
||||||
await openAddressDetail(env.page);
|
|
||||||
const before = await addressScreenState(env.page);
|
|
||||||
assert(
|
|
||||||
before.line.length > 0,
|
|
||||||
"the address screen was blank to begin with",
|
|
||||||
);
|
|
||||||
|
|
||||||
await env.page.click("#btn-settings");
|
|
||||||
await visible(env.page, "#view-settings");
|
|
||||||
|
|
||||||
await reopenPopup(env, "#view-settings");
|
|
||||||
|
|
||||||
await env.page.click("#btn-settings-back");
|
|
||||||
await visible(env.page, "#view-address");
|
|
||||||
|
|
||||||
const after = await addressScreenState(env.page);
|
|
||||||
assert(
|
|
||||||
after.line === before.line,
|
|
||||||
"the address line reads " +
|
|
||||||
JSON.stringify(after.line) +
|
|
||||||
", expected " +
|
|
||||||
JSON.stringify(before.line),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
after.balances.includes("ETH"),
|
|
||||||
"the balances read " + JSON.stringify(after.balances),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The same defect one screen further in. Receive holds the address twice
|
|
||||||
// over — as text and as the QR code the sender scans — and a blank one is
|
|
||||||
// worse than a missing screen.
|
|
||||||
// Everything the Receive screen must have on it. The QR code is read as
|
|
||||||
// pixels, not as an element: the blank template carries the canvas too, a
|
|
||||||
// default 300x150 one with nothing drawn on it and every pixel fully
|
|
||||||
// transparent. A drawn QR paints an opaque background across the whole
|
|
||||||
// canvas, so a single opaque pixel is the whole question.
|
|
||||||
function receiveScreenState(page) {
|
|
||||||
return page.evaluate(() => {
|
|
||||||
const block = document.getElementById("receive-address-block");
|
|
||||||
const canvas = document.getElementById("receive-qr");
|
|
||||||
const px = canvas
|
|
||||||
.getContext("2d")
|
|
||||||
.getImageData(0, 0, canvas.width, canvas.height).data;
|
|
||||||
let opaque = 0;
|
|
||||||
for (let i = 3; i < px.length; i += 4) {
|
|
||||||
if (px[i] > 0) opaque += 1;
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
address: block.dataset.full || "",
|
|
||||||
text: block.innerText.trim(),
|
|
||||||
qrOpaquePixels: opaque,
|
|
||||||
};
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
test("Back after reopening the popup renders the Receive screen (#268)", async (env) => {
|
|
||||||
await openAddressDetail(env.page);
|
|
||||||
await env.page.click("#btn-receive");
|
|
||||||
await visible(env.page, "#view-receive");
|
|
||||||
const before = await receiveScreenState(env.page);
|
|
||||||
assert(
|
|
||||||
/^0x[0-9a-fA-F]{40}$/.test(before.address),
|
|
||||||
"Receive showed no address to begin with: " +
|
|
||||||
JSON.stringify(before.address),
|
|
||||||
);
|
|
||||||
|
|
||||||
await env.page.click("#btn-settings");
|
|
||||||
await visible(env.page, "#view-settings");
|
|
||||||
|
|
||||||
await reopenPopup(env, "#view-settings");
|
|
||||||
|
|
||||||
await env.page.click("#btn-settings-back");
|
|
||||||
await visible(env.page, "#view-receive");
|
|
||||||
|
|
||||||
const shown = await receiveScreenState(env.page);
|
|
||||||
assert(
|
|
||||||
shown.address === before.address,
|
|
||||||
"Receive shows " +
|
|
||||||
JSON.stringify(shown.address) +
|
|
||||||
", expected " +
|
|
||||||
JSON.stringify(before.address),
|
|
||||||
);
|
|
||||||
assert(
|
|
||||||
shown.text.includes(before.address),
|
|
||||||
"the Receive address is not on screen: " + JSON.stringify(shown.text),
|
|
||||||
);
|
|
||||||
assert(shown.qrOpaquePixels > 0, "Receive shows an unpainted QR code");
|
|
||||||
|
|
||||||
// Leave the suite where it found it.
|
|
||||||
await env.page.click("#btn-receive-back");
|
|
||||||
await visible(env.page, "#view-address");
|
|
||||||
await env.page.click("#btn-address-back");
|
|
||||||
await visible(env.page, "#view-main");
|
|
||||||
});
|
|
||||||
|
|
||||||
// The other half of the requirement: Back renders a screen this page load
|
|
||||||
// never rendered, and must NOT re-render one it already has on screen.
|
|
||||||
// settings.show() reassigns #settings-rpc from persisted state, so
|
|
||||||
// re-rendering Settings on the way back would silently revert whatever the
|
|
||||||
// user typed and had not saved yet — and they could then press Save and
|
|
||||||
// store the value they believed they had replaced. No reopen here: this is
|
|
||||||
// an ordinary in-session forward-and-back, which is exactly why the render
|
|
||||||
// must not happen.
|
|
||||||
test("Back onto Settings keeps unsaved input (#268)", async (env) => {
|
|
||||||
await visible(env.page, "#view-main");
|
|
||||||
await env.page.click("#btn-settings");
|
|
||||||
await visible(env.page, "#view-settings");
|
|
||||||
|
|
||||||
const typed = "https://rpc.example.invalid/unsaved";
|
|
||||||
await env.page.fill("#settings-rpc", typed);
|
|
||||||
|
|
||||||
await env.page.click("#btn-settings-add-token");
|
|
||||||
await visible(env.page, "#view-settings-addtoken");
|
|
||||||
await env.page.click("#btn-settings-addtoken-back");
|
|
||||||
await visible(env.page, "#view-settings");
|
|
||||||
|
|
||||||
const kept = await env.page.inputValue("#settings-rpc");
|
|
||||||
assert(
|
|
||||||
kept === typed,
|
|
||||||
"the unsaved RPC URL reads " +
|
|
||||||
JSON.stringify(kept) +
|
|
||||||
", expected " +
|
|
||||||
JSON.stringify(typed),
|
|
||||||
);
|
|
||||||
|
|
||||||
// Leave the suite where it found it. The typed value was never saved,
|
|
||||||
// and Settings reloads the field from state next time it renders.
|
|
||||||
await env.page.click("#btn-settings-back");
|
|
||||||
await visible(env.page, "#view-main");
|
|
||||||
});
|
|
||||||
|
|
||||||
// -------------------------------------------- address removal (#162)
|
// -------------------------------------------- address removal (#162)
|
||||||
|
|
||||||
// Number of address rows across every wallet in the list, counted in the DOM
|
// Number of address rows across every wallet in the list, counted in the DOM
|
||||||
@@ -1757,15 +1591,14 @@ async function lastResponseError(page) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// A rejected prompt, asserted at both ends: the page's promise rejected
|
// A rejected prompt, asserted at both ends: the page's promise rejected
|
||||||
// rather than hanging or resolving, and the response that crossed the
|
// rather than hanging or resolving, and EIP-1193 code 4001 is present both
|
||||||
// boundary carried EIP-1193 code 4001.
|
// on the wire and on the Error the calling page catches.
|
||||||
//
|
//
|
||||||
// The code is asserted on the wire because that is the only place it
|
// Both ends matter because they used to disagree. The code crossed the
|
||||||
// survives. src/content/inpage.js rebuilds the rejection as `new
|
// boundary correctly and src/content/inpage.js then threw it away, rebuilding
|
||||||
// Error(error.message)`, so the Error the calling page catches carries the
|
// every rejection as `new Error(error.message)` — so a dApp branching on
|
||||||
// message and no code. That is reported rather than asserted either way —
|
// `err.code === 4001` saw undefined and could not tell a refusal from a
|
||||||
// locking in the current behaviour would make the gap permanent, and
|
// failure (#274). Asserting only the wire would leave that gap invisible.
|
||||||
// asserting the code on the Error would fail today.
|
|
||||||
async function assertUserRejection(page, key, label) {
|
async function assertUserRejection(page, key, label) {
|
||||||
const outcome = await settleRequest(page, key);
|
const outcome = await settleRequest(page, key);
|
||||||
assert(
|
assert(
|
||||||
@@ -1787,15 +1620,32 @@ async function assertUserRejection(page, key, label) {
|
|||||||
" did not carry EIP-1193 code 4001 across the boundary: " +
|
" did not carry EIP-1193 code 4001 across the boundary: " +
|
||||||
JSON.stringify(error),
|
JSON.stringify(error),
|
||||||
);
|
);
|
||||||
|
assert(
|
||||||
|
outcome.hasCode,
|
||||||
|
label +
|
||||||
|
" reached the page as an error with no code property at all, so a " +
|
||||||
|
"dApp cannot tell the user's refusal from a failure: " +
|
||||||
|
JSON.stringify(outcome),
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.code === 4001,
|
||||||
|
label +
|
||||||
|
" reached the page with code " +
|
||||||
|
JSON.stringify(outcome.code) +
|
||||||
|
" rather than EIP-1193 4001",
|
||||||
|
);
|
||||||
|
assert(
|
||||||
|
outcome.name === "ProviderRpcError",
|
||||||
|
label +
|
||||||
|
" reached the page as " +
|
||||||
|
JSON.stringify(outcome.name) +
|
||||||
|
" rather than an EIP-1193 ProviderRpcError",
|
||||||
|
);
|
||||||
console.log(
|
console.log(
|
||||||
"# " +
|
"# " +
|
||||||
label +
|
label +
|
||||||
": boundary code=" +
|
": code 4001 on the wire and on the page's " +
|
||||||
error.code +
|
outcome.name,
|
||||||
" page Error.code=" +
|
|
||||||
JSON.stringify(outcome.code) +
|
|
||||||
" page Error carries a code=" +
|
|
||||||
outcome.hasCode,
|
|
||||||
);
|
);
|
||||||
return outcome;
|
return outcome;
|
||||||
}
|
}
|
||||||
|
|||||||
310
tests/inpageErrors.test.js
Normal file
310
tests/inpageErrors.test.js
Normal file
@@ -0,0 +1,310 @@
|
|||||||
|
// The EIP-1193 error the page actually catches (src/content/inpage.js).
|
||||||
|
//
|
||||||
|
// The bug this pins down (issue #274): the provider rebuilt every failure as
|
||||||
|
// `new Error(error.message)`, so the `code` the background produced and the
|
||||||
|
// content script relayed intact was thrown away in the last hop. A dApp
|
||||||
|
// checking `err.code === 4001` — the standard way to tell "the user said no"
|
||||||
|
// from "the wallet broke" — saw undefined, and well-behaved sites showed an
|
||||||
|
// error or retried instead of accepting the refusal.
|
||||||
|
//
|
||||||
|
// inpage.js is a bare IIFE injected into the page's JS context, not a module:
|
||||||
|
// it takes no import and exports nothing, and reaches for `window` at load.
|
||||||
|
// So it is evaluated here the way the browser evaluates it, against a stub
|
||||||
|
// window, and the provider is collected from `window.ethereum`. The globals it
|
||||||
|
// touches are passed in as function parameters rather than assigned to
|
||||||
|
// globalThis: nothing leaks between tests, and the source is compiled in this
|
||||||
|
// realm, so the errors it constructs are comparable against this file's own
|
||||||
|
// `Error` — which a second realm's intrinsics would silently defeat.
|
||||||
|
//
|
||||||
|
// There is no jsdom in this repo; see tests/txStatus.test.js.
|
||||||
|
|
||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
const { webcrypto } = require("crypto");
|
||||||
|
|
||||||
|
const SOURCE = fs.readFileSync(
|
||||||
|
path.join(__dirname, "..", "src", "content", "inpage.js"),
|
||||||
|
"utf8",
|
||||||
|
);
|
||||||
|
|
||||||
|
const loadInto = new Function(
|
||||||
|
"window",
|
||||||
|
"self",
|
||||||
|
"crypto",
|
||||||
|
"Event",
|
||||||
|
"CustomEvent",
|
||||||
|
SOURCE,
|
||||||
|
);
|
||||||
|
|
||||||
|
class StubEvent {
|
||||||
|
constructor(type) {
|
||||||
|
this.type = type;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class StubCustomEvent extends StubEvent {
|
||||||
|
constructor(type, init) {
|
||||||
|
super(type);
|
||||||
|
this.detail = init && init.detail;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every code the background emits on the RPC path today, read out of
|
||||||
|
// src/background/index.js. The provider must not know this list — it passes
|
||||||
|
// through whatever arrived — but the cases below are the real ones.
|
||||||
|
const REJECTED = 4001; // user rejected the request
|
||||||
|
const UNAUTHORIZED = 4100; // site not connected / wrong address
|
||||||
|
const UNRECOGNIZED_CHAIN = 4902; // switch/add to an unsupported chain
|
||||||
|
|
||||||
|
// A stub window with the four things inpage.js touches: message listeners,
|
||||||
|
// postMessage out to the content script, window.ethereum, and dispatchEvent
|
||||||
|
// for the EIP-6963 announcement.
|
||||||
|
function loadProvider() {
|
||||||
|
const messageListeners = [];
|
||||||
|
const posted = [];
|
||||||
|
|
||||||
|
const win = {
|
||||||
|
addEventListener(type, fn) {
|
||||||
|
if (type === "message") messageListeners.push(fn);
|
||||||
|
},
|
||||||
|
removeEventListener(type, fn) {
|
||||||
|
const i = messageListeners.indexOf(fn);
|
||||||
|
if (type === "message" && i !== -1) messageListeners.splice(i, 1);
|
||||||
|
},
|
||||||
|
postMessage(data) {
|
||||||
|
posted.push(data);
|
||||||
|
},
|
||||||
|
dispatchEvent() {
|
||||||
|
return true;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
win.window = win;
|
||||||
|
|
||||||
|
loadInto(win, win, webcrypto, StubEvent, StubCustomEvent);
|
||||||
|
|
||||||
|
// Deliver the content script's answer to an outstanding request. The id is
|
||||||
|
// read back off the wire rather than assumed: inpage.js issues its own
|
||||||
|
// eth_chainId at load, so the first id a test sees is not 1.
|
||||||
|
function respond(response) {
|
||||||
|
const request = posted
|
||||||
|
.filter((m) => m.type === "AUTISTMASK_REQUEST")
|
||||||
|
.pop();
|
||||||
|
expect(request).toBeDefined();
|
||||||
|
const event = {
|
||||||
|
source: win,
|
||||||
|
data: { type: "AUTISTMASK_RESPONSE", id: request.id, ...response },
|
||||||
|
};
|
||||||
|
for (const fn of messageListeners.slice()) fn(event);
|
||||||
|
}
|
||||||
|
|
||||||
|
return { provider: win.ethereum, posted, respond };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start a request, answer it with `response`, and hand back the rejection.
|
||||||
|
// Fails the test if the call resolves instead.
|
||||||
|
async function rejectionFrom(start, response) {
|
||||||
|
const { provider, respond } = loadProvider();
|
||||||
|
const settled = start(provider).then(
|
||||||
|
(result) => ({ resolved: result }),
|
||||||
|
(error) => ({ error }),
|
||||||
|
);
|
||||||
|
// The provider posts synchronously, so the request is already on the wire.
|
||||||
|
respond(response);
|
||||||
|
const outcome = await settled;
|
||||||
|
expect(outcome).not.toHaveProperty("resolved");
|
||||||
|
return outcome.error;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("an EIP-1193 code reaches the page", () => {
|
||||||
|
test("a user rejection arrives as code 4001", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_requestAccounts" }),
|
||||||
|
{
|
||||||
|
error: {
|
||||||
|
code: REJECTED,
|
||||||
|
message: "User rejected the request.",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
expect(err.message).toBe("User rejected the request.");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("it is a ProviderRpcError, and an Error", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_requestAccounts" }),
|
||||||
|
{
|
||||||
|
error: {
|
||||||
|
code: REJECTED,
|
||||||
|
message: "User rejected the request.",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(err).toBeInstanceOf(Error);
|
||||||
|
expect(err.name).toBe("ProviderRpcError");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("4100 unauthorized arrives intact", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "personal_sign", params: ["0x00"] }),
|
||||||
|
{ error: { code: UNAUTHORIZED, message: "Unauthorized" } },
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(UNAUTHORIZED);
|
||||||
|
expect(err.message).toBe("Unauthorized");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("4902 unrecognized chain arrives intact", async () => {
|
||||||
|
const message =
|
||||||
|
"AutistMask supports Ethereum Mainnet and Sepolia Testnet only.";
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "wallet_switchEthereumChain" }),
|
||||||
|
{ error: { code: UNRECOGNIZED_CHAIN, message } },
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(UNRECOGNIZED_CHAIN);
|
||||||
|
expect(err.message).toBe(message);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The provider is not allowed to know the list above: a code added to the
|
||||||
|
// background later must reach the page without this file being edited.
|
||||||
|
test("a code the provider has never heard of is passed through", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_accounts" }),
|
||||||
|
{ error: { code: 4900, message: "Disconnected" } },
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(4900);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("data is carried when the boundary sent it", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_call" }),
|
||||||
|
{
|
||||||
|
error: {
|
||||||
|
code: -32000,
|
||||||
|
message: "execution reverted",
|
||||||
|
data: "0x08c379a0",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(-32000);
|
||||||
|
expect(err.data).toBe("0x08c379a0");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("no data property is invented when the boundary sent none", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_requestAccounts" }),
|
||||||
|
{
|
||||||
|
error: {
|
||||||
|
code: REJECTED,
|
||||||
|
message: "User rejected the request.",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect("data" in err).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the message is untouched", () => {
|
||||||
|
test("a coded error keeps the message byte for byte", async () => {
|
||||||
|
const message =
|
||||||
|
"This site asked to sign as an address that is not " +
|
||||||
|
"the active one.";
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "personal_sign" }),
|
||||||
|
{ error: { code: UNAUTHORIZED, message } },
|
||||||
|
);
|
||||||
|
expect(err.message).toBe(message);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an error the background sent with no code keeps its message", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_sendTransaction" }),
|
||||||
|
{ error: { message: "No accounts available" } },
|
||||||
|
);
|
||||||
|
expect(err.message).toBe("No accounts available");
|
||||||
|
});
|
||||||
|
|
||||||
|
// A ProviderRpcError whose code is undefined would claim a conformance it
|
||||||
|
// does not have, and `'code' in err` is exactly what a careful dApp asks.
|
||||||
|
test("an error with no code gets no code property at all", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_sendTransaction" }),
|
||||||
|
{ error: { message: "No accounts available" } },
|
||||||
|
);
|
||||||
|
expect(err).toBeInstanceOf(Error);
|
||||||
|
expect("code" in err).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an error with no message keeps the generic fallback", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_sendTransaction" }),
|
||||||
|
{ error: { code: REJECTED } },
|
||||||
|
);
|
||||||
|
expect(err.message).toBe("Request failed");
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Every entry point the provider exposes, not just eth_requestAccounts. They
|
||||||
|
// all funnel through the same response listener, and this is what says so.
|
||||||
|
describe("every request path carries the code", () => {
|
||||||
|
const rejection = {
|
||||||
|
error: { code: REJECTED, message: "User rejected the request." },
|
||||||
|
};
|
||||||
|
|
||||||
|
test("request()", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.request({ method: "eth_requestAccounts" }),
|
||||||
|
rejection,
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("enable()", async () => {
|
||||||
|
const err = await rejectionFrom((p) => p.enable(), rejection);
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("send(method, params)", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.send("eth_requestAccounts", []),
|
||||||
|
rejection,
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("send({ method, params })", async () => {
|
||||||
|
const err = await rejectionFrom(
|
||||||
|
(p) => p.send({ method: "personal_sign", params: ["0x00"] }),
|
||||||
|
rejection,
|
||||||
|
);
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("sendAsync() hands the code to its callback", async () => {
|
||||||
|
const { provider, respond } = loadProvider();
|
||||||
|
const called = new Promise((resolve) => {
|
||||||
|
provider.sendAsync({ id: 1, method: "eth_requestAccounts" }, (e) =>
|
||||||
|
resolve(e),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
respond(rejection);
|
||||||
|
const err = await called;
|
||||||
|
expect(err.name).toBe("ProviderRpcError");
|
||||||
|
expect(err.code).toBe(REJECTED);
|
||||||
|
expect(err.message).toBe("User rejected the request.");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("the success path is unchanged", () => {
|
||||||
|
test("a result still resolves", async () => {
|
||||||
|
const { provider, respond } = loadProvider();
|
||||||
|
const settled = provider.request({ method: "eth_requestAccounts" });
|
||||||
|
respond({ result: ["0xb61264DEFB0c4B8afb3D73724be15310036743a5"] });
|
||||||
|
await expect(settled).resolves.toEqual([
|
||||||
|
"0xb61264DEFB0c4B8afb3D73724be15310036743a5",
|
||||||
|
]);
|
||||||
|
expect(provider.selectedAddress).toBe(
|
||||||
|
"0xb61264DEFB0c4B8afb3D73724be15310036743a5",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user