Compare commits
1 Commits
issue-280-
...
a9c4080422
| Author | SHA1 | Date | |
|---|---|---|---|
| a9c4080422 |
15
README.md
15
README.md
@@ -638,6 +638,21 @@ 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
|
||||||
|
|||||||
50
TODO.md
50
TODO.md
@@ -45,39 +45,23 @@ undefined identifiers, which is how
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-14: A background message handler that throws now rejects the page
|
- 2026-08-12: "Back" now renders the screen it lands on instead of only unhiding
|
||||||
instead of hanging it. `handleRpc(...).then(sendResponse)` had no `.catch()`,
|
it. A reopened popup renders the wallet list and the one screen it restores
|
||||||
and `sendResponse` is the only thing that settles the dApp's
|
onto, so every screen further down the stack was still the blank template from
|
||||||
`window.ethereum.request()` promise — so any throw inside `handleRpc` left
|
`index.html`, and Back walked straight onto it — an empty address, no
|
||||||
that promise pending forever, with no error and no timeout, indistinguishable
|
balances, no QR code. The Back path now goes through the same per-view
|
||||||
from a slow wallet. It now answers `{ code: -32603, message }` (the JSON-RPC
|
dispatch and data guards as the restore (`src/popup/viewRouter.js`, shared
|
||||||
internal error EIP-1474 defines and EIP-1193 defers to; no EIP-1193 4xxx code
|
with `restoreView()`), falling back to Home when the state the target would
|
||||||
describes "the wallet broke" and none was invented) and logs the method and
|
render is gone. It renders only a view this page load has not rendered yet:
|
||||||
the throw to the background console rather than swallowing them. The two async
|
`viewRouter.js` records every view that reaches `showView()`, which is where
|
||||||
IIFEs behind `AUTISTMASK_TX_RESPONSE` and `AUTISTMASK_SIGN_RESPONSE` were the
|
forward navigation and the restore both end, so Back onto a view already on
|
||||||
same shape one level down — every statement inside a `try`, but a throw out of
|
the page unhides it and nothing more. That is what keeps a second render from
|
||||||
a `catch` block escaping unhandled — and each got a last-resort `.catch()`
|
re-fetching and overwriting what the view holds — an unsaved edit in Settings,
|
||||||
settling the approval through `settleApproval()` and answering the popup; the
|
a transaction list already loaded. Home is the exception and is always
|
||||||
transaction one reports the broadcast stage, because it cannot tell whether
|
re-rendered, as it was before. Covered by unit tests on the real `goBack()`
|
||||||
the transaction reached the network. Every other handler on the path is
|
and by three end-to-end cases against the real popup, each demonstrated
|
||||||
synchronous. All three are driven by real failures — a rejecting storage read,
|
failing on the unfixed build
|
||||||
and a failure classifier that throws while classifying a genuine verification
|
([#268](https://git.eeqj.de/sneak/AutistMask/issues/268)).
|
||||||
failure — and were demonstrated failing first, the RPC one with `sendResponse`
|
|
||||||
at zero calls ([#280](https://git.eeqj.de/sneak/AutistMask/issues/280)).
|
|
||||||
- 2026-08-12: EIP-1193 error codes now reach the page. `src/content/inpage.js`
|
|
||||||
rebuilt every failure as `new Error(error.message)`, so the code the
|
|
||||||
background produced and the content script relayed intact was dropped in the
|
|
||||||
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` —
|
||||||
|
|||||||
@@ -57,16 +57,6 @@ const connectedSites = {};
|
|||||||
// Pending approval requests: { id: { origin, hostname, resolve } }
|
// Pending approval requests: { id: { origin, hostname, resolve } }
|
||||||
const pendingApprovals = {};
|
const pendingApprovals = {};
|
||||||
|
|
||||||
// What the page is told when a request failed in a way the wallet has no
|
|
||||||
// specific answer for. -32603 is the JSON-RPC internal error EIP-1474 defines
|
|
||||||
// and EIP-1193 defers to for RPC-layer failures; no EIP-1193 4xxx code
|
|
||||||
// describes "the wallet broke", and one is not invented here. The cause is
|
|
||||||
// logged rather than put in the message: the page gets a stable sentence, the
|
|
||||||
// background console gets the throw.
|
|
||||||
const INTERNAL_ERROR_CODE = -32603;
|
|
||||||
const INTERNAL_ERROR_MESSAGE =
|
|
||||||
"AutistMask could not complete this request because of an internal error.";
|
|
||||||
|
|
||||||
async function getState() {
|
async function getState() {
|
||||||
const result = await storageApi.get("autistmask");
|
const result = await storageApi.get("autistmask");
|
||||||
return (
|
return (
|
||||||
@@ -875,25 +865,8 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
// keep fallback
|
// keep fallback
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
handleRpc(msg.method, msg.params, trustedOrigin)
|
handleRpc(msg.method, msg.params, trustedOrigin).then((response) => {
|
||||||
.then((response) => {
|
|
||||||
sendResponse(response);
|
sendResponse(response);
|
||||||
})
|
|
||||||
.catch((err) => {
|
|
||||||
// Without this the page's window.ethereum.request() promise
|
|
||||||
// stays pending forever: no response is sent, the content
|
|
||||||
// script posts nothing back, and the dApp cannot tell the
|
|
||||||
// failure from a slow wallet. handleRpc does real work —
|
|
||||||
// state loads, provider calls, transaction population — so
|
|
||||||
// "it does not throw today" is not a property anyone is
|
|
||||||
// maintaining.
|
|
||||||
log.errorf("RPC request failed:", msg.method, err);
|
|
||||||
sendResponse({
|
|
||||||
error: {
|
|
||||||
code: INTERNAL_ERROR_CODE,
|
|
||||||
message: INTERNAL_ERROR_MESSAGE,
|
|
||||||
},
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
@@ -1078,31 +1051,7 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
stage: TX_STAGE_BROADCAST,
|
stage: TX_STAGE_BROADCAST,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
})().catch((e) => {
|
})();
|
||||||
// Every statement above is inside a try, but a throw from one of
|
|
||||||
// the catch blocks escapes as an unhandled rejection and neither
|
|
||||||
// the popup nor the page is ever answered. Settle both, through
|
|
||||||
// the same chokepoint as every other retirement. The stage is
|
|
||||||
// broadcast because this cannot tell whether the transaction
|
|
||||||
// reached the network, and that is the wording that does not
|
|
||||||
// invite a second send.
|
|
||||||
log.errorf("transaction approval response failed:", e);
|
|
||||||
settleApproval(
|
|
||||||
msg.id,
|
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: INTERNAL_ERROR_CODE,
|
|
||||||
message: INTERNAL_ERROR_MESSAGE,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{ holdsClaim: true },
|
|
||||||
);
|
|
||||||
sendResponse({
|
|
||||||
error: INTERNAL_ERROR_MESSAGE,
|
|
||||||
retryable: false,
|
|
||||||
stage: TX_STAGE_BROADCAST,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1186,25 +1135,7 @@ runtime.onMessage.addListener((msg, sender, sendResponse) => {
|
|||||||
}
|
}
|
||||||
sendResponse({ error: errMsg, retryable });
|
sendResponse({ error: errMsg, retryable });
|
||||||
}
|
}
|
||||||
})().catch((e) => {
|
})();
|
||||||
// Same shape as the transaction path: a throw out of the catch
|
|
||||||
// block above would leave the popup and the page both waiting.
|
|
||||||
log.errorf("sign approval response failed:", e);
|
|
||||||
settleApproval(
|
|
||||||
msg.id,
|
|
||||||
{
|
|
||||||
error: {
|
|
||||||
code: INTERNAL_ERROR_CODE,
|
|
||||||
message: INTERNAL_ERROR_MESSAGE,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{ holdsClaim: true },
|
|
||||||
);
|
|
||||||
sendResponse({
|
|
||||||
error: INTERNAL_ERROR_MESSAGE,
|
|
||||||
retryable: false,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -11,39 +11,6 @@
|
|||||||
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;
|
||||||
@@ -53,7 +20,7 @@
|
|||||||
if (!p) return;
|
if (!p) return;
|
||||||
delete pending[id];
|
delete pending[id];
|
||||||
if (error) {
|
if (error) {
|
||||||
p.reject(toPageError(error));
|
p.reject(new Error(error.message || "Request failed"));
|
||||||
} else {
|
} else {
|
||||||
p.resolve(result);
|
p.resolve(result);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,16 +9,17 @@ const {
|
|||||||
$,
|
$,
|
||||||
showView,
|
showView,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
setRenderMain,
|
setBackRenderer,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
goBack,
|
goBack,
|
||||||
clearViewStack,
|
clearViewStack,
|
||||||
} = require("./views/helpers");
|
} = require("./views/helpers");
|
||||||
const { applyTheme } = require("./theme");
|
const { applyTheme } = require("./theme");
|
||||||
// Views that can be fully re-rendered from persisted state. All others fall
|
// Renders a view the popup lands on without having navigated to it forward:
|
||||||
// back to the nearest restorable parent; see the module for why the
|
// on restore here, and on Back. Only the views that can be fully re-rendered
|
||||||
// secret-bearing views are absent.
|
// from persisted state (RESTORABLE_VIEWS, src/popup/restorableViews.js) go
|
||||||
const { RESTORABLE_VIEWS } = require("./restorableViews");
|
// through it; anything else falls back to the nearest restorable parent.
|
||||||
|
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");
|
||||||
@@ -108,92 +109,23 @@ const ctx = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
function needsAddress(view) {
|
// The view modules the router renders through, keyed as it expects them.
|
||||||
return (
|
const viewModules = {
|
||||||
view === "address" ||
|
main: { show: () => fallbackView() },
|
||||||
view === "address-token" ||
|
addressDetail,
|
||||||
view === "receive" ||
|
addressToken,
|
||||||
view === "transaction"
|
receive,
|
||||||
);
|
settings,
|
||||||
}
|
settingsAddToken,
|
||||||
|
confirmTx,
|
||||||
function hasValidAddress() {
|
transactionDetail,
|
||||||
return (
|
txStatus,
|
||||||
state.selectedWallet !== null &&
|
};
|
||||||
state.selectedAddress !== null &&
|
|
||||||
state.wallets[state.selectedWallet] &&
|
|
||||||
state.wallets[state.selectedWallet].addresses[state.selectedAddress]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function restoreView() {
|
function restoreView() {
|
||||||
const view = state.currentView;
|
if (!renderView(state.currentView, state, viewModules)) {
|
||||||
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();
|
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;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function fallbackView() {
|
function fallbackView() {
|
||||||
@@ -247,7 +179,7 @@ async function init() {
|
|||||||
settings.show();
|
settings.show();
|
||||||
});
|
});
|
||||||
|
|
||||||
setRenderMain(renderWalletList);
|
setBackRenderer(makeBackRenderer(state, viewModules));
|
||||||
|
|
||||||
welcome.init(ctx);
|
welcome.init(ctx);
|
||||||
addWallet.init(ctx);
|
addWallet.init(ctx);
|
||||||
|
|||||||
167
src/popup/viewRouter.js
Normal file
167
src/popup/viewRouter.js
Normal file
@@ -0,0 +1,167 @@
|
|||||||
|
// 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,
|
||||||
|
};
|
||||||
@@ -7,6 +7,7 @@ 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.
|
||||||
@@ -76,6 +77,10 @@ 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);
|
||||||
}
|
}
|
||||||
@@ -111,12 +116,19 @@ function updateDebugBanner(viewName) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Callback to re-render the main/home view when navigating back to it.
|
// Callback that renders a view being navigated BACK onto. Set once by
|
||||||
// Set once by index.js via setRenderMain().
|
// index.js via setBackRenderer(), which routes the view through the same
|
||||||
let _renderMain = null;
|
// per-view render and data guards restoreView() uses.
|
||||||
|
//
|
||||||
|
// 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 setRenderMain(fn) {
|
function setBackRenderer(fn) {
|
||||||
_renderMain = fn;
|
_renderBack = fn;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Push the current view onto the navigation stack so goBack() can
|
// Push the current view onto the navigation stack so goBack() can
|
||||||
@@ -136,9 +148,11 @@ function goBack() {
|
|||||||
} else {
|
} else {
|
||||||
target = "main";
|
target = "main";
|
||||||
}
|
}
|
||||||
if (target === "main" && _renderMain) {
|
// A popped view is landed on, not navigated to. If the popup has been
|
||||||
_renderMain();
|
// closed and reopened since the view was pushed, nothing has ever
|
||||||
}
|
// 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);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -470,7 +484,7 @@ module.exports = {
|
|||||||
showView,
|
showView,
|
||||||
onViewLeave,
|
onViewLeave,
|
||||||
updateDebugBanner,
|
updateDebugBanner,
|
||||||
setRenderMain,
|
setBackRenderer,
|
||||||
pushCurrentView,
|
pushCurrentView,
|
||||||
goBack,
|
goBack,
|
||||||
clearViewStack,
|
clearViewStack,
|
||||||
|
|||||||
329
tests/backNavigation.test.js
Normal file
329
tests/backNavigation.test.js
Normal file
@@ -0,0 +1,329 @@
|
|||||||
|
// 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");
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -133,14 +133,6 @@ function loadBackground(options) {
|
|||||||
ensureRecurringAlarms: jest.fn(async () => {}),
|
ensureRecurringAlarms: jest.fn(async () => {}),
|
||||||
registerAlarmHandlers: jest.fn(),
|
registerAlarmHandlers: jest.fn(),
|
||||||
}));
|
}));
|
||||||
// The real verification module, except where a test replaces one export
|
|
||||||
// with a throw to drive the handler's own error handling into failing.
|
|
||||||
if (opts.approvalVerify) {
|
|
||||||
jest.doMock("../src/shared/approvalVerify", () => ({
|
|
||||||
...jest.requireActual("../src/shared/approvalVerify"),
|
|
||||||
...opts.approvalVerify,
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
const persisted = {
|
const persisted = {
|
||||||
wallets: [
|
wallets: [
|
||||||
@@ -160,10 +152,7 @@ function loadBackground(options) {
|
|||||||
global.chrome = {
|
global.chrome = {
|
||||||
storage: {
|
storage: {
|
||||||
local: {
|
local: {
|
||||||
get: jest.fn(
|
get: jest.fn(async () => ({ autistmask: persisted })),
|
||||||
opts.storageGet ||
|
|
||||||
(async () => ({ autistmask: persisted })),
|
|
||||||
),
|
|
||||||
set: jest.fn(async () => {}),
|
set: jest.fn(async () => {}),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -291,25 +280,6 @@ async function settle() {
|
|||||||
for (let i = 0; i < 50; i++) await Promise.resolve();
|
for (let i = 0; i < 50; i++) await Promise.resolve();
|
||||||
}
|
}
|
||||||
|
|
||||||
// Node aborts the worker process on an unhandled rejection; an extension
|
|
||||||
// service worker does not — the promise is simply never settled, nothing is
|
|
||||||
// sent back, and the page's window.ethereum.request() waits forever. Recording
|
|
||||||
// them instead of dying on them keeps that difference visible: the assertion
|
|
||||||
// that the page WAS answered is what reports the failure, and the recording is
|
|
||||||
// asserted empty alongside it.
|
|
||||||
const unhandledRejections = [];
|
|
||||||
process.on("unhandledRejection", (reason) => {
|
|
||||||
unhandledRejections.push(reason);
|
|
||||||
});
|
|
||||||
|
|
||||||
// Node reports an unhandled rejection on the macrotask turn after the promise
|
|
||||||
// was left unhandled, which is past everything settle() waits for.
|
|
||||||
async function settleIncludingRejections() {
|
|
||||||
await settle();
|
|
||||||
await new Promise((resolve) => setImmediate(resolve));
|
|
||||||
await new Promise((resolve) => setImmediate(resolve));
|
|
||||||
}
|
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
delete global.chrome;
|
delete global.chrome;
|
||||||
jest.resetModules();
|
jest.resetModules();
|
||||||
@@ -1064,147 +1034,6 @@ describe("a claimed approval outlives every other retirement path", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// A handler that throws must still answer. `sendResponse` is the only thing
|
|
||||||
// that settles the page's window.ethereum.request() promise, so a throw that
|
|
||||||
// escapes a handler leaves that promise pending forever — no error, no
|
|
||||||
// timeout, indistinguishable from a slow wallet. Each case below drives a real
|
|
||||||
// throw out of a handler rather than asserting the catch block exists.
|
|
||||||
describe("a handler that throws still settles the page", () => {
|
|
||||||
const INTERNAL_ERROR = {
|
|
||||||
code: -32603,
|
|
||||||
message:
|
|
||||||
"AutistMask could not complete this request because of an internal error.",
|
|
||||||
};
|
|
||||||
|
|
||||||
let errorLog;
|
|
||||||
beforeEach(() => {
|
|
||||||
errorLog = jest.spyOn(console, "error").mockImplementation(() => {});
|
|
||||||
unhandledRejections.length = 0;
|
|
||||||
});
|
|
||||||
afterEach(() => {
|
|
||||||
errorLog.mockRestore();
|
|
||||||
});
|
|
||||||
|
|
||||||
// getState() awaits extension storage unguarded, and every read path in
|
|
||||||
// handleRpc goes through it. A storage read that rejects is the whole
|
|
||||||
// failure — no hook in the handler itself.
|
|
||||||
test("a rejected handleRpc rejects the page instead of hanging it", async () => {
|
|
||||||
const bg = loadBackground({
|
|
||||||
storageGet: async () => {
|
|
||||||
throw new Error("storage unavailable");
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
const answer = bg.send(
|
|
||||||
{ type: "AUTISTMASK_RPC", method: "eth_accounts", params: [] },
|
|
||||||
{ origin: ORIGIN },
|
|
||||||
);
|
|
||||||
await settleIncludingRejections();
|
|
||||||
|
|
||||||
// The channel is held open for the async answer, and the answer
|
|
||||||
// arrives.
|
|
||||||
expect(answer.kept).toBe(true);
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith({
|
|
||||||
error: INTERNAL_ERROR,
|
|
||||||
});
|
|
||||||
expect(unhandledRejections).toEqual([]);
|
|
||||||
// Not swallowed: the throw is on the background console, which is how
|
|
||||||
// this class gets caught in future.
|
|
||||||
expect(errorLog).toHaveBeenCalledWith(
|
|
||||||
"[AutistMask]",
|
|
||||||
"RPC request failed:",
|
|
||||||
"eth_accounts",
|
|
||||||
expect.objectContaining({ message: "storage unavailable" }),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
// The transaction response handler wraps every statement in a try, so what
|
|
||||||
// escapes it is a throw from inside one of its catch blocks. Here the
|
|
||||||
// failure classifier itself throws while classifying a real verification
|
|
||||||
// failure — the approval is left claimed, so nothing else can settle it.
|
|
||||||
test("a throw while handling a failed transaction settles both the page and the popup", async () => {
|
|
||||||
const bg = loadBackground({
|
|
||||||
approvalVerify: {
|
|
||||||
describeTxFailure: () => {
|
|
||||||
throw new Error("classifier broke");
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const pending = bg.requestTx();
|
|
||||||
await settle();
|
|
||||||
const id = pending.id();
|
|
||||||
|
|
||||||
// A real verification failure: the artifact is signed at a nonce the
|
|
||||||
// approval never displayed.
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_TX_RESPONSE",
|
|
||||||
id,
|
|
||||||
approved: true,
|
|
||||||
rawSignedTx: await signedAtNonce(NONCE + 1),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settleIncludingRejections();
|
|
||||||
|
|
||||||
expect(bg.broadcastTransaction).not.toHaveBeenCalled();
|
|
||||||
expect(pending.result()).toEqual({ error: INTERNAL_ERROR });
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith({
|
|
||||||
error: INTERNAL_ERROR.message,
|
|
||||||
retryable: false,
|
|
||||||
// The handler cannot tell whether the transaction reached the
|
|
||||||
// network, so the popup must not say "start again from the site".
|
|
||||||
stage: "broadcast",
|
|
||||||
});
|
|
||||||
expect(unhandledRejections).toEqual([]);
|
|
||||||
expect(errorLog).toHaveBeenCalledWith(
|
|
||||||
"[AutistMask]",
|
|
||||||
"transaction approval response failed:",
|
|
||||||
expect.objectContaining({ message: "classifier broke" }),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a throw while handling a failed signature settles both the page and the popup", async () => {
|
|
||||||
const bg = loadBackground({
|
|
||||||
approvalVerify: {
|
|
||||||
failureIsRetryable: () => {
|
|
||||||
throw new Error("classifier broke");
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
const pending = bg.requestSign();
|
|
||||||
await settle();
|
|
||||||
|
|
||||||
// A real verification failure: the active address moved after the
|
|
||||||
// approval was raised.
|
|
||||||
bg.setActiveAddress(other.address);
|
|
||||||
const answer = bg.send(
|
|
||||||
{
|
|
||||||
type: "AUTISTMASK_SIGN_RESPONSE",
|
|
||||||
id: pending.id(),
|
|
||||||
approved: true,
|
|
||||||
signature: await signer.signMessage(
|
|
||||||
Buffer.from(MESSAGE.slice(2), "hex"),
|
|
||||||
),
|
|
||||||
},
|
|
||||||
{ url: bg.fromPopup.url },
|
|
||||||
);
|
|
||||||
await settleIncludingRejections();
|
|
||||||
|
|
||||||
expect(pending.result()).toEqual({ error: INTERNAL_ERROR });
|
|
||||||
expect(answer.sendResponse).toHaveBeenCalledWith({
|
|
||||||
error: INTERNAL_ERROR.message,
|
|
||||||
retryable: false,
|
|
||||||
});
|
|
||||||
expect(unhandledRejections).toEqual([]);
|
|
||||||
expect(errorLog).toHaveBeenCalledWith(
|
|
||||||
"[AutistMask]",
|
|
||||||
"sign approval response failed:",
|
|
||||||
expect.objectContaining({ message: "classifier broke" }),
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("popup-only messages", () => {
|
describe("popup-only messages", () => {
|
||||||
test("a page sender cannot answer an approval", async () => {
|
test("a page sender cannot answer an approval", async () => {
|
||||||
const bg = loadBackground();
|
const bg = loadBackground();
|
||||||
|
|||||||
@@ -86,11 +86,9 @@ 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 the whole observable shape of the error as it
|
// The rejection branch records `code` as it arrives. EIP-1193 says a user
|
||||||
// arrives — name, message, and whether a `code` is present at all as distinct
|
// rejection is a ProviderRpcError carrying code 4001; what the page can
|
||||||
// from its value. EIP-1193 says a user rejection is a ProviderRpcError
|
// actually see is recorded here rather than assumed, and asserted in run.js.
|
||||||
// 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
|
||||||
@@ -122,7 +120,6 @@ 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,",
|
||||||
" };",
|
" };",
|
||||||
|
|||||||
210
tests/e2e/run.js
210
tests/e2e/run.js
@@ -419,6 +419,172 @@ 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
|
||||||
@@ -1591,14 +1757,15 @@ 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 EIP-1193 code 4001 is present both
|
// rather than hanging or resolving, and the response that crossed the
|
||||||
// on the wire and on the Error the calling page catches.
|
// boundary carried EIP-1193 code 4001.
|
||||||
//
|
//
|
||||||
// Both ends matter because they used to disagree. The code crossed the
|
// The code is asserted on the wire because that is the only place it
|
||||||
// boundary correctly and src/content/inpage.js then threw it away, rebuilding
|
// survives. src/content/inpage.js rebuilds the rejection as `new
|
||||||
// every rejection as `new Error(error.message)` — so a dApp branching on
|
// Error(error.message)`, so the Error the calling page catches carries the
|
||||||
// `err.code === 4001` saw undefined and could not tell a refusal from a
|
// message and no code. That is reported rather than asserted either way —
|
||||||
// failure (#274). Asserting only the wire would leave that gap invisible.
|
// locking in the current behaviour would make the gap permanent, and
|
||||||
|
// 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(
|
||||||
@@ -1620,32 +1787,15 @@ 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 +
|
||||||
": code 4001 on the wire and on the page's " +
|
": boundary code=" +
|
||||||
outcome.name,
|
error.code +
|
||||||
|
" page Error.code=" +
|
||||||
|
JSON.stringify(outcome.code) +
|
||||||
|
" page Error carries a code=" +
|
||||||
|
outcome.hasCode,
|
||||||
);
|
);
|
||||||
return outcome;
|
return outcome;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,310 +0,0 @@
|
|||||||
// 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