Resolve TODO comments (batch 1) (#58553)

heiskr · web-flow · commit 96860a72bc09 · 2025-12-01T15:26:47.000Z
diff --git a/src/content-linter/lib/linting-rules/liquid-ifversion-versions.ts b/src/content-linter/lib/linting-rules/liquid-ifversion-versions.ts
@@ -15,8 +15,9 @@ import {
   isAllVersions,
   getFeatureVersionsObject,
   isInAllGhes,
+  isGhesReleaseDeprecated,
 } from '@/ghes-releases/scripts/version-utils'
-import { deprecated, oldestSupported } from '@/versions/lib/enterprise-server-releases'
+import { oldestSupported } from '@/versions/lib/enterprise-server-releases'
 import type { RuleParams, RuleErrorCallback } from '@/content-linter/types'
 
 export const liquidIfversionVersions = {
@@ -337,19 +338,9 @@ function updateConditionals(condTagItems: any[]) {
       }
       // Checks for features that are only available in no
       // supported GHES releases
-      // TODO use isGhesReleaseDeprecated
-      if (item.versionsObjAll.ghes.startsWith('<=')) {
-        const releaseNumber = item.versionsObjAll.ghes.replace('<=', '').trim()
-        if (deprecated.includes(releaseNumber)) {
-          item.action.type = 'delete'
-          continue
-        }
-      } else if (item.versionsObjAll.ghes.startsWith('<')) {
-        const releaseNumber = item.versionsObjAll.ghes.replace('<', '').trim()
-        if (deprecated.includes(releaseNumber) || releaseNumber === oldestSupported) {
-          item.action.type = 'delete'
-          continue
-        }
+      if (isGhesReleaseDeprecated(oldestSupported, item.versionsObjAll.ghes)) {
+        item.action.type = 'delete'
+        continue
       }
     }
     if (item.versionsObj?.feature || item.fileVersionsFm?.feature) break
diff --git a/src/content-linter/tests/category-pages.ts b/src/content-linter/tests/category-pages.ts
@@ -53,7 +53,7 @@ describe.skip('category pages', () => {
     // Get links included in product index page.
     // Each link corresponds to a product subdirectory (category).
     // Example: "getting-started-with-github"
-    const contents = fs.readFileSync(productIndex, 'utf8') // TODO move to async
+    const contents = fs.readFileSync(productIndex, 'utf8')
     const data = getFrontmatterData(contents)
 
     const productDir = path.dirname(productIndex)
@@ -62,7 +62,6 @@ describe.skip('category pages', () => {
     const categoryLinks = children
       // Only include category directories, not standalone category files like content/actions/quickstart.md
       .filter((link) => fs.existsSync(getPath(productDir, link, 'index')))
-    // TODO this should move to async, but you can't asynchronously define tests with vitest...
 
     // Map those to the Markdown file paths that represent that category page index
     const categoryPaths = categoryLinks.map((link) => getPath(productDir, link, 'index'))
diff --git a/src/early-access/scripts/what-docs-early-access-branch.ts b/src/early-access/scripts/what-docs-early-access-branch.ts
@@ -2,7 +2,6 @@ import { getOctokit } from '@actions/github'
 import { setOutput } from '@actions/core'
 
 async function main(): Promise<void> {
-  // TODO Is there a lib function for this?
   const { BRANCH_NAME, GITHUB_TOKEN } = process.env
   if (!BRANCH_NAME) throw new Error("'BRANCH_NAME' env var not set")
   if (!GITHUB_TOKEN) throw new Error("'GITHUB_TOKEN' env var not set")
diff --git a/src/frame/tests/page.ts b/src/frame/tests/page.ts
@@ -439,19 +439,6 @@ describe('catches errors thrown in Page class', () => {
     await expect(getPage).rejects.toThrowError('versions')
   })
 
-  // TODO - UNSKIP WHEN GHAE IS UPDATED WITH SEMVER VERSIONING
-  test.skip('invalid versions frontmatter', async () => {
-    async function getPage() {
-      return await Page.init({
-        relativePath: 'page-with-invalid-product-version.md',
-        basePath: path.join(__dirname, '../../../src/fixtures/fixtures'),
-        languageCode: 'en',
-      })
-    }
-
-    await expect(getPage).rejects.toThrowError('versions')
-  })
-
   test('English page with a version in frontmatter that its parent product is not available in', async () => {
     async function getPage() {
       return await Page.init({
diff --git a/src/frame/tests/site-tree.ts b/src/frame/tests/site-tree.ts
@@ -7,6 +7,7 @@ import { loadSiteTree } from '@/frame/lib/page-data'
 import nonEnterpriseDefaultVersion from '@/versions/lib/non-enterprise-default-version'
 import { formatAjvErrors } from '@/tests/helpers/schemas'
 import type { SiteTree, Tree } from '@/types'
+import findPageInSiteTree from '@/frame/lib/find-page-in-site-tree'
 
 const latestEnterpriseRelease = EnterpriseServerReleases.latest
 
@@ -37,15 +38,14 @@ describe('siteTree', () => {
       const ghesSiteTree = siteTree.en[ghesLatest]
 
       // Find a page in the tree that we know contains Liquid
-      // TODO: use new findPageInSiteTree helper when it's available
-      const pageWithDynamicTitle = ghesSiteTree.childPages
-        .find((child) => child.href === `/en/${ghesLatest}/admin`)
-        ?.childPages.find(
-          (child) => child.href === `/en/${ghesLatest}/admin/installing-your-enterprise-server`,
-        )
+      const pageWithDynamicTitle = findPageInSiteTree(
+        ghesSiteTree,
+        siteTree.en[nonEnterpriseDefaultVersion],
+        `/en/${ghesLatest}/admin/installing-your-enterprise-server`,
+      )
 
       // Confirm the raw title contains Liquid
-      expect(pageWithDynamicTitle?.page.title).toEqual(
+      expect(pageWithDynamicTitle.page.title).toEqual(
         'Installing {% data variables.product.prodname_enterprise %}',
       )
     })
diff --git a/src/landings/components/SidebarProduct.tsx b/src/landings/components/SidebarProduct.tsx
@@ -146,8 +146,6 @@ function RestNavListItem({ category }: { category: ProductTreeNode }) {
         },
         { rootMargin: '0px 0px -85% 0px' },
       )
-      // TODO: When we add the ## About the {title} API to each operation
-      // we can remove the h2 here
       const headingsList = Array.from(document.querySelectorAll('h2, h3'))
 
       for (const heading of headingsList) {
diff --git a/src/learning-track/middleware/learning-track.ts b/src/learning-track/middleware/learning-track.ts
@@ -27,8 +27,6 @@ export default async function learningTrack(
   const trackName = req.query.learn as string
 
   let trackProduct = req.context.currentProduct as string
-  // TODO: Once getDeepDataByLanguage is ported to TS
-  // a more appropriate API would be to use `getDeepDataByLanguage<LearningTracks)(...)`
   const allLearningTracks = getDeepDataByLanguage(
     'learning-tracks',
     req.language!,
diff --git a/src/learning-track/tests/lint-data.ts b/src/learning-track/tests/lint-data.ts
@@ -11,8 +11,6 @@ const pages = await loadPageMap(pageList)
 const redirects = await loadRedirects(pageList)
 
 describe('learning tracks', () => {
-  // TODO: Once getDeepDataByLanguage is ported to TS
-  // a more appropriate API would be to use `getDeepDataByLanguage<LearningTracks)(...)`
   const allLearningTracks = getDeepDataByLanguage('learning-tracks', 'en') as LearningTracks
   const topLevels = Object.keys(allLearningTracks)
 
diff --git a/src/observability/tests/logger.ts b/src/observability/tests/logger.ts
@@ -327,10 +327,6 @@ describe('createLogger', () => {
       logger = createLogger('file:///path/to/test.js')
     })
 
-    it('should include logger context in production logs', () => {
-      // TODO
-    })
-
     it('should handle missing logger context gracefully in development', () => {
       logger.info('No context test')
 
diff --git a/src/rest/scripts/update-files.ts b/src/rest/scripts/update-files.ts
@@ -114,10 +114,7 @@ async function main() {
   // so that we don't spend time generating data files for them.
   if (sourceRepos.includes(REST_API_DESCRIPTION_ROOT)) {
     const derefDir = await readdir(TEMP_OPENAPI_DIR)
-    // TODO: After migrating all-version.ts to TypeScript, we can remove the type assertion
-    const currentOpenApiVersions = Object.values(allVersions).map(
-      (elem) => (elem as any).openApiVersionName,
-    )
+    const currentOpenApiVersions = Object.values(allVersions).map((elem) => elem.openApiVersionName)
 
     for (const schema of derefDir) {
       // if the schema does not start with a current version name, delete it
diff --git a/src/rest/scripts/utils/operation.ts b/src/rest/scripts/utils/operation.ts
@@ -168,10 +168,6 @@ export default class Operation {
     // Operation Id: markdown/render-raw
     const contentType = Object.keys(this.#operation.requestBody.content)[0]
     const schema = get(this.#operation, `requestBody.content.${contentType}.schema`, {})
-    // TODO: Remove this check
-    if (this.#operation.operationId === 'checks/create') {
-      delete schema.oneOf
-    }
     // Merges any instances of allOf in the schema using a deep merge
     const mergedAllofSchema = mergeAllOf(schema)
     try {
diff --git a/src/search/components/helpers/execute-search-actions.ts b/src/search/components/helpers/execute-search-actions.ts
@@ -4,6 +4,7 @@ import { DEFAULT_VERSION } from '@/versions/components/useVersion'
 import { NextRouter } from 'next/router'
 import { sendEvent } from '@/events/components/events'
 import { SEARCH_OVERLAY_EVENT_GROUP } from '@/events/components/event-groups'
+import { sanitizeSearchQuery } from '@/search/lib/sanitize-search-query'
 
 // Search context values for identifying each search event
 export const GENERAL_SEARCH_CONTEXT = 'general-search'
@@ -21,7 +22,7 @@ export function executeGeneralSearch(
 ) {
   sendEvent({
     type: EventType.search,
-    search_query: localQuery,
+    search_query: sanitizeSearchQuery(localQuery),
     search_context: GENERAL_SEARCH_CONTEXT,
     eventGroupKey: SEARCH_OVERLAY_EVENT_GROUP,
     eventGroupId,
diff --git a/src/search/components/input/SearchOverlay.tsx b/src/search/components/input/SearchOverlay.tsx
@@ -30,6 +30,8 @@ import { useSharedUIContext } from '@/frame/components/context/SharedUIContext'
 import type { AIReference } from '../types'
 import type { AutocompleteSearchHit, GeneralSearchHit } from '@/search/types'
 
+import { sanitizeSearchQuery } from '@/search/lib/sanitize-search-query'
+
 import styles from './SearchOverlay.module.scss'
 
 type Props = {
@@ -317,15 +319,14 @@ export function SearchOverlay({
   const generalSearchResultOnSelect = (selectedOption: GeneralSearchHit) => {
     sendEvent({
       type: EventType.search,
-      // TODO: Remove PII so we can include the actual query
-      search_query: urlSearchInputQuery,
+      search_query: sanitizeSearchQuery(urlSearchInputQuery),
       search_context: GENERAL_SEARCH_CONTEXT,
       eventGroupKey: SEARCH_OVERLAY_EVENT_GROUP,
       eventGroupId: searchEventGroupId.current,
     })
     sendEvent({
       type: EventType.searchResult,
-      search_result_query: urlSearchInputQuery,
+      search_result_query: sanitizeSearchQuery(urlSearchInputQuery),
       search_result_index: selectedIndex,
       search_result_total: totalGeneralSearchResults,
       search_result_url: selectedOption.url || '',
diff --git a/src/search/lib/sanitize-search-query.ts b/src/search/lib/sanitize-search-query.ts
@@ -0,0 +1,58 @@
+// Remove PII from search queries before logging
+// Redacts common PII patterns like emails, tokens, and other sensitive data
+
+export function sanitizeSearchQuery(query: string): string {
+  if (!query) return query
+
+  let sanitized = query
+
+  // Redact email addresses
+  sanitized = sanitized.replace(/\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b/g, '[EMAIL]')
+
+  // Redact GitHub tokens (all formats)
+  // Classic tokens: ghp_, gho_, ghu_, ghs_, ghr_
+  sanitized = sanitized.replace(/\b(ghp|gho|ghu|ghs|ghr)_[A-Za-z0-9]{20,}\b/gi, '[TOKEN]')
+  // Fine-grained personal access tokens: github_pat_
+  sanitized = sanitized.replace(/\bgithub_pat_[A-Za-z0-9_]{20,}\b/gi, '[TOKEN]')
+  // OAuth tokens: gho_
+  sanitized = sanitized.replace(/\bgho_[A-Za-z0-9]{20,}\b/gi, '[TOKEN]')
+
+  // Redact UUIDs
+  sanitized = sanitized.replace(
+    /\b[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\b/gi,
+    '[UUID]',
+  )
+
+  // Redact JWT tokens (format: xxx.yyy.zzz where each part is base64url)
+  sanitized = sanitized.replace(
+    /\bey[A-Za-z0-9_-]{10,}\.[A-Za-z0-9_-]{10,}\.[A-Za-z0-9_-]{10,}\b/g,
+    '[JWT]',
+  )
+
+  // Redact IP addresses (with proper validation for 0-255 range)
+  sanitized = sanitized.replace(
+    /\b(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/g,
+    '[IP]',
+  )
+
+  // Redact SSH private key headers
+  sanitized = sanitized.replace(/-----BEGIN( [A-Z]+)? PRIVATE KEY-----/g, '[SSH_KEY]')
+
+  // Redact potential API keys (long strings of hex or base64-like characters)
+  // This catches high-entropy strings that might be secrets
+  sanitized = sanitized.replace(/\b[A-Za-z0-9_-]{40,}\b/g, (match) => {
+    // Only redact if it looks like high entropy (mixed case, numbers)
+    const hasLowerCase = /[a-z]/.test(match)
+    const hasUpperCase = /[A-Z]/.test(match)
+    const hasNumbers = /[0-9]/.test(match)
+    const entropyIndicators = [hasLowerCase, hasUpperCase, hasNumbers].filter(Boolean).length
+
+    // If it has at least 2 of the 3 character types, it's likely a secret
+    if (entropyIndicators >= 2) {
+      return '[SECRET]'
+    }
+    return match
+  })
+
+  return sanitized
+}
diff --git a/src/search/tests/sanitize-search-query.ts b/src/search/tests/sanitize-search-query.ts

Original file line number	Diff line number	Diff line change
`@@ -146,8 +146,6 @@ function RestNavListItem({ category }: { category: ProductTreeNode }) {`
`146`	`146`	`},`
`147`	`147`	`{ rootMargin: '0px 0px -85% 0px' },`
`148`	`148`	`)`
`149`		`- // TODO: When we add the ## About the {title} API to each operation`
`150`		`- // we can remove the h2 here`
`151`	`149`	`const headingsList = Array.from(document.querySelectorAll('h2, h3'))`
`152`	`150`
`153`	`151`	`for (const heading of headingsList) {`