Skip to content

feat(clerk-js): Handle needs_new_password status on sign in #6106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

brkalow
Copy link
Member

@brkalow brkalow commented Jun 12, 2025

Description

Handle needs_new_password in SignInStart and SignInFactorOnePasswordCard.

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
    • Users who need to set a new password during sign-in are now automatically directed to the password reset page.

@brkalow brkalow requested a review from braden-clerk June 12, 2025 02:02
Copy link

changeset-bot bot commented Jun 12, 2025

🦋 Changeset detected

Latest commit: 20c440c

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 Minor
@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

Copy link

vercel bot commented Jun 12, 2025

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 12, 2025 2:09am

Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

📝 Walkthrough

Walkthrough

The changes update two sign-in related components to handle a new response status, 'needs_new_password', by adding cases in their respective switch statements. When this status is encountered, the components now navigate to the '../reset-password' route. No other logic or exported entities are altered.

Changes

Files Change Summary
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx,
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx
Added handling for 'needs_new_password' status to navigate to '../reset-password' during sign-in flow

🪧 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 docstrings to generate docstrings for this 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx (1)

79-81: Hard-coded route string duplicated – consider extracting to a shared constant

This file and SignInStart.tsx both embed the literal '../reset-password'. Duplicated literal routes easily drift apart. Define a small ROUTES enum / constant (e.g. ROUTES.resetPassword) in ./shared and import it in both locations for maintainability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b0e47f1 and eb2f28a.

📒 Files selected for processing (2)
  • packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx (1 hunks)
  • packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx (1 hunks)
⏰ 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)
🔇 Additional comments (1)
packages/clerk-js/src/ui/components/SignIn/SignInStart.tsx (1)

232-233: Verify relative path – ../reset-password may jump outside the /sign-in segment

SignInStart currently navigates to siblings with navigate('factor-one') / navigate('factor-two'), i.e. no ../ prefix.
Adding ../ here makes the runtime resolve one level up:

/sign-in/start   ->  ../reset-password  ==>  /reset-password

If the reset-password route is meant to stay under /sign-in, this will mis-route users and potentially break SSR/hashes. Please cross-check the router tree; in most Clerk flows the correct sibling would be plain 'reset-password'.

-          case 'needs_new_password':
-            return navigate('../reset-password');
+          case 'needs_new_password':
+            return navigate('reset-password'); // adjust if route is indeed sibling

Copy link

pkg-pr-new bot commented Jun 12, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 20c440c

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.changeset/neat-cloths-dig.md (1)

5-5: Enhance summary clarity.
Consider expanding this line to note that users will now be redirected to "../reset-password" when the needs_new_password status is encountered, so the intent and UX impact are crystal clear.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eb2f28a and 20c440c.

📒 Files selected for processing (1)
  • .changeset/neat-cloths-dig.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: Build Packages
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/neat-cloths-dig.md (1)

1-3: Confirm bump type aligns with semantic versioning.
Adding support for a new sign-in status is non-breaking user-facing functionality, so a minor bump is appropriate here.

@brkalow
Copy link
Member Author

brkalow commented Jun 12, 2025

!snapshot

@clerk-cookie
Copy link
Collaborator

Hey @brkalow - the snapshot version command generated the following package versions:

Package Version
@clerk/agent-toolkit 0.1.1-snapshot.v20250612021008
@clerk/astro 2.9.1-snapshot.v20250612021008
@clerk/backend 2.1.0-snapshot.v20250612021008
@clerk/chrome-extension 2.4.12-snapshot.v20250612021008
@clerk/clerk-js 5.69.0-snapshot.v20250612021008
@clerk/elements 0.23.33-snapshot.v20250612021008
@clerk/clerk-expo 2.13.1-snapshot.v20250612021008
@clerk/expo-passkeys 0.3.10-snapshot.v20250612021008
@clerk/express 1.7.0-snapshot.v20250612021008
@clerk/fastify 2.4.0-snapshot.v20250612021008
@clerk/localizations 3.16.5-snapshot.v20250612021008
@clerk/nextjs 6.21.1-snapshot.v20250612021008
@clerk/nuxt 1.7.1-snapshot.v20250612021008
@clerk/clerk-react 5.31.10-snapshot.v20250612021008
@clerk/react-router 1.6.0-snapshot.v20250612021008
@clerk/remix 4.8.1-snapshot.v20250612021008
@clerk/shared 3.9.7-snapshot.v20250612021008
@clerk/tanstack-react-start 0.17.0-snapshot.v20250612021008
@clerk/testing 1.8.1-snapshot.v20250612021008
@clerk/themes 2.2.50-snapshot.v20250612021008
@clerk/types 4.60.1-snapshot.v20250612021008
@clerk/vue 1.8.8-snapshot.v20250612021008

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/agent-toolkit

npm i @clerk/[email protected] --save-exact

@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/expo-passkeys

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/nuxt

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/react-router

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-react-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

@clerk/vue

npm i @clerk/[email protected] --save-exact

@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'@clerk/clerk-js': minor
'@clerk/clerk-js': patch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants