feat(KNO-9338): add branch configuration options #696

mattmikolay · 2025-08-06T21:42:13Z

Description

This PR updates our client SDK and React SDK to support specifying a branch option in the Knock client, the <KnockProvider> component, and the useAuthenticatedKnockClient hook.

I’m marking this PR with the “do not merge” label until we’re ready to ship this.

Checklist

Tests have been added for new features or major refactors to existing features.

linear · 2025-08-06T21:42:16Z

KNO-9338 [JavaScript SDKs] Add support for X-Knock-Branch header to JS SDKs

changeset-bot · 2025-08-06T21:42:17Z

🦋 Changeset detected

Latest commit: 3173ae7

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

This PR includes changesets to release 13 packages

Name	Type
@knocklabs/react-core	Patch
nextjs-example	Patch
@knocklabs/client	Patch
@knocklabs/expo	Patch
@knocklabs/react-native	Patch
@knocklabs/react	Patch
client-example	Patch
guide-example	Patch
@knocklabs/expo-example	Patch
ms-teams-connect-example	Patch
nextjs-app-dir-example	Patch
slack-connect-example	Patch
slack-kit-example	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

mattmikolay · 2025-08-06T21:42:30Z

feat(KNO-9338): add branch configuration options #696 : 2 dependent PRs (#703 , #705 ) 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

vercel · 2025-08-06T21:44:24Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
javascript-ms-teams-connect-example	Ready	Preview	Comment	Nov 7, 2025 10:24pm
javascript-nextjs-example	Ready	Preview	Comment	Nov 7, 2025 10:24pm
javascript-slack-connect-example	Ready	Preview	Comment	Nov 7, 2025 10:24pm
javascript-slack-kit-example	Ready	Preview	Comment	Nov 7, 2025 10:24pm

kylemcd

This is so good! Appreciate all the docs and the tests 🙏

kylemcd · 2025-08-11T17:09:25Z

.changeset/cuddly-moments-fly.md

+  { id: user.id },
+  undefined, // userToken when needed
+  { branch: "my-branch-slug" },


