Redirect github-ae to enterprise-cloud or fpt or home page (#43460)

Author: Peter Bengtsson

package.json

@@ -30,7 +30,7 @@
     "fixture-dev": "cross-env ROOT=src/fixtures/fixtures npm start",
     "fixture-test": "cross-env ROOT=src/fixtures/fixtures npm test -- src/fixtures/tests",
     "index-elasticsearch": "node src/search/scripts/index-elasticsearch.js",
-    "index-test-fixtures": "npm run index-elasticsearch -- -l en -l ja -V ghae -V dotcom --index-prefix tests -- src/search/tests/fixtures/search-indexes",
+    "index-test-fixtures": "npm run index-elasticsearch -- -l en -l ja -V ghec -V dotcom --index-prefix tests -- src/search/tests/fixtures/search-indexes",
     "lint": "eslint '**/*.{js,mjs,ts,tsx}'",
     "lint-content": "node src/content-linter/scripts/lint-content.js",
     "lint-translation": "cross-env NODE_OPTIONS=--experimental-vm-modules jest src/content-linter/tests/lint-files.js",

src/audit-logs/tests/rendering.js

@@ -1,7 +1,7 @@
 import { expect } from '@jest/globals'
 
 import { getDOM } from '#src/tests/helpers/e2etest.js'
-import { allVersions } from '#src/versions/lib/all-versions.js'
+import { allTestableVersions } from '#src/versions/lib/all-versions.js'
 import { getAuditLogEvents } from '../lib/index.js'
 
 describe('audit log events docs', () => {
@@ -26,7 +26,7 @@ describe('audit log events docs', () => {
   test.each(auditLogEventPages)(
     'loads audit log event data for all versions on page %o',
     async (page) => {
-      for (const version in allVersions) {
+      for (const version of allTestableVersions) {
         const auditLogEvents = getAuditLogEvents(page.type, version, true)
 
         if (Object.keys(auditLogEvents).length === 0) {

src/languages/tests/frame.js

@@ -86,19 +86,27 @@ describe('release notes', () => {
   // Return an array of tuples for each language and each first version
   // per plan. E.g. ...
   //   [
+  //      ['ja', 'enterprise-server@3.9'],
+  //      ['pt', 'enterprise-server@3.9'],
+  //      ...
   //      ['ja', 'enterprise-server@3.8'],
   //      ['pt', 'enterprise-server@3.8'],
   //      ...
-  //      ['ja', 'github-ae@latest'],
-  //      ['pt', 'github-ae@latest'],
-  //      ...
   //
   // This is useful because if we test every single individual version of
   // every plan the test just takes way too long.
   const getReleaseNotesVersionCombinations = (langs) => {
     const combinations = []
     const prefixes = []
     for (const version of page.applicableVersions) {
+      // Like a chicken-and-egg problem, we can't entirely remove
+      // github-ae from the list of versions because first we
+      // have to stop depending on it and clean up all front matter
+      // and all Liquid. But we also shouldn't depend on testing it
+      // any more since it always redirects to enterprise-cloud.
+      if (version === 'github-ae@latest') {
+        continue
+      }
       const prefix = version.split('@')[0]
       if (prefixes.includes(prefix)) {
         continue

src/redirects/lib/get-redirect.js

@@ -7,7 +7,7 @@ import {
   supported,
   deprecatedWithFunctionalRedirects,
 } from '#src/versions/lib/enterprise-server-releases.js'
-import { getPathWithLanguage } from '#src/frame/lib/path-utils.js'
+import { getPathWithLanguage, getVersionStringFromPath } from '#src/frame/lib/path-utils.js'
 
 const languagePrefixRegex = new RegExp(`^/(${languageKeys.join('|')})/`)
 const nonEnterpriseDefaultVersionPrefix = `/${nonEnterpriseDefaultVersion}`
@@ -30,6 +30,19 @@ export default function getRedirect(uri, context) {
 
   const [language, withoutLanguage] = splitPathByLanguage(uri, userLanguage)
 
+  if (withoutLanguage.startsWith('/github-ae@latest')) {
+    // It has a different business logic that the rest because it's a
+    // version that now will always redirect. Just a question of where to
+    // exactly.
+    const nonAERedirect = githubAERedirect(uri, context)
+    if (nonAERedirect.includes('/github-ae@latest')) {
+      // If this happened some redirect in there didn't completely
+      // get away from github-ae.
+      throw new Error('Still going to github-ae@latest URL')
+    }
+    return nonAERedirect
+  }
+
   let destination
 
   // `redirects` is sourced from more than one thing. The primary use
@@ -182,6 +195,88 @@ export default function getRedirect(uri, context) {
   }
 }
 
+function githubAERedirect(uri, context) {
+  const { redirects, userLanguage, pages } = context
+
+  const [language, withoutLanguage] = splitPathByLanguage(uri, userLanguage)
+
+  // From now on, github-ae@latest redirects to enterprise-cloud or
+  // fpt or the home page.
+  const cloudEquivalent = uri.replace('/github-ae@latest', '/enterprise-cloud@latest')
+  const fptEquivalent = uri.replace('/github-ae@latest', '')
+  const withoutVersion = withoutLanguage.replace('/github-ae@latest', '')
+  if (!withoutVersion) {
+    // That means the version home page.
+    // Don't even need to check if that exists.
+    // But if it was without language, inject the language as
+    // we go to the enterprise-cloud equivalent
+    if (uri.startsWith('/github-ae@latest')) {
+      return `/${language}${cloudEquivalent}`
+    }
+    return cloudEquivalent
+  }
+
+  // What if the only missing thing is a language prefix, then
+  // it's easy too.
+  if (uri.startsWith('/github-ae@latest')) {
+    const languageCloudEquivalent = `/${language}${cloudEquivalent}`
+    if (languageCloudEquivalent in pages) {
+      return languageCloudEquivalent
+    }
+
+    const languageFptEquivalent = `/${language}${fptEquivalent}`
+    if (languageFptEquivalent in pages) {
+      return languageFptEquivalent
+    }
+  } else {
+    // If you're here it means the URL did start with a language.
+    if (cloudEquivalent in pages) {
+      return cloudEquivalent
+    }
+    if (fptEquivalent in pages) {
+      return fptEquivalent
+    }
+  }
+
+  // There are redirect exceptions the specifically spell out github-ae
+  // in the redirect.
+  const legacyRedirect = redirects[withoutLanguage]
+  if (legacyRedirect && !legacyRedirect.includes('/github-ae@latest')) {
+    if (legacyRedirect.includes('://')) {
+      return legacyRedirect
+    }
+    return `/${language}${legacyRedirect}`
+  }
+
+  // The `redirects` are "pure" and don't specific a specific version.
+  // For example `/articles/stuff` to `/get-started/new/name`
+  // We look for those and try enterprise-cloud in it.
+  if (redirects[withoutVersion]) {
+    const cloudCandidate = `/${language}/enterprise-cloud@latest${redirects[withoutVersion]}`
+    if (cloudCandidate in pages) {
+      return cloudCandidate
+    }
+
+    const fptCandidate = `/${language}${redirects[withoutVersion]}`
+    // The lookup of redirects might yield a versioned URL, whose version
+    // might be github-ae or enterprise-server. Skip those.
+    if (fptCandidate in pages) {
+      const versionFromCandidate = getVersionStringFromPath(fptCandidate)
+      if (
+        !(
+          versionFromCandidate.startsWith('enterprise-server@') ||
+          versionFromCandidate === 'github-ae@latest'
+        )
+      ) {
+        return fptCandidate
+      }
+    }
+  }
+
+  // Note that this includes completely unknown pages
+  return `/${language}`
+}
+
 // Over time, we've developed multiple ambiguous patterns of URLs
 // You can't simply assume that all `/admin/guides` should become
 // `/admin` for example.

src/redirects/lib/static/redirect-exceptions.txt

@@ -36,7 +36,16 @@
 - /enterprise-server@3.6/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository
 
 /github-ae@latest/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning
-- /github-ae@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository
+- /enterprise-cloud@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository
 
 /billing/managing-your-github-billing-settings/redeeming-a-coupon
 - /enterprise-cloud@latest/billing/managing-your-github-billing-settings/redeeming-a-coupon
+
+# Pages that existed *only* in github-ae need their equivalent
+/enterprise-cloud@latest/get-started/onboarding/getting-started-with-github-enterprise-cloud
+- /github-ae@latest/get-started/onboarding/getting-started-with-github-ae
+/enterprise-cloud@latest/admin/overview
+- /github-ae@latest/admin/overview/about-github-ae
+- /github-ae@latest/admin/overview/about-data-residency
+- /github-ae@latest/admin/overview/deploying-github-ae
+- /github-ae@latest/admin/overview/initializing-github-ae

src/redirects/tests/ghae.js

@@ -0,0 +1,40 @@
+/**
+ * We entirely removed GHAE but we have to support legacy links.
+ * We have some unit tests for this that tests the `getRedirect()` function.
+ * These tests here are more end-to-end tests that spans middleware
+ * (which internally uses `getRedirect()`).
+ *
+ * These tests are important to have because we intend (not done at the
+ * time of authoring this test suite) entirely remove ghae from
+ * the `allVersions` config object. When we do, we want to be certain that
+ * legacy redirects still work.
+ */
+
+import { head } from '#src/tests/helpers/e2etest.js'
+
+describe('ghae redirects', () => {
+  test('ghae home page', async () => {
+    const res = await head('/en/github-ae@latest')
+    expect(res.statusCode).toBe(301)
+    expect(res.headers.location).toMatch('/en/enterprise-cloud@latest')
+  })
+
+  test('ghae docset landing page', async () => {
+    const res = await head('/en/github-ae@latest/get-started')
+    expect(res.statusCode).toBe(301)
+    expect(res.headers.location).toMatch('/en/enterprise-cloud@latest/get-started')
+  })
+
+  test('search page', async () => {
+    const res = await head('/en/github-ae@latest/search?query=git')
+    expect(res.statusCode).toBe(301)
+    expect(res.headers.location).toMatch('/en/enterprise-cloud@latest/search?query=git')
+  })
+
+  test('ghae release notes', async () => {
+    const res = await head('/en/github-ae@latest/admin/release-notes')
+    expect(res.statusCode).toBe(301)
+    // There is not an "equivalent" release notes page for enterprise-cloud
+    expect(res.headers.location).toMatch('/en')
+  })
+})

src/redirects/tests/unit/get-redirect.js

@@ -35,8 +35,6 @@ describe('getRedirect basics', () => {
       pages: {},
       redirects: {},
     }
-    expect(getRedirect('/github-ae@latest', ctx)).toBe('/en/github-ae@latest')
-
     expect(getRedirect('/enterprise-cloud@latest', ctx)).toBe('/en/enterprise-cloud@latest')
 
     expect(getRedirect('/enterprise-server@3.8', ctx)).toBe('/en/enterprise-server@3.8')
@@ -161,3 +159,86 @@ describe('getRedirect basics', () => {
     expect(getRedirect('/enterprise/3.0/foo', ctx)).toBe('/en/enterprise-server@3.0/foo')
   })
 })
+
+describe('github-ae@latest', () => {
+  it('home page should redirect to enterprise-cloud home page', () => {
+    const ctx = {
+      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')
+  })
+  it('should redirect to home page for admin/release-notes', () => {
+    const ctx = {
+      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')
+  })
+  it('a page that does exits, without correction, in enterprise-cloud', () => {
+    const ctx = {
+      pages: {
+        '/en/enterprise-cloud@latest/foo': null,
+      },
+      redirects: {},
+    }
+    expect(getRedirect('/github-ae@latest/foo', ctx)).toBe('/en/enterprise-cloud@latest/foo')
+    expect(getRedirect('/en/github-ae@latest/foo', ctx)).toBe('/en/enterprise-cloud@latest/foo')
+  })
+  it("a page that doesn't exist in enterprise-cloud but in FPT", () => {
+    const ctx = {
+      pages: {
+        '/en/foo': true,
+      },
+      redirects: {},
+    }
+    expect(getRedirect('/github-ae@latest/foo', ctx)).toBe('/en/foo')
+    expect(getRedirect('/en/github-ae@latest/foo', ctx)).toBe('/en/foo')
+  })
+  it("a page that doesn't exist in enterprise-cloud or in FPT", () => {
+    const ctx = {
+      pages: {
+        '/en/foo': true,
+      },
+      redirects: {},
+    }
+    expect(getRedirect('/github-ae@latest/bar', ctx)).toBe('/en')
+    expect(getRedirect('/en/github-ae@latest/bar', ctx)).toBe('/en')
+  })
+  it('a URL with legacy redirects, that redirects to enterprise-cloud', () => {
+    const ctx = {
+      pages: {
+        '/en/foo': true,
+        '/en/enterprise-cloud@latest/foo': true,
+      },
+      redirects: {
+        '/food': '/foo',
+      },
+    }
+    expect(getRedirect('/github-ae@latest/food', ctx)).toBe('/en/enterprise-cloud@latest/foo')
+    expect(getRedirect('/en/github-ae@latest/food', ctx)).toBe('/en/enterprise-cloud@latest/foo')
+  })
+  it("a URL with legacy redirects, that can't redirect to enterprise-cloud", () => {
+    const ctx = {
+      pages: {
+        '/en/foo': true,
+        // Note the lack of an enterprise-cloud page here
+      },
+      redirects: {
+        '/food': '/foo',
+      },
+    }
+    expect(getRedirect('/github-ae@latest/food', ctx)).toBe('/en/foo')
+    expect(getRedirect('/en/github-ae@latest/food', ctx)).toBe('/en/foo')
+  })
+  it('should 404 if nothing matches at all', () => {
+    const ctx = {
+      pages: {},
+      redirects: {},
+    }
+    expect(getRedirect('/github-ae@latest/never/heard/of', ctx)).toBe('/en')
+    expect(getRedirect('/en/github-ae@latest/never/heard/of', ctx)).toBe('/en')
+  })
+})

src/release-notes/tests/release-notes-1.js

@@ -46,51 +46,22 @@ describe('release notes', () => {
     ).toBe(true)
   })
 
-  it('renders the release-notes layout for GitHub AE', async () => {
-    const res = await get('/en/github-ae@latest/admin/release-notes')
-    expect(res.statusCode).toBe(200)
-    const $ = await getDOM('/en/github-ae@latest/admin/release-notes')
-    expect($('h1').first().text()).toBe('GitHub AE release notes')
-    const sectionTitleRegex = /GitHub AE \d\d?\.\d\d?/ // E.g., GitHub AE 3.3
-
-    const releaseNotesH2 = $('h2').first().text().trim()
-    const sectionTitleMatch = sectionTitleRegex.test(releaseNotesH2)
-
-    expect(sectionTitleMatch).toBe(true)
-  })
-
   it('404 if a bogus version is requested', async () => {
     const res = await get('/en/enterprise-server@12345/admin/release-notes')
     expect(res.statusCode).toBe(404)
   })
 
   it('404 if a the pathname only ends with the /release-notes', async () => {
-    // enterprise-server
-    {
-      const res = await get(`/en/enterprise-server@latest/ANY/release-notes`, {
-        followAllRedirects: true,
-      })
-      expect(res.statusCode).toBe(404)
-    }
-    // github-ae
-    {
-      const res = await get('/en/github-ae@latest/ANY/release-notes')
-      expect(res.statusCode).toBe(404)
-    }
+    const res = await get(`/en/enterprise-server@latest/ANY/release-notes`, {
+      followAllRedirects: true,
+    })
+    expect(res.statusCode).toBe(404)
   })
 
   it('404 if a the pathname only ends with the /admin', async () => {
-    // enterprise-server
-    {
-      const res = await get(`/en/enterprise-server@latest/ANY/admin`, {
-        followAllRedirects: true,
-      })
-      expect(res.statusCode).toBe(404)
-    }
-    // github-ae
-    {
-      const res = await get('/en/github-ae@latest/ANY/admin')
-      expect(res.statusCode).toBe(404)
-    }
+    const res = await get(`/en/enterprise-server@latest/ANY/admin`, {
+      followAllRedirects: true,
+    })
+    expect(res.statusCode).toBe(404)
   })
 })