merge-main-to-public

.eslintrc.json

@@ -9,8 +9,7 @@
     "airbnb-typescript",
     "airbnb/hooks",
     "prettier",
-    "plugin:@tanstack/eslint-plugin-query/recommended",
-    "plugin:playwright/recommended"
+    "plugin:@tanstack/eslint-plugin-query/recommended"
   ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
@@ -21,17 +20,10 @@
     "sourceType": "module",
     "project": "./tsconfig.json"
   },
-  "plugins": [
-    "react",
-    "prettier",
-    "eslint-plugin-no-inline-styles",
-    "@tanstack/query",
-    "eslint-plugin-playwright"
-  ],
+  "plugins": ["react", "prettier", "eslint-plugin-no-inline-styles", "@tanstack/query"],
   "rules": {
     "consistent-return": "off",
     "no-await-in-loop": "off",
-    "playwright/valid-title": "off",
     "import/prefer-default-export": 1,
     "no-restricted-imports": [
       "warn",
@@ -62,6 +54,16 @@
     "@tanstack/query/exhaustive-deps": 1,
     "import/order": 0
   },
+  "overrides": [
+    {
+      "files": ["tests/**/*.{js,jsx,ts,tsx}"],
+      "plugins": ["playwright"],
+      "extends": ["plugin:playwright/playwright-test"],
+      "rules": {
+        "playwright/expect-expect": "off"
+      }
+    }
+  ],
   "settings": {
     "import/resolver": {
       "node": {

.github/workflows/build-rc.yml

@@ -12,12 +12,13 @@ on:
       - main
       - develop
 jobs:
-  test:
+  build:
     if: ${{ startsWith(github.head_ref, 'release/') }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
         with:
           always-auth: true
           node-version: 18
@@ -33,10 +34,100 @@ jobs:
           npx eslint .
           npx tsc --noEmit
           npm test
+      - name: Build
+        env:
+          TRANSAC_API_KEY: ${{ secrets.TRANSAC_API_KEY }}
+          MOON_PAY_API_KEY: ${{ secrets.MOON_PAY_API_KEY }}
+          MIX_PANEL_TOKEN: ${{ secrets.MIX_PANEL_TOKEN }}
+          MIX_PANEL_EXPLORE_APP_TOKEN: ${{ secrets.MIX_PANEL_EXPLORE_APP_TOKEN }}
+        run: npm run build
+      - name: Upload Archive
+        uses: actions/upload-artifact@v3
+        with:
+          name: web-extension1
+          path: ./build
+          retention-days: 5
+          if-no-files-found: error
+  UItest:
+    needs: [build]
+    name: UI Test ${{ matrix.shardIndex }} of ${{ matrix.shardTotal }}
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        shardIndex: [1, 2, 3, 4, 5]
+        shardTotal: [5]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download build artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: web-extension1
+          path: ./build
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          always-auth: true
+          node-version: 18
+          registry-url: https://npm.pkg.github.com
+          scope: '@secretkeylabs'
+          cache: npm
+      - name: Install dependencies
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_PACKAGE_REGISTRY_TOKEN }}
+        run: npm install playwright
+      - name: Install Playwright Browsers
+        run: npx playwright install chromium --with-deps
+      - name: Run UI test suite
+        run: xvfb-run --auto-servernum --server-args="-screen 0 360x360x24" npx playwright test --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
+      - name: Upload Playwright report
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: all-blob-reports
+          path: blob-report
+          retention-days: 1
+
+  merge-reports:
+    # Merge reports after playwright-tests, even if some shards have failed but not if the job was skipped
+    if: ${{ always() && needs.UItest.result != 'skipped' }}
+    needs: [UItest]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          always-auth: true
+          node-version: 18
+          registry-url: https://npm.pkg.github.com
+          scope: '@secretkeylabs'
+          cache: npm
+      - name: Install dependencies
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_PACKAGE_REGISTRY_TOKEN }}
+        run: npm install playwright
+
+      - name: Download blob reports from GitHub Actions Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: all-blob-reports
+          path: all-blob-reports
+
+      - name: Merge into HTML Report
+        run: npx playwright merge-reports --reporter html ./all-blob-reports
+
+      - name: Upload HTML report
+        uses: actions/upload-artifact@v3
+        with:
+          name: html-report--attempt-${{ github.run_attempt }}
+          path: playwright-report
+          retention-days: 5
+
   publish-rc:
     # TODO also keep the develop PR description up to date
     if: ${{ github.base_ref == 'main' }}
-    needs: test
+    needs: [UItest]
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -101,26 +192,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Download build artifact
+        uses: actions/download-artifact@v3
         with:
-          always-auth: true
-          node-version: 18
-          registry-url: https://npm.pkg.github.com
-          scope: '@secretkeylabs'
-          cache: npm
-      - name: Install dependencies
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GH_PACKAGE_REGISTRY_TOKEN }}
-        run: npm ci
-      - name: Build & zip
-        env:
-          TRANSAC_API_KEY: ${{ secrets.TRANSAC_API_KEY }}
-          MOON_PAY_API_KEY: ${{ secrets.MOON_PAY_API_KEY }}
-          MIX_PANEL_TOKEN: ${{ secrets.MIX_PANEL_TOKEN }}
-          MIX_PANEL_EXPLORE_APP_TOKEN: ${{ secrets.MIX_PANEL_EXPLORE_APP_TOKEN }}
-        run: |
-          npm run build
-          zip -rj build.zip ./build
+          name: web-extension1
+          path: ./build
+      - uses: actions/setup-node@v4
+      - name: zip
+        run: zip -rj build.zip ./build
       - name: Upload release asset
         uses: actions/upload-release-asset@v1
         env:

