Skip to content
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

fix: assign default value to field which uses auth() in @default when generating logical schema #1962

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jan 14, 2025

No description provided.

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

The changes introduce a new private method setDummyDefault in the PrismaSchemaGenerator class to handle default value generation for fields with an auth() default attribute in logical mode. The method uses pattern matching from the ts-pattern library to determine appropriate dummy default values based on the field's type. This enhancement allows for more flexible schema generation by setting placeholder default values while maintaining the schema's structural integrity.

Changes

File Change Summary
packages/schema/src/plugins/prisma/schema-generator.ts - Added import for P from ts-pattern
- Introduced private method setDummyDefault for generating dummy default values
- Modified generateModelField to utilize setDummyDefault in logical mode
- Added error handling for unsupported field types

Sequence Diagram

sequenceDiagram
    participant SchemaGenerator
    participant ModelField
    participant DataModelField
    participant P as Pattern Matcher

    SchemaGenerator->>ModelField: generateModelField()
    alt Is logical mode with auth() default
        SchemaGenerator->>SchemaGenerator: setDummyDefault()
        SchemaGenerator->>P: Match field type
        P-->>SchemaGenerator: Determine dummy value
        SchemaGenerator->>ModelField: Set dummy default
    end
Loading

The sequence diagram illustrates the flow of setting a dummy default value during schema generation, highlighting the interaction between the schema generator, model field, and pattern matching mechanism.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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
🪧 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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

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

883-898: Consider enhancing the implementation with these refinements.

  1. Add JSDoc documentation to explain the method's purpose and parameters
  2. Improve the error message to include the field name
  3. Optimize the pattern matching for numeric types

Here's a suggested implementation:

+    /**
+     * Sets a dummy default value for a field that uses auth() in @default
+     * @param result The ModelField to modify
+     * @param field The original DataModelField
+     */
     private setDummyDefault(result: ModelField, field: DataModelField) {
         const dummyDefaultValue = match(field.type.type)
             .with('String', () => new AttributeArgValue('String', ''))
-            .with(P.union('Int', 'BigInt', 'Float', 'Decimal'), () => new AttributeArgValue('Number', '0'))
+            .with(
+                P.union('Int', 'BigInt', 'Float', 'Decimal'),
+                (type) => new AttributeArgValue('Number', '0')
+            )
             .with('Boolean', () => new AttributeArgValue('Boolean', 'false'))
             .with('DateTime', () => new AttributeArgValue('FunctionCall', new PrismaFunctionCall('now')))
             .with('Json', () => new AttributeArgValue('String', '{}'))
             .with('Bytes', () => new AttributeArgValue('String', ''))
             .otherwise(() => {
-                throw new PluginError(name, `Unsupported field type with default value: ${field.type.type}`);
+                throw new PluginError(
+                    name,
+                    `Field "${field.$container.name}.${field.name}" has unsupported type "${field.type.type}" for @default(auth())`
+                );
             });

         result.attributes.push(
             new PrismaFieldAttribute('@default', [new PrismaAttributeArg(undefined, dummyDefaultValue)])
         );
     }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1a9cf5a and 3b183e0.

📒 Files selected for processing (1)
  • packages/schema/src/plugins/prisma/schema-generator.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: dependency-review
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: OSSAR-Scan
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
🔇 Additional comments (2)
packages/schema/src/plugins/prisma/schema-generator.ts (2)

872-879: LGTM! Clean implementation of logical mode handling.

The conditional block correctly handles fields with @default(auth()) in logical mode by setting appropriate dummy default values.


883-898: LGTM! Well-structured pattern matching implementation.

The method effectively handles all Prisma primitive types and sets appropriate dummy default values.

@ymc9 ymc9 merged commit 506cf99 into dev Jan 14, 2025
9 checks passed
@ymc9 ymc9 deleted the fix/logical-auth-default branch January 14, 2025 10:09
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