Merge branch 'main' into main

Author: himself65

.eslintignore

@@ -6,4 +6,5 @@ demos
 packages/runtime/src/templates/edge
 packages/runtime/src/templates/edge-shared
 packages/runtime/lib
-packages/runtime/dist-types
+packages/runtime/dist-types
+jestSetup.js

.eslintrc.js

@@ -46,6 +46,7 @@ module.exports = {
         // TODO: re-enable after dropping support for Node 12
         'n/no-unsupported-features/es-syntax': 'off',
         '@typescript-eslint/no-extra-semi': 'off',
+        'n/no-missing-import': 'off',
       },
     },
     {

.github/pull_request_template.md

@@ -1,3 +1,5 @@
+<!-- Before opening a pull request, ensure you've read our contributing guildines, https://github.com/netlify/next-runtime/blob/main/CONTRIBUTING.md. -->
+
 ### Summary
 
 <!-- Provide a brief summary of the change. -->

.github/workflows/e2e-next.yml

@@ -6,19 +6,77 @@ on:
     branches: [main]
 
 jobs:
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      test-files: ${{ steps['set-test-files'].outputs['test-files'] }}
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm install
+      - id: set-test-files
+        name: Get test files
+        # Extracts the list of all test files as JSON and trims to be relative to the test dir to be easier to read
+        run:
+          echo "test-files=$(npx jest -c test/e2e/jest.config.js --listTests --json | jq -cM 'map(.[env.PWD | length +
+          10:])')" >> $GITHUB_OUTPUT
+          # echo "test-files=$(npx jest -c test/e2e/jest.config.all.js --listTests --json | jq -cM 'map(.[env.PWD | length
+          # + 10:])')" >> $GITHUB_OUTPUT
+
   test:
-    name: E2E tests
     runs-on: ubuntu-latest
+    name: test (${{ matrix.test-file }})
+    needs:
+      - setup
+    strategy:
+      fail-fast: false
+      matrix:
+        # Creates a job for each chunk ID. This will be assigned one or more test files to run
+        test-file: ${{ fromJson(needs.setup.outputs['test-files']) }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Installing with LTS Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: 'lts/*'
-      - name: NPM Install
-        run: npm install
-      - name: Run Next.js e2e test suite
-        run: npm run test:next
+      - uses: actions/checkout@v3
+      - run: npm install
+      - name: Run tests
+        run: npx jest --reporters=jest-junit --reporters=default -c test/e2e/jest.config.all.js ${{ matrix.test-file }}
         env:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_BOT_AUTH_TOKEN }}
           NETLIFY_SITE_ID: 1d5a5c76-d445-4ae5-b694-b0d3f2e2c395
+          # RUN_SKIPPED_TESTS: true
+      # - uses: phoenix-actions/test-reporting@v10
+      #   if: ${{ always() }}
+      #   name: Report Test Results
+      #   # Generates annotations for the test failures
+      #   id: test-report
+      #   with:
+      #     name: E2E Test chunk ${{ matrix.chunk }}
+      #     path: 'reports/**/*.xml' # Path to test results (inside artifact .zip)
+      #     output-to: 'checks'
+      #     max-annotations: 49 # Maximum number of annotations to be created
+      #     reporter: jest-junit # Format of test results
+
+      - uses: actions/upload-artifact@v3
+        # upload test results
+        if: ${{ always() }}
+        name: Upload test results
+        with:
+          name: test-results
+          path: reports/jest-*.xml
+  report:
+    runs-on: ubuntu-latest
+    if: ${{ always() }}
+    needs:
+      - test
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          path: reports
+      - name: Combine reports
+        # The test reporter can handle multiple files, but these have random filenames so the output is better when combined
+        run: npx junit-report-merger test-results.xml reports/**/*.xml
+      - uses: phoenix-actions/test-reporting@v10
+        with:
+          name: Jest Tests
+          output-to: 'step-summary'
+          path: 'test-results.xml'
+          max-annotations: 49
+          reporter: jest-junit

.gitignore

@@ -150,3 +150,6 @@ packages/*/lib
 
 # Cypress
 cypress/screenshots
+
+# Test cases have node module fixtures
+!test/**/node_modules

CONTRIBUTING.md

@@ -2,12 +2,14 @@
 
 🎉 Thanks for considering contributing to this project! 🎉
 
