Fix GHES version comparison in update-files script (#56175)

Author: heiskr

src/rest/scripts/utils/update-markdown.js

@@ -27,6 +27,26 @@ export async function updateRestFiles() {
 
 // Reads data files from the directory provided and returns a
 // JSON object that lists the versions for each category/subcategory
+/**
+ * Extract GHES version from a file path if it's a GHES directory
+ * @param {string} filePath - File path to parse
+ * @returns {string|null} - GHES version or null if not a GHES file
+ */
+export function getGHESVersionFromFilepath(filePath) {
+  // Normalize path separators to handle both Unix and Windows paths
+  const normalizedPath = filePath.replace(/\\/g, '/')
+  const pathParts = normalizedPath.split('/')
+  const ghesDir = pathParts.find((part) => part.startsWith('ghes-'))
+
+  if (!ghesDir) {
+    return null
+  }
+
+  // Extract version from ghes-X.Y or ghes-X.Y-YYYY-MM-DD format
+  const versionMatch = ghesDir.match(/^ghes-(\d+\.\d+)/)
+  return versionMatch ? versionMatch[1] : null
+}
+
 // The data files are split up by version, so all files must be
 // read to get a complete list of versions.
 async function getDataFrontmatter(dataDirectory, schemaFilename) {
@@ -36,16 +56,15 @@ async function getDataFrontmatter(dataDirectory, schemaFilename) {
     // the most recent deprecated version but still allow data to exist.
     // This makes the deprecation steps easier.
     .filter((file) => {
-      return !deprecated.some((depVersion) =>
-        file.split(path.sep).find((pathSplit) => {
-          if (pathSplit.startsWith('ghes')) {
-            // An example version format is: ghes-3.6 or ghes-3.6-2022-01-01
-            const ghesVersion = pathSplit.split('-')[1]
-            return ghesVersion === depVersion
-          }
-          return false
-        }),
-      )
+      const ghesVersion = getGHESVersionFromFilepath(file)
+
+      // If it's not a GHES file, include it (e.g., ghae, fpt, ghec)
+      if (!ghesVersion) {
+        return true
+      }
+
+      // If it's a GHES file, exclude it only if the version is deprecated
+      return !deprecated.includes(ghesVersion)
     })
 
   const restVersions = {}

src/rest/tests/update-markdown.js

@@ -0,0 +1,59 @@
+import { describe, expect, test } from 'vitest'
+import { getGHESVersionFromFilepath } from '../scripts/utils/update-markdown.js'
+
+describe('GHES version extraction for update-markdown', () => {
+  test('extracts GHES version from file path with date suffix', () => {
+    const filePath = 'src/rest/data/ghes-3.10-2022-11-28/schema.json'
+    expect(getGHESVersionFromFilepath(filePath)).toBe('3.10')
+  })
+
+  test('extracts GHES version from file path without date suffix', () => {
+    const filePath = 'src/rest/data/ghes-3.6/schema.json'
+    expect(getGHESVersionFromFilepath(filePath)).toBe('3.6')
+  })
+
+  test('returns null for non-GHES file paths', () => {
+    expect(getGHESVersionFromFilepath('src/rest/data/ghae/schema.json')).toBeNull()
+    expect(getGHESVersionFromFilepath('src/rest/data/fpt-2022-11-28/schema.json')).toBeNull()
+    expect(getGHESVersionFromFilepath('src/rest/data/ghec-2022-11-28/schema.json')).toBeNull()
+  })
+
+  test('handles various GHES version formats', () => {
+    expect(getGHESVersionFromFilepath('src/rest/data/ghes-2.22/schema.json')).toBe('2.22')
+    expect(getGHESVersionFromFilepath('src/rest/data/ghes-3.0-2022-01-01/schema.json')).toBe('3.0')
+    expect(getGHESVersionFromFilepath('src/rest/data/ghes-3.15-2023-05-15/schema.json')).toBe(
+      '3.15',
+    )
+  })
+
+  test('returns null for malformed GHES paths', () => {
+    expect(getGHESVersionFromFilepath('src/rest/data/ghes-/schema.json')).toBeNull()
+    expect(getGHESVersionFromFilepath('src/rest/data/ghes-abc/schema.json')).toBeNull()
+    expect(getGHESVersionFromFilepath('src/rest/data/ghes/schema.json')).toBeNull()
+  })
+
+  test('works with different path separators and nested paths', () => {
+    const windowsPath = 'src\\rest\\data\\ghes-3.10-2022-11-28\\schema.json'
+    expect(getGHESVersionFromFilepath(windowsPath)).toBe('3.10')
+
+    const nestedPath = 'some/deep/path/src/rest/data/ghes-3.5-2021-12-31/nested/schema.json'
+    expect(getGHESVersionFromFilepath(nestedPath)).toBe('3.5')
+  })
+
+  test('demonstrates the original bug scenario', () => {
+    // This test demonstrates the bug described in the issue
+    // where ghes-3.10 would incorrectly match deprecated version 3.1
+    const filePath = 'src/rest/data/ghes-3.10-2022-11-28/schema.json'
+    const extractedVersion = getGHESVersionFromFilepath(filePath)
+
+    // Mock deprecated versions array like in the actual code
+    const deprecated = ['3.0', '3.1', '3.2', '2.22', '2.21']
+
+    expect(extractedVersion).toBe('3.10')
+    // This should be false - 3.10 is NOT in the deprecated list
+    expect(deprecated.includes(extractedVersion)).toBe(false)
+
+    // The old buggy logic would have incorrectly flagged this as deprecated
+    // because it would find '3.1' as a substring in the path
+  })
+})