Merge branch 'main' into mk/edge-router

Author: ascorbic

.eslintignore

@@ -3,4 +3,6 @@ node_modules
 test
 lib
 demos
-plugin/src/templates/edge
+plugin/src/templates/edge
+plugin/lib
+plugin/dist-types

.github/workflows/cypress-middleware.yml

@@ -0,0 +1,73 @@
+name: Run e2e (middleware demo)
+on:
+  pull_request:
+    types: [opened, labeled, unlabeled, synchronize]
+  push:
+    branches:
+      - main
+    paths:
+      - 'demos/middleware/**/*.{js,jsx,ts,tsx}'
+      - 'cypress/integration/middleware/**/*.{ts,js}'
+      - 'src/**/*.{ts,js}'
+jobs:
+  cypress:
+    name: Cypress
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        containers: [1, 2, 3, 4]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Generate Github token
+        uses: navikt/github-app-token-generator@v1
+        id: get-token
+        with:
+          private-key: ${{ secrets.TOKENS_PRIVATE_KEY }}
+          app-id: ${{ secrets.TOKENS_APP_ID }}
+
+      - name: Checkout @netlify/wait-for-deploy-action
+        uses: actions/checkout@v2
+        with:
+          repository: netlify/wait-for-deploy-action
+          token: ${{ steps.get-token.outputs.token }}
+          path: ./.github/actions/wait-for-netlify-deploy
+
+      - name: Wait for Netlify Deploy
+        id: deploy
+        uses: ./.github/actions/wait-for-netlify-deploy
+        with:
+          site-name: next-plugin-edge-middleware
+          timeout: 300
+
+      - name: Deploy successful
+        if: ${{ steps.deploy.outputs.origin-url }}
+        run: echo ${{ steps.deploy.outputs.origin-url }}
+
+      - name: Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - run: npm install
+
+      - name: Cypress run
+        if: ${{ steps.deploy.outputs.origin-url }}
+        id: cypress
+        uses: cypress-io/github-action@v2
+        with:
+          browser: chrome
+          headless: true
+          record: true
+          parallel: true
+          config-file: cypress/config/middleware.json
+          group: 'Next Plugin - Middleware'
+          spec: cypress/integration/middleware/*
+        env:
+          DEBUG: '@cypress/github-action'
+          CYPRESS_baseUrl: ${{ steps.deploy.outputs.origin-url }}
+          CYPRESS_NETLIFY_CONTEXT: ${{ steps.deploy.outputs.context }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CYPRESS_RECORD_KEY: ${{ secrets.MIDDLEWARE_CYPRESS_RECORD_KEY }}

.gitignore

@@ -147,6 +147,7 @@ Temporary Items
 demos/default/.next
 .parcel-cache
 plugin/lib
+plugin/dist-types
 
 # Cypress
 cypress/screenshots

.prettierignore

@@ -22,4 +22,6 @@ lib
 tsconfig.json
 demos/nx-next-monorepo-demo
 
-plugin/CHANGELOG.md
+plugin/CHANGELOG.md
+plugin/lib
+plugin/dist-types

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  "plugin": "4.13.1"
+  "plugin": "4.14.1"
 }

cypress/config/middleware.json

@@ -0,0 +1,5 @@
+{
+  "baseUrl": "http://localhost:8888",
+  "integrationFolder": "cypress/integration/middleware",
+  "projectId": "yn8qwi"
+}

cypress/integration/middleware/enhanced.spec.ts

@@ -0,0 +1,28 @@
+describe('Enhanced middleware', () => {
+  it('adds request headers', () => {
+    cy.request('/api/hello').then((response) => {
+      expect(response.body).to.have.nested.property('headers.x-hello', 'world')
+    })
+  })
+
+  it('adds request headers to a rewrite', () => {
+    cy.request('/headers').then((response) => {
+      expect(response.body).to.have.nested.property('headers.x-hello', 'world')
+    })
+  })
+
+  it('rewrites the response body', () => {
+    cy.visit('/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('modifies the page props', () => {
+    cy.request('/_next/data/build-id/static.json').then((response) => {
+      expect(response.body).to.have.nested.property('pageProps.showAd', true)
+      expect(response.body)
+        .to.have.nested.property('pageProps.message')
+        .that.includes('This was static but has been transformed in')
+    })
+  })
+})

cypress/integration/middleware/standard.spec.ts

@@ -0,0 +1,22 @@
+describe('Standard middleware', () => {
+  it('rewrites to internal page', () => {
+    // preview mode is off by default
+    cy.visit('/shows/rewriteme')
+    cy.get('h1').should('contain', 'Show #100')
+    cy.url().should('eq', `${Cypress.config().baseUrl}/shows/rewriteme`)
+  })
+
+  it('rewrites to external page', () => {
+    cy.visit('/shows/rewrite-external')
+    cy.get('h1').should('contain', 'Example Domain')
+    cy.url().should('eq', `${Cypress.config().baseUrl}/shows/rewrite-external`)
+  })
+
+  it('adds headers to static pages', () => {
+    cy.request('/shows/static/3').then((response) => {
+      expect(response.headers).to.have.property('x-middleware-date')
+      expect(response.headers).to.have.property('x-is-deno', 'true')
+      expect(response.headers).to.have.property('x-modified-edge', 'true')
+    })
+  })
+})