fix: a refresh asked for while another runs is no longer dropped (closes #581)

doRefreshAndRender() returned at once when a refresh was already running. An
import asks for a refresh after its address scan. During a refresh, that
request was dropped. The addresses the scan found then showed 0.0000 until the
next ten-second refresh.

While a refresh runs, a request through ctx now sets a flag. One more refresh
runs once the running one ends. Several requests in that time lead to one more
refresh, not several. A tick of the ten-second timer that finds a refresh
running is still dropped.

Model: opus-5-5

Dockerfile

@@ -10,7 +10,6 @@ WORKDIR /app
 
 COPY script/ script/
 COPY package.json yarn.lock ./
-# yarn warns about the workspaces field in eslint and babel-plugin-istanbul; no newer release drops it.
 RUN script/bootstrap
 
 COPY . .

README.md

@@ -2053,21 +2053,15 @@ view would leave a wallet one click from deletion.
       fee estimate and the contract and never-sent recipient checks ask that
       network's RPC endpoint, and the Etherscan label check asks that network's
       explorer
-    - "Sign & Send" (correct password) when the gas limit or a fee is over its
+    - "Sign & Send" (correct password) when the gas limit, a fee per gas or the
-      bound → nothing is signed; "The gas limit or fee the RPC endpoint quoted
+      total fee the RPC endpoint fills in at signing is over its bound in
-      for this transaction is more than this wallet will sign for, so it was not
+      `assertWithinCeilings()` (`src/shared/approvalVerify.js`) → nothing is
-      sent. Please go back and try again." in its own box, no screen change. For
+      signed; "The gas limit or fee the RPC endpoint quoted for this transaction
-      an ETH amount that Send's "Max" filled in, the gas limit and fees are
+      is more than this wallet will sign for, so it was not sent. Please go back
-      those of this screen's own fee estimate (see Amount above). For any other
+      and try again." in its own box, the same sentence for all three, no screen
-      send, the RPC endpoint fills in the gas limit and fees at signing. Just
+      change
-      before signing, `assertWithinCeilings()` (`src/shared/approvalVerify.js`)
+    - "Sign & Send" (wrong password) → "Wrong password." on the password error
-      refuses the send when any of these is over its bound:
+      line, no screen change
-        - the gas limit
-        - each fee per gas the transaction sets
-        - the total fee: the gas limit times `maxFeePerGas`, or times `gasPrice`
-          when the transaction has no `maxFeePerGas`
-    - "Sign & Send" (wrong password) → "That password is incorrect. Please try
-      again." on the password error line, no screen change
     - "Sign & Send" signs as the From address above, not as whichever address is
       selected: the two are saved separately, so the popup can reopen onto this
       screen with another address selected. When the selected wallet does not
@@ -2239,8 +2233,6 @@ view would leave a wallet one click from deletion.
       **AddressDetail**
     - "Add" with a token already tracked, a scam-listed address, or a failed
       contract lookup → flash message, no screen change
-    - "Add", then the contract lookup answers while another screen shows, or
-      after AddToken was opened again → tracks the token, no screen change
     - "Add", then a network switch in Settings before the contract lookup
       answers → nothing is tracked; "The active network changed before the
       lookup finished, so the token was not added." flash message, no screen

package.json

@@ -6,8 +6,8 @@
     "license": "GPL-3.0",
     "private": true,
     "scripts": {
-        "test": "jest --maxWorkers=3",
+        "test": "jest --forceExit --maxWorkers=3",
-        "test:verbose": "jest --maxWorkers=3 --verbose",
+        "test:verbose": "jest --forceExit --maxWorkers=3 --verbose",
         "build": "node build.js",
         "lint": "eslint . && prettier --check .",
         "fmt": "prettier --write .",

script/bootstrap

@@ -118,7 +118,6 @@ ensure_yarn() {
     fi
 }
 
-# yarn warns about the workspaces field in eslint and babel-plugin-istanbul; no newer release drops it.
 install_js_deps() {
     if missing yarn && [ -s "$HOME/.nvm/nvm.sh" ]; then
         nvm_sh "nvm use $NODE_VERSION >/dev/null && cd \"$ROOT\" && \

src/popup/views/addToken.js

@@ -5,12 +5,7 @@ const { lookupTokenInfo } = require("../../shared/balances");
 const { isScamAddress } = require("../../shared/scamlist");
 const { log } = require("../../shared/log");
 
-// Counts the times AddToken has opened. A contract lookup started before
-// AddToken was last opened changes neither the screen nor the status line.
-let addTokenScreenOpenings = 0;
-
 function show() {
-    addTokenScreenOpenings++;
     $("add-token-address").value = "";
     $("add-token-info").textContent = "";
     $("add-token-info").style.visibility = "hidden";
@@ -60,7 +55,6 @@ function init(ctx) {
         // The network the lookup asks, which Settings may switch away from
         // before it answers, as for a transaction in confirmTx.js.
         const chainId = currentNetwork().chainId;
-        const opening = addTokenScreenOpenings;
         try {
             const info = await lookupTokenInfo(
                 contractAddr,
@@ -86,17 +80,6 @@ function init(ctx) {
             });
             await saveState();
             ctx.doRefreshAndRender();
-            // If the lookup answers after AddToken was opened again, the
-            // token is still added, but the screen and the status line stay
-            // as they are.
-            if (addTokenScreenOpenings !== opening) return;
-            // The lookup is over, so a later Back onto AddToken shows no
-            // status.
-            infoEl.textContent = "";
-            infoEl.style.visibility = "hidden";
-            // If the lookup answers while another screen shows, the token is
-            // still added but the screen does not change.
-            if (state.currentView !== "add-token") return;
             // Pop the stack (back to address detail) and re-render it
             // so the newly added token is visible immediately.
             if (state.viewStack.length > 0) {
@@ -117,7 +100,6 @@ function init(ctx) {
                     ? detail
                     : "Could not add the token.",
             );
-            if (addTokenScreenOpenings !== opening) return;
             infoEl.textContent = "";
             infoEl.style.visibility = "hidden";
         }

tests/addTokenLateAnswer.test.js

@@ -1,137 +0,0 @@
-// A contract lookup on AddToken can answer after the user has left AddToken.
-// The token is still added, and the screen the user is on does not change
-// (https://git.eeqj.de/sneak/AutistMask/issues/603). An answer while AddToken
-// still shows goes to AddressDetail. Driven through the real popup over a
-// stored profile.
-
-const {
-    bootPopup,
-    cleanupPopup,
-    unversionedValidProfile,
-    TOKEN_ADDRESS,
-} = require("./support/popupBoot");
-
-const TOKEN = {
-    address: TOKEN_ADDRESS,
-    symbol: "TST",
-    decimals: 18,
-    name: "Test Token",
-};
-
-// A second contract address, typed after AddToken was opened again.
-const OTHER_TOKEN_ADDRESS = "0xBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB";
-
-afterEach(() => {
-    cleanupPopup();
-});
-
-// The popup reopened onto AddressDetail, then AddToken opened from it with
-// TOKEN's contract address typed in.
-async function openAddToken() {
-    const boot = await bootPopup(
-        unversionedValidProfile({
-            currentView: "address",
-            selectedWallet: 0,
-            selectedAddress: 0,
-        }),
-    );
-    expect(boot.pageErrors).toEqual([]);
-    await boot.click("btn-add-token");
-    expect(boot.visibleViews()).toEqual(["add-token"]);
-    boot.node("add-token-address").value = TOKEN.address;
-    return boot;
-}
-
-// Presses Add with a contract lookup that answers only when the function
-// returned here is called. That function waits for Add to finish.
-function addWithPendingLookup(boot) {
-    const { lookupTokenInfo } = require("../src/shared/balances");
-    let answer;
-    lookupTokenInfo.mockImplementationOnce(
-        () =>
-            new Promise((resolve) => {
-                answer = resolve;
-            }),
-    );
-    const adding = boot.click("btn-add-token-confirm");
-    return async () => {
-        answer({
-            symbol: TOKEN.symbol,
-            decimals: TOKEN.decimals,
-            name: TOKEN.name,
-        });
-        await adding;
-    };
-}
-
-test("an answer after the user opened Settings adds the token and Settings stays", async () => {
-    const boot = await openAddToken();
-    const answerLookup = addWithPendingLookup(boot);
-    await boot.click("btn-settings");
-    expect(boot.visibleViews()).toEqual(["settings"]);
-
-    await answerLookup();
-    expect(boot.visibleViews()).toEqual(["settings"]);
-    expect(boot.storage.read("autistmask").trackedTokens).toEqual([TOKEN]);
-});
-
-test("Back from Settings onto AddToken after the lookup answered shows no lookup status", async () => {
-    const boot = await openAddToken();
-    const answerLookup = addWithPendingLookup(boot);
-    expect(boot.text("add-token-info")).toBe("Looking up token...");
-    await boot.click("btn-settings");
-    await answerLookup();
-
-    await boot.click("btn-settings-back");
-    expect(boot.visibleViews()).toEqual(["add-token"]);
-    expect(boot.text("add-token-info")).toBe("");
-    expect(boot.node("add-token-info").style.visibility).toBe("hidden");
-});
-
-test("an answer after AddToken was opened again adds the token and leaves AddToken and its status line as they are", async () => {
-    const boot = await openAddToken();
-    const answerFirstLookup = addWithPendingLookup(boot);
-    await boot.click("btn-add-token-back");
-    await boot.click("btn-add-token");
-    expect(boot.visibleViews()).toEqual(["add-token"]);
-    boot.node("add-token-address").value = OTHER_TOKEN_ADDRESS;
-    // The second lookup is never answered.
-    addWithPendingLookup(boot);
-
-    await answerFirstLookup();
-    expect(boot.visibleViews()).toEqual(["add-token"]);
-    expect(boot.text("add-token-info")).toBe("Looking up token...");
-    expect(boot.storage.read("autistmask").trackedTokens).toEqual([TOKEN]);
-});
-
-test("a lookup that fails after AddToken was opened again leaves the status line as it is", async () => {
-    const boot = await openAddToken();
-    const { lookupTokenInfo } = require("../src/shared/balances");
-    let failFirstLookup;
-    lookupTokenInfo.mockImplementationOnce(
-        () =>
-            new Promise((_, reject) => {
-                failFirstLookup = reject;
-            }),
-    );
-    const firstAdd = boot.click("btn-add-token-confirm");
-    await boot.click("btn-add-token-back");
-    await boot.click("btn-add-token");
-    boot.node("add-token-address").value = OTHER_TOKEN_ADDRESS;
-    // The second lookup is never answered.
-    addWithPendingLookup(boot);
-
-    failFirstLookup(new Error("lookup failed"));
-    await firstAdd;
-    expect(boot.text("add-token-info")).toBe("Looking up token...");
-});
-
-test("an answer while AddToken still shows goes to AddressDetail with the token listed", async () => {
-    const boot = await openAddToken();
-    const answerLookup = addWithPendingLookup(boot);
-
-    await answerLookup();
-    expect(boot.visibleViews()).toEqual(["address"]);
-    expect(boot.node("address-balances").innerHTML).toContain("TST");
-    expect(boot.storage.read("autistmask").trackedTokens).toEqual([TOKEN]);
-});

tests/addressKey.test.js

@@ -161,7 +161,7 @@ function click(element) {
 
 // show() starts the fee estimate without awaiting it; this lets it settle.
 async function settle() {
-    for (let i = 0; i < 10; i++) await jest.advanceTimersByTimeAsync(0);
+    for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
 }
 
 // ------------------------------------------------------------ harness
@@ -188,11 +188,7 @@ let sent;
 // handler to the buttons it drew, as the browser's fresh list would have.
 let plusButton;
 
-// showFlash() starts a timer that clears the message one or two seconds later.
-// Each test here runs on fake timers and drops them in afterEach, so that timer
-// never outlives the test.
 beforeEach(() => {
-    jest.useFakeTimers();
     approvalDetails = null;
     sent = [];
     mockNode.broadcast = [];
@@ -243,7 +239,6 @@ beforeEach(() => {
 });
 
 afterEach(() => {
-    jest.useRealTimers();
     jest.restoreAllMocks();
 });
 

tests/backgroundApproval.test.js

@@ -537,18 +537,7 @@ async function settleIncludingRejections() {
     await new Promise((resolve) => setImmediate(resolve));
 }
 
-// While an approval is pending, the background starts a 20-second timer to
-// keep itself running. The timer is stubbed and never starts, so no test in
-// this file leaves it running.
-let keepRunningTimer;
-beforeEach(() => {
-    keepRunningTimer = jest
-        .spyOn(global, "setInterval")
-        .mockImplementation(() => 1);
-});
-
 afterEach(() => {
-    keepRunningTimer.mockRestore();
     delete global.chrome;
     jest.resetModules();
 });
@@ -1894,6 +1883,18 @@ describe("a closed approval window leaves the request pending", () => {
         return bg.actionPopups[bg.actionPopups.length - 1];
     }
 
+    // The timer that keeps the worker running while an approval is pending is
+    // stubbed, so no test here leaves that timer running when it ends.
+    let keepRunningTimer;
+    beforeEach(() => {
+        keepRunningTimer = jest
+            .spyOn(global, "setInterval")
+            .mockImplementation(() => 1);
+    });
+    afterEach(() => {
+        keepRunningTimer.mockRestore();
+    });
+
     test("the toolbar popup opens a closed transaction approval, and approving it there sends", async () => {
         const bg = loadBackground();
         const pending = bg.requestTx();

tests/backgroundStateIsolation.test.js

@@ -103,18 +103,7 @@ function deferred() {
     return { promise, resolve };
 }
 
-// While an approval is pending, the background starts a 20-second timer to
-// keep itself running. The timer is stubbed and never starts, so no test in
-// this file leaves it running.
-let keepRunningTimer;
-beforeEach(() => {
-    keepRunningTimer = jest
-        .spyOn(global, "setInterval")
-        .mockImplementation(() => 1);
-});
-
 afterEach(() => {
-    keepRunningTimer.mockRestore();
     delete global.chrome;
 });
 

tests/chainSwitchGate.test.js

@@ -56,18 +56,7 @@ async function settle() {
     for (let i = 0; i < 50; i++) await Promise.resolve();
 }
 
-// While an approval is pending, the background starts a 20-second timer to
-// keep itself running. The timer is stubbed and never starts, so no test in
-// this file leaves it running.
-let keepRunningTimer;
-beforeEach(() => {
-    keepRunningTimer = jest
-        .spyOn(global, "setInterval")
-        .mockImplementation(() => 1);
-});
-
 afterEach(() => {
-    keepRunningTimer.mockRestore();
     delete global.chrome;
 });
 

tests/coldWorkerChainSwitch.test.js

@@ -64,18 +64,7 @@ async function settle() {
     for (let i = 0; i < 50; i++) await Promise.resolve();
 }
 
-// While an approval is pending, the background starts a 20-second timer to
-// keep itself running. The timer is stubbed and never starts, so no test in
-// this file leaves it running.
-let keepRunningTimer;
-beforeEach(() => {
-    keepRunningTimer = jest
-        .spyOn(global, "setInterval")
-        .mockImplementation(() => 1);
-});
-
 afterEach(() => {
-    keepRunningTimer.mockRestore();
     delete global.chrome;
 });
 

tests/coldWorkerSendTransaction.test.js

@@ -76,18 +76,7 @@ async function settle() {
     for (let i = 0; i < 60; i++) await Promise.resolve();
 }
 
-// While an approval is pending, the background starts a 20-second timer to
-// keep itself running. The timer is stubbed and never starts, so no test in
-// this file leaves it running.
-let keepRunningTimer;
-beforeEach(() => {
-    keepRunningTimer = jest
-        .spyOn(global, "setInterval")
-        .mockImplementation(() => 1);
-});
-
 afterEach(() => {
-    keepRunningTimer.mockRestore();
     delete global.chrome;
 });
 

tests/connectedSitesWorkerRestart.test.js

@@ -57,18 +57,7 @@ async function settle() {
     for (let i = 0; i < 50; i++) await Promise.resolve();
 }
 
-// While an approval is pending, the background starts a 20-second timer to
-// keep itself running. The timer is stubbed and never starts, so no test in
-// this file leaves it running.
-let keepRunningTimer;
-beforeEach(() => {
-    keepRunningTimer = jest
-        .spyOn(global, "setInterval")
-        .mockImplementation(() => 1);
-});
-
 afterEach(() => {
-    keepRunningTimer.mockRestore();
     delete global.chrome;
     jest.resetModules();
 });

tests/deleteWalletLostPassword.test.js

@@ -102,17 +102,6 @@ function makeDocument() {
 
 // ------------------------------------------------------------ harness
 
-// showFlash() starts a timer that clears the message two seconds later. Each
-// test here runs on fake timers and drops them in afterEach, so that timer
-// never outlives the test.
-beforeEach(() => {
-    jest.useFakeTimers();
-});
-
-afterEach(() => {
-    jest.useRealTimers();
-});
-
 function wallet(name, secret, addresses) {
     return {
         type: "hd",

tests/sendAmountRule.test.js

@@ -131,14 +131,10 @@ async function review(amount, token) {
 async function confirm(amount, token) {
     const txInfo = await review("0.5", token);
     confirmTx.show({ ...txInfo, amount });
-    for (let i = 0; i < 10; i++) await jest.advanceTimersByTimeAsync(0);
+    for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
 }
 
-// showFlash() starts a timer that clears the message two seconds later. Each
-// test here runs on fake timers and drops them in afterEach, so that timer
-// never outlives the test.
 beforeEach(() => {
-    jest.useFakeTimers();
     elements.clear();
     state.wallets = [
         {
@@ -171,10 +167,6 @@ beforeEach(() => {
     state.currentView = null;
 });
 
-afterEach(() => {
-    jest.useRealTimers();
-});
-
 describe.each([
     ["1e-3", "ETH"],
     ["1e-3", "TOK"],

tests/sendMax.test.js

@@ -277,18 +277,14 @@ async function review() {
 
 // show() starts the fee estimate without awaiting it; this lets it settle.
 async function settle() {
-    for (let i = 0; i < 10; i++) await jest.advanceTimersByTimeAsync(0);
+    for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
 }
 
 function canSend() {
     return !el("btn-confirm-send").disabled;
 }
 
-// showFlash() starts a timer that clears the message two seconds later. Each
-// test here runs on fake timers and drops them in afterEach, so that timer
-// never outlives the test.
 beforeEach(() => {
-    jest.useFakeTimers();
     elements.clear();
     log.errorf.mockClear();
     pageClosed = new AbortController();
@@ -301,10 +297,6 @@ beforeEach(() => {
     mockNode.broadcast = [];
 });
 
-afterEach(() => {
-    jest.useRealTimers();
-});
-
 describe("Max on an ETH send", () => {
     test("fills in the exact balance minus the fee reserve", async () => {
         await refreshWith(BALANCE_WEI);

tests/walletDefects.test.js

@@ -357,11 +357,6 @@ describe("every way to a signature or the private key refuses a defective wallet
     });
 
     beforeEach(() => {
-        // showFlash() starts a timer that clears the message two seconds
-        // later. Each test here runs on fake timers and drops them in
-        // afterEach, so that timer never outlives the test.
-        jest.useFakeTimers();
-
         const broken = brokenXprvWallet();
         // A balance, so that no Send button's zero-balance refusal can stand
         // in for the defect check.
@@ -403,7 +398,6 @@ describe("every way to a signature or the private key refuses a defective wallet
     });
 
     afterEach(() => {
-        jest.useRealTimers();
         state.wallets = [];
         state.activeAddress = null;
         state.selectedWallet = null;