Phantom e2e tests

.github/workflows/test.yml

@@ -1,79 +1,92 @@
-name: 🧑‍🔧 Test
-
-on:
-  push:
-    branches:
-      - dev
-  pull_request:
-    paths:
-      - '.github/actions/**/*.yml'
-      - '.github/workflows/**/*.yml'
-      - 'packages/**'
-      - 'wallets/**'
-
-jobs:
-  test-unit:
-    name: Run unit tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
-
-      - name: Setup Node & Install dependencies
-        uses: ./.github/actions/setup
-
-      - name: Build project
-        run: pnpm run build
-
-      - name: Run tests
-        run: pnpm run test
-
-  test-e2e-headful:
-    name: Run E2E tests (headful)
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
-
-      - name: Setup Node & Install dependencies
-        uses: ./.github/actions/setup
-
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c # [email protected]
-
-      - name: Install Playwright dependencies
-        run: pnpm dlx [email protected] install-deps
-
-      # For now, we only need Chromium.
-      - name: Install browsers for Playwright
-        run: pnpm dlx [email protected] install chromium
-
-      - name: Build project
-        run: pnpm run build
-
-      - name: Install linux dependencies
-        run: |
-          sudo apt-get install --no-install-recommends -y \
-          xvfb
-
-      - name: Build project
-        run: pnpm run build
-
-      - name: Serve MetaMask Test Dapp
-        run: |
-          pnpm run serve:test-dapp &
-
-      - name: Build cache
-        run: |
-          xvfb-run pnpm run build:cache
-
-      - name: Run E2E tests (headful)
-        run: |
-          xvfb-run pnpm run test:playwright:headful
-
-      - name: Archive Playwright report
-        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # [email protected]
-        if: success() || failure()
-        with:
-          name: playwright-report-headful
-          path: |
-            wallets/metamask/playwright-report-headful/
-          if-no-files-found: error
+# name: 🧑‍🔧 Test
+
+# on:
+#   push:
+#     branches:
+#       - dev
+#   pull_request:
+#     paths:
+#       - '.github/actions/**/*.yml'
+#       - '.github/workflows/**/*.yml'
+#       - 'packages/**'
+#       - 'wallets/**'
+
+# jobs:
+#   test-unit:
+#     name: Run unit tests
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
+
+#       - name: Setup Node & Install dependencies
+#         uses: ./.github/actions/setup
+
+#       - name: Build project
+#         run: pnpm run build
+
+#       - name: Run tests
+#         run: pnpm run test
+
+#   test-e2e-headful:
+#     name: Run E2E tests (headful)
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
+
+#       - name: Setup Node & Install dependencies
+#         uses: ./.github/actions/setup
+
+#       - name: Install Foundry
+#         uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c # [email protected]
+
+#       - name: Install Playwright dependencies
+#         run: pnpm dlx [email protected] install-deps
+
+#       # For now, we only need Chromium.
+#       - name: Install browsers for Playwright
+#         run: pnpm dlx [email protected] install chromium
+
+#       - name: Build project
+#         run: pnpm run build
+
+#       - name: Install linux dependencies
+#         run: |
+#           sudo apt-get install --no-install-recommends -y \
+#           xvfb
+
+#       - name: Build project
+#         run: pnpm run build
+
+#       - name: Serve MetaMask Test Dapp
+#         run: |
+#           pnpm run serve:test-dapp &
+
+#       - name: Build cache (metamask)
+#         run: |
+#           xvfb-run pnpm run build:cache:metamask
+
+#       - name: Build cache (phantom)
+#         run: |
+#           xvfb-run pnpm run build:cache:phantom
+
+#       - name: Run E2E tests (headful)
+#         run: |
+#           xvfb-run pnpm run test:playwright:headful
+
+#       - name: Archive Playwright report Phantom
+#         uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # [email protected]
+#         if: success() || failure()
+#         with:
+#           name: playwright-report-headful-phantom
+#           path: |
+#             wallets/phantom/playwright-report-headful/
+#           if-no-files-found: error
+
+#       - name: Archive Playwright report Metamask
+#         uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # [email protected]
+#         if: success() || failure()
+#         with:
+#           name: playwright-report-headful-metamask
+#           path: |
+#             wallets/metamask/playwright-report-headful/
+#           if-no-files-found: error

.github/workflows/testjj2.yml

