Merge pull request github#18670 from github/repo-sync

repo sync

Author: Octomerger

.github/workflows/check-all-english-links.yml

@@ -17,14 +17,17 @@ jobs:
   check_all_english_links:
     name: Check all links
     if: github.repository == 'github/docs-internal'
-    runs-on: self-hosted
+    runs-on: ubuntu-20.04-xl
     env:
       GITHUB_TOKEN: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
       FIRST_RESPONDER_PROJECT: Docs content first responder
       REPORT_AUTHOR: docubot
       REPORT_LABEL: broken link report
       REPORT_REPOSITORY: github/docs-content
     steps:
+      - name: Check that gh CLI is installed
+        run: gh --version
+
       - name: Check out repo's default branch
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
       - name: Setup Node
@@ -60,8 +63,8 @@ jobs:
           DISABLE_REWRITE_ASSET_URLS: true
         run: |
           node server.mjs > /tmp/stdout.log 2> /tmp/stderr.log &
-          sleep 5
-          curl --retry-connrefused --retry 4 -I http://localhost:4000/
+          sleep 6
+          curl --retry-connrefused --retry 5 -I http://localhost:4000/
 
       - if: ${{ failure() }}
         name: Debug server outputs on errors

tests/helpers/caching-headers.js

@@ -3,7 +3,7 @@ import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js'
 export function checkCachingHeaders(res, defaultSurrogateKey = false, minMaxAge = 60 * 60) {
   expect(res.headers['set-cookie']).toBeUndefined()
   expect(res.headers['cache-control']).toContain('public')
-  const maxAgeSeconds = parseInt(res.header['cache-control'].match(/max-age=(\d+)/)[1], 10)
+  const maxAgeSeconds = parseInt(res.headers['cache-control'].match(/max-age=(\d+)/)[1], 10)
   // Let's not be too specific in the tests, just as long as it's testing
   // that it's a reasonably large number of seconds.
   expect(maxAgeSeconds).toBeGreaterThanOrEqual(minMaxAge)

tests/unit/static-assets.js

@@ -1,8 +1,51 @@
 import nock from 'nock'
 import { expect, jest } from '@jest/globals'
 
-import { get } from '../helpers/supertest.js'
 import { checkCachingHeaders } from '../helpers/caching-headers.js'
+import { setDefaultFastlySurrogateKey } from '../../middleware/set-fastly-surrogate-key.js'
+import archivedEnterpriseVersionsAssets from '../../middleware/archived-enterprise-versions-assets.js'
+
+function mockRequest(path, { headers }) {
+  const _headers = Object.fromEntries(
+    Object.entries(headers || {}).map(([key, value]) => [key.toLowerCase(), value])
+  )
+  return {
+    path,
+    url: path,
+    get: (header) => {
+      return _headers[header.toLowerCase()]
+    },
+    set: (header, value) => {
+      _headers[header.toLowerCase()] = value
+    },
+
+    headers,
+  }
+}
+const mockResponse = () => {
+  const res = {}
+  res.status = 404
+  res.statusCode = 404
+  res.json = (payload) => {
+    res._json = payload
+  }
+  res.send = (body) => {
+    res.status = 200
+    res.statusCode = 200
+    res._send = body
+  }
+  res.headers = {}
+  res.set = (key, value) => {
+    if (typeof key === 'string') {
+      res.headers[key.toLowerCase()] = value
+    } else {
+      for (const [k, value] of Object.entries(key)) {
+        res.headers[k.toLowerCase()] = value
+      }
+    }
+  }
+  return res
+}
 
 describe('archived enterprise static assets', () => {
   // Sometimes static assets are proxied. The URL for the static asset
@@ -51,51 +94,87 @@ describe('archived enterprise static assets', () => {
   afterAll(() => nock.cleanAll())
 
   it('should proxy if the static asset is prefixed', async () => {
-    const res = await get('/enterprise/2.21/_next/static/foo.css', {
+    const req = mockRequest('/enterprise/2.21/_next/static/foo.css', {
       headers: {
         Referrer: '/enterprise/2.21',
       },
     })
+    const res = mockResponse()
+    const next = () => {
+      throw new Error('did not expect this to ever happen')
+    }
+    setDefaultFastlySurrogateKey(req, res, () => {})
+    await archivedEnterpriseVersionsAssets(req, res, next)
     expect(res.statusCode).toBe(200)
     checkCachingHeaders(res, true, 60)
   })
+
   it('should proxy if the Referrer header indicates so', async () => {
-    const res = await get('/_next/static/only-on-proxy.css', {
+    const req = mockRequest('/_next/static/only-on-proxy.css', {
       headers: {
         Referrer: '/enterprise/2.21',
       },
     })
+    const res = mockResponse()
+    const next = () => {
+      throw new Error('did not expect this to ever happen')
+    }
+    setDefaultFastlySurrogateKey(req, res, () => {})
+    await archivedEnterpriseVersionsAssets(req, res, next)
     expect(res.statusCode).toBe(200)
     checkCachingHeaders(res, true, 60)
   })
+
   it('should proxy if the Referrer header indicates so', async () => {
-    const res = await get('/_next/static/only-on-2.3.css', {
+    const req = mockRequest('/_next/static/only-on-2.3.css', {
       headers: {
         Referrer: '/en/[email protected]/some/page',
       },
     })
+    const res = mockResponse()
+    const next = () => {
+      throw new Error('did not expect this to ever happen')
+    }
+    setDefaultFastlySurrogateKey(req, res, () => {})
+    await archivedEnterpriseVersionsAssets(req, res, next)
     expect(res.statusCode).toBe(200)
     checkCachingHeaders(res, true, 60)
   })
+
   it('might still 404 even with the right referrer', async () => {
-    const res = await get('/_next/static/fourofour.css', {
+    const req = mockRequest('/_next/static/fourofour.css', {
       headers: {
         Referrer: '/en/[email protected]/some/page',
       },
     })
+    const res = mockResponse()
+    let nexted = false
+    const next = () => {
+      nexted = true
+    }
+    setDefaultFastlySurrogateKey(req, res, next)
+    await archivedEnterpriseVersionsAssets(req, res, next)
     expect(res.statusCode).toBe(404)
-    checkCachingHeaders(res, true, 60)
+    // It did't exit in that middleware but called next() to move on
+    // with any other middlewares.
+    expect(nexted).toBe(true)
   })
 
   it('404 on the proxy but actually present here', async () => {
-    const res = await get('/assets/images/site/logo.png', {
+    const req = mockRequest('/assets/images/site/logo.png', {
       headers: {
         Referrer: '/en/[email protected]/some/page',
       },
     })
+    const res = mockResponse()
+    let nexted = false
+    const next = () => {
+      nexted = true
+    }
+    setDefaultFastlySurrogateKey(req, res, () => {})
+    await archivedEnterpriseVersionsAssets(req, res, next)
     // It tried to go via the proxy, but it wasn't there, but then it
     // tried "our disk" and it's eventually there.
-    expect(res.statusCode).toBe(200)
-    checkCachingHeaders(res, true, 60)
+    expect(nexted).toBe(true)
   })
 })