updates for clarity

Author: sarahs

lib/path-utils.js

@@ -1,7 +1,7 @@
 const slash = require('slash')
 const path = require('path')
 const patterns = require('./patterns')
-const { deprecated } = require('./enterprise-server-releases')
+const { deprecated, latest } = require('./enterprise-server-releases')
 const allProducts = require('./all-products')
 const allVersions = require('./all-versions')
 const supportedVersions = new Set(Object.keys(allVersions))
@@ -23,7 +23,7 @@ function getVersionedPathWithoutLanguage (href, version) {
   // example: enterprise-server@2.22 or free-pro-team@latest
   let versionFromPath = getVersionStringFromPath(href)
 
-  // update the path with the full version so we can go through the rest of the checks
+  // if a real version was found, add it to the path so we can go through the rest of the checks
   if (supportedVersions.has(versionFromPath)) {
     href = href.replace(href.split('/')[1], versionFromPath)
   }
@@ -36,6 +36,7 @@ function getVersionedPathWithoutLanguage (href, version) {
     productObjectFromPath = allProducts[versionFromPath]
 
     // if so, add the first supported version for that product to the href
+    // (this is just to get a path with all the expected segments; the version will be updated later if needed)
     if (productObjectFromPath) {
       href = path.join('/', productObjectFromPath.versions[0], href)
       versionFromPath = productObjectFromPath.versions[0]
@@ -89,25 +90,32 @@ function getPathWithoutVersion (href) {
 function getVersionStringFromPath (href) {
   href = getPathWithoutLanguage(href)
 
+  // return immediately if this is a link to the homepage
+  if (href === '/') {
+    return 'homepage'
+  }
+
+  // check if the first segment is a supported version
   const versionFromPath = href.split('/')[1]
 
-  if (allVersions[versionFromPath]) {
+  if (supportedVersions.has(versionFromPath)) {
     return versionFromPath
   }
 
   // if the version segment is the latest enterprise-server release, return the latest release
   if (versionFromPath === 'enterprise-server@latest') {
-    const enterpriseServerObject = Object.values(allVersions).find(v => v.plan === 'enterprise-server')
-    return allVersions[enterpriseServerObject.latestVersion].version
+    return `enterprise-server@${latest}`
   }
 
-  // if it's just a plan with no @release, find the plan's latest release
+  // if it's just a plan with no @release (e.g., `enterprise-server`), return the latest release
   const planObject = Object.values(allVersions).find(v => v.plan === versionFromPath)
   if (planObject) {
     return allVersions[planObject.latestVersion].version
   }
 
-  return versionFromPath || 'homepage'
+  // otherwise, return the first segment as-is, which may not be a proper version
+  // but additional checks are done on this segment in getVersionedPathWithoutLanguage
+  return versionFromPath
 }
 
 // Return the corresponding object for the version segment in a path

tests/helpers/links-checker.js

@@ -145,8 +145,10 @@ class LinksChecker {
         if (gheVersionInLink && deprecated.includes(gheVersionInLink[1])) continue
         // ------ END ONEOFF EXCLUSIONS -------///
 
-        // look for linked page
+        // the link at this point should include a version via lib/rewrite-local-links
         const versionFromHref = getVersionStringFromPath(link)
+
+        // look for linked page
         const linkedPage = findPageInVersion(link, context.pages, context.redirects, this.languageCode, versionFromHref)
         this.checkedLinksCache.add(link)