fix: default auth without user context

[Azzerty23]

The withDefaultAuth enhancer should allow actions that do not use this feature. However, it throws an error when there is a @default(auth()) in the schema for an anonymous user, regardless of whether the action involves it.

Summary by CodeRabbit

• Refactor
  • Improved default authentication handling for enhanced security and reliability.
• Tests
  • Added new test case to verify authentication behavior in specific scenarios.
• Bug Fixes
  • Updated parameter type in useModelQuery and useInfiniteModelQuery functions to exclude queryKey property.

[coderabbitai]

Walkthrough

Walkthrough

The recent update enhances authentication handling by initializing context as an empty object by default and refining user context checks. It eliminates the preliminary check for context.user in the DefaultAuthHandler constructor, ensuring direct assignment and error handling for absent user contexts in critical methods. Additionally, a new integration test evaluates the auth() function's behavior in the absence of a user context, ensuring robustness and reliability in authentication processes.

Changes

File Path	Change Summary
packages/runtime/src/enhancements/default-auth.ts	- Initialized context with an empty object by default. - Refined context.user checks.
tests/integration/tests/enhancements/with-policy/auth.test.ts	- Added test for auth() function without user context.

🐇✨
In the realm of code, where logic does play,
A rabbit hopped in, with updates to say.
"No user, no cry," it cheerfully spoke,
Ensuring your auth won't suddenly choke.
With tests and with checks, it dances around,
In a land of binaries, where bugs are found.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

• 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 generate unit tests for this file.
  • @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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 7b453f7 and dad65de.

Files selected for processing (2)

• packages/runtime/src/enhancements/default-auth.ts (3 hunks)
• tests/integration/tests/enhancements/with-policy/auth.test.ts (1 hunks)

Additional comments: 4

packages/runtime/src/enhancements/default-auth.ts (3)

• 18-18: The modification to default the context parameter to an empty object in the withDefaultAuth function is a good practice. It ensures that the function can be called without explicitly passing a context, which aligns with the PR's objective to support actions that do not require user context.
• 35-35: The change in the DefaultAuthHandler constructor to directly assign this.context.user to this.userContext without checking for its existence is aligned with the PR's objective. However, it's important to ensure that downstream code that relies on this.userContext is prepared to handle it being potentially undefined.

Verification successful

---

The verification process has confirmed that the code in default-auth.ts is prepared to handle this.userContext being potentially undefined. Specifically, there is a conditional check to ensure this.userContext exists before proceeding with certain logic, and its usage in a function call suggests that the function is expected to handle undefined as a valid input. Therefore, the change in the DefaultAuthHandler constructor aligns with the PR's objective, and the downstream code is indeed prepared for this.userContext being potentially undefined.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that all usages of `this.userContext` properly handle the case where it might be undefined.
ast-grep --lang typescript --pattern $'this.userContext'

Length of output: 366

* 94-96: The addition of a check for `this.userContext` in the `getDefaultValueFromAuth` method before throwing an error is crucial for the PR's objective. This ensures that errors related to the absence of a user context are only thrown when necessary, specifically when attempting to use `auth()` in `@default` without a user context. This change improves the flexibility of the `withDefaultAuth` enhancer by allowing it to be used in scenarios that do not involve user authentication.

tests/integration/tests/enhancements/with-policy/auth.test.ts (1)

• 509-536: The addition of the test case Default auth() without user context is a valuable contribution to the test suite. It verifies that an error is thrown when attempting to use auth() in @default without a user context, which aligns with the changes made in the PR. This test ensures that the new behavior works as expected and helps prevent regressions in the future.

[Azzerty23]

As tests failed anyway, I could also improve the error message. What about: "Using `auth()` in `@default` for the field `${fieldInfo.name}` requires a user context" or just "`${fieldInfo.name}` requires a user context"?

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between dad65de and e1979bd.

Files selected for processing (3)

• packages/plugins/tanstack-query/src/runtime/vue.ts (2 hunks)
• packages/runtime/src/enhancements/default-auth.ts (3 hunks)
• tests/integration/tests/enhancements/with-policy/auth.test.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• packages/runtime/src/enhancements/default-auth.ts
• tests/integration/tests/enhancements/with-policy/auth.test.ts

Additional comments: 2

packages/plugins/tanstack-query/src/runtime/vue.ts (2)

• 64-64: The update to the options parameter type in useModelQuery function to exclude the queryKey property is a good practice. It ensures that the queryKey is managed internally and not overridden by external inputs, which could potentially lead to unexpected behavior. This change enhances type safety and clarity in the function's usage.
• 90-90: Similarly, the modification in the useInfiniteModelQuery function to exclude the queryKey from the options parameter type aligns with best practices for managing internal state and parameters. By preventing external overriding of the queryKey, it maintains the integrity of the query management within the function, contributing to more predictable and safer code.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6d043a5 and 32414f4.

Files selected for processing (2)

• packages/runtime/src/enhancements/default-auth.ts (3 hunks)
• tests/integration/tests/enhancements/with-policy/auth.test.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• packages/runtime/src/enhancements/default-auth.ts
• tests/integration/tests/enhancements/with-policy/auth.test.ts