Restore GitHub API user agent

Author: tannerlinsley

src/utils/documents.server.ts

@@ -74,6 +74,8 @@ export function isRecoverableGitHubContentError(
   )
 }
 
+const DEFAULT_GITHUB_API_USER_AGENT = 'TanStack-Docs'
+
 export async function cancelUnusedResponseBody(
   response: Response,
 ): Promise<void> {
@@ -880,9 +882,7 @@ function getGitHubContentFetchOptionsWithToken(
     headers['X-GitHub-Api-Version'] = '2022-11-28'
   }
 
-  if (opts?.userAgent) {
-    headers['User-Agent'] = opts.userAgent
-  }
+  headers['User-Agent'] = opts?.userAgent ?? DEFAULT_GITHUB_API_USER_AGENT
 
   if (token && opts?.includeAuthorization !== false) {
     headers.Authorization = `Bearer ${token}`

tests/github-content-fetch-options.test.ts

@@ -16,6 +16,11 @@ assert.equal(
   'Bearer host-token',
   'GitHub API fetches use the Worker env token when present',
 )
+assert.equal(
+  getHeaderValue(authenticatedOptions, 'User-Agent'),
+  'TanStack-Docs',
+  'GitHub API fetches include the required default User-Agent',
+)
 
 const unauthenticatedOptions = runWithHostRuntimeEnv(
   { GITHUB_AUTH_TOKEN: 'host-token' },
@@ -27,5 +32,13 @@ assert.equal(
   null,
   'GitHub API fetches can still opt out of authorization',
 )
+assert.equal(
+  getHeaderValue(
+    getGitHubContentFetchOptions({ userAgent: 'docs:tanstack/table' }),
+    'User-Agent',
+  ),
+  'docs:tanstack/table',
+  'GitHub API fetches can override the default User-Agent',
+)
 
 console.log('github-content-fetch-options tests passed')