@@ -0,0 +1,65 @@
+name: 🧑‍🔧 Test - Phantom
+
+on:
+  push:
+    branches:
+      - dev
+  pull_request:
+    paths:
+      - '.github/actions/**/*.yml'
+      - '.github/workflows/**/*.yml'
+      - 'packages/**'
+      - 'wallets/**'
+
+jobs:
+  test-e2e-headful:
+    name: Run E2E tests (headful)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # [email protected]
+
+      - name: Setup Node & Install dependencies
+        uses: ./.github/actions/setup
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c # [email protected]
+
+      - name: Install Playwright dependencies
+        run: pnpm dlx [email protected] install-deps
+
+      # For now, we only need Chromium.
+      - name: Install browsers for Playwright
+        run: pnpm dlx [email protected] install chromium
+
+      - name: Build project
+        run: pnpm run build
+
+      - name: Install linux dependencies
+        run: |
+          sudo apt-get install --no-install-recommends -y \
+          xvfb
+
+      - name: Build project
+        run: pnpm run build
+
+      - name: Serve MetaMask Test Dapp
+        run: |
+          pnpm run serve:test-dapp &
+
+      - name: Build cache (phantom)
+        run: |
+          xvfb-run pnpm run build:cache:phantom
+
+      - name: Run E2E tests (headful)
+        run: |
+          xvfb-run pnpm run test:playwright:headful
+
+      - name: Archive Playwright report Phantom
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # [email protected]
+        if: success() || failure()
+        with:
+          name: playwright-report-headful-phantom
+          path: |
+            wallets/phantom/playwright-report-headful/
+          if-no-files-found: error
+

.gitignore

@@ -57,3 +57,5 @@ playwright/.cache
 output
 
 synpress-source.txt
+
+playwright-report*

package.json

@@ -8,8 +8,8 @@
   "license": "MIT",
   "scripts": {
     "build": "turbo build",
-    "build:cache": "turbo build:cache --filter=@synthetixio/synpress-metamask",
-    "docs:build": "turbo docs:build --filter=docs",
+    "build:cache:metamask": "turbo build:cache --filter=@synthetixio/synpress-metamask",
+    "build:cache:phantom": "turbo build:cache --filter=@synthetixio/synpress-phantom",
     "format": "biome format . --write",
     "format:check": "biome format . --error-on-warnings",
     "preinstall": "npx only-allow pnpm",
@@ -21,8 +21,8 @@
     "sort-package-json": "sort-package-json 'package.json' '{packages,wallets,examples}/*/package.json'",
     "sort-package-json:check": "sort-package-json 'package.json' '{packages,wallets,examples}/*/package.json' --check",
     "test": "turbo test",
-    "test:playwright:headful": "turbo test:playwright:headful --filter=@synthetixio/synpress-metamask --filter=@synthetixio/ethereum-wallet-mock",
-    "test:playwright:headless": "turbo test:playwright:headless --filter=@synthetixio/synpress-metamask --filter=@synthetixio/ethereum-wallet-mock",
+    "test:playwright:headful": "turbo test:playwright:headful --filter=@synthetixio/synpress-phantom",
+    "test:playwright:headless": "turbo test:playwright:headless --filter=@synthetixio/synpress-metamask --filter=@synthetixio/ethereum-wallet-mock --filter=@synthetixio/synpress-phantom",
     "update:deps": "ncu -u -ws --root"
   },
   "lint-staged": {

packages/cache/package.json

@@ -44,6 +44,7 @@
     "gradient-string": "2.0.2",
     "progress": "2.0.3",
     "tsup": "8.0.2",
+    "unzip-crx-3": "0.2.0",
     "unzipper": "0.10.14",
     "zod": "3.22.4"
   },

packages/cache/src/cli/cliEntrypoint.ts

@@ -7,13 +7,15 @@ import { rimraf } from 'rimraf'
 import { WALLET_SETUP_DIR_NAME } from '../constants'
 import { createCache } from '../createCache'
 import { prepareExtension } from '../prepareExtension'
+import { prepareExtensionPhantom } from '../prepareExtensionPhantom'
 import { compileWalletSetupFunctions } from './compileWalletSetupFunctions'
 import { footer } from './footer'
 
 interface CliFlags {
   headless: boolean
   force: boolean
   debug: boolean
+  phantom: boolean
 }
 
 // Helper function to check if running in WSL
