Complete TypeScript migration for src/redirects - Convert all test files (#56633)

Author: heiskr

…irects/tests/content/redirect-orphans.js …irects/tests/content/redirect-orphans.tssrc/redirects/tests/content/redirect-orphans.js renamed to src/redirects/tests/content/redirect-orphans.ts src/redirects/tests/content/redirect-orphans.js renamed to src/redirects/tests/content/redirect-orphans.ts

@@ -23,6 +23,7 @@ describe('redirects', () => {
       basePath: path.join(__dirname, '../../../content'),
       languageCode: 'en',
     })
+    if (!page) throw new Error('Failed to initialize page')
     const pageRedirects = page.buildRedirects()
     expect(isPlainObject(pageRedirects)).toBe(true)
   })
@@ -33,6 +34,7 @@ describe('redirects', () => {
       basePath: path.join(__dirname, '../../../content'),
       languageCode: 'en',
     })
+    if (!page) throw new Error('Failed to initialize page')
     const pageRedirects = page.buildRedirects()
     expect(pageRedirects['/about-issues']).toBe('/issues')
     expect(pageRedirects['/creating-an-issue']).toBe('/issues')
@@ -88,7 +90,7 @@ describe('redirects', () => {
   })
 
   describe('trailing slashes', () => {
-    let redirects
+    let redirects: Record<string, string>
     beforeAll(async () => {
       const res = await get('/en?json=redirects')
       redirects = JSON.parse(res.body)
@@ -102,7 +104,7 @@ describe('redirects', () => {
 
     test('are absent from all destination URLs', async () => {
       const values = Object.entries(redirects)
-        .filter(([, to]) => !to.includes('://'))
+        .filter(([, to]: [string, string]) => !to.includes('://'))
         .map(([from_]) => from_)
       expect(values.length).toBeGreaterThan(100)
       expect(values.every((value) => !value.endsWith('/'))).toBe(true)
@@ -138,24 +140,24 @@ describe('redirects', () => {
   })
 
   describe('external redirects', () => {
-    let redirects
+    let redirects: Record<string, string>
     beforeAll(async () => {
       const res = await get('/en?json=redirects')
       redirects = JSON.parse(res.body)
     })
 
     test('no external redirect starts with a language prefix', () => {
       const values = Object.entries(redirects)
-        .filter(([, to]) => to.includes('://'))
+        .filter(([, to]: [string, string]) => to.includes('://'))
         .map(([from_]) => from_)
         .filter((from_) => from_.startsWith('/en/'))
       expect(values.length).toBe(0)
     })
 
     test('no external redirect should go to developer.github.com', () => {
       const values = Object.values(redirects)
-        .filter((to) => to.includes('://'))
-        .filter((to) => new URL(to).hostname === 'developer.github.com')
+        .filter((to: string) => to.includes('://'))
+        .filter((to: string) => new URL(to).hostname === 'developer.github.com')
       expect(values.length).toBe(0)
     })
 

src/redirects/tests/ghae.js src/redirects/tests/ghae.tssrc/redirects/tests/ghae.js renamed to src/redirects/tests/ghae.ts

@@ -106,18 +106,18 @@ describe('developer redirects', () => {
         graphql: './src/fixtures/fixtures/graphql-redirects.json',
       }
       if (!(label in FIXTURES)) throw new Error('unrecognized label')
-      const fixtures = readJsonFile(FIXTURES[label])
+      const fixtures = readJsonFile(FIXTURES[label as keyof typeof FIXTURES])
       // Don't use a `Promise.all()` because it's actually slower
       // because of all the eventloop context switching.
       for (let [oldPath, newPath] of Object.entries(fixtures)) {
         // REST and GraphQL developer Enterprise paths with a version are only supported up to 2.21.
         // We make an exception to always redirect versionless paths to the latest version.
-        newPath = newPath.replace(
+        newPath = (newPath as string).replace(
           '/enterprise-server/',
           `/enterprise-server@${enterpriseServerReleases.latest}/`,
         )
         const res = await get(oldPath)
-        const sameFirstPrefix = oldPath.split('/')[1] === newPath.split('/')[1]
+        const sameFirstPrefix = oldPath.split('/')[1] === (newPath as string).split('/')[1]
         expect(res.statusCode, `${oldPath} did not redirect to ${newPath}`).toBe(
           sameFirstPrefix ? 301 : 302,
         )

src/redirects/tests/redirects.js src/redirects/tests/redirects.tssrc/redirects/tests/redirects.js renamed to src/redirects/tests/redirects.ts

@@ -76,7 +76,7 @@ describe('versioned redirects', () => {
       newPath.includes('/enterprise-server@latest'),
     )
 
-    enterpriseServerPaths.forEach(([oldPath, newPath]) => {
+    enterpriseServerPaths.forEach(([, newPath]) => {
       const transformedPath = `/en${newPath.replace(
         '/enterprise-server@latest',
         `/enterprise-server@${latest}`,

…ests/routing/developer-site-redirects.js …ests/routing/developer-site-redirects.tssrc/redirects/tests/routing/developer-site-redirects.js renamed to src/redirects/tests/routing/developer-site-redirects.ts src/redirects/tests/routing/developer-site-redirects.js renamed to src/redirects/tests/routing/developer-site-redirects.ts

@@ -8,6 +8,12 @@ import {
   oldestSupported,
 } from '@/versions/lib/enterprise-server-releases'
 
+// Test helper type for mocking contexts
+type TestContext = {
+  pages: Record<string, any>
+  redirects: Record<string, string>
+}
+
 const previousEnterpriserServerVersion = supported[1]
 
 describe('getRedirect basics', () => {
@@ -19,7 +25,7 @@ describe('getRedirect basics', () => {
     // part.
     // But some redirects from `developer.json` as old and static.
     const uri = '/enterprise/3.0/foo/bar'
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {
         '/enterprise/3.0/foo/bar': '/something/else',
@@ -29,15 +35,15 @@ describe('getRedirect basics', () => {
   })
 
   test('should return undefined if nothing could be found', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
     expect(getRedirect('/foo/pizza', ctx)).toBeUndefined()
   })
 
   test('should just inject language on version "home pages"', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
@@ -69,7 +75,7 @@ describe('getRedirect basics', () => {
   })
 
   test('should handle some odd exceptions', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
@@ -86,7 +92,7 @@ describe('getRedirect basics', () => {
   })
 
   test('should figure out redirect based on presence of pages in certain cases', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {
         [`/en/enterprise-server@${previousEnterpriserServerVersion}/foo/bar`]: null,
         [`/en/enterprise-server@${previousEnterpriserServerVersion}/admin/github-management`]: null,
@@ -131,7 +137,7 @@ describe('getRedirect basics', () => {
   })
 
   test('should not do anything on some prefixes', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
@@ -159,7 +165,7 @@ describe('getRedirect basics', () => {
   test('should work for some deprecated enterprise-server URLs too', () => {
     // Starting with enterprise-server 3.0, we have made redirects become
     // a *function* rather than a lookup on a massive object.
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
@@ -170,23 +176,23 @@ describe('getRedirect basics', () => {
 
 describe('github-ae@latest', () => {
   test('home page should redirect to enterprise-cloud home page', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
     expect(getRedirect('/github-ae@latest', ctx)).toBe('/en/enterprise-cloud@latest')
     expect(getRedirect('/en/github-ae@latest', ctx)).toBe('/en/enterprise-cloud@latest')
   })
   test('should redirect to home page for admin/release-notes', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {},
       redirects: {},
     }
     expect(getRedirect('/github-ae@latest/admin/release-notes', ctx)).toBe('/en')
     expect(getRedirect('/en/github-ae@latest/admin/release-notes', ctx)).toBe('/en')
   })
   test('a page that does exits, without correction, in enterprise-cloud', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {
         '/en/enterprise-cloud@latest/foo': null,
       },
@@ -196,7 +202,7 @@ describe('github-ae@latest', () => {
     expect(getRedirect('/en/github-ae@latest/foo', ctx)).toBe('/en/enterprise-cloud@latest/foo')
   })
   test("a page that doesn't exist in enterprise-cloud but in FPT", () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {
         '/en/foo': true,
       },
@@ -206,7 +212,7 @@ describe('github-ae@latest', () => {
     expect(getRedirect('/en/github-ae@latest/foo', ctx)).toBe('/en/foo')
   })
   test("a page that doesn't exist in enterprise-cloud or in FPT", () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {
         '/en/foo': true,
       },
@@ -216,7 +222,7 @@ describe('github-ae@latest', () => {
     expect(getRedirect('/en/github-ae@latest/bar', ctx)).toBe('/en')
   })
   test('a URL with legacy redirects, that redirects to enterprise-cloud', () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {
         '/en/foo': true,
         '/en/enterprise-cloud@latest/foo': true,
@@ -229,7 +235,7 @@ describe('github-ae@latest', () => {
     expect(getRedirect('/en/github-ae@latest/food', ctx)).toBe('/en/enterprise-cloud@latest/foo')
   })
   test("a URL with legacy redirects, that can't redirect to enterprise-cloud", () => {
-    const ctx = {
+    const ctx: TestContext = {
       pages: {
         '/en/foo': true,
         // Note the lack of an enterprise-cloud page here

…cts/tests/routing/redirect-exceptions.js …cts/tests/routing/redirect-exceptions.tssrc/redirects/tests/routing/redirect-exceptions.js renamed to src/redirects/tests/routing/redirect-exceptions.ts src/redirects/tests/routing/redirect-exceptions.js renamed to src/redirects/tests/routing/redirect-exceptions.ts

@@ -43,9 +43,9 @@ export const deprecatedReleasesOnDeveloperSite: string[]
 export const firstReleaseNote: string
 export const firstRestoredAdminGuides: string
 
-export declare function findReleaseNumberIndex(releaseNum: number): number
-export declare function getNextReleaseNumber(releaseNum: number): string
-export declare function getPreviousReleaseNumber(releaseNum: number): string
+export declare function findReleaseNumberIndex(releaseNum: string): number
+export declare function getNextReleaseNumber(releaseNum: string): string
+export declare function getPreviousReleaseNumber(releaseNum: string): string
 
 const allExports = {
   dates,