catch typos near 'AUTOTITLE' (github#34493)

Co-authored-by: Sarah Schneider <[email protected]>

Author: peterbe

lib/render-content/plugins/rewrite-local-links.js

@@ -1,5 +1,6 @@
 import path from 'path'
 import { visit } from 'unist-util-visit'
+import { distance } from 'fastest-levenshtein'
 import { getPathWithoutLanguage, getVersionStringFromPath } from '../../path-utils.js'
 import { getNewVersionedPath } from '../../old-versions-utils.js'
 import patterns from '../../patterns.js'
@@ -40,8 +41,21 @@ export default function rewriteLocalLinks(context) {
         node.properties.href = newHref
       }
       for (const child of node.children) {
-        if (child.value && AUTOTITLE.test(child.value)) {
-          promises.push(getNewTitleSetter(child, node.properties.href, context))
+        if (child.value) {
+          if (AUTOTITLE.test(child.value)) {
+            promises.push(getNewTitleSetter(child, node.properties.href, context))
+          } else if (process.env.NODE_ENV !== 'production') {
+            // Throw if the link text *almost*  is AUTOTITLE
+            if (
+              child.value.toUpperCase() === 'AUTOTITLE' ||
+              distance(child.value.toUpperCase(), 'AUTOTITLE') <= 2
+            ) {
+              throw new Error(
+                `Found link text '${child.value}', expected 'AUTOTITLE'. ` +
+                  `Find the mention of the link text '${child.value}' and change it to 'AUTOTITLE'. Case matters.`
+              )
+            }
+          }
         }
       }
     })

middleware/handle-errors.js

@@ -3,6 +3,8 @@ import { nextApp } from './next.js'
 import { setFastlySurrogateKey, SURROGATE_ENUMS } from './set-fastly-surrogate-key.js'
 import { errorCacheControl } from './cache-control.js'
 
+const DEBUG_MIDDLEWARE_TESTS = Boolean(JSON.parse(process.env.DEBUG_MIDDLEWARE_TESTS || 'false'))
+
 function shouldLogException(error) {
   const IGNORED_ERRORS = [
     // Client connected aborted
@@ -43,7 +45,7 @@ export default async function handleError(error, req, res, next) {
       // loading all the middlewares.
       setFastlySurrogateKey(res, SURROGATE_ENUMS.DEFAULT)
     }
-  } else if (process.env.NODE_ENV === 'test') {
+  } else if (DEBUG_MIDDLEWARE_TESTS) {
     console.warn('An error occurrred in some middleware handler', error)
   }
 

package-lock.json

@@ -30,6 +30,7 @@
     "dotenv": "^16.0.1",
     "express": "^4.18.1",
     "express-timeout-handler": "^2.2.2",
+    "fastest-levenshtein": "1.0.16",
     "file-type": "18.2.0",
     "flat": "^5.0.2",
     "github-slugger": "^2.0.0",

package.json

@@ -6,7 +6,7 @@ but it's helpful to run tests locally before pushing your changes to
 GitHub.
 
 Tests are written using [jest](https://ghub.io/jest), a framework maintained
-by Facebook and used by many teams at GitHub. 
+by Facebook and used by many teams at GitHub.
 Jest provides everything: a test runner, an assertion library, code coverage analysis,
 custom reporters for different types of test output, etc.
 
@@ -98,7 +98,21 @@ In another terminal, type:
 START_JEST_SERVER=false jest tests/rendering/foo/bar.js
 ```
 
-Or whatever the testing command you use is. 
+Or whatever the testing command you use is.
 
 The `START_JEST_SERVER` environment variable needs to be set to `false`, or else `jest` will try to start
 a server on `:4000` too.
+
+### Debugging middleware errors
+
+By default, errors handled by the middleware are dealt with just like
+any error in production. It's common to have end-to-end tests that expect
+a page to throw a 500 Internal Server Error response.
+
+If you don't expect that and you might struggle to see exactly where the
+error is happening, set `$DEBUG_MIDDLEWARE_TESTS` to `true`. For example:
+
+```sh
+export DEBUG_MIDDLEWARE_TESTS=true
+jest tests/rendering/ -b
+```

tests/README.md

@@ -10,5 +10,6 @@ versions:
 children:
   - /bar
   - /autotitling
+  - /typo-autotitling
   - /cross-version-linking
 ---

tests/fixtures/content/get-started/foo/index.md

@@ -0,0 +1,21 @@
+---
+title: Typo autotitling
+intro: If the author typos the word "AUTOTITLE" it will throw
+versions:
+  fpt: '*'
+  ghes: '*'
+  ghae: '*'
+type: how_to
+---
+
+## Example
+
+{% ifversion ghes %}
+
+"[Autotitle](/get-started/quickstart/hello-world)."
+
+{% else %}
+
+"[AUTOTITLES](/get-started/quickstart/hello-world)."
+
+{% endif %}

tests/fixtures/content/get-started/foo/typo-autotitling.md

@@ -1,4 +1,4 @@
-import { getDOM } from '../helpers/e2etest.js'
+import { get, getDOM } from '../helpers/e2etest.js'
 import enterpriseServerReleases from '../../lib/enterprise-server-releases.js'
 import { allVersions } from '../../lib/all-versions.js'
 
@@ -14,6 +14,21 @@ describe('autotitle', () => {
     // There are 4 links on the `autotitling.md` content.
     expect.assertions(4)
   })
+
+  test('typos lead to error when NODE_ENV !== production', async () => {
+    // The fixture typo-autotitling.md contains two different typos
+    // of the word "AUTOTITLE", separated by `{% if version ghes %}`
+    {
+      const res = await get('/get-started/foo/typo-autotitling', { followRedirects: true })
+      expect(res.statusCode).toBe(500)
+    }
+    {
+      const res = await get('/enterprise-server@latest/get-started/foo/typo-autotitling', {
+        followRedirects: true,
+      })
+      expect(res.statusCode).toBe(500)
+    }
+  })
 })
 
 describe('cross-version-links', () => {