fix(clerk-js): Remove duplicate prepare first factor calls #6134

jacekradko · 2025-06-16T15:19:55Z

Description

Fixes: USER-2179

Reworked the cache key creation logic not to rely on sign_in.id, which can change after re-renders

Initial state: signIn.id = "sia_...."
After setActive() signIn.id changes to undefined
Cache key changes: From {..., "id": "sia_...."} to {..., "id": undefined}
Re-render in the host app
useFetch re-triggers because the cache key changed
SignIn object is invalid so the duplicate call fails

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

Summary by CodeRabbit

Tests
- Added a comprehensive test suite for the sign-in code form, covering cache key logic, API call behavior, and form rendering for different verification strategies.
Bug Fixes
- Improved cache key generation for sign-in factor preparation, reducing redundant API calls and ensuring correct handling of communication channels.
- Stabilized cache key by removing dependency on mutable sign-in ID to prevent cache inconsistencies.

changeset-bot · 2025-06-16T15:19:59Z

🦋 Changeset detected

Latest commit: 59828e8

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

This PR includes changesets to release 3 packages

Name	Type
@clerk/clerk-js	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-expo	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 · 2025-06-16T15:20:23Z

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 16, 2025 10:39pm

coderabbitai · 2025-06-16T17:12:30Z

📝 Walkthrough

Walkthrough

The changes introduce a memoized cacheKey object in the SignInFactorOneCodeForm component, which is used as the query key for the useFetch hook that triggers the sign-in first factor preparation. The cacheKey is now based on the factor's strategy and relevant identifiers, excluding the signIn.id, to prevent unnecessary re-fetches. A comprehensive test suite for the component is also added, focusing on the new cache key logic, API call behavior, and component rendering under different scenarios.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent `/prepare_first_factor` from firing twice by stabilizing the query key (USER-2179)	✅
Remove `signIn.id` from the query key to avoid redundant API calls (USER-2179)	✅
Ensure cache key includes relevant factor identifiers and communication channel (USER-2179)	✅
Add/adjust tests to verify cache key logic and API call behavior (USER-2179)	✅

Suggested reviewers

NicolasLopes7

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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: 1

🧹 Nitpick comments (3)

packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOneCodeForm.spec.tsx (3)
12-18: Module mock is never restored – may leak into unrelated test files

vi.mock('../../../hooks', …) is declared at top scope, so the mocked useFetch persists for the entire test suite (including other files executed later). Wrap the mock in vi.mock + vi.importActual inside the describe or add an afterAll that calls vi.unmock to avoid cross-test pollution.

26-29: options parameter typed as any – lose IDE help & safety

Give renderWithProviders a proper generic signature instead of falling back to any, e.g.:
-const renderWithProviders = (component: React.ReactElement, options?: any) => {
+const renderWithProviders = <T extends object = unknown>(
+  component: React.ReactElement,
+  options?: T,
+) => {
Small, but it preserves type checking for future contributors.

100-166: Duplicated test scenario – consider merging to keep suite lean

The assertion “still calls prepare when factor is already prepared but verification not verified” appears in both the Cache Key Generation and shouldAvoidPrepare Logic describe blocks. Combining them in a single place will shorten execution time and avoid maintenance divergence.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 656851d and 3f91967.

📒 Files selected for processing (2)

packages/clerk-js/src/ui/components/SignIn/SignInFactorOneCodeForm.tsx (3 hunks)
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOneCodeForm.spec.tsx (1 hunks)

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

GitHub Check: Analyze (javascript-typescript)

packages/clerk-js/src/ui/components/SignIn/SignInFactorOneCodeForm.tsx

pkg-pr-new · 2025-06-16T20:07:27Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 59828e8

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

.changeset/real-bees-post.md (1)

5-5: Enhance changeset description with context and references.

The summary is clear, but adding the issue ID (USER-2179) and explicitly calling out the removal of duplicate prepare-first-factor calls will improve traceability. For example:

“Remove duplicate prepare-first-factor calls (USER-2179) by stabilizing cache‐key generation in SignInFactorOneCodeForm.tsx—no longer relying on signIn.id.”

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 05dda3d and 59828e8.

📒 Files selected for processing (1)

.changeset/real-bees-post.md (1 hunks)

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

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

clerk-cookie added the clerk-js label Jun 16, 2025

vercel bot deployed to Preview June 16, 2025 15:20 View deployment

vercel bot deployed to Preview June 16, 2025 15:45 View deployment

vercel bot deployed to Preview June 16, 2025 17:04 View deployment

fix(clerk-js): Remove duplicate prepare first factor fetch

3f91967

jacekradko force-pushed the fix/remove-duplicate-prepare-first-factor-call branch from 3e2b253 to 3f91967 Compare June 16, 2025 17:06

vercel bot deployed to Preview June 16, 2025 17:07 View deployment

jacekradko marked this pull request as ready for review June 16, 2025 17:08

jacekradko requested review from a team, aeliox and wobsoriano as code owners June 16, 2025 17:08

coderabbitai bot reviewed Jun 16, 2025

View reviewed changes

packages/clerk-js/src/ui/components/SignIn/SignInFactorOneCodeForm.tsx Outdated Show resolved Hide resolved

panteliselef approved these changes Jun 16, 2025

View reviewed changes

Merge branch 'main' into fix/remove-duplicate-prepare-first-factor-call

514e807

vercel bot deployed to Preview June 16, 2025 20:00 View deployment

stable useMemo deps

b849413

vercel bot deployed to Preview June 16, 2025 20:03 View deployment

wip

05dda3d

vercel bot deployed to Preview June 16, 2025 21:49 View deployment

changeset

59828e8

vercel bot deployed to Preview June 16, 2025 22:39 View deployment

coderabbitai bot reviewed Jun 16, 2025

View reviewed changes

jacekradko merged commit e436882 into main Jun 17, 2025
63 of 64 checks passed

jacekradko deleted the fix/remove-duplicate-prepare-first-factor-call branch June 17, 2025 00:47

clerk-cookie mentioned this pull request Jun 16, 2025

ci(repo): Version packages #6136

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(clerk-js): Remove duplicate prepare first factor calls #6134

fix(clerk-js): Remove duplicate prepare first factor calls #6134

Uh oh!

jacekradko commented Jun 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Jun 16, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jun 16, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 16, 2025 •

edited

Loading

Walkthrough

Assessment against linked issues

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 16, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fix(clerk-js): Remove duplicate prepare first factor calls #6134

fix(clerk-js): Remove duplicate prepare first factor calls #6134

Uh oh!

Conversation

jacekradko commented Jun 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

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

Uh oh!

Uh oh!

coderabbitai bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Assessment against linked issues

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jacekradko commented Jun 16, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 16, 2025 •

edited

Loading

vercel bot commented Jun 16, 2025 •

edited

Loading

coderabbitai bot commented Jun 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jun 16, 2025 •

edited

Loading