From 9b0f3b2435dd6372fee2279c96a433c011ba8daa Mon Sep 17 00:00:00 2001 From: Roomote Bot Date: Tue, 8 Jul 2025 20:19:56 -0700 Subject: [PATCH] feat: add User-Agent header to API providers (#5492) --- src/api/providers/__tests__/constants.spec.ts | 61 +++++++++++++++++++ src/api/providers/__tests__/openai.spec.ts | 2 + .../providers/__tests__/openrouter.spec.ts | 2 + src/api/providers/__tests__/requesty.spec.ts | 2 + src/api/providers/constants.ts | 3 + 5 files changed, 70 insertions(+) create mode 100644 src/api/providers/__tests__/constants.spec.ts diff --git a/src/api/providers/__tests__/constants.spec.ts b/src/api/providers/__tests__/constants.spec.ts new file mode 100644 index 0000000000..8a04416d72 --- /dev/null +++ b/src/api/providers/__tests__/constants.spec.ts @@ -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"]) + }) +}) diff --git a/src/api/providers/__tests__/openai.spec.ts b/src/api/providers/__tests__/openai.spec.ts index 86d57ab3f5..b4b5f29204 100644 --- a/src/api/providers/__tests__/openai.spec.ts +++ b/src/api/providers/__tests__/openai.spec.ts @@ -5,6 +5,7 @@ import { ApiHandlerOptions } from "../../../shared/api" import { Anthropic } from "@anthropic-ai/sdk" import OpenAI from "openai" import { openAiModelInfoSaneDefaults } from "@roo-code/types" +import { Package } from "../../../shared/package" const mockCreate = vitest.fn() @@ -104,6 +105,7 @@ describe("OpenAiHandler", () => { defaultHeaders: { "HTTP-Referer": "https://github.com/RooVetGit/Roo-Cline", "X-Title": "Roo Code", + "User-Agent": `RooCode/${Package.version}`, }, }) }) diff --git a/src/api/providers/__tests__/openrouter.spec.ts b/src/api/providers/__tests__/openrouter.spec.ts index 5c0e52c2c2..ea850c47be 100644 --- a/src/api/providers/__tests__/openrouter.spec.ts +++ b/src/api/providers/__tests__/openrouter.spec.ts @@ -8,6 +8,7 @@ import OpenAI from "openai" import { OpenRouterHandler } from "../openrouter" import { ApiHandlerOptions } from "../../../shared/api" +import { Package } from "../../../shared/package" // Mock dependencies vitest.mock("openai") @@ -62,6 +63,7 @@ describe("OpenRouterHandler", () => { defaultHeaders: { "HTTP-Referer": "https://github.com/RooVetGit/Roo-Cline", "X-Title": "Roo Code", + "User-Agent": `RooCode/${Package.version}`, }, }) }) diff --git a/src/api/providers/__tests__/requesty.spec.ts b/src/api/providers/__tests__/requesty.spec.ts index 7f7fc2d527..55fb976fd1 100644 --- a/src/api/providers/__tests__/requesty.spec.ts +++ b/src/api/providers/__tests__/requesty.spec.ts @@ -5,6 +5,7 @@ import OpenAI from "openai" import { RequestyHandler } from "../requesty" import { ApiHandlerOptions } from "../../../shared/api" +import { Package } from "../../../shared/package" const mockCreate = vitest.fn() @@ -59,6 +60,7 @@ describe("RequestyHandler", () => { defaultHeaders: { "HTTP-Referer": "https://github.com/RooVetGit/Roo-Cline", "X-Title": "Roo Code", + "User-Agent": `RooCode/${Package.version}`, }, }) }) diff --git a/src/api/providers/constants.ts b/src/api/providers/constants.ts index e7c4398324..144ff72349 100644 --- a/src/api/providers/constants.ts +++ b/src/api/providers/constants.ts @@ -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}`, }