-
Notifications
You must be signed in to change notification settings - Fork 2.6k
feat: add User-Agent header to API providers #5492
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
2818d40
feat: add User-Agent header to API providers
roomote 77d4505
feat: use dynamic version in User-Agent header
roomote 02a8e6a
Rename User-Agent from 'roo-cline' to 'RooCode'
roomote 8e419fc
test: use dynamic Package.version in User-Agent tests
roomote File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| // npx vitest run src/api/providers/__tests__/constants.spec.ts | ||
|
|
||
| import { describe, it, expect } from "vitest" | ||
| import { DEFAULT_HEADERS } from "../constants" | ||
| import { Package } from "../../../shared/package" | ||
|
|
||
| describe("DEFAULT_HEADERS", () => { | ||
| it("should contain all required headers", () => { | ||
| expect(DEFAULT_HEADERS).toHaveProperty("HTTP-Referer") | ||
| expect(DEFAULT_HEADERS).toHaveProperty("X-Title") | ||
| expect(DEFAULT_HEADERS).toHaveProperty("User-Agent") | ||
| }) | ||
|
|
||
| it("should have correct HTTP-Referer value", () => { | ||
| expect(DEFAULT_HEADERS["HTTP-Referer"]).toBe("https://github.com/RooVetGit/Roo-Cline") | ||
| }) | ||
|
|
||
| it("should have correct X-Title value", () => { | ||
| expect(DEFAULT_HEADERS["X-Title"]).toBe("Roo Code") | ||
| }) | ||
|
|
||
| it("should have correct User-Agent format", () => { | ||
| const userAgent = DEFAULT_HEADERS["User-Agent"] | ||
| expect(userAgent).toBe(`RooCode/${Package.version}`) | ||
|
|
||
| // Verify it follows the tool_name/version pattern | ||
| expect(userAgent).toMatch(/^[a-zA-Z-]+\/\d+\.\d+\.\d+$/) | ||
| }) | ||
|
|
||
| it("should have User-Agent with correct tool name", () => { | ||
| const userAgent = DEFAULT_HEADERS["User-Agent"] | ||
| expect(userAgent.startsWith("RooCode/")).toBe(true) | ||
| }) | ||
|
|
||
| it("should have User-Agent with semantic version format", () => { | ||
| const userAgent = DEFAULT_HEADERS["User-Agent"] | ||
| const version = userAgent.split("/")[1] | ||
|
|
||
| // Check semantic version format (major.minor.patch) | ||
| expect(version).toMatch(/^\d+\.\d+\.\d+$/) | ||
|
|
||
| // Verify current version matches package version | ||
| expect(version).toBe(Package.version) | ||
| }) | ||
|
|
||
| it("should be an object with string values", () => { | ||
| expect(typeof DEFAULT_HEADERS).toBe("object") | ||
| expect(DEFAULT_HEADERS).not.toBeNull() | ||
|
|
||
| Object.values(DEFAULT_HEADERS).forEach((value) => { | ||
| expect(typeof value).toBe("string") | ||
| expect(value.length).toBeGreaterThan(0) | ||
| }) | ||
| }) | ||
|
|
||
| it("should have exactly 3 headers", () => { | ||
| const headerKeys = Object.keys(DEFAULT_HEADERS) | ||
| expect(headerKeys).toHaveLength(3) | ||
| expect(headerKeys).toEqual(["HTTP-Referer", "X-Title", "User-Agent"]) | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,7 @@ | ||
| import { Package } from "../../shared/package" | ||
|
|
||
| export const DEFAULT_HEADERS = { | ||
| "HTTP-Referer": "https://github.com/RooVetGit/Roo-Cline", | ||
| "X-Title": "Roo Code", | ||
| "User-Agent": `RooCode/${Package.version}`, | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Out of scope, but 🤨
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.
Yeah... forever linked to that in OpenRouter