orgBrowserE2E.yml

name: OrgBrowser E2E (Playwright)

on:
  workflow_dispatch:
    inputs:
      vscode_version:
        description: 'VS Code version for E2E (e.g. 1.116.0). Empty uses repo variable
          PLAYWRIGHT_VSCODE_VERSION.'
        required: false
        type: string
        default: ''
  workflow_call:
    inputs:
      vscode_version:
        description: 'VS Code version for E2E (e.g. 1.116.0). Empty uses repo variable
          PLAYWRIGHT_VSCODE_VERSION.'
        required: false
        type: string
        default: ''
  push:
    branches-ignore: [ main, develop ]
    paths-ignore:
      - '.claude/**'
      - '.cursor/**'
      - 'contributing/**'
      - 'CONTRIBUTING.md'
      - 'docs/**'
      - '**/README*'
      - 'SECURITY*'
      - 'CODE_OF_CONDUCT*'
      - 'CHANGELOG*'
      - '**/CHANGELOG*'

concurrency:
  group: ci-${{ github.ref }}-orgBrowserE2E
  cancel-in-progress: true

jobs:
  e2e-web:
    runs-on: ubuntu-latest
    timeout-minutes: 60
    env:
      DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
      SFDX_AUTH_URL: ${{ secrets.SFDX_AUTH_URL_E2E }}
      # sf CLI hides authFields from `sf org create scratch --json` output by default; tests need them.
      SF_TEMP_SHOW_SECRETS: true
      PLAYWRIGHT_VSCODE_VERSION: ${{ github.event_name != 'push' &&
        inputs.vscode_version != '' && inputs.vscode_version ||
        vars.PLAYWRIGHT_VSCODE_VERSION }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '22.22.3'
          cache: 'npm'

      - uses: google/wireit@setup-github-actions-caching/v2

      - name: Install dependencies
        uses: salesforcecli/github-workflows/.github/actions/npmInstallWithRetries@main

      # Try E2E tests first. When wireit cache hits, it skips the command and exits 0—we never need CLI, orgs, or Playwright.
      # When cache misses, tests fail on missing org/chromium. E2E_NO_RETRIES=1 disables Playwright retries in config
      # so failures are fast (env var doesn't affect wireit cache key since it's not part of the npm command).
      - name: Try E2E tests
        id: try-run
        continue-on-error: true
        timeout-minutes: 5
        env:
          DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
          CI: 1
          E2E_NO_RETRIES: 1
        run: |
          npm run test:web -w salesforcedx-vscode-org-browser -- --reporter=html

      # Only run expensive setup when try-run failed (cache miss). On cache hit we never reach these steps.
      - uses: ./.github/actions/cache-vscode-web
        if: steps.try-run.outcome == 'failure'
        with:
          vscode-version: ${{ env.PLAYWRIGHT_VSCODE_VERSION }}

      - name: Install Salesforce CLI
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: npm i -g @salesforce/cli
          retry_wait_seconds: 30

      - name: Clone dreamhouse
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: git clone --depth=1 https://github.com/trailheadapps/dreamhouse-lwc
            dreamhouse-lwc
          retry_wait_seconds: 60

      - name: Auth to dev hub (global)
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: bash -c 'echo "$SFDX_AUTH_URL" | sf org login sfdx-url
            --set-default-dev-hub --alias hub --sfdx-url-stdin'
          retry_wait_seconds: 30

      - name: Install Playwright browsers and OS deps
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: npx playwright install chromium --with-deps
          retry_wait_seconds: 60

      - name: create scratch org and set up dreamhouse
        if: steps.try-run.outcome == 'failure'
        # the tests expect a scratch org with dreamhouse at a certain alias but don't use the directory directly
        shell: bash
        run: |
          sf org create scratch -y 1 -d -f config/project-scratch-def.json -a "$DREAMHOUSE_ORG_ALIAS" --json --wait 30
          sf project deploy start
          sf org assign permset -n dreamhouse
        working-directory: dreamhouse-lwc

      - name: Run Org Browser E2E tests (parallel)
        if: steps.try-run.outcome == 'failure'
        id: parallel-run
        continue-on-error: true
        env:
          DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
          CI: 1
        run: |
          npm run test:web -w salesforcedx-vscode-org-browser -- --reporter=html

      - name: Retry failed tests (sequential)
        if: steps.try-run.outcome == 'failure' && steps.parallel-run.outcome ==
          'failure'
        env:
          DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
          CI: 1
          PLAYWRIGHT_WORKERS: 1
        run: |
          npm run test:web -w salesforcedx-vscode-org-browser -- --last-failed --reporter=html

      - name: Copy span files to test-results
        if: always()
        shell: bash
        run: |
          mkdir -p packages/salesforcedx-vscode-org-browser/test-results/spans
          cp -r ~/.sf/vscode-spans/. packages/salesforcedx-vscode-org-browser/test-results/spans/ 2>/dev/null || true

      - name: Upload Playwright HTML report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: playwright-report
          path: packages/salesforcedx-vscode-org-browser/playwright-report
          if-no-files-found: ignore

      - name: Cleanup scratch org
        if: always() && steps.try-run.outcome == 'failure'
        continue-on-error: true
        run: |
          sf org delete scratch -o "$DREAMHOUSE_ORG_ALIAS" --no-prompt || true

  e2e-desktop:
    runs-on: ${{ matrix.os }}
    timeout-minutes: 60
    strategy:
      matrix:
        os: [ macos-latest, ubuntu-latest, windows-latest ]
        include:
          - os: ubuntu-latest
            test_runner_prefix: 'xvfb-run -a '
      fail-fast: false

    env:
      DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
      SFDX_AUTH_URL: ${{ secrets.SFDX_AUTH_URL_E2E }}
      # sf CLI hides authFields from `sf org create scratch --json` output by default; tests need them.
      SF_TEMP_SHOW_SECRETS: true
      PLAYWRIGHT_VSCODE_VERSION: ${{ github.event_name != 'push' &&
        inputs.vscode_version != '' && inputs.vscode_version ||
        vars.PLAYWRIGHT_VSCODE_VERSION }}
      E2E_FROM_VSIX: 1
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Log desktop VS Code version
        shell: bash
        run: echo "::notice::VS Code version=${PLAYWRIGHT_VSCODE_VERSION}"

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '22.22.3'
          cache: 'npm'

      - uses: google/wireit@setup-github-actions-caching/v2

      - name: Install dependencies
        uses: salesforcecli/github-workflows/.github/actions/npmInstallWithRetries@main

      # Try E2E tests first. When wireit cache hits, it skips the command and exits 0—we never need CLI, orgs, or Playwright.
      # When cache misses, tests fail on missing org. E2E_NO_RETRIES=1 disables Playwright retries in config
      # so failures are fast (env var doesn't affect wireit cache key since it's not part of the npm command).
      - name: Try E2E tests
        id: try-run
        continue-on-error: true
        timeout-minutes: 5
        env:
          DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
          CI: 1
          VSCODE_DESKTOP: 1
          E2E_NO_RETRIES: 1
        run: ${{ matrix.test_runner_prefix }}npm run test:desktop -w
          salesforcedx-vscode-org-browser -- --reporter=html

      # Only run expensive setup when try-run failed (cache miss). On cache hit we never reach these steps.
      - uses: ./.github/actions/cache-vscode-desktop
        if: steps.try-run.outcome == 'failure'
        with:
          vscode-version: ${{ env.PLAYWRIGHT_VSCODE_VERSION }}

      - name: Install Salesforce CLI
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: npm i -g @salesforce/cli
          retry_wait_seconds: 30

      - name: Install Playwright browsers and OS deps
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: npx playwright install chromium --with-deps
          retry_wait_seconds: 60

      - name: Clone dreamhouse
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: git clone --depth=1 https://github.com/trailheadapps/dreamhouse-lwc
            dreamhouse-lwc
          retry_wait_seconds: 60

      - name: Auth to dev hub (global)
        if: steps.try-run.outcome == 'failure'
        uses: salesforcecli/github-workflows/.github/actions/retry@main
        with:
          max_attempts: 3
          command: bash -c 'echo "$SFDX_AUTH_URL" | sf org login sfdx-url
            --set-default-dev-hub --alias hub --sfdx-url-stdin'
          retry_wait_seconds: 30

      - name: create scratch org and set up dreamhouse
        if: steps.try-run.outcome == 'failure'
        # the tests expect a scratch org with dreamhouse at a certain alias but don't use the directory directly
        shell: bash
        run: |
          sf org create scratch -y 1 -d -f config/project-scratch-def.json -a "$DREAMHOUSE_ORG_ALIAS" --json --wait 30
          sf project deploy start
          sf org assign permset -n dreamhouse
        working-directory: dreamhouse-lwc

      - name: Run Org Browser E2E tests (parallel)
        if: steps.try-run.outcome == 'failure'
        id: parallel-run
        continue-on-error: true
        env:
          DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
          CI: 1
          VSCODE_DESKTOP: 1
        run: ${{ matrix.test_runner_prefix }}npm run test:desktop -w
          salesforcedx-vscode-org-browser -- --reporter=html

      - name: Retry failed tests (sequential)
        if: steps.try-run.outcome == 'failure' && steps.parallel-run.outcome ==
          'failure'
        env:
          DREAMHOUSE_ORG_ALIAS: orgBrowserDreamhouseTestOrg
          CI: 1
          VSCODE_DESKTOP: 1
          PLAYWRIGHT_WORKERS: 1
        run: ${{ matrix.test_runner_prefix }}npm run test:desktop -w
          salesforcedx-vscode-org-browser -- --last-failed --reporter=html

      - name: Copy span files to test-results
        if: always()
        shell: bash
        run: |
          mkdir -p packages/salesforcedx-vscode-org-browser/test-results/spans
          cp -r ~/.sf/vscode-spans/. packages/salesforcedx-vscode-org-browser/test-results/spans/ 2>/dev/null || true

      - name: Upload Playwright HTML report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: playwright-report-desktop-${{ matrix.os }}
          path: packages/salesforcedx-vscode-org-browser/playwright-report
          if-no-files-found: ignore

      - name: Upload Playwright Test Results
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: playwright-test-results-desktop-${{ matrix.os }}
          path: packages/salesforcedx-vscode-org-browser/test-results
          if-no-files-found: ignore

      - name: Cleanup scratch org
        if: always() && steps.try-run.outcome == 'failure'
        continue-on-error: true
        shell: bash
        run: |
          sf org delete scratch -o "$DREAMHOUSE_ORG_ALIAS" --no-prompt || true