feat(nextjs): Include metadata as headers on keyless creation #6483
Conversation
🦋 Changeset detectedLatest commit: e8cc210 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 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 Git ↗︎
|
@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: |
📝 WalkthroughWalkthroughThe changes implement telemetry and metadata forwarding enhancements for accountless application workflows. Backend API methods for creating and completing accountless applications now accept an optional Estimated code review effort🎯 3 (Moderate) | ⏱️ ~15–20 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (5)
⏰ 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)
🪧 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 comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts (1)
27-29: Track the TODO for abandon functionality.The placeholder method is appropriate for this PR, but ensure the abandon functionality is tracked in your issue management system.
Would you like me to create a GitHub issue to track the implementation of the
abandonAccountlessApplicationfunctionality?packages/nextjs/src/server/keyless-custom-headers.ts (1)
25-32: Consider improving Next.js version extraction robustness.The regex parsing of
process.titleis clever but could be fragile if the format changes. The current implementation might return the entireprocess.titleas fallback which could contain sensitive information.Consider this more defensive approach:
nextVersion: () => { try { // Extract version from process.title: 'next-server (v15.4.5)' -> 'v15.4.5' const match = process.title.match(/\(v([\d.]+)\)/); - return match ? `v${match[1]}` : process.title; + return match ? `v${match[1]}` : undefined; } catch { return undefined; } },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts(1 hunks)packages/nextjs/src/app-router/server/keyless-provider.tsx(2 hunks)packages/nextjs/src/server/keyless-custom-headers.ts(1 hunks)packages/nextjs/src/server/keyless-node.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (9)
**/*.{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/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.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/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.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/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.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/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
packages/nextjs/src/server/keyless-node.tspackages/nextjs/src/app-router/server/keyless-provider.tsxpackages/nextjs/src/server/keyless-custom-headers.tspackages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
**/*.{jsx,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components:UserProfile,NavigationMenu
Keep components focused on a single responsibility - split large components
Limit component size to 150-200 lines; extract logic into custom hooks
Use composition over inheritance - prefer smaller, composable components
Export components as named exports for better tree-shaking
One component per file with matching filename and component name
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...
Files:
packages/nextjs/src/app-router/server/keyless-provider.tsx
**/*.tsx
📄 CodeRabbit Inference Engine (.cursor/rules/react.mdc)
**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering
Files:
packages/nextjs/src/app-router/server/keyless-provider.tsx
🧬 Code Graph Analysis (2)
packages/nextjs/src/server/keyless-node.ts (1)
packages/nextjs/src/server/keyless-custom-headers.ts (2)
collectKeylessMetadata(52-64)formatMetadataHeaders(69-80)
packages/nextjs/src/app-router/server/keyless-provider.tsx (2)
packages/nextjs/src/server/keyless-custom-headers.ts (2)
collectKeylessMetadata(52-64)formatMetadataHeaders(69-80)packages/nextjs/src/server/keyless-log-cache.ts (1)
clerkDevelopmentCache(64-64)
⏰ 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). (5)
- GitHub Check: Build Packages
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (12)
packages/nextjs/src/app-router/server/keyless-provider.tsx (2)
8-8: LGTM!The import statement correctly brings in the telemetry collection functions needed for the keyless metadata feature.
110-110: API call correctly forwards telemetry headers.The modification properly passes the collected metadata headers to the backend API, aligning with the updated method signature.
packages/nextjs/src/server/keyless-node.ts (2)
5-5: LGTM!The import statement correctly brings in the required telemetry collection functions.
149-149: LGTM!The API call correctly passes the collected telemetry headers to the backend method.
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts (3)
8-8: LGTM!The method signatures correctly accept optional Headers parameters while maintaining backward compatibility through the optional type.
Also applies to: 17-17
9-9: LGTM!The header conversion logic properly transforms Headers objects to plain objects using the standard approach with type guards for safety.
Also applies to: 18-18
13-13: LGTM!The headerParams correctly forwards the converted telemetry headers through the request system.
Also applies to: 23-23
packages/nextjs/src/server/keyless-custom-headers.ts (5)
3-8: LGTM!The interface is well-designed with appropriate optional properties and clear naming conventions for telemetry metadata.
13-18: LGTM!The header mapping properly namespaces headers with 'Clerk-' prefix and follows HTTP header conventions. The 'as const' assertion ensures type safety.
41-47: LGTM!The safeCollect utility function provides robust error handling for metadata collection with proper generic typing.
52-64: LGTM!The function efficiently collects metadata using concurrent execution with Promise.all and properly combines environment and request data.
69-80: LGTM!The function efficiently converts metadata to HTTP headers with proper filtering and type-safe mapping using the centralized header configuration.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.changeset/strong-chicken-lie.md (1)
6-6: Update summary to reflect all forwarded metadataThe implementation also forwards the Next.js version, but the changeset text omits it. Including every forwarded field avoids confusion when reading the changelog.
-feat(nextjs): Forward user-agent, arch, platform, and npm config with POST requests to /accountless_applications +feat(nextjs): Forward user-agent, arch, platform, next.js version, and npm config with POST requests to /accountless_applications
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.changeset/strong-chicken-lie.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.changeset/**
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/strong-chicken-lie.md
⏰ 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). (3)
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
946db15 to
76eb474
Compare
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Outdated
Show resolved
Hide resolved
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Outdated
Show resolved
Hide resolved
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Outdated
Show resolved
Hide resolved
6b4920c to
8cc18eb
Compare
There was a problem hiding this comment.
@heatlikeheatwave great job! I've left a few minor comments, approving to unblock for when everything's ready
packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Outdated
Show resolved
Hide resolved
2929090 to
9dbf813
Compare
1332fb3 to
b8775e8
Compare
… to /accountless_applications
d6462c1 to
08d30b0
Compare
…plication-created-and-dev
Description
To help us debug why keyless applications are failing to make API requests, this PR forwards the user-agent, arch, platform, nextjs version, and npm config with POST requests to create keyless app instance.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes