Merge pull request #13072 from github/repo-sync

repo sync

Author: Octomerger

.github/workflows/link-check-dotcom.yml

@@ -6,9 +6,6 @@ name: 'Link Checker: Dotcom'
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - main
   pull_request:
 
 permissions:

.github/workflows/link-check-ghae.yml

@@ -6,9 +6,6 @@ name: 'Link Checker: GitHub AE'
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - main
   pull_request:
 
 permissions:

.github/workflows/link-check-ghec.yml

@@ -6,9 +6,6 @@ name: 'Link Checker: Enterprise Cloud'
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - main
   pull_request:
 
 permissions:

.github/workflows/link-check-ghes.yml

@@ -6,9 +6,6 @@ name: 'Link Checker: Enterprise Server'
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - main
   pull_request:
 
 permissions:

middleware/render-page.js

@@ -1,22 +1,124 @@
 import { get } from 'lodash-es'
+import QuickLRU from 'quick-lru'
+
 import patterns from '../lib/patterns.js'
 import getMiniTocItems from '../lib/get-mini-toc-items.js'
 import Page from '../lib/page.js'
 import statsd from '../lib/statsd.js'
 import { isConnectionDropped } from './halt-on-dropped-connection.js'
 import { nextApp, nextHandleRequest } from './next.js'
 
