Skip to content

fix: incorrect value type when using @default with boolean field from auth() #2052

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

Merged
merged 1 commit into from
Mar 21, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Mar 21, 2025

fixes #2038

Copy link
Contributor

coderabbitai bot commented Mar 21, 2025

📝 Walkthrough

Walkthrough

This pull request updates the schema generation process to handle Boolean default values correctly. The setDummyDefault method in the Prisma schema generator now assigns false as a Boolean rather than the string 'false'. Additionally, a new regression test (issue 2038) has been added to confirm that models using Boolean defaults are generated and processed accurately in the system.

Changes

File(s) Change Summary
packages/schema/src/.../schema-generator.ts Modified setDummyDefault to assign Boolean false (Boolean type) instead of 'false' (string) for Boolean fields in the generated schema.
tests/regression/tests/issue-2038.test.ts Added a regression test for issue #2038 which loads a schema with Boolean fields and asserts that default values are correctly applied during creation.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test
    participant LS as loadSchema
    participant P as PrismaSchemaGenerator
    participant DB as Database

    T->>LS: Define schema (User, Post models)
    LS->>P: Request schema generation
    P->>P: Execute setDummyDefault (use Boolean false)
    P->>DB: Return schema with correct defaults
    T->>DB: Create record and assert Boolean default value
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure Boolean default values are correctly typed [#2038]

Possibly related PRs


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8438f35 and 3612bac.

📒 Files selected for processing (2)
  • packages/schema/src/plugins/prisma/schema-generator.ts (1 hunks)
  • tests/regression/tests/issue-2038.test.ts (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
packages/schema/src/plugins/prisma/schema-generator.ts (1)
packages/schema/src/plugins/prisma/prisma-builder.ts (1) (1)
  • AttributeArgValue (231-289)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
🔇 Additional comments (2)
tests/regression/tests/issue-2038.test.ts (1)

1-26: Well-designed regression test for issue #2038

This test effectively verifies the fix for incorrect boolean type handling when using @default with auth(). It creates a clear scenario where a Post model has a published field defaulting to the value of auth().flag, and confirms the boolean value is correctly propagated.

packages/schema/src/plugins/prisma/schema-generator.ts (1)

896-896: Good fix for boolean type handling

This change fixes the core issue by ensuring that default values for Boolean fields are represented as actual Boolean types (false) rather than strings ('false'). This is essential for proper type handling when using @default(auth().flag) as demonstrated in the regression test.

The AttributeArgValue constructor expects the value's type to match the specified type parameter, and this change correctly aligns them.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies 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 testing code 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 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 generate unit testing code.
    • @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.

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 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.

@ymc9 ymc9 merged commit e0676f2 into dev Mar 21, 2025
11 checks passed
@ymc9 ymc9 deleted the fix/issue-2038 branch March 21, 2025 05:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant