Expose document type for articles in API (#60109)

Author: jennysharps

src/article-api/README.md

@@ -68,7 +68,8 @@ Get article metadata and content in a single object. Equivalent to calling `/art
   "meta": {
     "title": "About GitHub and Git",
     "intro": "You can use GitHub and Git to collaborate on work.",
-    "product": "Get started"
+    "product": "Get started",
+    "documentType": "article"
   },
   "body": "## About GitHub\n\nGitHub is a cloud-based platform where you can store, share, and work together with others to write code.\n\nStoring your code in a \"repository\" on GitHub allows you to:\n\n* **Showcase or share** your work.\n [...]"
 }
@@ -111,7 +112,7 @@ Get metadata about an article.
 **Parameters**:
 - **pathname** (string) - Article path (e.g. '/en/get-started/article-name')
 
-**Returns**: (object) - JSON object containing article metadata with title, intro, and product information.
+**Returns**: (object) - JSON object containing article metadata with title, intro, product, and documentType information.
 
 **Throws**:
 - (Error): 400 - If pathname parameter is invalid.
@@ -124,6 +125,7 @@ Get metadata about an article.
   "title": "About GitHub and Git",
   "intro": "You can use GitHub and Git to collaborate on work.",
   "product": "Get started",
+  "documentType": "article",
   "breadcrumbs": [
     {
       "href": "/en/get-started",

src/article-api/middleware/article-pageinfo.ts

@@ -135,13 +135,14 @@ export async function getMetadata(req: ExtendedRequestWithPageInfo) {
   // So by the time we get here, the pathname should be one of the
   // page's valid permalinks.
   const { page, pathname, archived } = req.pageinfo
+  const documentType = page?.documentType ?? null
 
   if (archived && archived.isArchived) {
     const { requestedVersion } = archived
     const title = `GitHub Enterprise Server ${requestedVersion} Help Documentation`
     const intro = ''
     const product = 'GitHub Enterprise Server'
-    return { meta: { intro, title, product } }
+    return { meta: { intro, title, product, documentType } }
   }
 
   if (!page) {
@@ -156,5 +157,5 @@ export async function getMetadata(req: ExtendedRequestWithPageInfo) {
   const fromCache = await getPageInfoFromCache(page, pathname)
   const { cacheInfo, ...meta } = fromCache
 
-  return { meta, cacheInfo }
+  return { meta: { ...meta, documentType }, cacheInfo }
 }

src/article-api/middleware/article.ts

@@ -39,7 +39,8 @@ const router = express.Router()
  *   "meta": {
  *     "title": "About GitHub and Git",
  *     "intro": "You can use GitHub and Git to collaborate on work.",
- *     "product": "Get started"
+ *     "product": "Get started",
+ *     "documentType": "article"
  *   },
  *   "body": "## About GitHub\n\nGitHub is a cloud-based platform where you can store, share, and work together with others to write code.\n\nStoring your code in a \"repository\" on GitHub allows you to:\n\n* **Showcase or share** your work.\n [...]"
  * }
@@ -112,7 +113,7 @@ router.get(
  * Get metadata about an article.
  * @route GET /api/article/meta
  * @param {string} pathname - Article path (e.g. '/en/get-started/article-name')
- * @returns {object} JSON object containing article metadata with title, intro, and product information.
+ * @returns {object} JSON object containing article metadata with title, intro, product, and documentType information.
  * @throws {Error} 400 - If pathname parameter is invalid.
  * @throws {Error} 404 - If the path is valid, but the page couldn't be resolved.
  * @example
@@ -121,6 +122,7 @@ router.get(
  *   "title": "About GitHub and Git",
  *   "intro": "You can use GitHub and Git to collaborate on work.",
  *   "product": "Get started",
+ *   "documentType": "article",
  *   "breadcrumbs": [
  *     {
  *       "href": "/en/get-started",

src/article-api/tests/pageinfo.ts

@@ -11,6 +11,7 @@ interface PageMetadata {
   product: string
   title: string
   intro: string
+  documentType: string | null
 }
 
 interface ErrorResponse {
@@ -44,6 +45,7 @@ describe('pageinfo api', () => {
     expect(meta.intro).toBe(
       'Get started using HubGit to manage Git repositories and collaborate with others.',
     )
+    expect(meta.documentType).toBe('category')
     // Check that it can be cached at the CDN
     expect(res.headers['set-cookie']).toBeUndefined()
     expect(res.headers['cache-control']).toContain('public')
@@ -170,6 +172,44 @@ describe('pageinfo api', () => {
     }
   })
 
+  test('documentType for different page types', async () => {
+    // Homepage
+    {
+      const res = await get(makeURL('/en'))
+      expect(res.statusCode).toBe(200)
+      const meta = JSON.parse(res.body) as PageMetadata
+      expect(meta.documentType).toBe('homepage')
+    }
+    // Product
+    {
+      const res = await get(makeURL('/en/get-started'))
+      expect(res.statusCode).toBe(200)
+      const meta = JSON.parse(res.body) as PageMetadata
+      expect(meta.documentType).toBe('product')
+    }
+    // Category
+    {
+      const res = await get(makeURL('/en/get-started/start-your-journey'))
+      expect(res.statusCode).toBe(200)
+      const meta = JSON.parse(res.body) as PageMetadata
+      expect(meta.documentType).toBe('category')
+    }
+    // Subcategory
+    {
+      const res = await get(makeURL('/en/actions/category/subcategory'))
+      expect(res.statusCode).toBe(200)
+      const meta = JSON.parse(res.body) as PageMetadata
+      expect(meta.documentType).toBe('subcategory')
+    }
+    // Article
+    {
+      const res = await get(makeURL('/en/get-started/start-your-journey/hello-world'))
+      expect(res.statusCode).toBe(200)
+      const meta = JSON.parse(res.body) as PageMetadata
+      expect(meta.documentType).toBe('article')
+    }
+  })
+
   test('archived enterprise versions', async () => {
     // For example /en/enterprise-server@3.8 is a valid Page in the
     // site tree, but /en/enterprise-server@2.6 is not. Yet we can
@@ -182,6 +222,7 @@ describe('pageinfo api', () => {
       expect(res.statusCode).toBe(200)
       const meta = JSON.parse(res.body) as PageMetadata
       expect(meta.title).toMatch('GitHub Enterprise Server 3.2 Help Documentation')
+      expect(meta.documentType).toBeNull()
     }
 
     // The oldest known archived version that we proxy