The Open Framework for Building Agents
feat(eve): identify TUI endpoint requests via useragent (#2710)
Colton Padden9d28f89ad2d6
diff --git a/.changeset/bright-tuis-identify.md b/.changeset/bright-tuis-identify.mdnew file mode 100644index 000000000..e38554803--- /dev/null+++ b/.changeset/bright-tuis-identify.md@@ -0,0 +1,5 @@+---+"eve": patch+---++Identify requests from the `eve dev` terminal UI with an `eve-tui/<version>` User-Agent product token while preserving caller-supplied User-Agent values.diff --git a/packages/eve/src/cli/dev/tui/tui.test.ts b/packages/eve/src/cli/dev/tui/tui.test.tsindex ded6898e9..989dda7d1 100644--- a/packages/eve/src/cli/dev/tui/tui.test.ts+++ b/packages/eve/src/cli/dev/tui/tui.test.ts@@ -66,6 +66,7 @@ describe("runDevelopmentTui", () => {await runDevelopmentTui({headers: {authorization: "Basic dGVzdDpzZWNyZXQ=",+ "User-Agent": "caller/1.0","x-tenant": "acme",},target,@@ -81,6 +82,7 @@ describe("runDevelopmentTui", () => {const headers = new Headers(fetchMock.mock.calls[0]?.[1]?.headers);expect(headers.get("authorization")).toBe("Basic dGVzdDpzZWNyZXQ=");+ expect(headers.get("user-agent")).toMatch(/^caller\/1\.0 eve-tui\/.+/);expect(headers.get("x-tenant")).toBe("acme");},);diff --git a/packages/eve/src/cli/dev/tui/tui.ts b/packages/eve/src/cli/dev/tui/tui.tsindex edb056f62..5467f1848 100644--- a/packages/eve/src/cli/dev/tui/tui.ts+++ b/packages/eve/src/cli/dev/tui/tui.ts@@ -1,5 +1,7 @@import { Client } from "#client/index.js";import type { DevBootProgressReporter } from "#internal/dev-boot-progress.js";+import { resolveInstalledPackageInfo } from "#internal/application/package.js";+import { appendUserAgentProduct } from "#internal/user-agent.js";import type { CommandLifecycle } from "#cli/shutdown.js";import {resolveLocalDevelopmentClientOptions,@@ -117,6 +119,14 @@ function prepareDevelopmentTarget(target: DevelopmentTuiTarget): PreparedDevelop: { kind: "remote", target, remote: prepareRemoteTarget(target) };}+function withTuiUserAgent(+ headers: Readonly<Record<string, string>> | undefined,+): Readonly<Record<string, string>> {+ const resolved = new Headers(headers);+ appendUserAgentProduct(resolved, `eve-tui/${resolveInstalledPackageInfo().version}`);+ return Object.fromEntries(resolved.entries());+}+/*** Runs the `eve dev` terminal UI against the given server URL until the* user exits.@@ -139,7 +149,7 @@ export async function runDevelopmentTui(input: RunDevelopmentTuiInput): Promise<} = input;const prepared = prepareDevelopmentTarget(target);const { serverUrl } = target;- const headerOptions = headers === undefined ? {} : { headers };+ const headerOptions = { headers: withTuiUserAgent(headers) };const client = new Client(prepared.kind === "local"diff --git a/packages/eve/src/internal/user-agent.ts b/packages/eve/src/internal/user-agent.tsindex ff2568e9b..dd20c759e 100644--- a/packages/eve/src/internal/user-agent.ts+++ b/packages/eve/src/internal/user-agent.ts@@ -17,15 +17,19 @@ function joinUserAgentProducts(...products: (string | null | undefined)[]): strireturn products.filter(Boolean).join(" ");}-/** Appends the installed package product without discarding an existing User-Agent. */-export function appendPackageUserAgent(headers: Headers): Headers {- const product = buildPackageUserAgent();+/** Appends one product token without discarding an existing User-Agent. */+export function appendUserAgentProduct(headers: Headers, product: string): Headers {const existing = headers.get("user-agent");if (existing?.split(/\s+/).includes(product)) return headers;headers.set("user-agent", joinUserAgentProducts(existing, product));return headers;}+/** Appends the installed package product without discarding an existing User-Agent. */+export function appendPackageUserAgent(headers: Headers): Headers {+ return appendUserAgentProduct(headers, buildPackageUserAgent());+}+/*** Wraps a `fetch` implementation so every request's `user-agent` carries the* installed package product token (appended after existing products). Without