-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Adding better tracking of AI agents responsible for API calls #9730
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.
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @joehan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refactors how API calls are attributed by modifying the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request enhances API call tracking by including AI agent information in the User-Agent and X-Client-Version headers. The implementation correctly moves the detectAIAgent function to a shared utility file for broader use. My review includes a couple of suggestions to improve code maintainability and consistency, such as refactoring the agent detection logic and using an existing helper function for environment checks.
src/apiv2.ts
Outdated
| import { detectAIAgent } from "./utils"; | ||
|
|
||
| // Using import would require resolveJsonModule, which seems to break the | ||
| // build/output format. | ||
| const pkg = require("../package.json"); | ||
| const CLI_VERSION: string = pkg.version; | ||
|
|
||
| const agent = detectAIAgent(); | ||
| const agentStr = agent === "unknown" ? "None" : agent; | ||
| const platform = process.env.IS_FIREBASE_MCP ? "FirebaseMCP" : "FirebaseCLI"; | ||
| const clientVersion = `${platform}/${CLI_VERSION}/${agentStr}`; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve maintainability and consistency, consider using the isFirebaseMcp function from src/env.ts to determine the platform. This centralizes the logic for checking the environment, as a helper function for this already exists. This change would involve importing isFirebaseMcp and using it to set the platform constant.
| import { detectAIAgent } from "./utils"; | |
| // Using import would require resolveJsonModule, which seems to break the | |
| // build/output format. | |
| const pkg = require("../package.json"); | |
| const CLI_VERSION: string = pkg.version; | |
| const agent = detectAIAgent(); | |
| const agentStr = agent === "unknown" ? "None" : agent; | |
| const platform = process.env.IS_FIREBASE_MCP ? "FirebaseMCP" : "FirebaseCLI"; | |
| const clientVersion = `${platform}/${CLI_VERSION}/${agentStr}`; | |
| import { detectAIAgent } from "./utils"; | |
| import { isFirebaseMcp } from "./env"; | |
| // Using import would require resolveJsonModule, which seems to break the | |
| // build/output format. | |
| const pkg = require("../package.json"); | |
| const CLI_VERSION: string = pkg.version; | |
| const agent = detectAIAgent(); | |
| const agentStr = agent === "unknown" ? "None" : agent; | |
| const platform = isFirebaseMcp() ? "FirebaseMCP" : "FirebaseCLI"; | |
| const clientVersion = `${platform}/${CLI_VERSION}/${agentStr}`; |
Description
In apiv2.ts, we have some STANDARD_HEADERS that we include on all requests. We use these to attribute API usage to the CLI.
Currently, they look like:
"User-Agent":
FirebaseCLI/${CLI_VERSION},"X-Client-Version":
FirebaseCLI/${CLI_VERSION},After this change, they will look like
"User-Agent":
Firebase${CLI or MCP}$/${CLI_VERSION}/${AgentName or "None"},"X-Client-Version":
Firebase${CLI or MCP}$/${CLI_VERSION}/${AgentName or "None"}