-These guidelines will help you send a pull request.
+When contributing to this repository, please first discuss the change you wish to make via an
+[issue](https://github.com/netlify/next-runtime/issues/new/choose). Please use the issue templates. They are there to
+help you and to help the maintainers gather information.
 
-If you're submitting an issue instead, please skip this document.
+Before working on an issue, ask to be assigned to it. This makes it clear to other potential contributors that someone
+is working on the issue.
 
-If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's `Edit`
-button (pencil icon) and directly suggest a correction instead.
+When creating a PR, please use the template. The information in the template helps maintainers review your pull request.```
 
 This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
 
@@ -37,9 +39,9 @@ We use [Conventional Commit messages](https://www.conventionalcommits.org/) to a
 
 Most common commit message prefixes are:
 
-* `fix:` which represents bug fixes, and generate a patch release.
-* `feat:` which represents a new feature, and generate a minor release.
-* `feat!:`, `fix!:` or `refactor!:` and generate a major release.
+- `fix:` which represents bug fixes, and generate a patch release.
+- `feat:` which represents a new feature, and generate a minor release.
+- `feat!:`, `fix!:` or `refactor!:` and generate a major release.
 
 ## Releasing
 

README.md

@@ -44,7 +44,7 @@ by targeting the `/_next/image/*` route:
 
 ## Disabling included image loader
 
-If you wish to disable the use of the image loader which is bundled into the runtime by default, set the `DISABLE_IPX` environment variable to `true`. 
+If you wish to disable the use of the image loader which is bundled into the runtime by default, set the `DISABLE_IPX` environment variable to `true`.
 
 This should only be done if the site is not using `next/image` or is using a different loader (such as Cloudinary or Imgix).
 
@@ -60,7 +60,7 @@ For more details on Next.js Middleware with Netlify, see the [middleware docs](h
 
 ### Limitations
 
-Due to how the site configuration is handled when it's run using Netlify Edge Functions, data such as `locale` and `defaultLocale` will be missing on the `req.nextUrl` object when running `netlify dev`. 
+Due to how the site configuration is handled when it's run using Netlify Edge Functions, data such as `locale` and `defaultLocale` will be missing on the `req.nextUrl` object when running `netlify dev`.
 
 However, this data is available on `req.nextUrl` in a production environment.
 
@@ -107,7 +107,15 @@ Edge runtime or middleware is enabled it will also generate edge functions for m
 
 ## Manually installing the Next.js Runtime
 
-The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it manually like this:
+The Next.js Runtime installs automatically for new Next.js sites on Netlify. You can also install it manually in the
+following ways:
+
+### From the UI (Recommended):
+
+You can go to the [UI](https://app.netlify.com/plugins/@netlify/plugin-nextjs/install) and choose the site to install the Next.js Runtime on. This method
+is recommended because you will benefit from auto-upgrades to important fixes and feature updates.
+
+### From `npm`:
 
 ```shell
 npm install -D @netlify/plugin-nextjs
@@ -117,9 +125,11 @@ npm install -D @netlify/plugin-nextjs
 
 ```toml
 [[plugins]]
-package = "@netlify/plugin-nextjs"
+  package = "@netlify/plugin-nextjs"
 ```
 
+This method is recommended if you wish to pin the Next.js Runtime to a specific version.
+
 ## Manually upgrading from an older version of the Next.js Runtime
 
 If you previously set these values, they're no longer needed and should be removed:
@@ -139,7 +149,7 @@ information on changes to how they are handled in this version. In particular, n
 files must be placed in `public`, not in the root of the site.
 
 ## Using with pnpm
-If your site uses pnpm to manage dependencies, currently you must [enable public hoisting](https://pnpm.io/npmrc#public-hoist-pattern). 
+If your site uses pnpm to manage dependencies, currently you must [enable public hoisting](https://pnpm.io/npmrc#public-hoist-pattern).
 The simplest way to do this is to create a `.npmrc` file in the root of your project with the content:
 
 ```ini

cypress/integration/middleware/enhanced.spec.ts

@@ -36,4 +36,16 @@ describe('Enhanced middleware', () => {
       expect(response.body).to.have.nested.property('headers.x-geo-timezone')
     })
   })
+
+  it('handles uppercase i18n redirects properly ', () => {
+    cy.visit('/de-DE/static')
+    cy.get('#message').contains('This was static but has been transformed in')
+    cy.contains("This is an ad that isn't shown by default")
+  })
+
+  it('handles lowercase i18n redirects properly ', () => {
+    cy.visit('/de-de/static')
+    cy.get('#message').contains('This was static but has been transformed in')
+    cy.contains("This is an ad that isn't shown by default")
+  })
 })

demos/base-path/package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "",
   "devDependencies": {
+    "@netlify/next": "*",
     "@netlify/plugin-nextjs": "*",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",

demos/canary/package-lock.json

@@ -14,6 +14,7 @@
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
+    "@netlify/next": "*",
     "@netlify/plugin-nextjs": "*",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",

demos/canary/package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "description": "",
   "devDependencies": {
+    "@netlify/next": "*",
     "@netlify/plugin-nextjs": "*",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",

demos/custom-routes/package.json

@@ -21,12 +21,13 @@
     "@netlify/next": "*",
     "@reach/dialog": "^0.16.2",
     "@reach/visually-hidden": "^0.16.0",
-    "@vercel/og": "^0.0.20",
+    "@vercel/og": "^0.0.21",
     "next": "^13.0.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
+    "@netlify/next": "*",
     "@netlify/plugin-nextjs": "*",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",

demos/default/package.json

@@ -9,7 +9,7 @@ const nextConfig = {
   generateBuildId: () => 'build-id',
   i18n: {
     defaultLocale: 'en',
-    locales: ['en'],
+    locales: ['en', 'de-DE'],
   },
 }
 

demos/middleware/next.config.js

@@ -30,6 +30,7 @@
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
+    "@netlify/next": "*",
     "@netlify/plugin-nextjs": "*",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",

demos/next-auth/package.json

@@ -6,6 +6,7 @@
     "next": "^13.0.3"
   },
   "devDependencies": {
+    "@netlify/next": "*",
     "@netlify/plugin-nextjs": "*",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",