@@ -41,6 +43,7 @@ export const cliEntrypoint = async () => {
     )
     .option('-f, --force', 'Force the creation of cache even if it already exists', false)
     .option('-d, --debug', 'If this flag is present, the compilation files are not going to be deleted', false)
+    .option('-p, --phantom', 'If this flag is present, Phantom extension will be installed instead of Metamask', false)
     .helpOption(undefined, 'Display help for command')
     .addHelpText('afterAll', `\n${footer}\n`)
     .parse(process.argv)
@@ -88,8 +91,12 @@ export const cliEntrypoint = async () => {
     flags.debug
   )
 
-  // TODO: We should be using `prepareExtension` function from the wallet itself!
-  await createCache(compiledWalletSetupDirPath, setupFunctionHashes, prepareExtension, flags.force)
+  // TODO: We should be using `prepareExtension` functions from the wallet itself!
+  if (flags.phantom) {
+    await createCache(compiledWalletSetupDirPath, setupFunctionHashes, prepareExtensionPhantom, flags.force)
+  } else {
+    await createCache(compiledWalletSetupDirPath, setupFunctionHashes, prepareExtension, flags.force)
+  }
 
   if (!flags.debug) {
     await rimraf(compiledWalletSetupDirPath)

packages/cache/src/index.ts

@@ -8,3 +8,4 @@ export * from './utils/createTempContextDir'
 export * from './utils/removeTempContextDir'
 export * from './prepareExtension'
 export * from './cli/cliEntrypoint'
+export * from './prepareExtensionPhantom'

packages/cache/src/prepareExtensionPhantom.ts

@@ -0,0 +1,21 @@
+import { downloadFile, ensureCacheDirExists, unzipArchivePhantom } from '.'
+
+export const DEFAULT_PHANTOM_VERSION = 'latest'
+export const PHANTOM_EXTENSION_DOWNLOAD_URL = 'https://crx-backup.phantom.dev/latest.crx'
+
+// NOTE: This function is copied from `wallets/phantom/src/prepareExtensionPhantom.ts` only TEMPORARILY!
+export async function prepareExtensionPhantom() {
+  const cacheDirPath = ensureCacheDirExists()
+
+  const downloadResult = await downloadFile({
+    url: PHANTOM_EXTENSION_DOWNLOAD_URL,
+    outputDir: cacheDirPath,
+    fileName: 'phantom-chrome-latest.crx'
+  })
+
+  const unzipResult = await unzipArchivePhantom({
+    archivePath: downloadResult.filePath
+  })
+
+  return unzipResult.outputPath
+}

packages/cache/src/unzipArchive.ts

@@ -1,5 +1,6 @@
 import path from 'node:path'
 import fs from 'fs-extra'
+import unzipCrx from 'unzip-crx-3'
 import unzippper from 'unzipper'
 
 type UnzipArchiveOptions = {
@@ -73,3 +74,27 @@ export async function unzipArchive(options: UnzipArchiveOptions) {
     throw new Error(`[UnzipFile] Error unzipping the file - ${error.message}`)
   })
 }
+
+export async function unzipArchivePhantom(options: UnzipArchiveOptions) {
+  const { archivePath, overwrite } = options
+
+  const archiveFileExtension = archivePath.split('.').slice(-1)
+  const outputPath = archivePath.replace(`.${archiveFileExtension}`, '')
+
+  const fileExists = fs.existsSync(outputPath)
+  if (fileExists && !overwrite) {
+    return {
+      outputPath,
+      unzipSkipped: true
+    }
+  }
+
+  // Creates the output directory
+  fs.mkdirSync(outputPath, { recursive: true })
+
+  await unzipCrx(archivePath, outputPath)
+
+  // TODO: Handle errors
+
+  return { outputPath }
+}

packages/cache/tsconfig.build.json

@@ -8,5 +8,5 @@
     "declarationMap": true
   },
   "include": ["src"],
-  "files": ["environment.d.ts"]
+  "files": ["environment.d.ts", "unzip-crx-3.d.ts"]
 }

packages/cache/tsconfig.json

@@ -4,9 +4,6 @@
     "rootDir": ".",
     "lib": ["DOM"]
   },
-  "include": [
-    "src",
-    "test"
-  ],
-  "files": ["environment.d.ts"]
+  "include": ["src", "test"],
+  "files": ["environment.d.ts", "unzip-crx-3.d.ts"]
 }

packages/cache/unzip-crx-3.d.ts

@@ -0,0 +1 @@
+declare module 'unzip-crx-3'