.github/workflows/build.yml

@@ -40,8 +40,8 @@ jobs:
         run: npm run build --if-present
       - name: Install Playwright Browsers
         run: npx playwright install chromium --with-deps
-      - name: Run health check
-        run: xvfb-run --auto-servernum --server-args="-screen 0 1024x768x24" npx playwright test tests/specs/healthcheck.spec.ts --reporter=html
+      - name: Run UI test suite
+        run: xvfb-run --auto-servernum --server-args="-screen 0 360x360x24" npx playwright test --grep "#smoketest" --reporter=html
       - name: Upload Playwright report
         if: always()
         uses: actions/upload-artifact@v3

.github/workflows/playwright.yml

@@ -1,14 +1,9 @@
 name: Playwright Tests
 on:
   workflow_dispatch:
-    inputs:
-      branch:
-        description: Branch name
-        required: true
-        default: develop
 jobs:
-  test:
-    timeout-minutes: 10
+  build:
+    if: ${{ !startsWith(github.head_ref, 'release/') }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -24,21 +19,97 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GH_PACKAGE_REGISTRY_TOKEN }}
         run: npm ci
+      - name: Test
+        run: |
+          npx eslint .
+          npx tsc --noEmit
+          npm test
       - name: Build
         env:
           TRANSAC_API_KEY: ${{ secrets.TRANSAC_API_KEY }}
           MOON_PAY_API_KEY: ${{ secrets.MOON_PAY_API_KEY }}
           MIX_PANEL_TOKEN: ${{ secrets.MIX_PANEL_TOKEN }}
           MIX_PANEL_EXPLORE_APP_TOKEN: ${{ secrets.MIX_PANEL_EXPLORE_APP_TOKEN }}
         run: npm run build --if-present
+      - name: Upload Archive
+        uses: actions/upload-artifact@v3
+        with:
+          name: web-extension1
+          path: ./build
+          retention-days: 5
+          if-no-files-found: error
+  UItest:
+    needs: [build]
+    name: UI Test ${{ matrix.shardIndex }} of ${{ matrix.shardTotal }}
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        shardIndex: [1, 2, 3, 4, 5]
+        shardTotal: [5]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download build artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: web-extension1
+          path: ./build
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          always-auth: true
+          node-version: 18
+          registry-url: https://npm.pkg.github.com
+          scope: '@secretkeylabs'
+          cache: npm
+      - name: Install dependencies
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_PACKAGE_REGISTRY_TOKEN }}
+        run: npm install playwright
       - name: Install Playwright Browsers
         run: npx playwright install chromium --with-deps
       - name: Run UI test suite
-        run: xvfb-run --auto-servernum --server-args="-screen 0 360x360x24" npx playwright test --reporter=html
+        run: xvfb-run --auto-servernum --server-args="-screen 0 360x360x24" npx playwright test --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
       - name: Upload Playwright report
-        if: always()
+        if: ${{ !cancelled() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: all-blob-reports
+          path: blob-report
+          retention-days: 1
+
+  merge-reports:
+    # Merge reports after playwright-tests, even if some shards have failed
+    if: ${{ !cancelled() }}
+    needs: [UItest]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          always-auth: true
+          node-version: 18
+          registry-url: https://npm.pkg.github.com
+          scope: '@secretkeylabs'
+          cache: npm
+      - name: Install dependencies
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GH_PACKAGE_REGISTRY_TOKEN }}
+        run: npm install playwright
+
+      - name: Download blob reports from GitHub Actions Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: all-blob-reports
+          path: all-blob-reports
+
+      - name: Merge into HTML Report
+        run: npx playwright merge-reports --reporter html ./all-blob-reports
+
+      - name: Upload HTML report
         uses: actions/upload-artifact@v3
         with:
-          name: playwright-report
-          path: playwright-report/
-          retention-days: 30
+          name: html-report--attempt-${{ github.run_attempt }}
+          path: playwright-report
+          retention-days: 5

.github/workflows/release.yml

@@ -99,7 +99,6 @@ jobs:
           ./merge-to-remote.sh
       - id: copy-release-to-public
         name: Copy release to public remote
-        needs: push-to-public
         env:
           REMOTE_REPO: xverse-web-extension
         run: |

.gitignore

@@ -135,3 +135,5 @@ yarn-error.log*
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+tests/specs/seedWords.json
+tests/specs/addresses.json

README.md

@@ -7,7 +7,7 @@
 1. Check if your [Node.js](https://nodejs.org/) version is >= **14**.
 2. Clone this repository.
 3. Make sure you're logged in to the @secretkeylabs scope on the GitHub NPM package registry. See the [Guide](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token)
-   1. Create a GitHub personal access token (classic) 
+   1. Create a GitHub personal access token (classic)
    2. Run `npm login --scope=@secretkeylabs --registry=https://npm.pkg.github.com`
    3. Username: GITHUB USERNAME
       Password: PERSONAL_ACCESS_TOKEN
@@ -42,4 +42,4 @@ npm run uitest
 To generate test report, run:
 ```
 npm run uitest:report
-```
+```