feat(clerk-js): SignIn and SignUp debug logs #6665
Conversation
🦋 Changeset detectedLatest commit: 180635d The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds debug logging across SignIn and SignUp flows, converts their public Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant UI
participant SignIn
participant DebugLogger as DebugLogger
participant Backend
User->>UI: Trigger sign-in
UI->>SignIn: create(params)
SignIn->>DebugLogger: debug("SignIn.create", {id, strategy})
SignIn->>Backend: POST /sign_in (strategy, config)
Backend-->>SignIn: SignInResource
SignIn->>DebugLogger: debug("status transition", {from, to})
SignIn-->>UI: SignInResource
rect rgba(230,247,255,0.4)
note over SignIn: First/Second factor flows use params.* consistently
UI->>SignIn: prepare/attemptFirstFactor(params)
SignIn->>DebugLogger: debug("prepare/attemptFirstFactor", {id, strategy})
SignIn->>Backend: POST factor (params.strategy, config)
Backend-->>SignIn: response
SignIn->>DebugLogger: debug("status transition", {from, to})
end
sequenceDiagram
autonumber
actor User
participant UI
participant SignUp
participant ClerkClient as Clerk Client
participant DebugLogger as DebugLogger
participant Backend
User->>UI: Trigger sign-up
UI->>SignUp: create(params)
SignUp->>DebugLogger: debug("SignUp.create", {id, strategy})
alt transfer && CAPTCHA bypass
SignUp->>ClerkClient: read signIn.firstFactorVerification.strategy
ClerkClient-->>SignUp: strategy?
SignUp->>SignUp: set params.strategy = derived strategy (if present)
end
SignUp->>Backend: POST /sign_up (params with strategy, normalized metadata)
Backend-->>SignUp: SignUpResource
SignUp->>DebugLogger: debug("status transition", {from, to})
SignUp-->>UI: SignUpResource
note over SignUp: prepare/attemptVerification also emit debug logs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
packages/clerk-js/src/core/resources/SignUp.ts (2)
128-152: Avoid param reassignment; derive strategy safely during transferReassigning function params can trip ESLint (no-param-reassign) and reduce readability. Also, only set params.strategy when the inferred value is in the allowed bypass list to prevent invalid strategies sneaking in.
Apply:
- create = async (params: SignUpCreateParams): Promise<SignUpResource> => { - debugLogger.debug('SignUp.create', { id: this.id, strategy: params.strategy }); + create = async (params: SignUpCreateParams): Promise<SignUpResource> => { + debugLogger.debug('SignUp.create', { id: this.id, strategy: params.strategy }); + let nextParams = params; if (!__BUILD_DISABLE_RHC__ && !this.clientBypass() && !this.shouldBypassCaptchaForAttempt(params)) { const captchaChallenge = new CaptchaChallenge(SignUp.clerk); const captchaParams = await captchaChallenge.managedOrInvisible({ action: 'signup' }); if (!captchaParams) { throw new ClerkRuntimeError('', { code: 'captcha_unavailable' }); } - params = { ...params, ...captchaParams }; + nextParams = { ...nextParams, ...captchaParams }; } - if (params.transfer && this.shouldBypassCaptchaForAttempt(params)) { - const strategy = SignUp.clerk.client?.signIn.firstFactorVerification.strategy; - if (strategy) { - params.strategy = strategy as SignUpCreateParams['strategy']; - } + if (nextParams.transfer && this.shouldBypassCaptchaForAttempt(nextParams)) { + const inferred = SignUp.clerk.client?.signIn.firstFactorVerification.strategy; + const allowed = SignUp.clerk.__unstable__environment?.displayConfig.captchaOauthBypass ?? []; + if (inferred && allowed.includes(inferred)) { + nextParams = { ...nextParams, strategy: inferred as SignUpCreateParams['strategy'] }; + } } return this._basePost({ path: this.pathRoot, - body: normalizeUnsafeMetadata(params), + body: normalizeUnsafeMetadata(nextParams), }); };
495-516: Guard against undefined environment and client in captcha bypass
Remove non-null assertions in shouldBypassCaptchaForAttempt and default to an empty array:- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - const captchaOauthBypass = SignUp.clerk.__unstable__environment!.displayConfig.captchaOauthBypass; + const captchaOauthBypass = + SignUp.clerk.__unstable__environment?.displayConfig.captchaOauthBypass ?? []; if (captchaOauthBypass.some(strategy => strategy === params.strategy)) { return true; } if ( params.transfer && - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - captchaOauthBypass.some(strategy => strategy === SignUp.clerk.client!.signIn.firstFactorVerification.strategy) + captchaOauthBypass.some( + strategy => strategy === SignUp.clerk.client?.signIn.firstFactorVerification.strategy, + ) ) { return true; }
🧹 Nitpick comments (3)
packages/clerk-js/src/core/resources/SignIn.ts (3)
136-142: Create() debug context is appropriateCaptures id and strategy discriminated via 'in'. Consider adding transfer flag when present for richer traces (optional).
Apply:
- debugLogger.debug('SignIn.create', { id: this.id, strategy: 'strategy' in params ? params.strategy : undefined }); + debugLogger.debug('SignIn.create', { + id: this.id, + strategy: 'strategy' in params ? params.strategy : undefined, + transfer: 'transfer' in params ? (params as { transfer?: boolean }).transfer : undefined, +});
151-206: Factor preparation switch reads from params correctlyConfig extraction aligns with type unions and avoids reading from factor state. Good.
To eliminate several
asassertions, consider introducing typed builders per strategy to construct configs, improving type safety and reducing casts.
208-225: Nit: avoid duplicatingstrategyin request bodyFor non-passkey branches,
{ ...params }already containsstrategy. No functional bug, but removing the extra property may appease linters.Apply:
- let config; + let config: Record<string, unknown>; switch (params.strategy) { case 'passkey': config = { publicKeyCredential: JSON.stringify(serializePublicKeyCredentialAssertion(params.publicKeyCredential)), }; break; default: - config = { ...params }; + config = { ...params }; } return this._basePost({ - body: { ...config, strategy: params.strategy }, + body: 'strategy' in config ? config : { ...config, strategy: params.strategy }, action: 'attempt_first_factor', });
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
.changeset/thirty-knives-refuse.md(1 hunks)packages/clerk-js/src/core/resources/SignIn.ts(6 hunks)packages/clerk-js/src/core/resources/SignUp.ts(6 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/thirty-knives-refuse.md
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/clerk-js/src/core/resources/SignUp.tspackages/clerk-js/src/core/resources/SignIn.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/core/resources/SignUp.tspackages/clerk-js/src/core/resources/SignIn.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/core/resources/SignUp.tspackages/clerk-js/src/core/resources/SignIn.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/core/resources/SignUp.tspackages/clerk-js/src/core/resources/SignIn.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/clerk-js/src/core/resources/SignUp.tspackages/clerk-js/src/core/resources/SignIn.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/clerk-js/src/core/resources/SignUp.tspackages/clerk-js/src/core/resources/SignIn.ts
🧬 Code graph analysis (2)
packages/clerk-js/src/core/resources/SignUp.ts (3)
packages/types/src/signUpCommon.ts (4)
SignUpStatus(25-25)SignUpField(27-27)SignUpCreateParams(81-104)AttemptVerificationParams(57-65)packages/clerk-js/src/utils/debug.ts (1)
debugLogger(150-179)packages/types/src/signUp.ts (1)
SignUpResource(41-116)
packages/clerk-js/src/core/resources/SignIn.ts (5)
packages/types/src/signInCommon.ts (5)
SignInStatus(61-66)SignInCreateParams(123-164)PrepareFirstFactorParams(98-108)AttemptFirstFactorParams(110-117)AttemptSecondFactorParams(121-121)packages/clerk-js/src/utils/debug.ts (1)
debugLogger(150-179)packages/types/src/signIn.ts (1)
SignInResource(34-91)packages/types/src/factors.ts (9)
PassKeyConfig(102-102)EmailLinkConfig(96-98)EmailCodeConfig(95-95)PhoneCodeConfig(99-99)Web3SignatureConfig(100-100)ResetPasswordPhoneCodeFactorConfig(92-92)ResetPasswordEmailCodeFactorConfig(93-93)SamlConfig(110-113)EnterpriseSSOConfig(115-119)packages/clerk-js/src/core/errors.ts (1)
clerkInvalidStrategy(59-61)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (23)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Unit Tests (22, **)
- GitHub Check: Static analysis
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (8)
.changeset/thirty-knives-refuse.md (1)
1-5: Changeset entry looks goodPatch release scoped to @clerk/clerk-js with a concise summary. No issues.
packages/clerk-js/src/core/resources/SignUp.ts (4)
38-39: Good: centralized debug logger importConsistent with SignIn; enables buffered logging before real logger init.
75-107: Status accessors with transition logging look solidBacked by a private field; logs only on change; avoids null spam.
153-159: Good: prepareVerification debug logIncludes id and strategy; helpful for flow traces.
161-167: Good: attemptVerification debug logConsistent with prepare; minimal context, no PII leakage.
packages/clerk-js/src/core/resources/SignIn.ts (3)
56-57: Good: centralized debug logger importMatches SignUp; consistent instrumentation.
93-115: Status accessors with transition logging look correctLogs only on actual changes; avoids null noise.
263-277: Second factor instrumentation is consistentMinimal and helpful debug logs; no PII exposure.
| params.strategy = SignUp.clerk.client?.signIn.firstFactorVerification.strategy; | ||
| const strategy = SignUp.clerk.client?.signIn.firstFactorVerification.strategy; | ||
| if (strategy) { | ||
| params.strategy = strategy as SignUpCreateParams['strategy']; |
There was a problem hiding this comment.
Do we want to modify the input params directly vs the prior _params?
There was a problem hiding this comment.
We should not: 9202934
| }; | ||
|
|
||
| prepareFirstFactor = (factor: PrepareFirstFactorParams): Promise<SignInResource> => { | ||
| prepareFirstFactor = (params: PrepareFirstFactorParams): Promise<SignInResource> => { |
There was a problem hiding this comment.
Renamed this to params for consistency with other methods and classes
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
packages/clerk-js/src/core/resources/SignUp.ts (1)
128-153: Don’t override a caller-provided strategy; improve CAPTCHA error; log effective params
- Overwrites params.strategy when transfer+bypass are true. Only infer when strategy is absent to avoid surprising callers.
- Provide a meaningful error message for CAPTCHA failures.
- Log the final effective strategy/transfer to aid traceability.
- Nice: cloning into finalParams avoids mutating inputs. (Follow-up to prior thread.)
Apply:
- create = async (params: SignUpCreateParams): Promise<SignUpResource> => { - debugLogger.debug('SignUp.create', { id: this.id, strategy: params.strategy }); + /** + * Create a sign-up. + * Strategy is inferred only when not explicitly provided. + * @public + */ + create = async (params: SignUpCreateParams): Promise<SignUpResource> => { + debugLogger.debug('SignUp.create', { id: this.id, strategy: params.strategy }); let finalParams = { ...params }; if (!__BUILD_DISABLE_RHC__ && !this.clientBypass() && !this.shouldBypassCaptchaForAttempt(params)) { const captchaChallenge = new CaptchaChallenge(SignUp.clerk); const captchaParams = await captchaChallenge.managedOrInvisible({ action: 'signup' }); if (!captchaParams) { - throw new ClerkRuntimeError('', { code: 'captcha_unavailable' }); + throw new ClerkRuntimeError('Captcha challenge unavailable or failed to initialize.', { + code: 'captcha_unavailable', + }); } finalParams = { ...finalParams, ...captchaParams }; } - if (finalParams.transfer && this.shouldBypassCaptchaForAttempt(finalParams)) { + if (finalParams.transfer && !finalParams.strategy && this.shouldBypassCaptchaForAttempt(finalParams)) { const strategy = SignUp.clerk.client?.signIn.firstFactorVerification.strategy; if (strategy) { finalParams = { ...finalParams, strategy: strategy as SignUpCreateParams['strategy'] }; } } - return this._basePost({ + debugLogger.debug('SignUp.create.final', { + id: this.id, + strategy: finalParams.strategy, + transfer: !!finalParams.transfer, + }); + return this._basePost({ path: this.pathRoot, body: normalizeUnsafeMetadata(finalParams), }); };Optional follow-up: consider inferring transfer-bypass strategy before launching CAPTCHA to avoid unnecessary challenges when we already know we’ll bypass.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/clerk-js/src/core/resources/SignUp.ts(4 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/clerk-js/src/core/resources/SignUp.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/core/resources/SignUp.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/core/resources/SignUp.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/core/resources/SignUp.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/clerk-js/src/core/resources/SignUp.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/clerk-js/src/core/resources/SignUp.ts
🧬 Code graph analysis (1)
packages/clerk-js/src/core/resources/SignUp.ts (4)
packages/types/src/signUpCommon.ts (4)
SignUpStatus(25-25)SignUpCreateParams(81-104)PrepareVerificationParams(29-55)AttemptVerificationParams(57-65)packages/clerk-js/src/utils/debug.ts (1)
debugLogger(150-179)packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts (1)
CaptchaChallenge(8-92)packages/shared/src/error.ts (1)
ClerkRuntimeError(241-281)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (4)
packages/clerk-js/src/core/resources/SignUp.ts (4)
38-39: Logging instrumentation import — OKBrings in debug logger without side effects; aligns with the PR goal.
75-79: Private backing field for status — OKEncapsulation looks good; snapshot/fromJSON still map through the accessor.
156-161: prepareVerification debug log — OKCaptures strategy context without leaking sensitive data.
164-169: attemptVerification debug log — OKConsistent with prepareVerification; good for tracing.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/clerk-js/src/core/resources/SignIn.ts (3)
56-56: Add a consistent log source for easier filtering.Pass a stable source to all debug logs and avoid repeating the class name string.
import { debugLogger } from '@/utils/debug'; +const LOG_SOURCE = 'SignIn';- debugLogger.debug('SignIn.create', { id: this.id, strategy: 'strategy' in params ? params.strategy : undefined }); + debugLogger.debug('SignIn.create', { id: this.id, strategy: 'strategy' in params ? params.strategy : undefined }, LOG_SOURCE);- debugLogger.debug('SignIn.prepareFirstFactor', { id: this.id, strategy: params.strategy }); + debugLogger.debug('SignIn.prepareFirstFactor', { id: this.id, strategy: params.strategy }, LOG_SOURCE);- debugLogger.debug('SignIn.attemptFirstFactor', { id: this.id, strategy: params.strategy }); + debugLogger.debug('SignIn.attemptFirstFactor', { id: this.id, strategy: params.strategy }, LOG_SOURCE);- debugLogger.debug('SignIn.prepareSecondFactor', { id: this.id, strategy: params.strategy }); + debugLogger.debug('SignIn.prepareSecondFactor', { id: this.id, strategy: params.strategy }, LOG_SOURCE);- debugLogger.debug('SignIn.attemptSecondFactor', { id: this.id, strategy: params.strategy }); + debugLogger.debug('SignIn.attemptSecondFactor', { id: this.id, strategy: params.strategy }, LOG_SOURCE);Also applies to: 149-149, 164-164, 221-221, 276-276, 284-284
112-126: Also log transitions to null to capture full lifecycle.Currently transitions to null are silent. Logging all changes helps trace resets (e.g., after finalize/failure).
- if (value && previousStatus !== value) { + if (previousStatus !== value) { debugLogger.debug('SignIn.status', { id: this.id, from: previousStatus, to: value }); }
220-237: Avoid duplicatingstrategyin the request body.Spreading
paramsthen re-settingstrategyduplicates the key. Harmless but noisy.- switch (params.strategy) { + switch (params.strategy) { case 'passkey': config = { publicKeyCredential: JSON.stringify(serializePublicKeyCredentialAssertion(params.publicKeyCredential)), }; break; default: - config = { ...params }; + { + const { strategy, ...rest } = params as Record<string, unknown>; + config = rest; + } }
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/clerk-js/src/core/resources/SignIn.ts(6 hunks)packages/clerk-js/src/core/resources/SignUp.ts(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/clerk-js/src/core/resources/SignUp.ts
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/clerk-js/src/core/resources/SignIn.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/core/resources/SignIn.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/core/resources/SignIn.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/core/resources/SignIn.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/clerk-js/src/core/resources/SignIn.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/clerk-js/src/core/resources/SignIn.ts
🧬 Code graph analysis (1)
packages/clerk-js/src/core/resources/SignIn.ts (6)
packages/types/src/signInCommon.ts (5)
SignInStatus(61-66)SignInCreateParams(123-164)PrepareFirstFactorParams(98-108)AttemptFirstFactorParams(110-117)AttemptSecondFactorParams(121-121)packages/clerk-js/src/utils/debug.ts (1)
debugLogger(150-179)packages/types/src/signIn.ts (1)
SignInResource(34-91)packages/types/src/factors.ts (9)
PassKeyConfig(102-102)EmailLinkConfig(96-98)EmailCodeConfig(95-95)PhoneCodeConfig(99-99)Web3SignatureConfig(100-100)ResetPasswordPhoneCodeFactorConfig(92-92)ResetPasswordEmailCodeFactorConfig(93-93)SamlConfig(110-113)EnterpriseSSOConfig(115-119)packages/clerk-js/src/core/errors.ts (1)
clerkInvalidStrategy(59-61)packages/clerk-js/src/utils/passkeys.ts (1)
serializePublicKeyCredentialAssertion(233-233)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (7)
packages/clerk-js/src/core/resources/SignIn.ts (7)
93-93: Private backing field for status looks good.Matches the interface and enables controlled updates.
103-111: Getter is clean and typed correctly.No further action.
148-154: create(): correct return type and minimal logging.Return type aligns with SignInResource; logging avoids PII. LGTM.
275-281: prepareSecondFactor logging: LGTM.Minimal, non-PII, consistent with create/first-factor.
284-289: attemptSecondFactor logging: LGTM.Consistent and safe.
163-213: Confirm prepareFirstFactor handles all non-OAuth first-factor strategies and that no OAuth (‘oauth_*’) strategies are routed here. prepareFirstFactor currently handles passkey, email_link, email_code, phone_code, web3_metamask_signature, web3_base_signature, web3_coinbase_wallet_signature, web3_okx_wallet_signature, reset_password_phone_code, reset_password_email_code, saml and enterprise_sso; OAuth strategies should be invoked via authenticateWithRedirect/create—verify no callers pass an ‘oauth_*’ strategy to prepareFirstFactor.
226-227: No change required: backend expects a JSON string
The Frontend API schema for passkey verification defines public_key_credential as a string, so wrapping the serialized object in JSON.stringify is correct.
3 participants
Description
Adding baseline debug logging to SignIn and SignUp components
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Refactor
Chores