Phase 1: Convert core validation utility to TypeScript (#56420)

heiskr · Ebonsignori · Copilot · web-flow · commit ad1238c44b8c · 2025-07-09T19:35:54.000Z
Co-authored-by: Evan Bonsignori &lt;ebonsignori@github.com&gt;
Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/src/content-linter/lib/helpers/get-lintable-yml.js b/src/content-linter/lib/helpers/get-lintable-yml.js
@@ -2,7 +2,7 @@ import yaml from 'js-yaml'
 import fs from 'fs/promises'
 
 import dataSchemas from '#src/data-directory/lib/data-schemas/index.ts'
-import ajv from '#src/tests/lib/validate-json-schema.js'
+import ajv from '#src/tests/lib/validate-json-schema.ts'
 
 // AJV already has a built-in way to extract out properties
 // with a specific keyword using a custom validator function.
diff --git a/src/data-directory/tests/data-schemas.js b/src/data-directory/tests/data-schemas.js
@@ -5,8 +5,8 @@ import { extname, basename } from 'path'
 import walk from 'walk-sync'
 import { beforeAll, describe, expect, test } from 'vitest'
 
-import { getJsonValidator, validateJson } from '#src/tests/lib/validate-json-schema.js'
-import { formatAjvErrors } from '#src/tests/helpers/schemas.js'
+import { getJsonValidator, validateJson } from '#src/tests/lib/validate-json-schema.ts'
+import { formatAjvErrors } from '#src/tests/helpers/schemas.ts'
 import dataSchemas from '#src/data-directory/lib/data-schemas/index.ts'
 
 const schemaPaths = Object.keys(dataSchemas)
diff --git a/src/early-access/tests/early-access-rendering.ts b/src/early-access/tests/early-access-rendering.ts
@@ -3,7 +3,7 @@ import path from 'path'
 
 import { describe, expect } from 'vitest'
 
-import { testViaActionsOnly } from '@/tests/helpers/conditional-runs.js'
+import { testViaActionsOnly } from '@/tests/helpers/conditional-runs'
 import { get, getDOM } from '@/tests/helpers/e2etest.js'
 
 describe('cloning early-access', () => {
diff --git a/src/early-access/tests/early-access-unit.ts b/src/early-access/tests/early-access-unit.ts
@@ -1,7 +1,7 @@
 import { expect, test, vi } from 'vitest'
 import { get, getDOM } from '@/tests/helpers/e2etest.js'
 
-import { describeIfDocsEarlyAccess } from '@/tests/helpers/conditional-runs.js'
+import { describeIfDocsEarlyAccess } from '@/tests/helpers/conditional-runs'
 import languages from '@/languages/lib/languages'
 
 const VALID_EARLY_ACCESS_URI = '/early-access/github/save-time-with-slash-commands'
diff --git a/src/events/tests/middleware-errors.ts b/src/events/tests/middleware-errors.ts
@@ -1,6 +1,6 @@
 import { describe, test } from 'vitest'
 
-import { validateJson } from '@/tests/lib/validate-json-schema.js'
+import { validateJson } from '@/tests/lib/validate-json-schema'
 import { formatErrors } from '../lib/middleware-errors.js'
 import { schemas } from '../lib/schema.js'
 
diff --git a/src/frame/lib/read-frontmatter.js b/src/frame/lib/read-frontmatter.js
@@ -1,6 +1,6 @@
 import matter from 'gray-matter'
 
-import { validateJson } from '#src/tests/lib/validate-json-schema.js'
+import { validateJson } from '#src/tests/lib/validate-json-schema.ts'
 
 function readFrontmatter(markdown, opts = {}) {
   const schema = opts.schema || { type: 'object', properties: {} }
diff --git a/src/frame/tests/server.js b/src/frame/tests/server.js
@@ -3,7 +3,7 @@ import { beforeAll, describe, expect, test, vi } from 'vitest'
 
 import enterpriseServerReleases from '#src/versions/lib/enterprise-server-releases.js'
 import { get, getDOM, head, post } from '#src/tests/helpers/e2etest.js'
-import { describeViaActionsOnly } from '#src/tests/helpers/conditional-runs.js'
+import { describeViaActionsOnly } from '#src/tests/helpers/conditional-runs.ts'
 import { loadPages } from '#src/frame/lib/page-data.js'
 import {
   SURROGATE_ENUMS,
diff --git a/src/frame/tests/site-tree.js b/src/frame/tests/site-tree.js
@@ -1,11 +1,11 @@
 import { beforeAll, describe, expect, test, vi } from 'vitest'
 
-import { getJsonValidator } from '#src/tests/lib/validate-json-schema.js'
+import { getJsonValidator } from '#src/tests/lib/validate-json-schema.ts'
 import schema from '#src/tests/helpers/schemas/site-tree-schema.js'
 import EnterpriseServerReleases from '#src/versions/lib/enterprise-server-releases.js'
 import { loadSiteTree } from '#src/frame/lib/page-data.js'
 import nonEnterpriseDefaultVersion from '#src/versions/lib/non-enterprise-default-version.js'
-import { formatAjvErrors } from '#src/tests/helpers/schemas.js'
+import { formatAjvErrors } from '#src/tests/helpers/schemas.ts'
 
 const latestEnterpriseRelease = EnterpriseServerReleases.latest
 
diff --git a/src/github-apps/scripts/sync.js b/src/github-apps/scripts/sync.js
@@ -9,7 +9,7 @@ import walk from 'walk-sync'
 import { getContents, getDirectoryContents } from '#src/workflows/git-utils.ts'
 import permissionSchema from './permission-list-schema.js'
 import enabledSchema from './enabled-list-schema.js'
-import { validateJson } from '#src/tests/lib/validate-json-schema.js'
+import { validateJson } from '#src/tests/lib/validate-json-schema.ts'
 
 const ENABLED_APPS_DIR = 'src/github-apps/data'
 const CONFIG_FILE = 'src/github-apps/lib/config.json'
diff --git a/src/graphql/tests/validate-schema.js b/src/graphql/tests/validate-schema.js
@@ -1,9 +1,9 @@
 import { describe, expect, test, vi } from 'vitest'
 
-import { getJsonValidator, validateJson } from '#src/tests/lib/validate-json-schema.js'
+import { getJsonValidator, validateJson } from '#src/tests/lib/validate-json-schema.ts'
 import readJsonFile from '#src/frame/lib/read-json-file.js'
 import { schemaValidator, previewsValidator, upcomingChangesValidator } from '../lib/validator.ts'
-import { formatAjvErrors } from '#src/tests/helpers/schemas.js'
+import { formatAjvErrors } from '#src/tests/helpers/schemas.ts'
 import { allVersions } from '#src/versions/lib/all-versions.ts'
 import { GRAPHQL_DATA_DIR } from '../lib/index.js'
 
diff --git a/src/languages/tests/api-search.js b/src/languages/tests/api-search.js
@@ -1,6 +1,6 @@
 import { expect, test, vi } from 'vitest'
 
-import { describeIfElasticsearchURL } from '#src/tests/helpers/conditional-runs.js'
+import { describeIfElasticsearchURL } from '#src/tests/helpers/conditional-runs.ts'
 import { get } from '#src/tests/helpers/e2etest.js'
 
 // This suite only runs if $ELASTICSEARCH_URL is set.
diff --git a/src/products/tests/products.ts b/src/products/tests/products.ts
@@ -1,8 +1,8 @@
 import { describe, expect, test } from 'vitest'
 
-import { getJsonValidator } from '@/tests/lib/validate-json-schema.js'
+import { getJsonValidator } from '@/tests/lib/validate-json-schema'
 import { productMap } from '@/products/lib/all-products'
-import { formatAjvErrors } from '@/tests/helpers/schemas.js'
+import { formatAjvErrors } from '@/tests/helpers/schemas'
 // @ts-ignore - Products schema doesn't have TypeScript types yet
 import schema from '@/tests/helpers/schemas/products-schema.js'
 
diff --git a/src/rest/scripts/utils/operation.js b/src/rest/scripts/utils/operation.js
@@ -6,7 +6,7 @@ import mergeAllOf from 'json-schema-merge-allof'
 import { renderContent } from './render-content'
 import getCodeSamples from './create-rest-examples.js'
 import operationSchema from './operation-schema.js'
-import { validateJson } from '#src/tests/lib/validate-json-schema.js'
+import { validateJson } from '#src/tests/lib/validate-json-schema.ts'
 import { getBodyParams } from './get-body-params'
 
 export default class Operation {
diff --git a/src/search/tests/api-ai-search-autocomplete.ts b/src/search/tests/api-ai-search-autocomplete.ts
@@ -13,7 +13,7 @@
 
 import { expect, test, vi } from 'vitest'
 
-import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs.js'
+import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs'
 import { get } from '@/tests/helpers/e2etest-ts'
 
 import type { AutocompleteSearchResponse } from '@/search/types'
diff --git a/src/search/tests/api-combined-search.ts b/src/search/tests/api-combined-search.ts
@@ -13,7 +13,7 @@
 
 import { expect, test, vi } from 'vitest'
 
-import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs.js'
+import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs'
 import { get } from '@/tests/helpers/e2etest-ts'
 
 import type { CombinedSearchResponse } from '@/search/types'
diff --git a/src/search/tests/api-search.ts b/src/search/tests/api-search.ts
@@ -12,7 +12,7 @@
  */
 
 import { expect, test, vi } from 'vitest'
-import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs.js'
+import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs'
 import { get } from '@/tests/helpers/e2etest-ts'
 import { GeneralSearchResponse, SearchResultAggregations, GeneralSearchHit } from '@/search/types'
 
diff --git a/src/search/tests/rendering.ts b/src/search/tests/rendering.ts
@@ -13,7 +13,7 @@
 
 import { expect, test, vi } from 'vitest'
 
-import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs.js'
+import { describeIfElasticsearchURL } from '@/tests/helpers/conditional-runs'
 import { get, getDOM } from '@/tests/helpers/e2etest-ts'
 import { SURROGATE_ENUMS } from '@/frame/middleware/set-fastly-surrogate-key.js'
 
diff --git a/src/secret-scanning/scripts/sync.ts b/src/secret-scanning/scripts/sync.ts
@@ -14,9 +14,9 @@ import yaml from 'js-yaml'
 import { getContentAndData, getCommitSha } from '@/workflows/git-utils.js'
 import schema from '@/secret-scanning/data/public-docs-schema'
 // This is temporarily being imported until the subsequent modules
-// have beeen converted to TypeScript.
-import { validateJson } from '@/tests/lib/validate-json-schema.js'
-import { formatAjvErrors } from '@/tests/helpers/schemas.js'
+// have been converted to TypeScript.
+import { validateJson } from '@/tests/lib/validate-json-schema'
+import { formatAjvErrors } from '@/tests/helpers/schemas'
 
 const SECRET_SCANNING_FILEPATH = 'src/secret-scanning/data/public-docs.yml'
 type PipelineConfig = { sha: string; 'blob-sha': string }
diff --git a/src/tests/helpers/conditional-runs.ts b/src/tests/helpers/conditional-runs.ts
diff --git a/src/tests/helpers/schemas.ts b/src/tests/helpers/schemas.ts
@@ -1,3 +1,5 @@
+import type { ErrorObject } from 'ajv'
+
 // lightly format the schema errors object returned from ajv to connect the
 // error message to where the problem is -- for example, if a top level 'date'
 // property isn't correctly formatted as a date we return:
@@ -8,7 +10,7 @@
 // property and we misspell the property name in the first item:
 //
 //   at 'sections > features > item 0': must have required property 'notes'
-export const formatAjvErrors = (errors = []) => {
+export const formatAjvErrors = (errors: ErrorObject[] = []): string => {
   return errors
     .map((errorObj) => {
       // ajv instancePath tells us in the data we're checking where there was a
@@ -31,7 +33,7 @@ export const formatAjvErrors = (errors = []) => {
 
       const schemaErrorPath = split
         .map((item) => {
-          if (!isNaN(item)) {
+          if (!isNaN(Number(item))) {
             return `item ${item}`
           } else {
             return item
diff --git a/src/tests/lib/validate-json-schema.ts b/src/tests/lib/validate-json-schema.ts
@@ -1,4 +1,4 @@
-import Ajv from 'ajv'
+import Ajv, { type ValidateFunction, type ErrorObject, type SchemaObject } from 'ajv'
 import addErrors from 'ajv-errors'
 import addFormats from 'ajv-formats'
 import semver from 'semver'
@@ -24,7 +24,7 @@ ajv.addKeyword({
 
 // Custom JSON formats
 ajv.addFormat('semver', {
-  validate: (x) => semver.validRange(x),
+  validate: (x: string): boolean => semver.validRange(x) !== null,
 })
 
 // The ajv.validate function is supposed to cache
@@ -35,18 +35,24 @@ ajv.addFormat('semver', {
 // this is the best function to use. If the schema
 // changes from one call to the next, then the validateJson
 // function makes more sense to use.
-export function getJsonValidator(schema) {
+export function getJsonValidator(schema: SchemaObject): ValidateFunction {
   return ajv.compile(schema)
 }
 
 // The next call to ajv.validate will overwrite
 // the ajv.errors property, so returning it here
 // ensures that it remains accessible.
-export function validateJson(schema, data) {
+export function validateJson(
+  schema: SchemaObject,
+  data: unknown,
+): {
+  isValid: boolean
+  errors: ErrorObject[] | null
+} {
   const isValid = ajv.validate(schema, data)
   return {
     isValid,
-    errors: isValid ? null : structuredClone(ajv.errors),
+    errors: isValid ? null : structuredClone(ajv.errors || []),
   }
 }
 
diff --git a/src/versions/tests/versions.js b/src/versions/tests/versions.js
@@ -1,11 +1,11 @@
 import { describe, expect, test } from 'vitest'
 
-import { getJsonValidator } from '#src/tests/lib/validate-json-schema.js'
+import { getJsonValidator } from '#src/tests/lib/validate-json-schema.ts'
 import { allVersions } from '#src/versions/lib/all-versions.ts'
 import { latest } from '#src/versions/lib/enterprise-server-releases.js'
 import schema from '#src/tests/helpers/schemas/versions-schema.js'
 import nonEnterpriseDefaultVersion from '#src/versions/lib/non-enterprise-default-version.js'
-import { formatAjvErrors } from '#src/tests/helpers/schemas.js'
+import { formatAjvErrors } from '#src/tests/helpers/schemas.ts'
 
 const validate = getJsonValidator(schema)
 
