add some article api test debugging (#59072)

Author: rsese

.github/workflows/test.yml

@@ -163,4 +163,7 @@ jobs:
           ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }}
           ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }}
           TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api') && 'src/fixtures/fixtures/translations' || '' }}
+          # Enable debug logging when "Re-run jobs with debug logging" is used in GitHub Actions UI
+          # This will output additional timing and path information to help diagnose timeout issues
+          RUNNER_DEBUG: ${{ runner.debug }}
         run: npm test -- src/${{ matrix.name }}/tests/

src/article-api/tests/github-apps-transformer.ts

@@ -70,11 +70,15 @@ describe('GitHub Apps transformer', () => {
     })
 
     test('endpoints are formatted as bullet lists', async () => {
-      const res = await get(
-        makeURL(
-          '/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens',
-        ),
+      const DEBUG = process.env.RUNNER_DEBUG === '1' || process.env.DEBUG === '1'
+      const url = makeURL(
+        '/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens',
       )
+      const startTime = DEBUG ? Date.now() : 0
+      if (DEBUG) console.log(`[DEBUG] Test sending request to ${url}`)
+      const res = await get(url)
+      if (DEBUG)
+        console.log(`[DEBUG] Test response: ${res.statusCode} in ${Date.now() - startTime}ms`)
       expect(res.statusCode).toBe(200)
 
       // Check for bullet list items with asterisks (per content guidelines)

src/article-api/tests/rest-transformer.ts

@@ -81,7 +81,13 @@ describe('REST transformer', () => {
   })
 
   test('Status codes are formatted correctly', async () => {
-    const res = await get(makeURL('/en/rest/actions/artifacts'))
+    const DEBUG = process.env.RUNNER_DEBUG === '1' || process.env.DEBUG === '1'
+    const url = makeURL('/en/rest/actions/artifacts')
+    const startTime = DEBUG ? Date.now() : 0
+    if (DEBUG) console.log(`[DEBUG] Test sending request to ${url}`)
+    const res = await get(url)
+    if (DEBUG)
+      console.log(`[DEBUG] Test response: ${res.statusCode} in ${Date.now() - startTime}ms`)
     expect(res.statusCode).toBe(200)
 
     // Check for status codes section

src/article-api/transformers/github-apps-transformer.ts

@@ -8,6 +8,7 @@ import { fileURLToPath } from 'url'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
+const DEBUG = process.env.RUNNER_DEBUG === '1' || process.env.DEBUG === '1'
 
 // GitHub Apps data types
 interface GitHubAppsOperation {
@@ -100,6 +101,9 @@ export class GithubAppsTransformer implements PageTransformer {
     context: Context,
     apiVersion?: string,
   ): Promise<string> {
+    const startTime = DEBUG ? Date.now() : 0
+    if (DEBUG) console.log(`[DEBUG] GitHubAppsTransformer: ${pathname}`)
+
     // Import getAppsData dynamically to avoid circular dependencies
     const { getAppsData } = await import('@/github-apps/lib/index')
 
@@ -216,6 +220,10 @@ export class GithubAppsTransformer implements PageTransformer {
       })
     }
 
+    if (DEBUG)
+      console.log(
+        `[DEBUG] GitHubAppsTransformer.transform completed in ${Date.now() - startTime}ms`,
+      )
     return finalContent
   }
 

src/article-api/transformers/rest-transformer.ts

@@ -10,6 +10,7 @@ import { fastTextOnly } from '@/content-render/unified/text-only'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
+const DEBUG = process.env.RUNNER_DEBUG === '1' || process.env.DEBUG === '1'
 
 /**
  * Transformer for REST API pages
@@ -28,6 +29,9 @@ export class RestTransformer implements PageTransformer {
     context: Context,
     apiVersion?: string,
   ): Promise<string> {
+    const startTime = DEBUG ? Date.now() : 0
+    if (DEBUG) console.log(`[DEBUG] RestTransformer: ${pathname}`)
+
     // Import getRest dynamically to avoid circular dependencies
     const { default: getRest } = await import('@/rest/lib/index')
 
@@ -110,6 +114,7 @@ export class RestTransformer implements PageTransformer {
       markdownRequested: true,
     })
 
+    if (DEBUG) console.log(`[DEBUG] RestTransformer completed in ${Date.now() - startTime}ms`)
     return rendered
   }
 

src/github-apps/lib/index.ts

@@ -12,6 +12,7 @@ interface AppsConfig {
 // Note: Using 'any' for AppsData to maintain compatibility with existing consumers that expect different shapes
 type AppsData = any
 
+const DEBUG = process.env.RUNNER_DEBUG === '1' || process.env.DEBUG === '1'
 const ENABLED_APPS_DIR = 'src/github-apps/data'
 const githubAppsData = new Map<string, Map<string, AppsData>>()
 
@@ -29,6 +30,12 @@ export async function getAppsData(
   docsVersion: string,
   apiVersion?: string,
 ): Promise<AppsData> {
+  if (DEBUG) {
+    console.log(
+      `[DEBUG] getAppsData: ROOT=${process.env.ROOT || '(not set)'}, path=${ENABLED_APPS_DIR}`,
+    )
+  }
+
   const pageTypeMap = githubAppsData.get(pageType)!
   const filename = `${pageType}.json`
   const openApiVersion = getOpenApiVersion(docsVersion) + (apiVersion ? `-${apiVersion}` : '')