chore: restore reverting package.json change when testing non-latest version (#336)

* chore: restore reverting package.json change

* test: restore package.json revert in prepare, reapply update when coppying fixture in integration, move version updating to shared utility

* chore: remove duplicated log

* chore: remove pnpm lock files and use packageManager field to decide on package manager to install deps

* chore: make integration fixture setup not output next version adjusting related logs

* remove locks from smoke fixtures

* adjust smoke fixtures to depend on latest to match other fixtures

* add some logs about actually resolved version for latest/canary

* fixup next version resolve id mess

* run next version resolution in bash

* add failure to cleanup error log

Author: pieh

.github/workflows/run-tests.yml

@@ -87,11 +87,19 @@ jobs:
       - name: Install Playwright Browsers
         if: steps.playwright-cache.outputs.cache-hit != 'true'
         run: npx playwright install --with-deps
+      - name: Resolve Next.js version
+        id: resolve-next-version
+        shell: bash
+        run: |
+          RESOLVED_VERSION=$(npm view next@${{ matrix.version }} version)
+          echo "version=$RESOLVED_VERSION" >> $GITHUB_OUTPUT
+          echo "Resolved Next.js version for 'next@${{ matrix.version }}' is '$RESOLVED_VERSION'"
       - name: Run Playwright tests
         run: npm run e2e:ci -- --shard=${{ matrix.shard }}/4
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
           NEXT_VERSION: ${{ matrix.version }}
+          NEXT_RESOLVED_VERSION: ${{ steps.resolve-next-version.outputs.version }}
       - name: Upload blob report to GitHub Actions Artifacts
         uses: actions/upload-artifact@v4
         if: always()
@@ -135,9 +143,13 @@ jobs:
         run: |
           npm i -g netlify-cli
           netlify login
-      - name: Get actual Next.js version
-        id: actual-next-version
-        run: echo "version=$(npm view next@${{ matrix.version }} version)" >> $GITHUB_OUTPUT
+      - name: Resolve Next.js version
+        id: resolve-next-version
+        shell: bash
+        run: |
+          RESOLVED_VERSION=$(npm view next@${{ matrix.version }} version)
+          echo "version=$RESOLVED_VERSION" >> $GITHUB_OUTPUT
+          echo "Resolved Next.js version for 'next@${{ matrix.version }}' is '$RESOLVED_VERSION'"
       - name: Compute Fixtures Cache Key
         id: fixture-cache-key
         # Fixtures only need to be rebuilt if anything in the tests/fixtures directory changes,
@@ -152,18 +164,20 @@ jobs:
         with:
           path: tests/fixtures
           key:
-            integration-fixtures-${{ runner.os }}-${{steps.next-version.outputs.version}}-${{
+            integration-fixtures-${{ runner.os }}-${{steps.resolve-next-version.outputs.version}}-${{
             steps.fixture-cache-key.outputs.key }}
       - name: 'Prepare Fixtures'
         if: steps.cache-fixtures.outputs.cache-hit != 'true'
         run: npm run pretest
         env:
           NEXT_VERSION: ${{ matrix.version }}
+          NEXT_RESOLVED_VERSION: ${{ steps.resolve-next-version.outputs.version }}
       - name: 'Test'
         run: npm run test:ci -- --shard=${{ matrix.shard }}/8
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_TOKEN }}
           NEXT_VERSION: ${{ matrix.version }}
+          NEXT_RESOLVED_VERSION: ${{ steps.resolve-next-version.outputs.version }}
           TEMP: ${{ github.workspace }}/..
   merge-reports:
     if: always()

.github/workflows/test-e2e.yml

@@ -69,18 +69,6 @@ jobs:
       - name: setup pnpm/yarn
         run: corepack enable
 
-      - name: get pnpm store
-        id: pnpm-store
-        run: echo "PATH=$(pnpm store path --silent)" >> ${GITHUB_OUTPUT}
-
-      - name: cache pnpm deps
-        uses: actions/cache@v4
-        with:
-          path: ${{ steps.pnpm-store.outputs.PATH }}
-          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            pnpm-store-
-
       - name: get npm cache
         id: npm-cache
         run: echo "PATH=$(npm config get cache)" >> ${GITHUB_OUTPUT}

.gitignore

@@ -14,4 +14,6 @@ deno.lock
 .eslintcache
 /report/index.html
 .DS_Store
-tests/fixtures/**/package-lock.json
+tests/**/package-lock.json
+tests/**/pnpm-lock.yaml
+tests/**/yarn.lock

tests/e2e/e2e-helpers.ts

@@ -1,7 +1,7 @@
 import { expect } from '@playwright/test'
+import { nextVersionSatisfies } from '../utils/next-version-helpers.mjs'
 import { test } from '../utils/playwright-helpers.js'
 import { getImageSize } from 'next/dist/server/image-optimizer.js'
-import { nextVersionSatisfies } from './e2e-helpers.js'
 
 test('Runs edge middleware', async ({ page, middleware }) => {
   await page.goto(`${middleware.url}/test/redirect`)

tests/e2e/edge-middleware.test.ts

@@ -1,6 +1,6 @@
 import { type Locator, expect } from '@playwright/test'
+import { nextVersionSatisfies } from '../utils/next-version-helpers.mjs'
 import { test } from '../utils/playwright-helpers.js'
-import { nextVersionSatisfies } from './e2e-helpers.js'
 
 const expectImageWasLoaded = async (locator: Locator) => {
   expect(await locator.evaluate((img: HTMLImageElement) => img.naturalHeight)).toBeGreaterThan(0)

tests/e2e/simple-app.test.ts

@@ -25,5 +25,6 @@
     "nx": "17.3.0",
     "ts-node": "10.9.1",
     "typescript": "~5.3.2"
-  }
+  },
+  "packageManager": "pnpm@8.9.0"
 }