Skip to content

Repo sync #39845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2025
Merged

Repo sync #39845

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 46 additions & 4 deletions src/search/lib/helpers/external-search-analytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import { publish } from '@/events/lib/hydro'
import { hydroNames } from '@/events/lib/schema'
import { createLogger } from '@/observability/logger'

const logger = createLogger(import.meta.url)

/**
* Handles search analytics and client_name validation for external requests
Expand Down Expand Up @@ -40,20 +43,29 @@ export async function handleExternalSearchAnalytics(
else if (normalizedHost.endsWith('.github.net') || normalizedHost.endsWith('.githubapp.com')) {
return null
}
// For localhost development without client_name, we'll still send analytics below
}

// For localhost, ensure we have a client_name for analytics
if (normalizedHost === 'localhost' && !client_name) {
client_name = 'localhost'
}

// Log when we detect an external request that we will send analytics for
if (client_name && client_name !== 'docs.github.com-client') {
logger.info('External search analytics: Sending analytics for external client', {
client_name,
searchContext,
isLikelyExternalAPI,
normalizedHost,
userAgent: sanitizeUserAgent(req.headers['user-agent']),
})
}

// Send search event with client identifier
try {
await publish({
const analyticsPayload = {
schema: hydroNames.search,
value: {
type: 'search',
version: '1.0.0',
context: {
event_id: crypto.randomUUID(),
Expand All @@ -73,7 +85,9 @@ export async function handleExternalSearchAnalytics(
search_context: searchContext,
search_client: client_name as string,
},
})
}

await publish(analyticsPayload)
} catch (error) {
// Don't fail the request if analytics fails
console.error('Failed to send search analytics:', error)
Expand All @@ -82,6 +96,34 @@ export async function handleExternalSearchAnalytics(
return null
}

/**
* Sanitizes user agent by extracting only the main client type
* Returns a safe string with just the primary client identifier
*/
function sanitizeUserAgent(userAgent: string | undefined): string {
if (!userAgent) return 'unknown'

// Extract common client types while removing version numbers and detailed info
const patterns = [
{ regex: /^curl/i, name: 'curl' },
{ regex: /^wget/i, name: 'wget' },
{ regex: /python-requests/i, name: 'python-requests' },
{ regex: /axios/i, name: 'axios' },
{ regex: /node-fetch/i, name: 'node-fetch' },
{ regex: /Go-http-client/i, name: 'go-http-client' },
{ regex: /okhttp/i, name: 'okhttp' },
{ regex: /Mozilla/i, name: 'browser' },
]

for (const pattern of patterns) {
if (pattern.regex.test(userAgent)) {
return pattern.name
}
}

return 'other'
}

/**
* Determines if a host should bypass client_name requirement for analytics
* Returns true if the host ends with github.net or githubapp.com
Expand Down
Loading