fix: the address screen shows a token just added at its fetched balance, not 0.0000 (closes #516)

A balance refresh that returns now draws the balances on AddressDetail or
AddressToken again when that screen is up, not only the wallet list. Their
transaction lists are left alone.

Every add path on AddToken and SettingsAddToken tracks a token through
trackToken(), which gives the tracked record `balanceNotFetched: true`. While
the field is set, the token's line reads `quantity unknown` instead of 0.0000.
The popup's refresh deletes the field once it has read the token's balance at
every address. refreshBalances() now resolves with those tokens. The field is
part of the tracked record, so removing the token removes it, and each network
keeps its own records.

Model: opus-5-5

tests/addedTokenBalance.test.js

@@ -0,0 +1,382 @@
+// After "Add" on AddToken, AddressDetail lists the new token. Its line reads
+// `quantity unknown`, not 0.0000, until a balance refresh has read the token's
+// balance at every address, even if the popup closes and opens again
+// meanwhile. A token added on SettingsAddToken reads the same wherever it is
+// listed. A refresh that returns draws the balances on AddressDetail or
+// AddressToken again, so the fetched balance shows without the screen being
+// reopened (https://git.eeqj.de/sneak/AutistMask/issues/516).
+//
+// The tracked token's record carries `balanceNotFetched` until a refresh has
+// read the token's balance. Removing the token removes that record. A network
+// switch keeps each network's records apart.
+//
+// Driven through the real popup over a stored profile on Ethereum Mainnet,
+// with "Show tracked tokens with zero balance" on, as it is by default.
+
+const {
+    bootPopup,
+    cleanupPopup,
+    unversionedValidProfile,
+} = require("./support/popupBoot");
+
+// Tracked by nobody until a test adds it.
+const NEW_TOKEN = "0xBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB";
+
+// A holding of a million NEW_TOKEN, as refreshBalances() stores it.
+const MILLION = {
+    address: NEW_TOKEN,
+    name: "New Token",
+    symbol: "NEW",
+    decimals: 18,
+    balance: "1000000.0",
+    holders: 3,
+};
+
+afterEach(() => {
+    cleanupPopup();
+});
+
+// The popup reopened onto AddressDetail for the one address.
+function bootOnAddress(extra) {
+    return bootPopup(
+        unversionedValidProfile({
+            currentView: "address",
+            selectedWallet: 0,
+            selectedAddress: 0,
+            ...extra,
+        }),
+    );
+}
+
+// Holds the next balance refresh open. The returned function lets it finish
+// with the address's ETH balance at 2 and `tokenBalances` as its token
+// entries, having read the balance of every token tracked when it started.
+// Given null, it finishes having read no token's balance, as when every
+// balanceOf fails, and leaves the token entries as they were.
+function holdNextRefresh(page) {
+    const { refreshBalances } = require("../src/shared/balances");
+    let release;
+    refreshBalances.mockImplementationOnce(
+        async (wallets, rpcUrl, explorerUrl, trackedTokens) => {
+            const read = trackedTokens.map((t) => t.address.toLowerCase());
+            const tokenBalances = await new Promise((resolve) => {
+                release = resolve;
+            });
+            wallets[0].addresses[0].balance = "2.0";
+            if (tokenBalances === null) return [];
+            wallets[0].addresses[0].tokenBalances = tokenBalances;
+            return read;
+        },
+    );
+    return async (tokenBalances) => {
+        release(tokenBalances);
+        await page.settle();
+    };
+}
+
+// Runs the ten-second refresh to the end, finishing it as holdNextRefresh()
+// does with `tokenBalances`.
+async function refreshOnce(page, tokenBalances) {
+    const finish = holdNextRefresh(page);
+    const ticking = page.tick();
+    await page.settle();
+    await finish(tokenBalances);
+    await ticking;
+}
+
+// "+ Token", NEW_TOKEN typed in, and "Add", with the contract lookup
+// answering at once.
+async function addNewToken(page) {
+    const { lookupTokenInfo } = require("../src/shared/balances");
+    lookupTokenInfo.mockResolvedValueOnce({
+        symbol: "NEW",
+        decimals: 18,
+        name: "New Token",
+    });
+    await page.click("btn-add-token");
+    page.node("add-token-address").value = NEW_TOKEN;
+    await page.click("btn-add-token-confirm");
+}
+
+// Settings' "+ Add token", NEW_TOKEN typed in, and "Add", with the contract
+// lookup answering at once. It ends on SettingsAddToken.
+async function addOnSettingsAddToken(page) {
+    const { lookupTokenInfo } = require("../src/shared/balances");
+    lookupTokenInfo.mockResolvedValueOnce({
+        symbol: "NEW",
+        decimals: 18,
+        name: "New Token",
+    });
+    await page.click("btn-settings-add-token");
+    page.node("settings-addtoken-address").value = NEW_TOKEN;
+    await page.click("btn-settings-addtoken-manual");
+}
+
+// The "[x]" button Settings draws beside the first tracked token. The page
+// stub does not turn the markup Settings draws into elements. So the list
+// hands Settings a stand-in for that button each time it is drawn, and
+// `press()` presses the last one drawn. Call it before Settings opens.
+function firstRemoveButton(page) {
+    const button = { press: null };
+    page.node("settings-tracked-tokens").querySelectorAll = () => [
+        {
+            dataset: { idx: "0" },
+            addEventListener: (name, fn) => {
+                button.press = fn;
+            },
+        },
+    ];
+    return button;
+}
+
+// Picks `networkId` in the Settings network selector, as the user does.
+async function chooseNetwork(page, networkId) {
+    const select = page.node("settings-network");
+    select.value = networkId;
+    for (const fn of select.listeners.change) await fn();
+    await page.settle();
+}
+
+// NEW_TOKEN's row in the balance list in element `id`, AddressDetail's unless
+// another is named, as markup.
+function newTokenRow(page, id = "address-balances") {
+    return page
+        .node(id)
+        .innerHTML.split("<div ")
+        .find((row) =>
+            row.includes('data-token="' + NEW_TOKEN.toLowerCase() + '"'),
+        );
+}
+
+// AddressDetail for the one address opened from Home, as its `[info]` button
+// does.
+async function openAddress(page) {
+    const { state } = require("../src/shared/state");
+    state.selectedWallet = 0;
+    state.selectedAddress = 0;
+    require("../src/popup/views/helpers").pushCurrentView();
+    require("../src/popup/views/addressDetail").show();
+    await page.settle();
+}
+
+// AddressToken for `token` opened from AddressDetail, as tapping the token's
+// row there does.
+async function openToken(page, token) {
+    const { state } = require("../src/shared/state");
+    state.selectedToken = token;
+    require("../src/popup/views/helpers").pushCurrentView();
+    require("../src/popup/views/addressToken").show();
+    await page.settle();
+}
+
+test("until the refresh Add started returns, the new token's line reads quantity unknown", async () => {
+    const page = await bootOnAddress();
+    expect(page.pageErrors).toEqual([]);
+    const finish = holdNextRefresh(page);
+
+    await addNewToken(page);
+
+    expect(page.visibleViews()).toEqual(["address"]);
+    const row = newTokenRow(page);
+    expect(row).toContain("quantity unknown");
+    expect(row).not.toContain("0.0000");
+    await finish([MILLION]);
+});
+
+test("once that refresh returns, AddressDetail shows the fetched balance without being reopened", async () => {
+    const page = await bootOnAddress();
+    const finish = holdNextRefresh(page);
+    await addNewToken(page);
+    // Stands for the transactions on the screen, which only show() replaces.
+    page.node("tx-list").innerHTML = "transactions on the screen";
+
+    await finish([MILLION]);
+
+    expect(page.visibleViews()).toEqual(["address"]);
+    expect(newTokenRow(page)).toContain("1000000.0000");
+    // Only the balances are drawn again, not the transaction list.
+    expect(page.node("tx-list").innerHTML).toBe("transactions on the screen");
+});
+
+test("a refresh already running when the token is added does not count as reading its balance", async () => {
+    const page = await bootOnAddress();
+    const finishRunning = holdNextRefresh(page);
+    const ticking = page.tick();
+    await page.settle();
+
+    await addNewToken(page);
+    await finishRunning([]);
+    await ticking;
+
+    expect(newTokenRow(page)).toContain("quantity unknown");
+
+    // The next one reads the token's balance, which is zero.
+    await refreshOnce(page, []);
+
+    expect(newTokenRow(page)).toContain("0.0000");
+});
+
+test("closed and opened again before any refresh has read its balance, the new token's line still reads quantity unknown", async () => {
+    const closed = await bootOnAddress();
+    holdNextRefresh(closed);
+    await addNewToken(closed);
+    cleanupPopup();
+
+    // The refresh this boot starts reads no token's balance: the boot's stub
+    // of refreshBalances() reads none.
+    const page = await bootPopup(undefined, { storage: closed.storage });
+    expect(page.visibleViews()).toEqual(["address"]);
+    const row = newTokenRow(page);
+    expect(row).toContain("quantity unknown");
+    expect(row).not.toContain("0.0000");
+
+    await refreshOnce(page, [MILLION]);
+
+    expect(newTokenRow(page)).toContain("1000000.0000");
+});
+
+test("a refresh that could not read the new token's balance leaves its line quantity unknown", async () => {
+    const page = await bootOnAddress();
+    const finish = holdNextRefresh(page);
+    await addNewToken(page);
+
+    await finish(null);
+
+    // Drawn again: the ETH balance it fetched is shown.
+    expect(page.node("address-balances").innerHTML).toContain("2.0000");
+    expect(newTokenRow(page)).toContain("quantity unknown");
+});
+
+test("AddressToken for the new token reads quantity unknown until the refresh returns, then the fetched balance", async () => {
+    const page = await bootOnAddress();
+    const finish = holdNextRefresh(page);
+    await addNewToken(page);
+
+    await openToken(page, NEW_TOKEN.toLowerCase());
+
+    expect(page.visibleViews()).toEqual(["address-token"]);
+    const before = page.node("address-token-balance").innerHTML;
+    expect(before).toContain("quantity unknown");
+    expect(before).not.toContain("0.0000");
+
+    await finish([MILLION]);
+
+    expect(page.node("address-token-balance").innerHTML).toContain(
+        "1000000.0000",
+    );
+});
+
+test("a token added by contract address on SettingsAddToken reads quantity unknown until the refresh returns", async () => {
+    const page = await bootPopup(unversionedValidProfile());
+    expect(page.visibleViews()).toEqual(["main"]);
+    const finish = holdNextRefresh(page);
+
+    await page.click("btn-settings");
+    await addOnSettingsAddToken(page);
+    await page.click("btn-settings-addtoken-back");
+    await page.click("btn-settings-back");
+    expect(page.visibleViews()).toEqual(["main"]);
+    const onHome = newTokenRow(page, "wallet-list");
+    expect(onHome).toContain("quantity unknown");
+    expect(onHome).not.toContain("0.0000");
+
+    await openAddress(page);
+    const onAddress = newTokenRow(page);
+    expect(onAddress).toContain("quantity unknown");
+    expect(onAddress).not.toContain("0.0000");
+
+    await finish([MILLION]);
+
+    expect(newTokenRow(page)).toContain("1000000.0000");
+});
+
+test("a refresh that returns while AddressToken is up draws its balance again", async () => {
+    const page = await bootPopup(
+        unversionedValidProfile({
+            currentView: "address-token",
+            viewStack: ["main", "address"],
+            selectedWallet: 0,
+            selectedAddress: 0,
+            selectedToken: "ETH",
+        }),
+    );
+    expect(page.visibleViews()).toEqual(["address-token"]);
+    expect(page.node("address-token-balance").innerHTML).toContain("1.5000");
+
+    await refreshOnce(page, null);
+
+    expect(page.node("address-token-balance").innerHTML).toContain("2.0000");
+});
+
+test("a token removed before any refresh has read its balance leaves nothing stored, and adding it again tracks it once", async () => {
+    const page = await bootPopup(unversionedValidProfile());
+    const removeButton = firstRemoveButton(page);
+    const stored = () => page.storage.read("autistmask");
+
+    await page.click("btn-settings");
+    await addOnSettingsAddToken(page);
+    // Settings opened again from Home draws its list with the token in it.
+    await page.click("btn-settings-addtoken-back");
+    await page.click("btn-settings-back");
+    await page.click("btn-settings");
+    await removeButton.press();
+    await page.settle();
+
+    expect(stored().trackedTokens).toEqual([]);
+    // Nothing in the stored record names the token any more.
+    expect(JSON.stringify(stored()).toLowerCase()).not.toContain(
+        NEW_TOKEN.toLowerCase(),
+    );
+
+    await addOnSettingsAddToken(page);
+    // A second add of the same token is refused.
+    page.node("settings-addtoken-address").value = NEW_TOKEN;
+    await page.click("btn-settings-addtoken-manual");
+
+    const added = { address: NEW_TOKEN, symbol: "NEW", decimals: 18 };
+    expect(stored().trackedTokens).toEqual([
+        { ...added, name: "New Token", balanceNotFetched: true },
+    ]);
+
+    await refreshOnce(page, []);
+
+    expect(stored().trackedTokens).toEqual([{ ...added, name: "New Token" }]);
+});
+
+test("a refresh on another network leaves the new token reading quantity unknown on its own", async () => {
+    // Sepolia tracks a token at the same contract address, also just added.
+    const sepoliaToken = {
+        address: NEW_TOKEN,
+        symbol: "SEP",
+        name: "Sepolia Token",
+        decimals: 18,
+    };
+    const page = await bootOnAddress({
+        networkTrackedTokens: {
+            sepolia: [{ ...sepoliaToken, balanceNotFetched: true }],
+        },
+    });
+    const finishMainnet = holdNextRefresh(page);
+    await addNewToken(page);
+
+    await page.click("btn-settings");
+    await chooseNetwork(page, "sepolia");
+    // The refresh Add started returns after the switch and writes nothing.
+    await finishMainnet([MILLION]);
+    // Sepolia's refresh reads the balance of its own token.
+    await refreshOnce(page, []);
+
+    const stored = page.storage.read("autistmask");
+    expect(stored.trackedTokens).toEqual([sepoliaToken]);
+    expect(stored.networkTrackedTokens.mainnet[0].balanceNotFetched).toBe(true);
+
+    await chooseNetwork(page, "mainnet");
+    await page.click("btn-settings-back");
+
+    expect(page.visibleViews()).toEqual(["address"]);
+    expect(newTokenRow(page)).toContain("quantity unknown");
+
+    await refreshOnce(page, [MILLION]);
+
+    expect(newTokenRow(page)).toContain("1000000.0000");
+});

tests/balanceRefreshNetworkSwitch.test.js

@@ -41,6 +41,7 @@ async function holdRefresh(page) {
                 holders: null,
             },
         ];
