fix(bg/tabEvents): don't clear sessions on iframe navigation

biome.jsonc

@@ -28,6 +28,9 @@
         "noExplicitAny": "off", // TODO: turn on, too many cases
         "noConsole": "warn"
       },
+      "correctness": {
+        "noUnusedVariables": "warn"
+      },
       "a11y": {
         "noSvgWithoutTitle": "off"
       }

src/background/services/tabEvents.ts

@@ -87,7 +87,7 @@ export class TabEvents {
      * if loading and no url -> clear all sessions but not the overpaying state
      * if loading and url -> we need to check if state keys include this url.
      */
-    if (changeInfo.status === 'loading') {
+    if (changeInfo.status === 'loading' && changeInfo.url) {
       const url = tab.url ? removeQueryParams(tab.url) : '';
       const clearOverpaying = this.tabState.shouldClearOverpaying(tabId, url);
 

src/pages/popup/components/NotMonetized.tsx

@@ -7,7 +7,12 @@ export const NotMonetized = ({ text }: { text: string }) => {
       <div className="flex-shrink-0">
         <WarningSign className="size-10 text-medium" />
       </div>
-      <h3 className="text-center text-lg leading-tight text-medium">{text}</h3>
+      <h3
+        className="text-center text-lg leading-tight text-medium"
+        data-testid="not-monetized-message"
+      >
+        {text}
+      </h3>
     </div>
   );
 };

tests/e2e/special.spec.ts

@@ -0,0 +1,143 @@
+import { spy } from 'tinyspy';
+import { test, expect } from './fixtures/connected';
+
+test('iframe add/remove does not de-monetize main page', async ({
+  page,
+  popup,
+}) => {
+  const walletAddressUrl = process.env.TEST_WALLET_ADDRESS_URL;
+  const playgroundUrl = 'https://webmonetization.org/play/';
+
+  await test.step('prepare', async () => {
+    await expect(popup.getByTestId('not-monetized-message')).toBeVisible();
+
+    await page.goto(playgroundUrl);
+
+    const monetizationCallback = spy<[Event], void>();
+    await page.exposeFunction('monetizationCallback', monetizationCallback);
+    await page.evaluate(() => {
+      window.addEventListener('monetization', monetizationCallback);
+    });
+
+    await page
+      .getByLabel('Wallet address/Payment pointer')
+      .fill(walletAddressUrl);
+    await page.getByRole('button', { name: 'Add monetization link' }).click();
+
+    await page.$eval(
+      'link[rel="monetization"]',
+      (el) => new Promise((res) => el.addEventListener('load', res)),
+    );
+
+    await page.waitForTimeout(2000);
+    await expect(monetizationCallback).toHaveBeenCalledTimes(1);
+    await expect(monetizationCallback).toHaveBeenLastCalledWithMatching({
+      paymentPointer: walletAddressUrl,
+    });
+
+    await expect(popup.getByTestId('home-page')).toBeVisible();
+
+    return monetizationCallback;
+  });
+
+  await test.step('add iframe', async () => {
+    await page.evaluate(() => {
+      return new Promise((resolve) => {
+        const iframe = document.createElement('iframe');
+        iframe.id = 'cross-origin-iframe';
+        iframe.src = 'https://example.com';
+        document.body.prepend(iframe);
+        iframe.addEventListener('load', resolve);
+      });
+    });
+
+    await expect(page.locator('#cross-origin-iframe')).toBeVisible();
+    await expect(popup.getByTestId('home-page')).toBeVisible();
+  });
+
+  await test.step('remove iframe', async () => {
+    await page.evaluate(() => {
+      const iframe = document.getElementById('cross-origin-iframe');
+      iframe?.remove();
+    });
+    await expect(page.locator('#cross-origin-iframe')).not.toBeAttached();
+
+    await expect(popup.getByTestId('not-monetized-message')).not.toBeVisible();
+    await expect(popup.getByTestId('home-page')).toBeVisible();
+  });
+});
+
+test('iframe navigate does not de-monetize main page', async ({
+  page,
+  popup,
+}) => {
+  test.fail(
+    true,
+    'https://github.com/interledger/web-monetization-extension/issues/819',
+  );
+  const walletAddressUrl = process.env.TEST_WALLET_ADDRESS_URL;
+  const playgroundUrl = 'https://webmonetization.org/play/';
+
+  await test.step('prepare', async () => {
+    await expect(popup.getByTestId('not-monetized-message')).toBeVisible();
+
+    await page.goto(playgroundUrl);
+
+    const monetizationCallback = spy<[Event], void>();
+    await page.exposeFunction('monetizationCallback', monetizationCallback);
+    await page.evaluate(() => {
+      window.addEventListener('monetization', monetizationCallback);
+    });
+
+    await page
+      .getByLabel('Wallet address/Payment pointer')
+      .fill(walletAddressUrl);
+    await page.getByRole('button', { name: 'Add monetization link' }).click();
+
+    await page.$eval(
+      'link[rel="monetization"]',
+      (el) => new Promise((res) => el.addEventListener('load', res)),
+    );
+
+    await page.waitForTimeout(2000);
+    await expect(monetizationCallback).toHaveBeenCalledTimes(1);
+    await expect(monetizationCallback).toHaveBeenLastCalledWithMatching({
+      paymentPointer: walletAddressUrl,
+    });
+
+    await expect(popup.getByTestId('home-page')).toBeVisible();
+
+    return monetizationCallback;
+  });
+
+  await test.step('add iframe', async () => {
+    await page.evaluate(() => {
+      return new Promise((resolve) => {
+        const iframe = document.createElement('iframe');
+        iframe.id = 'cross-origin-iframe';
+        iframe.src = 'https://example.com';
+        document.body.prepend(iframe);
+        iframe.addEventListener('load', resolve, { once: true });
+      });
+    });
+  });
+
+  await test.step('navigate iframe', async () => {
+    await page.evaluate(() => {
+      return new Promise((resolve, reject) => {
+        const iframe = document.getElementById('cross-origin-iframe');
+        if (!iframe) {
+          reject(new Error('iframe not found'));
+          return;
+        }
+        iframe.addEventListener('load', resolve, { once: true });
+        iframe.addEventListener('error', resolve, { once: true });
+        iframe.setAttribute('src', 'https://example.net');
+      });
+    });
+
+    // this fails
+    await expect(popup.getByTestId('not-monetized-message')).not.toBeVisible();
+    await expect(popup.getByTestId('home-page')).toBeVisible();
+  });
+});