chore(shared): Track usage of react hooks

[panteliselef]

Description

Reminder that this is applied only to dev instances.

Checklist

• pnpm test runs as expected.
• pnpm build runs as expected.
• (If applicable) JSDoc comments have been added or updated for any package exports
• (If applicable) Documentation has been updated

Type of change

• 🐛 Bug fix
• 🌟 New feature
• 🔨 Breaking change
• 📖 Refactoring / dependency upgrade / documentation
• other:

Summary by CodeRabbit

• New Features
  • Added usage tracking for several React hooks, including useReverification, useSession, useSessionList, and useUser, on development instances.
• Chores
  • Improved consistency in hook implementation and internal usage of constants.

[changeset-bot]

🦋 Changeset detected

Latest commit: dc253a2

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

This PR includes changesets to release 19 packages

Name	Type
@clerk/shared	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-js	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/clerk-expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/vue	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]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 23, 2025 9:10am

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce telemetry event recording to several React hooks in the shared package, specifically useReverification, useSession, useSessionList, and useUser. For each hook, a telemetry event is now recorded at the start of the hook to log its invocation, including whether certain options are provided. In useReverification, the telemetry event related to custom UI invocation is removed and replaced with a general event at hook initialization. The usage of context retrieval is standardized by switching to useClerkInstanceContext where applicable. No changes are made to the public APIs or exported function signatures.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/shared/src/react/hooks/useSessionList.ts (1)

51-57: Eliminate redundant clerk instance variable.

The hook now has two variables from useClerkInstanceContext(): isomorphicClerk (line 53) and clerk (line 55). This creates unnecessary redundancy.

Use the existing isomorphicClerk variable for telemetry instead:

 export const useSessionList = (): UseSessionListReturn => {
   useAssertWrappedByClerkProvider(hookName);
 
   const isomorphicClerk = useClerkInstanceContext();
   const client = useClientContext();
-  const clerk = useClerkInstanceContext();
 
-  clerk.telemetry?.record(eventMethodCalled(hookName));
+  isomorphicClerk.telemetry?.record(eventMethodCalled(hookName));

packages/shared/src/react/hooks/useSession.ts (1)

8-8: Minor: Consider using single quotes for consistency.

While functionally identical, other hooks use single quotes for the hookName constant. Consider using 'useSession' instead of template literals for consistency.

-const hookName = `useSession`;
+const hookName = 'useSession';

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 877bc85 and 2c591bd.

📒 Files selected for processing (5)

• .changeset/fresh-regions-stand.md (1 hunks)
• packages/shared/src/react/hooks/useReverification.ts (1 hunks)
• packages/shared/src/react/hooks/useSession.ts (2 hunks)
• packages/shared/src/react/hooks/useSessionList.ts (2 hunks)
• packages/shared/src/react/hooks/useUser.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: semgrep-cloud-platform/scan
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (8)

.changeset/fresh-regions-stand.md (1)

1-6: LGTM! Changeset properly documents the telemetry tracking changes.

The changeset correctly identifies this as a patch update to @clerk/shared and accurately describes the changes being made to track telemetry of hooks.

packages/shared/src/react/hooks/useUser.ts (3)

3-4: LGTM! Proper telemetry imports and context usage.

The telemetry imports and useClerkInstanceContext addition are correctly structured and align with the telemetry tracking objectives.

---

6-6: LGTM! Good practice using a constant for the hook name.

Using hookName constant instead of hardcoded strings improves maintainability and consistency across the codebase.

---

131-136: LGTM! Telemetry implementation follows best practices.

The telemetry recording is properly implemented:

• Uses the hook name constant for consistency
• Records immediately after getting the clerk instance
• Uses optional chaining for safety
• Doesn't interfere with the core hook logic

packages/shared/src/react/hooks/useSessionList.ts (1)

3-6: LGTM! Proper telemetry imports and hook name constant.

The telemetry imports and hookName constant follow the established pattern consistently.

packages/shared/src/react/hooks/useSession.ts (2)

3-4: LGTM! Proper telemetry imports and context usage.

The telemetry imports and context modifications are correctly implemented.

---

59-64: LGTM! Telemetry implementation is correct.

The telemetry recording follows the established pattern and is properly positioned before the core hook logic.

packages/shared/src/react/hooks/useReverification.ts (1)

201-205: LGTM! Appropriate telemetry implementation with valuable metadata.

The telemetry recording is well-implemented for this hook:

• Uses existing useClerk() hook appropriately
• Records valuable metadata about onNeedsReverification usage
• Positioned correctly to capture all hook invocations
• Follows the pattern established in other hooks while adapting to this hook's specific context

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.changeset/violet-symbols-go.md (1)

5-5: Capitalize "React"
The framework name should be capitalized as a proper noun.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c591bd and dc253a2.

📒 Files selected for processing (1)

• .changeset/violet-symbols-go.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

.changeset/violet-symbols-go.md

[grammar] ~5-~5: “React” is a proper noun and needs to be capitalized.
Context: ...lerk/shared': patch --- Track usage of react hooks on development instances. - `useR...

(A_GOOGLE)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: semgrep-cloud-platform/scan
• GitHub Check: Build Packages
• GitHub Check: Formatting | Dedupe | Changeset
• GitHub Check: semgrep/ci
• GitHub Check: Analyze (javascript-typescript)

[pkg-pr-new]

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6158

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6158

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6158

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6158

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6158

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6158

@clerk/upgrade

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

@clerk/vue

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

commit: dc253a2