Dang, really wish we would have just put these 3 into a single object when creating this hook originally :(

cursor · 2025-08-11T21:38:54Z

packages/client/src/knock.ts

  ) {
    this.host = options.host || DEFAULT_HOST;
    this.logLevel = options.logLevel;
+    this.branch = options.branch || undefined;


Bug: Null Branch Value Causes Header and Parameter Errors

The ApiClient class initializes this.branch to null when the branch option is undefined. This null value is then incorrectly used for the X-Knock-Branch HTTP header and the branch_slug WebSocket parameter, which should be strings or omitted.

Additional Locations (2)

packages/client/src/api.ts#L44-L45

packages/client/src/api.ts#L53-L54

cursor

Bug: Knock instance reuses outdated configuration.

When userId or userToken changes simultaneously with branch (or host/logLevel), the hook reuses the existing Knock instance instead of creating a new one. Since branch is readonly and set during construction, the old branch value persists. The condition should verify that configuration options haven't changed before taking the early return path.

packages/react-core/src/modules/core/hooks/useAuthenticatedKnockClient.ts#L67-L76

javascript/packages/react-core/src/modules/core/hooks/useAuthenticatedKnockClient.ts

Lines 67 to 76 in 3173ae7

    
           if ( 
        
             currentKnock && 
        
             currentKnock.isAuthenticated() && 
        
             (currentKnock.userId !== userId || currentKnock.userToken !== userToken) 
        
           ) { 
        
             authenticateWithOptions( 
        
               currentKnock, 
        
               stableUserIdOrObject, 
        
               userToken, 
        
               stableOptions,

codecov · 2025-11-07T22:31:04Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.49%. Comparing base (9368d1e) to head (3173ae7).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #696      +/-   ##
==========================================
- Coverage   65.53%   65.49%   -0.05%     
==========================================
  Files         189      189              
  Lines        7771     7793      +22     
  Branches      954      956       +2     
==========================================
+ Hits         5093     5104      +11     
- Misses       2651     2662      +11     
  Partials       27       27

Files with missing lines	Coverage Δ
packages/client/src/api.ts	`100.00% <100.00%> (ø)`
packages/client/src/knock.ts	`100.00% <100.00%> (ø)`
...ct-core/src/modules/core/context/KnockProvider.tsx	`96.22% <100.00%> (+0.22%)`	⬆️
.../modules/core/hooks/useAuthenticatedKnockClient.ts	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

mattmikolay changed the title ~~feat(KNO-9338): add branch option to ApiClient and Knock~~ feat(KNO-9338): add branch configuration option Aug 6, 2025

mattmikolay changed the title ~~feat(KNO-9338): add branch configuration option~~ feat(KNO-9338): add branch configuration options Aug 6, 2025

vercel bot deployed to Preview – javascript-slack-kit-example August 6, 2025 21:45 View deployment

vercel bot deployed to Preview – javascript-ms-teams-connect-example August 6, 2025 21:45 View deployment

vercel bot deployed to Preview – javascript-nextjs-example August 6, 2025 21:46 View deployment

vercel bot deployed to Preview – javascript-slack-connect-example August 6, 2025 21:46 View deployment

vercel bot deployed to Preview – javascript-slack-kit-example August 8, 2025 14:45 View deployment

vercel bot deployed to Preview – javascript-slack-connect-example August 8, 2025 14:46 View deployment

vercel bot deployed to Preview – javascript-ms-teams-connect-example August 8, 2025 14:46 View deployment

vercel bot deployed to Preview – javascript-nextjs-example August 8, 2025 14:47 View deployment

vercel bot deployed to Preview – javascript-slack-kit-example August 11, 2025 15:58 View deployment

vercel bot deployed to Preview – javascript-slack-connect-example August 11, 2025 15:58 View deployment

vercel bot deployed to Preview – javascript-ms-teams-connect-example August 11, 2025 16:00 View deployment

vercel bot deployed to Preview – javascript-nextjs-example August 11, 2025 16:01 View deployment

mattmikolay added the do not merge label Aug 11, 2025

mattmikolay marked this pull request as ready for review August 11, 2025 17:06

mattmikolay requested review from cjbell, kylemcd and meryldakin August 11, 2025 17:06

kylemcd approved these changes Aug 11, 2025

View reviewed changes

vercel bot deployed to Preview – javascript-nextjs-example August 11, 2025 17:57 View deployment

vercel bot deployed to Preview – javascript-slack-connect-example August 11, 2025 17:57 View deployment

This comment was marked as outdated.

Sign in to view

vercel bot deployed to Preview – javascript-slack-kit-example August 11, 2025 17:59 View deployment

vercel bot deployed to Preview – javascript-ms-teams-connect-example August 11, 2025 17:59 View deployment

mattmikolay mentioned this pull request Aug 11, 2025

feat(KNO-9339): enable use of branches with SlackKit #703

Merged

1 task

vercel bot deployed to Preview – javascript-slack-connect-example August 11, 2025 21:37 View deployment

vercel bot deployed to Preview – javascript-ms-teams-connect-example August 11, 2025 21:38 View deployment

cursor bot reviewed Aug 11, 2025

View reviewed changes

vercel bot deployed to Preview – javascript-nextjs-example August 11, 2025 21:40 View deployment

vercel bot deployed to Preview – javascript-slack-kit-example August 11, 2025 21:44 View deployment

mattmikolay mentioned this pull request Aug 11, 2025

feat(KNO-9332): enable use of branches with TeamsKit #705

Merged

1 task

mattmikolay removed the do not merge label Nov 7, 2025

mattmikolay added 12 commits November 7, 2025 17:16

feat(KNO-9338): add branch option to ApiClient and Knock

ce46493

Update useAuthenticatedKnockClient

2d4127e

Update KnockProvider

60d3755

Add changesets

d1256c4

Update example branch slug in changeset

14ee73d

Update Next.js example app

d361c09

Update UTs

46d74ba

Update UTs

0b56300

Update UTs

2f21752

Update UTs

c10016b

Fix test

5127b57

Default setting branch to undefined in Knock

3173ae7

mattmikolay force-pushed the mattmik-kno-9338-javascript-sdks-add-support-for-x-knock-branch-header-to-js branch from 6adce9f to 3173ae7 Compare November 7, 2025 22:22

cursor bot reviewed Nov 7, 2025

View reviewed changes

vercel bot deployed to Preview – javascript-nextjs-example November 7, 2025 22:23 View deployment

vercel bot deployed to Preview – javascript-ms-teams-connect-example November 7, 2025 22:23 View deployment

vercel bot deployed to Preview – javascript-slack-kit-example November 7, 2025 22:24 View deployment

vercel bot deployed to Preview – javascript-slack-connect-example November 7, 2025 22:24 View deployment

mattmikolay merged commit 571abb1 into main Nov 7, 2025
12 of 13 checks passed

mattmikolay deleted the mattmik-kno-9338-javascript-sdks-add-support-for-x-knock-branch-header-to-js branch November 7, 2025 22:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(KNO-9338): add branch configuration options #696

feat(KNO-9338): add branch configuration options #696

Uh oh!

mattmikolay commented Aug 6, 2025 •

edited

Loading

Uh oh!

linear bot commented Aug 6, 2025

Uh oh!

changeset-bot bot commented Aug 6, 2025 •

edited

Loading

Uh oh!

mattmikolay commented Aug 6, 2025 •

edited

Loading

Uh oh!

vercel bot commented Aug 6, 2025 •

edited

Loading

Uh oh!

kylemcd left a comment

Uh oh!

kylemcd Aug 11, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Aug 11, 2025

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

codecov bot commented Nov 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	if (
	currentKnock &&
	currentKnock.isAuthenticated() &&
	(currentKnock.userId !== userId \|\| currentKnock.userToken !== userToken)
	) {
	authenticateWithOptions(
	currentKnock,
	stableUserIdOrObject,
	userToken,
	stableOptions,

feat(KNO-9338): add branch configuration options #696

feat(KNO-9338): add branch configuration options #696

Uh oh!

Conversation

mattmikolay commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

linear bot commented Aug 6, 2025

Uh oh!

changeset-bot bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

mattmikolay commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kylemcd left a comment

Choose a reason for hiding this comment

Uh oh!

kylemcd Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Aug 11, 2025

Choose a reason for hiding this comment

Bug: Null Branch Value Causes Header and Parameter Errors

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Knock instance reuses outdated configuration.

Uh oh!

Uh oh!

codecov bot commented Nov 7, 2025

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mattmikolay commented Aug 6, 2025 •

edited

Loading

changeset-bot bot commented Aug 6, 2025 •

edited

Loading

mattmikolay commented Aug 6, 2025 •

edited

Loading

vercel bot commented Aug 6, 2025 •

edited

Loading