Skip to content

fix(delegate): don't generate both "@@schema" attributes from base and sub models #1940

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
Jan 6, 2025

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Jan 6, 2025

fixes #1647

Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

📝 Walkthrough

Walkthrough

The pull request addresses a bug related to schema inheritance in Prisma models. The changes modify the attribute filtering logic in the AST utility functions to allow sub-models to override the database schema attribute (@@Schema). This enables more flexible schema configurations, particularly in multi-tenant setups where base and extended models might need to be in different database schemas.

Changes

File Change Summary
packages/schema/src/utils/ast-utils.ts - Added new hasAttribute import
- Modified filterBaseAttribute function to support attribute overriding
- Introduced overrideAttributes constant for managing overridable attributes
tests/regression/tests/issue-1647.test.ts - Added new test suite for schema inheritance
- Created two test cases validating schema inheritance and override behavior

Assessment against linked issues

Objective Addressed Explanation
Support different db schemas for delegate and extended models [#1647]
Allow @@Schema override in extended models

Possibly related PRs

Sequence Diagram

sequenceDiagram
    participant BaseModel
    participant SubModel
    participant SchemaGenerator

    BaseModel->>SchemaGenerator: Define initial @@schema
    SubModel->>SchemaGenerator: Override @@schema if specified
    SchemaGenerator->>SchemaGenerator: Apply attribute override logic
    SchemaGenerator-->>SubModel: Generate model with appropriate schema
Loading

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)
tests/regression/tests/issue-1647.test.ts (1)

5-35: First test case is well-structured.
The test confirms correct inheritance of the default @@schema("public") across base and sub-models. As a best practice, consider also verifying unexpected schemas do not appear, ensuring negative checks are covered.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3ee50d3 and 2017e62.

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

1-2: Imports are correct and straightforward.
These imports properly reference test tools and the filesystem, which is standard and succinct.


36-68: Second test case thoroughly validates overrides.
Using a sub-model schema ensures that the override logic is tested. This is a solid example of verifying that only a single occurrence of @@schema("public") remains in the final output, emphasizing that @@schema("post") properly overrides the parent model’s schema.

packages/schema/src/utils/ast-utils.ts (3)

19-26: Verified new import statements.
Importing hasAttribute from @zenstackhq/sdk is a clean approach that improves readability by eliminating the need to reimplement similar checks.


106-108: Definition of overrideAttributes is clear and maintainable.
This array-based approach allows for easy extension if future inherited attributes need to be overridden.


122-125: Conditional check for overridden attributes.
This logic correctly prevents inheriting @@schema when already present in the sub-model. It aligns with the issue’s goal by ensuring duplicate attributes are not generated.

@ymc9 ymc9 merged commit 00c1982 into dev Jan 6, 2025
9 checks passed
@ymc9 ymc9 deleted the fix/issue-1647 branch January 6, 2025 13:58
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