do rendering end-to-end tests with a real server (github#26169)

* reinstate

* start server manually

* routing tests too

* skip more

* sleep more and fail if not 200

* use e2etest for content/ too

* feedbacked

Author: peterbe

.github/workflows/test.yml

@@ -140,6 +140,16 @@ jobs:
           NODE_ENV: test
         run: ./script/warm-before-tests.mjs
 
+      - name: Start production-like server in the background
+        if: ${{ matrix.test-group == 'rendering' || matrix.test-group == 'routing' || matrix.test-group == 'content' }}
+        env:
+          NODE_ENV: test
+          PORT: 4000
+        run: |
+          node server.mjs &
+          sleep 3
+          curl --retry-connrefused --retry 5 -I --fail http://localhost:4000/healthz
+
       - name: Run tests
         env:
           DIFF_FILE: get_diff_files.txt

middleware/rate-limit.js

@@ -3,7 +3,7 @@ import statsd from '../lib/statsd.js'
 
 const EXPIRES_IN_AS_SECONDS = 60
 
-const MAX = process.env.RATE_LIMIT_MAX ? parseInt(process.env.RATE_LIMIT_MAX, 10) : 1000
+const MAX = process.env.RATE_LIMIT_MAX ? parseInt(process.env.RATE_LIMIT_MAX, 10) : 10000
 if (isNaN(MAX)) {
   throw new Error(`process.env.RATE_LIMIT_MAX (${process.env.RATE_LIMIT_MAX}) not a number`)
 }

tests/content/featured-links.js

@@ -7,7 +7,7 @@ import nock from 'nock'
 import japaneseCharacters from 'japanese-characters'
 
 import '../../lib/feature-flags.js'
-import { getDOM, getJSON } from '../helpers/supertest.js'
+import { getDOM, getJSON } from '../helpers/e2etest.js'
 import enterpriseServerReleases from '../../lib/enterprise-server-releases.js'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))

tests/content/search.js

@@ -4,7 +4,7 @@ import { dates, supported } from '../../lib/enterprise-server-releases.js'
 import libLanguages from '../../lib/languages.js'
 import { namePrefix } from '../../lib/search/config.js'
 import lunrIndexNames from '../../script/search/lunr-get-index-names.js'
-import { get } from '../helpers/supertest.js'
+import { get } from '../helpers/e2etest.js'
 
 const languageCodes = Object.keys(libLanguages)
 

tests/content/webhooks.js

@@ -1,5 +1,5 @@
 import { difference } from 'lodash-es'
-import { getJSON } from '../helpers/supertest.js'
+import { getJSON } from '../helpers/e2etest.js'
 import { latest } from '../../lib/enterprise-server-releases.js'
 import { allVersions } from '../../lib/all-versions.js'
 import getWebhookPayloads from '../../lib/webhooks'

tests/helpers/caching-headers.js

@@ -0,0 +1,14 @@
+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)
+  // 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)
+  // Because it doesn't have have a unique URL
+  expect(res.headers['surrogate-key']).toBe(
+    defaultSurrogateKey ? SURROGATE_ENUMS.DEFAULT : SURROGATE_ENUMS.MANUAL
+  )
+}

tests/helpers/e2etest.js

@@ -0,0 +1,83 @@
+import cheerio from 'cheerio'
+import got from 'got'
+
+export async function get(
+  route,
+  opts = {
+    method: 'get',
+    body: undefined,
+    followRedirects: false,
+    followAllRedirects: false,
+    headers: {},
+  }
+) {
+  const method = opts.method || 'get'
+  const fn = got[method]
+  if (!fn || typeof fn !== 'function') throw new Error(`No method function for '${method}'`)
+  const absURL = `http://localhost:4000${route}`
+  const res = await fn(absURL, {
+    body: opts.body,
+    headers: opts.headers,
+    retry: { limit: 0 },
+    throwHttpErrors: false,
+    followRedirect: opts.followAllRedirects || opts.followRedirects,
+  })
+  // follow all redirects, or just follow one
+  if (opts.followAllRedirects && [301, 302].includes(res.status)) {
+    // res = await get(res.headers.location, opts)
+    throw new Error('A')
+  } else if (opts.followRedirects && [301, 302].includes(res.status)) {
+    // res = await get(res.headers.location)
+    throw new Error('B')
+  }
+
+  const text = res.body
+  const status = res.statusCode
+  const headers = res.headers
+  return {
+    text,
+    status,
+    statusCode: status, // Legacy
+    headers,
+    header: headers, // Legacy
+    url: res.url,
+  }
+}
+
+export async function head(route, opts = { followRedirects: false }) {
+  const res = await get(route, { method: 'head', followRedirects: opts.followRedirects })
+  return res
+}
+
+export function post(route, opts) {
+  return get(route, Object.assign({}, opts, { method: 'post' }))
+}
+
+export async function getDOM(
+  route,
+  { headers, allow500s, allow404 } = { headers: undefined, allow500s: false, allow404: false }
+) {
+  const res = await get(route, { followRedirects: true, headers })
+  if (!allow500s && res.status >= 500) {
+    throw new Error(`Server error (${res.status}) on ${route}`)
+  }
+  if (!allow404 && res.status === 404) {
+    throw new Error(`Page not found on ${route}`)
+  }
+  const $ = cheerio.load(res.text || '', { xmlMode: true })
+  $.res = Object.assign({}, res)
+  return $
+}
+
+// For use with the ?json query param
+// e.g. await getJSON('/en?json=breadcrumbs')
+export async function getJSON(route) {
+  const res = await get(route, { followRedirects: true })
+  if (res.status >= 500) {
+    throw new Error(`Server error (${res.status}) on ${route}`)
+  }
+  if (res.status >= 400) {
+    console.warn(`${res.status} on ${route} and the response might not be JSON`)
+  }
+  return JSON.parse(res.text)
+}

tests/rendering/breadcrumbs.js

@@ -1,6 +1,7 @@
-import { getDOM, getJSON } from '../helpers/supertest.js'
 import { jest } from '@jest/globals'
 
+import { getDOM, getJSON } from '../helpers/e2etest.js'
+
 // TODO: Use `describeViaActionsOnly` instead. See tests/rendering/server.js
 const describeInternalOnly =
   process.env.GITHUB_REPOSITORY === 'github/docs-internal' ? describe : describe.skip

tests/rendering/curated-homepage-links.js

@@ -1,4 +1,4 @@
-import { getDOM } from '../helpers/supertest.js'
+import { getDOM } from '../helpers/e2etest.js'
 import { jest } from '@jest/globals'
 
 describe('curated homepage links', () => {

tests/rendering/favicons.js

@@ -1,7 +1,7 @@
 import { expect } from '@jest/globals'
 
 import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js'
-import { get } from '../helpers/supertest.js'
+import { get } from '../helpers/e2etest.js'
 
 describe('favicon assets', () => {
   it('should serve a valid and aggressively caching /favicon.ico', async () => {