feat(nuxt): Introduce machine auth #6391
Conversation
🦋 Changeset detectedLatest commit: eac3bdf The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 ↗︎
|
📝 WalkthroughWalkthroughThis change set enhances the Nuxt integration package by introducing support for machine authentication tokens. It updates the Estimated code review effort🎯 3 (Moderate) | ⏱️ ~15–20 minutes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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). (4)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
@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
🧹 Nitpick comments (2)
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts (2)
35-38: Remove console.log from test mockThe console.log statement should be removed from the test mock as it adds unnecessary noise to test output and isn't needed for testing functionality.
- toAuth: () => { - console.log('Mock toAuth() called, returning:', AUTH_RESPONSE); - return AUTH_RESPONSE; - }, + toAuth: () => AUTH_RESPONSE,
51-119: Consider adding machine authentication specific testsWhile the existing tests cover the basic middleware functionality, consider adding tests that specifically verify machine authentication scenarios, such as:
- Testing with different token types (session vs machine tokens)
- Verifying the new authentication properties are properly handled
- Testing authentication failures and edge cases specific to machine auth
Since this PR introduces machine authentication, it would be valuable to add test cases that specifically exercise this new functionality to ensure robust coverage.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts(2 hunks)packages/nuxt/src/runtime/server/clerkMiddleware.ts(3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/nuxt/src/runtime/server/clerkMiddleware.ts
🧰 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/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.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/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.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/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts
packages/**/*.{test,spec}.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Unit tests should use Jest or Vitest as the test runner.
Files:
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.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/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts
**/__tests__/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/typescript.mdc)
**/__tests__/**/*.{ts,tsx}: Create type-safe test builders/factories
Use branded types for test isolation
Implement proper mock types that match interfaces
Files:
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.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.Whenever reviewing a pull request, if there are any changes that could impact security, always tag
@clerk/securityin the PR.Security-impacting changes include, but are not limited to:
- Changes to authentication logic or mechanisms (e.g. login, session handling, token issuance)
- Any modification to access control, authorization checks, or role-based permissions
- Introduction or modification of hashing algorithms, signature verification, or cryptographic primitives
- Handling of sensitive data (e.g. passwords, tokens, secrets, PII)
- Integration with external identity providers (e.g. SSO, OAuth, OpenID Connect)
- Modifications to security headers, cookie flags, CORS policies, or CSRF protections
- Bypass mechanisms (e.g. feature flags, testing overrides) that could weaken protections
- Changes to rate limiting, abuse prevention, or input validation
If you're unsure whether a change is security-relevant, err on the side of caution and tag
@clerk/security.Any time that you tag
@clerk/security, please do so explicitly in a code comment, rather than within a collapsed section in a coderabbit comment, such as the "recent review details" section. If you do use the team name in any thinking or non-direct-code-comment content, it can be referred to as "clerk security team" to avoid accidentally printing the tag which sends a notification to the team.
Files:
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts
⏰ 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: semgrep-cloud-platform/scan
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
packages/nuxt/src/runtime/server/__tests__/clerkMiddleware.test.ts (1)
9-18: LGTM: Mock data expanded to match new authentication interfaceThe addition of these authentication properties aligns well with the machine authentication feature being introduced. The mock data includes all the necessary fields for testing the enhanced authentication response.
wobsoriano
changed the title
| const requestState = await clerkClient(event).authenticateRequest(clerkRequest, options); | ||
| const requestState = await clerkClient(event).authenticateRequest(clerkRequest, { | ||
| ...options, | ||
| acceptsToken: 'any', |
There was a problem hiding this comment.
This is the option that enables verification of api keys, oauth tokens and machine tokens
| const authHandler = () => authObject; | ||
| const authHandler: AuthFn = ((options?: AuthOptions) => { | ||
| const acceptsToken = options?.acceptsToken ?? TokenType.SessionToken; | ||
| return getAuthObjectForAcceptedToken({ authObject, acceptsToken }); |
There was a problem hiding this comment.
This is a shared helper across our SDKs to get the actual auth object based on the acceptsToken value. It is unit tested there.
| /** | ||
| * @deprecated Use `event.context.auth()` instead. | ||
| */ | ||
| export function getAuth(event: H3Event): SessionAuthObject { |
There was a problem hiding this comment.
We're deprecating this helper in favor of event.context.auth() to follow Nuxt conventions where event.context is the standard pattern for accessing request-scoped data.
This function is not documented as well so it's safe to deprecated. We already use event.context.auth() in our docs
Description
getAuth()helper in favor ofevent.context.auth()to follow Nuxt conventions whereevent.contextis the standard pattern for accessing request-scoped dataResolves USER-2456
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Refactor
getAuthfunction in favor of direct context calls, adding runtime warnings.Tests
Chores