+        return [];
     });
     const ticking = page.tick();
     await page.settle();

tests/blockscoutEtherscanSettings.test.js

@@ -720,6 +720,7 @@ describe("the popup", () => {
                 tokenRow(TRACKED, "TRK"),
                 tokenRow(UNTRACKED, "TST"),
             ];
+            return [];
         });
         const ticking = page.tick();
         await page.settle();
@@ -764,6 +765,7 @@ describe("the popup", () => {
                 addr.tokenBalances = after
                     ? [tokenRow(TRACKED, "TRK"), tokenRow(UNTRACKED, "TST")]
                     : [tokenRow(TRACKED, "TRK")];
+                return [];
             });
 
             anotherPageSaves(page, { useBlockscout: after });

tests/e2e/run.js

@@ -969,7 +969,8 @@ test("a token added by its contract address is listed on the address screen (#15
     await visible(env.page, "#view-address");
 
     // No wait: the confirm renders the balance list before it shows the
-    // screen, and nothing renders the list again while the screen is up.
+    // screen. The refresh it starts draws the list again, with the row still
+    // in it.
     const row = env.page.locator(
         '#address-balances [data-token="' + STUB_TOKEN.address + '"]',
         { hasText: STUB_TOKEN.symbol },

tests/firstWalletRefresh.test.js

@@ -48,6 +48,7 @@ async function boot(stored) {
         for (const wallet of wallets) {
             for (const addr of wallet.addresses) addr.balance = chainBalance;
         }
+        return [];
     });
     return { page, refreshBalances };
 }

