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(delegate): generated fk fields shouldn't inherit @map attribute from its origin #1633

Merged
merged 1 commit into from
Aug 3, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Aug 2, 2024

Fixes #1551

Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

Walkthrough

The recent changes enhance the PrismaSchemaGenerator class by improving the handling of relational field attributes and implementing a filtering mechanism for foreign key attributes. A regression test for issue #1551 is also introduced, ensuring that schema generation remains robust and functional, particularly regarding polymorphic relations and field mapping.

Changes

File(s) Change Summary
packages/schema/src/plugins/prisma/schema-generator.ts Improved readability of PrismaAttributeArg instantiation and added filtering for @map attributes in foreign key fields. Renamed foreign key fields for clarity.
tests/regression/tests/issue-1551.test.ts Introduced a regression test that validates schema integrity for polymorphic model relations.

Assessment against linked issues

Objective Addressed Explanation
Address schema generation issues with @map attribute (#[1551])
Ensure that foreign key attributes do not inherit @map (#[1551])

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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between da69e02 and 0f3c034.

Files selected for processing (2)
  • packages/schema/src/plugins/prisma/schema-generator.ts (2 hunks)
  • tests/regression/tests/issue-1551.test.ts (1 hunks)
Additional comments not posted (8)
tests/regression/tests/issue-1551.test.ts (6)

1-1: Import statement is correct.

The import statement for loadSchema is necessary for the test.


2-2: Test suite description is clear.

The description of the issue 1551 test suite is clear and follows standard conventions.


3-3: Test case name is appropriate.

The asynchronous test case is named regression, indicating its purpose.


4-4: Usage of await is correct.

The await keyword is necessary for the asynchronous operation of loading the schema.


5-24: Schema definition is correct.

The schema includes three models: User, Profile, and IndividualProfile. It correctly sets up the relations and attributes to replicate the issue described in #1551.


25-26: Test closure is correct.

The syntax for closing the asynchronous function and the test suite is correct.

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

445-448: Addition of PrismaAttributeArg is correct.

The new PrismaAttributeArg for the @relation attribute improves the clarity of the relation name.


491-493: Filtering of @map attribute is correct.

The filtering mechanism for the @map attribute from foreign key field attributes addresses the issue described in #1551.

@ymc9 ymc9 merged commit ba8a888 into dev Aug 3, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1551 branch August 3, 2024 00:35
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