Trim excessive comments in src/frame/middleware (#63259)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com>
Copilot-Session: 17588eeb-788a-4f82-9d36-b5079fb36521

Author: 3 people

src/frame/lib/permalink.ts

@@ -29,7 +29,7 @@ page.permalinks is an array of objects that looks like this:
 */
 // String interning pool: deduplicates low-cardinality, highly-repeated values (languageCode, pageVersion)
 // across ~975K Permalink instances (~9 languages × ~9 versions × ~65K pages). Because these fields have
-// few distinct values (~81 total), the pool stays bounded — do not use intern() for high-cardinality
+// few distinct values (~81 total), the pool stays bounded. Do not use intern() for high-cardinality
 // fields like relativePath or title, where the pool would grow unbounded and leak memory.
 const stringPool = new Map<string, string>()
 

src/frame/lib/read-file-contents.ts

@@ -7,9 +7,6 @@ import fm from './frontmatter'
 const fmCache =
   process.env.NODE_ENV === 'production' ? new Map<string, ReturnType<typeof fm>>() : null
 
-/**
- * Read only the frontmatter from  file
- */
 export default async function fmfromf(filepath: string): Promise<ReturnType<typeof fm>> {
   const cached = fmCache?.get(filepath)
   if (cached) return cached

src/frame/lib/read-frontmatter.ts

@@ -56,7 +56,7 @@ function readFrontmatter(markdown: string, opts: ReadFrontmatterOptions = {}) {
   // return:
   //   property: 'versions.ftp'
   //
-  // The purpose is to help users understand that the error is on the `fpt` key within the `versions` object.
+  // The purpose is to help users understand that the error is on the `ftp` key within the `versions` object.
   // Note if the error is on a top-level FM property like `title`, the `instancePath` will be empty.
   const cleanPropertyPath = (
     params: Record<string, unknown>,

src/frame/lib/strip-outer-tag.ts

@@ -5,7 +5,6 @@
 export function stripOuterTag(html: string): string {
   if (!html) return ''
 
-  // Extract opening tag and tag name
   const openMatch = html.match(/^<([a-z][a-z0-9]*)\b[^>]*>/i)
   if (!openMatch) return html
 

src/frame/lib/warm-server.ts

@@ -14,8 +14,7 @@ type WarmServerResult = {
   pageMap: Awaited<ReturnType<typeof loadPageMap>>
 }
 
-// Instrument these functions so that
-// it's wrapped in a timer that reports to Datadog
+// Wrap these functions in timers that report to Datadog.
 const dog = {
   loadUnversionedTree: statsd.asyncTimer(
     adaptForTimer(loadUnversionedTree),
@@ -28,7 +27,6 @@ const dog = {
   warmServer: statsd.asyncTimer(adaptForTimer(warmServer), 'warm_server'),
 }
 
-// For multiple-triggered Promise sharing
 let promisedWarmServer: Promise<WarmServerResult> | undefined
 
 async function warmServer(languagesOnly: string[] = []): Promise<WarmServerResult> {
@@ -94,10 +92,6 @@ async function warmServer(languagesOnly: string[] = []): Promise<WarmServerResul
   }
 }
 
-// Instrument the `warmServer` function so that
-// it's wrapped in a timer that reports to Datadog
-// dog.warmServer = statsd.asyncTimer(warmServer, 'warm_server') as typeof warmServer
-
 // We only want statistics if the priming needs to occur, so let's wrap the
 // real method and return early [without statistics] whenever possible
 export default async function warmServerWrapper(languagesOnly: string[] = []) {

src/frame/middleware/abort.ts

@@ -36,7 +36,6 @@ export default function abort(req: ExtendedRequest, res: Response, next: NextFun
 
     const abortError = new AbortError('Client closed request', 499, 'ECONNRESET')
 
-    // Pass the error to the Express error handler
     return next(abortError)
   })
 

src/frame/middleware/api.ts

@@ -63,7 +63,6 @@ router.get('/cookies', (req, res) => {
   res.json(cookies)
 })
 
-// Handle root /api requests
 router.get('/', (req, res) => {
   res.status(404).json({ error: `${req.path} not found` })
 })

src/frame/middleware/cache-control.ts

@@ -53,7 +53,7 @@ function cacheControlFactory(
   }
 }
 
-// ### These are roughly in order from shortest to longest. ###
+// The rest of this file is roughly in order from shortest max age to longest.
 
 // If you do not want caching.
 export const noCacheControl = cacheControlFactory(0)

src/frame/middleware/context/context.ts

@@ -91,14 +91,12 @@ export default async function contextualize(
   const restDate = new Date(req.context.initialRestVersioningReleaseDate)
   req.context.initialRestVersioningReleaseDateLong = restDate.toUTCString().split(' 00:')[0]
 
-  // Conditionally add this for non-English pages so what inside the
-  // `Page.render` method, when it calls out to `renderContentWithFallback`
-  // it can be able to fall back get original content from English if there's
-  // some runtime rendering error from the translation.
+  // Non-English pages need this so that `Page.render`, when it calls
+  // `renderContentWithFallback`, can fall back to the English content when the
+  // translation hits a fallback-eligible error (Liquid, autotitle, empty title).
   if (req.language !== 'en') {
-    // The reason this is a function is because most of the time, we don't
-    // need to know the English equivalent. It only comes into play if a
-    // translated
+    // This is a function so the lookup only happens when a translated page
+    // actually needs to fall back. Most requests never need it.
     req.context.getEnglishPage = (ctx) => {
       if (!ctx.enPage) {
         const { page } = ctx

src/frame/middleware/context/current-product-tree.ts

@@ -49,7 +49,7 @@ export default async function currentProductTree(
     req.context,
   )
   // Now make an even slimmer version that excludes all hidden pages.
-  // This is i used for sidebars.
+  // This is used for sidebars.
   req.context.currentProductTreeTitlesExcludeHidden = excludeHidden(
     req.context.currentProductTreeTitles,
   )