tests/flashLine.test.js

@@ -88,6 +88,7 @@ describe.each([
             showFlash: (msg) => flashes.push(msg),
             escapeHtml: (s) => s,
             goBack: () => {},
+            trackToken: () => {},
         }));
 
         require("../src/popup/views/" + view).init({

tests/support/popupBoot.js

@@ -279,10 +279,11 @@ async function bootPopup(stored, options) {
         getAddressValue: () => ({ usd: null, partial: false }),
     }));
     // scanForAddresses() answers in the real one's shape, a scan that found
-    // no used address: AddWallet reads `addresses` from it.
+    // no used address: AddWallet reads `addresses` from it. refreshBalances()
+    // answers as a refresh that read no tracked token's balance.
     jest.doMock("../../src/shared/balances", () => ({
         fetchTokenBalances: jest.fn(async () => []),
-        refreshBalances: jest.fn(async () => {}),
+        refreshBalances: jest.fn(async () => []),
         dropUntrackedTokens: jest.requireActual("../../src/shared/balances")
             .dropUntrackedTokens,
         lookupTokenInfo: jest.fn(async () => null),

tests/trackedTokenBalances.test.js

@@ -307,3 +307,31 @@ test("a tracked token wearing a known symbol from another contract is not listed
     );
     expect(first.tokenBalances).toEqual([]);
 });
+
+test("the refresh resolves with each tracked token whose balance it read at every address", async () => {
+    const flaky = "0x9999999999999999999999999999999999999999";
+    holdings[TOKEN] = { [FIRST]: 2000000n, [SECOND]: 0n };
+    // balanceOf answers at FIRST and fails at SECOND.
+    holdings[flaky] = { [FIRST]: 2000000n };
+    const read = await refreshBalances(
+        [
+            {
+                addresses: [
+                    { address: FIRST, tokenBalances: [] },
+                    { address: SECOND, tokenBalances: [] },
+                ],
+            },
+        ],
+        RPC_URL,
+        EXPLORER_URL,
+        [
+            TRACKED,
+            { address: flaky, symbol: "FLK", name: "Flaky", decimals: 6 },
+            // A known symbol from another contract: its balance is not read.
+            { address: OTHER, symbol: "USDC", name: "Fake", decimals: 6 },
+        ],
+        "mainnet",
+        new AbortController().signal,
+    );
+    expect(read).toEqual([TOKEN]);
+});

tests/trackedTokensPerNetwork.test.js

@@ -159,7 +159,9 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
         "sepolia",
         expect.anything(),
     );
-    expect(stored().trackedTokens).toEqual([SEPOLIA_TOKEN]);
+    // No refresh has read the new token's balance yet.
+    const added = { ...SEPOLIA_TOKEN, balanceNotFetched: true };
+    expect(stored().trackedTokens).toEqual([added]);
 
     await boot.click("btn-settings");
     await chooseNetwork(boot, "mainnet");
@@ -171,7 +173,7 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
 
     await chooseNetwork(boot, "sepolia");
     expect(stored().networkId).toBe("sepolia");
-    expect(stored().trackedTokens).toEqual([SEPOLIA_TOKEN]);
+    expect(stored().trackedTokens).toEqual([added]);
     const onSepolia = boot.node("settings-tracked-tokens").innerHTML;
     expect(onSepolia).toContain("TST");
     expect(onSepolia).not.toContain("DAI");