feat(electron): allow custom user agent for session activity by jeremy-clerk · Pull Request #9066 · clerk/javascript

jeremy-clerk · 2026-07-01T19:11:44Z

Summary

Adds a userAgent option to createClerkBridge() for Electron apps that want to control how the app appears in UserProfile session activity.

The option sets Electron's app.userAgentFallback, and the README now shows the setup alongside the existing bridge configuration.

Summary by CodeRabbit

New Features
- Electron apps can now pass a custom userAgent when creating the Clerk bridge to improve UserProfile session activity attribution.
Bug Fixes
- User-agent fallback now preserves platform-related information when available.
- If platform details can’t be derived (including malformed fallbacks), the configured userAgent is used.
Documentation
- Updated the Electron “Getting Started” guide with the new userAgent configuration example.

changeset-bot · 2026-07-01T19:11:48Z

🦋 Changeset detected

Latest commit: 679d52f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@clerk/electron	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2026-07-01T19:11:52Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clerk-js-sandbox	Ready	Preview, Comment	Jul 1, 2026 8:23pm
swingset	Ready	Preview, Comment	Jul 1, 2026 8:23pm

coderabbitai · 2026-07-01T19:12:02Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 6b0dde49-1f01-4997-a0eb-0d099488eb4e

📥 Commits

Reviewing files that changed from the base of the PR and between c68c2b4 and 679d52f.

📒 Files selected for processing (2)

packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
packages/electron/src/main/create-clerk-bridge.ts

🚧 Files skipped from review as they are similar to previous changes (2)

packages/electron/src/main/tests/create-clerk-bridge.test.ts
packages/electron/src/main/create-clerk-bridge.ts

📝 Walkthrough

Walkthrough

Adds an optional userAgent option to CreateClerkBridgeOptions and updates createClerkBridge to derive app.userAgentFallback from it while preserving platform details when available. Tests, README guidance, and a changeset were added.

Changes

Electron userAgent Option

Layer / File(s)	Summary
Type declaration for userAgent option `packages/electron/src/shared/types.ts`	Adds optional `userAgent?: string` to `CreateClerkBridgeOptions` with documentation.
Bridge fallback construction `packages/electron/src/main/create-clerk-bridge.ts`	Imports `app`, adds `buildUserAgentFallback`, and conditionally sets `app.userAgentFallback` from `options.userAgent`.
Tests for userAgent behavior `packages/electron/src/main/__tests__/create-clerk-bridge.test.ts`	Adds a default `app.userAgentFallback`, resets it per test, and verifies the new fallback-building behavior.
Docs and changeset `packages/electron/README.md`, `.changeset/electron-user-agent.md`	Adds a README example showing `userAgent` usage and a changeset for the new patch release.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: wobsoriano

Poem

A bunny twitched its whiskers bright,
and set a fallback just right 🐰
With user-agent in the breeze,
platform crumbs stay where they please,
and session tags hop true tonight.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding custom user agent support for Electron session activity.
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.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

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

pkg-pr-new · 2026-07-01T19:14:26Z

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9066

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9066

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9066

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9066

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9066

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9066

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9066

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9066

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9066

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9066

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9066

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9066

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9066

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9066

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9066

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9066

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9066

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9066

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9066

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9066

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9066

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9066

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9066

commit: 679d52f

wobsoriano · 2026-07-01T19:15:54Z

  const passkeys = options.passkeys ? setupPasskeysMain() : null;

+  if (options.userAgent) {
+    app.userAgentFallback = options.userAgent;


TIL https://www.electronjs.org/docs/latest/api/app#appuseragentfallback

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/electron/src/main/__tests__/create-clerk-bridge.test.ts`:
- Around line 13-14: Add a test assertion for the plain createClerkBridge({
storage }) path to verify app.userAgentFallback remains unchanged when no
userAgent is provided. Update the create-clerk-bridge test around the
createClerkBridge and app mock setup so it explicitly checks the default
behavior alongside the existing userAgentFallback case, ensuring the omitted
userAgent branch does not modify the fallback.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 8353bbde-4e9c-4740-a3a4-69c3eb6d617c

📥 Commits

Reviewing files that changed from the base of the PR and between d6d62f0 and c68c2b4.

📒 Files selected for processing (5)

.changeset/electron-user-agent.md
packages/electron/README.md
packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
packages/electron/src/main/create-clerk-bridge.ts
packages/electron/src/shared/types.ts

✅ Files skipped from review due to trivial changes (3)

packages/electron/src/shared/types.ts
packages/electron/README.md
.changeset/electron-user-agent.md

feat(electron): allow custom user agent for session activity

d6d62f0

vercel Bot deployed to Preview – clerk-js-sandbox July 1, 2026 19:12 View deployment

vercel Bot deployed to Preview – swingset July 1, 2026 19:13 View deployment

wobsoriano reviewed Jul 1, 2026

View reviewed changes

wobsoriano approved these changes Jul 1, 2026

View reviewed changes

Merge branch 'main' into jw/user-agent-setting

e383b8b

vercel Bot deployed to Preview – clerk-js-sandbox July 1, 2026 19:18 View deployment

vercel Bot deployed to Preview – swingset July 1, 2026 19:20 View deployment

fix(electron): preserve platform in custom user agent

c68c2b4

vercel Bot deployed to Preview – clerk-js-sandbox July 1, 2026 20:06 View deployment

vercel Bot deployed to Preview – swingset July 1, 2026 20:08 View deployment

github-advanced-security AI found potential problems Jul 1, 2026

View reviewed changes

Comment thread packages/electron/src/main/create-clerk-bridge.ts Fixed

coderabbitai Bot reviewed Jul 1, 2026

View reviewed changes

Comment thread packages/electron/src/main/__tests__/create-clerk-bridge.test.ts

fix(electron): avoid regex parsing user agent fallback

679d52f

vercel Bot deployed to Preview – clerk-js-sandbox July 1, 2026 20:22 View deployment

vercel Bot deployed to Preview – swingset July 1, 2026 20:23 View deployment

wobsoriano merged commit 04bbfe9 into main Jul 1, 2026
51 checks passed

wobsoriano deleted the jw/user-agent-setting branch July 1, 2026 21:08

clerk-cookie mentioned this pull request Jul 1, 2026

ci(repo): Version packages #9062

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(electron): allow custom user agent for session activity#9066

feat(electron): allow custom user agent for session activity#9066
wobsoriano merged 4 commits into
mainfrom
jw/user-agent-setting

jeremy-clerk commented Jul 1, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Jul 1, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jul 1, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 1, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Jul 1, 2026 •

edited

Loading

Uh oh!

wobsoriano Jul 1, 2026

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

jeremy-clerk commented Jul 1, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wobsoriano Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jeremy-clerk commented Jul 1, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Jul 1, 2026 •

edited

Loading

vercel Bot commented Jul 1, 2026 •

edited

Loading

coderabbitai Bot commented Jul 1, 2026 •

edited

Loading

pkg-pr-new Bot commented Jul 1, 2026 •

edited

Loading