fix: set canonical User-Agent header format

[gjtorikian]

Description

The outgoing User-Agent header is now always workos-node/{VERSION} — the canonical WorkOS Node SDK format used through the 6.x line. The 7.x and 8.x lines accumulated several augmentations that no longer conformed (/fetch HTTP-client annotation, (node/v22.0.0) runtime info, appName: appVer from appInfo).

Behavior changes

• Runtime detection is no longer appended to the header.
• appInfo option still parses for backwards compatibility, but the value no longer affects the User-Agent header.
• Removed the now-unused HTTP client name plumbing flagged by Greptile.
• Clarified User-Agent test names to reflect the canonical format.

Callers relying on these tokens being present in User-Agent will need to set a separate header via the request-options headers mechanism.

Test plan

• npm run lint
• npm run typecheck
• npm test -- src/workos.spec.ts
• npm test -- src/workos.spec.ts src/common/net/fetch-client.spec.ts
• npx jest (683 passed, 0 failed)
• Confirm User-Agent: workos-node/{VERSION} on a real outgoing request

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

No WorkOS Docs changes are required for this cleanup.

Link to Devin session: https://app.devin.ai/sessions/7fb05fc5793448acbeb705fc97e36592
Requested by: @gjtorikian

[coderabbitai]

📝 Walkthrough

Walkthrough

User-Agent header generation is simplified across the SDK. The implementation no longer appends runtime version information or app info details, reducing the User-Agent to a basic workos-node/<version> format. Corresponding test expectations are updated to match the simplified format.

Changes

Cohort / File(s)	Summary
Core User-Agent Generation src/workos.ts, src/common/net/http-client.ts	User-Agent generation logic simplified to return only workos-node/<version> without runtime/fetch information or appInfo fields. getRuntimeInfo import removed and addClientToUserAgent now returns input unchanged.
Test Assertions src/sso/sso.spec.ts, src/workos.spec.ts	User-Agent header regex expectations relaxed to match only workos-node/<version> pattern instead of additionally requiring the "/fetch (node/v...)" segment.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: standardizing the User-Agent header format to a canonical format.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description check	✅ Passed	The PR description comprehensively covers all required sections with clear behavior changes, test results, and documentation considerations addressed.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/user-agent-format

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[greptile-apps]

Greptile Summary

This PR simplifies the User-Agent header to the canonical workos-node/{VERSION} format by removing the /fetch HTTP-client annotation, Node.js runtime info, and appInfo augmentation that accumulated in the 7.x/8.x lines.

• Dead-code removal: getClientName() is deleted from the interface, base class, and FetchHttpClient; addClientToUserAgent() and getRuntimeInfo import are also removed.
• appInfo silently no-ops: The option is still accepted and parsed for backwards compatibility, but no longer affects the User-Agent header; both previous comments from the last review cycle have been addressed.

Confidence Score: 5/5

Safe to merge — the change is a straightforward simplification of User-Agent construction with no functional side-effects on request routing or auth.

The change removes dead code and simplifies header construction to a static string. All existing tests were updated and pass. No request logic, auth flows, or error handling paths were touched.

No files require special attention.

Important Files Changed

Filename	Overview
src/workos.ts	Simplified createUserAgent to return just workos-node/{VERSION}; removed getRuntimeInfo import and appInfo augmentation. The _options parameter is kept for interface stability but is now intentionally unused.
src/common/net/fetch-client.ts	Removed getClientName() override and the addClientToUserAgent() call; User-Agent is now set directly from the passed-in value with a bare workos-node fallback.
src/common/net/http-client.ts	Removed the getClientName() stub and addClientToUserAgent() helper; base class is now leaner with no dead plumbing.
src/common/interfaces/http-client.interface.ts	Removed getClientName from the interface contract, consistent with its removal from implementations.
src/workos.spec.ts	Updated User-Agent regex expectations and test descriptions to match the new canonical format; previously flagged stale description has been corrected.
src/sso/sso.spec.ts	Two User-Agent regex assertions updated to the simplified canonical pattern.

Sequence Diagram

sequenceDiagram
    participant Caller
    participant WorkOS
    participant FetchHttpClient

    Caller->>WorkOS: new WorkOS(key, options)
    WorkOS->>WorkOS: "createUserAgent(options) → workos-node/{VERSION}"
    WorkOS->>FetchHttpClient: createHttpClient(options, userAgent)

    Caller->>WorkOS: post("/path", body)
    WorkOS->>FetchHttpClient: post(path, entity, options)
    FetchHttpClient->>FetchHttpClient: "User-Agent = userAgent || workos-node"
    FetchHttpClient-->>Caller: HTTP response

Loading

_{Reviews (3): Last reviewed commit: "Clarify app info user-agent test" | Re-trigger Greptile}