+function cacheOnReq(fn, minSize = 1024, lruMaxSize = 1000) {
+  const cache = new QuickLRU({ maxSize: lruMaxSize })
+
+  return async function (req) {
+    const path = req.pagePath || req.path
+
+    // Is the request for the GraphQL Explorer page?
+    const isGraphQLExplorer =
+      req.context.currentPathWithoutLanguage === '/graphql/overview/explorer'
+
+    // Serve from the cache if possible
+    const isCacheable =
+      // Skip for HTTP methods other than GET
+      req.method === 'GET' &&
+      // Skip for JSON debugging info requests
+      !('json' in req.query) &&
+      // Skip for the GraphQL Explorer page
+      !isGraphQLExplorer
+
+    if (isCacheable && cache.has(path)) {
+      return cache.get(path)
+    }
+    const result = await fn(req)
+
+    if (result && isCacheable && result.length > minSize) {
+      cache.set(path, result)
+    }
+    return result
+  }
+}
+
+async function buildRenderedPage(req) {
+  const { context } = req
+  const { page } = context
+  const path = req.pagePath || req.path
+
+  const pageRenderTimed = statsd.asyncTimer(page.render, 'middleware.render_page', [`path:${path}`])
+
+  const renderedPage = await pageRenderTimed(context)
+
+  // handle special-case prerendered GraphQL objects page
+  if (path.endsWith('graphql/reference/objects')) {
+    return renderedPage + context.graphql.prerenderedObjectsForCurrentVersion.html
+  }
+
+  // handle special-case prerendered GraphQL input objects page
+  if (path.endsWith('graphql/reference/input-objects')) {
+    return renderedPage + context.graphql.prerenderedInputObjectsForCurrentVersion.html
+  }
+
+  // handle special-case prerendered GraphQL mutations page
+  if (path.endsWith('graphql/reference/mutations')) {
+    return renderedPage + context.graphql.prerenderedMutationsForCurrentVersion.html
+  }
+
+  return renderedPage
+}
+
+async function buildMiniTocItems(req) {
+  const { context } = req
+  const { page } = context
+  const path = req.pagePath || req.path
+
+  // get mini TOC items on articles
+  if (!page.showMiniToc) {
+    return
+  }
+
+  const miniTocItems = getMiniTocItems(context.renderedPage, page.miniTocMaxHeadingLevel)
+
+  // handle special-case prerendered GraphQL objects page
+  if (path.endsWith('graphql/reference/objects')) {
+    // concat the markdown source miniToc items and the prerendered miniToc items
+    return miniTocItems.concat(context.graphql.prerenderedObjectsForCurrentVersion.miniToc)
+  }
+
+  // handle special-case prerendered GraphQL input objects page
+  if (path.endsWith('graphql/reference/input-objects')) {
+    // concat the markdown source miniToc items and the prerendered miniToc items
+    return miniTocItems.concat(context.graphql.prerenderedInputObjectsForCurrentVersion.miniToc)
+  }
+
+  // handle special-case prerendered GraphQL mutations page
+  if (path.endsWith('graphql/reference/mutations')) {
+    // concat the markdown source miniToc items and the prerendered miniToc items
+    return miniTocItems.concat(context.graphql.prerenderedMutationsForCurrentVersion.miniToc)
+  }
+
+  return miniTocItems
+}
+
+// The avergage size of buildRenderedPage() is about 22KB.
+// The median in 7KB. By only caching those larger than 10KB we avoid
+// putting too much into the cache.
+const wrapRenderedPage = cacheOnReq(buildRenderedPage, 10 * 1024)
+// const wrapMiniTocItems = cacheOnReq(buildMiniTocItems)
+
 export default async function renderPage(req, res, next) {
-  if (req.path.startsWith('/storybook')) {
+  const { context } = req
+  const { page } = context
+  const path = req.pagePath || req.path
+
+  if (path.startsWith('/storybook')) {
     return nextHandleRequest(req, res)
   }
 
-  const page = req.context.page
   // render a 404 page
   if (!page) {
-    if (process.env.NODE_ENV !== 'test' && req.context.redirectNotFound) {
+    if (process.env.NODE_ENV !== 'test' && context.redirectNotFound) {
       console.error(
-        `\nTried to redirect to ${req.context.redirectNotFound}, but that page was not found.\n`
+        `\nTried to redirect to ${context.redirectNotFound}, but that page was not found.\n`
       )
     }
     return nextApp.render404(req, res)
@@ -27,79 +129,38 @@ export default async function renderPage(req, res, next) {
     return res.status(200).end()
   }
 
-  // Is the request for JSON debugging info?
-  const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production'
-
-  // add page context
-  const context = Object.assign({}, req.context, { page })
-
   // Updating the Last-Modified header for substantive changes on a page for engineering
   // Docs Engineering Issue #945
-  if (context.page.effectiveDate) {
+  if (page.effectiveDate) {
     // Note that if a page has an invalidate `effectiveDate` string value,
     // it would be caught prior to this usage and ultimately lead to
     // 500 error.
-    res.setHeader('Last-Modified', new Date(context.page.effectiveDate).toUTCString())
+    res.setHeader('Last-Modified', new Date(page.effectiveDate).toUTCString())
   }
 
   // collect URLs for variants of this page in all languages
-  context.page.languageVariants = Page.getLanguageVariants(req.pagePath)
+  page.languageVariants = Page.getLanguageVariants(path)
+
   // Stop processing if the connection was already dropped
   if (isConnectionDropped(req, res)) return
 
-  // render page
-  const pageRenderTimed = statsd.asyncTimer(page.render, 'middleware.render_page', [
-    `path:${req.pagePath || req.path}`,
-  ])
-  context.renderedPage = await pageRenderTimed(context)
+  req.context.renderedPage = await wrapRenderedPage(req)
+  req.context.miniTocItems = await buildMiniTocItems(req)
 
   // Stop processing if the connection was already dropped
   if (isConnectionDropped(req, res)) return
 
-  // get mini TOC items on articles
-  if (page.showMiniToc) {
-    context.miniTocItems = getMiniTocItems(context.renderedPage, page.miniTocMaxHeadingLevel)
-  }
-
-  // handle special-case prerendered GraphQL objects page
-  if (req.pagePath.endsWith('graphql/reference/objects')) {
-    // concat the markdown source miniToc items and the prerendered miniToc items
-    context.miniTocItems = context.miniTocItems.concat(
-      req.context.graphql.prerenderedObjectsForCurrentVersion.miniToc
-    )
-    context.renderedPage =
-      context.renderedPage + req.context.graphql.prerenderedObjectsForCurrentVersion.html
-  }
-
-  // handle special-case prerendered GraphQL input objects page
-  if (req.pagePath.endsWith('graphql/reference/input-objects')) {
-    // concat the markdown source miniToc items and the prerendered miniToc items
-    context.miniTocItems = context.miniTocItems.concat(
-      req.context.graphql.prerenderedInputObjectsForCurrentVersion.miniToc
-    )
-    context.renderedPage =
-      context.renderedPage + req.context.graphql.prerenderedInputObjectsForCurrentVersion.html
-  }
-
-  // handle special-case prerendered GraphQL mutations page
-  if (req.pagePath.endsWith('graphql/reference/mutations')) {
-    // concat the markdown source miniToc items and the prerendered miniToc items
-    context.miniTocItems = context.miniTocItems.concat(
-      req.context.graphql.prerenderedMutationsForCurrentVersion.miniToc
-    )
-    context.renderedPage =
-      context.renderedPage + req.context.graphql.prerenderedMutationsForCurrentVersion.html
-  }
-
   // Create string for <title> tag
-  context.page.fullTitle = context.page.titlePlainText
+  page.fullTitle = page.titlePlainText
 
   // add localized ` - GitHub Docs` suffix to <title> tag (except for the homepage)
-  if (!patterns.homepagePath.test(req.pagePath)) {
-    context.page.fullTitle =
-      context.page.fullTitle + ' - ' + context.site.data.ui.header.github_docs
+  if (!patterns.homepagePath.test(path)) {
+    page.fullTitle = page.fullTitle + ' - ' + context.site.data.ui.header.github_docs
   }
 
+  // Is the request for JSON debugging info?
+  const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production'
+
   // `?json` query param for debugging request context
   if (isRequestingJsonForDebugging) {
     if (req.query.json.length > 1) {
@@ -115,8 +176,5 @@ export default async function renderPage(req, res, next) {
     }
   }
 
-  // Hand rendering over to NextJS
-  req.context.renderedPage = context.renderedPage
-  req.context.miniTocItems = context.miniTocItems
   return nextHandleRequest(req, res)
 }

package-lock.json

@@ -62,6 +62,7 @@
     "node-fetch": "^3.1.0",
     "parse5": "^6.0.1",
     "port-used": "^2.0.8",
+    "quick-lru": "6.0.2",
     "rate-limit-redis": "^2.1.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",