Fix extension mocking during tests (#3773)

Fixed testing setup of `jest-webextension-mock` and, removed the custom `webextension-polyfill` mock as it was no longer necessary. Missing methods not supplied by `jest-webextension-mock` are initialized during setup through `setup-extension-mock.ts`. Also fixed an `await` omission in a test... Latest build: [extension-builds-3773](https://github.com/tahowallet/extension/suites/34000366804/artifacts/2544398379) (as of Thu, 06 Feb 2025 00:21:17 GMT).
tahowallet · Feb 13, 2025 · 037fa86 · 037fa86
2 parents d63f477 + 5daa119
commit 037fa86
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 61 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -71,7 +71,7 @@ jobs:
           prerelease: ${{ contains(github.ref, '-pre') || contains(github.ref, 'v0.') }}
       - name: Upload build asset
         if: ${{ !startsWith(github.ref, 'refs/tags/') }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: extension-builds-${{ github.event.number || github.event.head_commit.id }}
           path: dist/*.zip
@@ -106,7 +106,7 @@ jobs:
           USE_MAINNET_FORK: true
       - name: Upload build asset
         if: ${{ !startsWith(github.ref, 'refs/tags/') }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: extension-builds-fork-${{ github.event.number || github.event.head_commit.id }}
           path: dist/*.zip
@@ -179,7 +179,7 @@ jobs:
       - run: yarn install --frozen-lockfile
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps chromium
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: extension-builds-${{ github.event.number || github.event.head_commit.id }}
       - name: Extract extension
@@ -205,7 +205,7 @@ jobs:
           TEST_WALLET_JSON_BODY: ${{ secrets.TEST_WALLET_JSON_BODY }}
           TEST_WALLET_JSON_PASSWORD: ${{ secrets.TEST_WALLET_JSON_PASSWORD }}
         run: xvfb-run npx playwright test --grep @expensive
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: debug-output
@@ -234,7 +234,7 @@ jobs:
       - run: yarn install --frozen-lockfile
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps chromium
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: extension-builds-fork-${{ github.event.number || github.event.head_commit.id }}
       - name: Extract extension
@@ -268,7 +268,7 @@ jobs:
           TEST_WALLET_JSON_PASSWORD: ${{ secrets.TEST_WALLET_JSON_PASSWORD }}
           USE_MAINNET_FORK: true
         run: xvfb-run npx playwright test
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: fork-debug-output

diff --git a/__mocks__/webextension-polyfill.ts b/__mocks__/webextension-polyfill.ts
diff --git a/background/services/abilities/tests/index.integration.test.ts b/background/services/abilities/tests/index.integration.test.ts
@@ -25,7 +25,9 @@ type AbilitiesServiceExternalized = Omit<AbilitiesService, "db"> & {
   db: AbilitiesDatabase
 }
 
-describe("AbilitiesService", () => {
+it.todo("Abilities has been disabled")
+
+describe.skip("AbilitiesService", () => {
   const sandbox = sinon.createSandbox()
   let abilitiesService: AbilitiesService
   let chainService: ChainService

diff --git a/background/services/chain/tests/index.integration.test.ts b/background/services/chain/tests/index.integration.test.ts
@@ -7,6 +7,7 @@ import {
   TransactionRequestWithNonce,
 } from "../../../networks"
 import {
+  createAddressOnNetwork,
   createAnyEVMTransaction,
   createChainService,
   createLegacyTransactionRequest,
@@ -449,6 +450,8 @@ describe("ChainService", () => {
 
   describe("getNetworksToTrack", () => {
     it("Should fetch built-in and custom networks to track", async () => {
+      const account = createAddressOnNetwork()
+
       await chainService.addCustomChain({
         chainName: "Foo",
         chainId: "12345",
@@ -462,7 +465,7 @@ describe("ChainService", () => {
       })
 
       await chainService.addAccountToTrack({
-        address: "0x123",
+        address: account.address,
         network: {
           name: "Foo",
           chainID: "12345",
@@ -477,7 +480,7 @@ describe("ChainService", () => {
       })
 
       await chainService.addAccountToTrack({
-        address: "0x123",
+        address: account.address,
         network: ETHEREUM,
       })
       const networksToTrack = await chainService.getNetworksToTrack()

diff --git a/background/services/chain/tests/index.unit.test.ts b/background/services/chain/tests/index.unit.test.ts
@@ -176,7 +176,7 @@ describe("Chain Service", () => {
         .stub(chainService, "markNetworkActivity")
         .callsFake(async () => {})
 
-      chainService.markAccountActivity(
+      await chainService.markAccountActivity(
         createAddressOnNetwork({ network: ETHEREUM }),
       )
 

diff --git a/background/tests/factories.ts b/background/tests/factories.ts
@@ -6,7 +6,7 @@ import {
   TransactionResponse,
 } from "@ethersproject/abstract-provider"
 import { DexieOptions } from "dexie"
-import { BigNumber } from "ethers"
+import { BigNumber, Wallet } from "ethers"
 import { keccak256 } from "ethers/lib/utils"
 import { AccountBalance, AddressOnNetwork } from "../accounts"
 import {
@@ -27,7 +27,6 @@ import {
   USD,
 } from "../constants"
 import { DaylightAbility } from "../lib/daylight"
-import { normalizeEVMAddress } from "../lib/utils"
 import {
   AnyEVMTransaction,
   LegacyEVMTransactionRequest,
@@ -56,13 +55,17 @@ import {
   QueuedTxToRetrieve,
 } from "../services/chain"
 import { EIP712TypedData } from "../types"
+import { normalizeEVMAddress } from "../lib/utils"
 
 // We don't want the chain service to use a real provider in tests
 jest.mock("../services/chain/serial-fallback-provider")
 
 const createRandom0xHash = () =>
   keccak256(Buffer.from(Math.random().toString()))
 
+export const createRandomAddress = () =>
+  normalizeEVMAddress(Wallet.createRandom().address)
+
 export const createPreferenceService = async (): Promise<PreferenceService> =>
   PreferenceService.create()
 
@@ -309,7 +312,7 @@ export const createAnyEVMBlock = (
 export const createAccountBalance = (
   overrides: Partial<AccountBalance> = {},
 ): AccountBalance => ({
-  address: createRandom0xHash(),
+  address: createRandomAddress(),
   assetAmount: {
     asset: {
       metadata: {
@@ -333,7 +336,7 @@ export const createAccountBalance = (
 export const createAddressOnNetwork = (
   overrides: Partial<AddressOnNetwork> = {},
 ): AddressOnNetwork => ({
-  address: normalizeEVMAddress(createRandom0xHash()),
+  address: createRandomAddress(),
   network: ETHEREUM,
   ...overrides,
 })
@@ -400,7 +403,7 @@ export const createTransactionResponse = (
   blockHash: createRandom0xHash(),
   timestamp: Date.now(),
   confirmations: 0,
-  from: createRandom0xHash(),
+  from: createRandomAddress(),
   nonce: 570,
   gasLimit: BigNumber.from(15000000),
   data: "...",
@@ -468,7 +471,7 @@ export const createSmartContractAsset = (
     symbol,
     decimals: 18,
     homeNetwork: ETHEREUM,
-    contractAddress: createRandom0xHash(),
+    contractAddress: createRandomAddress(),
   }
 
   return {
@@ -492,7 +495,7 @@ export const createNetworkBaseAsset = (
     decimals: 18,
     coinType: 60,
     chainID: "1",
-    contractAddress: createRandom0xHash(),
+    contractAddress: createRandomAddress(),
   }
 
   return {

diff --git a/package.json b/package.json
@@ -18,8 +18,8 @@
       "default"
     ],
     "setupFiles": [
+      "./setup-extension-mock.ts",
       "fake-indexeddb/auto",
-      "jest-webextension-mock",
       "./setupJest.ts"
     ],
     "setupFilesAfterEnv": [
@@ -126,6 +126,7 @@
     "install": "^0.13.0",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
+    "jest-webextension-mock": "^3.7.22",
     "npm": "^7.5.6",
     "npm-run-all": "^4.1.5",
     "patch-package": "^6.4.7",

diff --git a/setup-extension-mock.ts b/setup-extension-mock.ts
@@ -0,0 +1,30 @@
+import "jest-webextension-mock"
+
+global.chrome.runtime.id = "mocked-extension-runtime-id"
+
+Object.assign(global.chrome, {
+  ...global.chrome,
+  runtime: {
+    ...global.chrome.runtime,
+    setUninstallURL: jest.fn(),
+  },
+  windows: {
+    ...global.chrome.windows,
+    getCurrent: jest.fn(),
+    create: jest.fn(),
+    onRemoved: {
+      ...(global.chrome.windows?.onRemoved ?? {}),
+      addListener: jest.fn(),
+    },
+  },
+  alarms: {
+    ...global.chrome.alarms,
+    create: jest.fn(),
+    clear: jest.fn(),
+    onAlarm: {
+      ...(global.chrome.alarms?.onAlarm ?? {}),
+      addListener: jest.fn(),
+      removeListener: jest.fn(),
+    },
+  },
+})
diff --git a/setupJest.ts b/setupJest.ts
@@ -11,7 +11,7 @@ const IS_CI = process.env.CI === "true"
 // CI workflows to get an overview of both failed expectations and possible errors.
 // This is not the case during development, hence, we set the minimum log level to warning
 // as it helps with debugging while writing new tests.
-logger.logLevel = IS_CI ? LogLevel.error : LogLevel.warn
+logger.logLevel = IS_CI ? LogLevel.off : LogLevel.warn
 
 // ref: https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom
 // ref: https://github.com/jsdom/jsdom/issues/2524