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(cli): regular relation fields are incorrectly recognized as self-relation #1790

Merged
merged 3 commits into from
Oct 21, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Oct 20, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Oct 20, 2024

📝 Walkthrough
<details>
<summary>📝 Walkthrough</summary>

## Walkthrough
This pull request introduces several modifications to the `DataModelValidator` class in the `datamodel-validator.ts` file, focusing on enhancing validation logic and error handling for relation fields. Key updates include the removal of an import, improved error messages, and refined method signatures. Additionally, the `datamodel-validation.test.ts` file has been updated with new test cases and refined assertions to ensure comprehensive coverage of validation scenarios, particularly related to relations and unique constraints.

## Changes

| File                                                                 | Change Summary                                                                                                           |
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
| packages/schema/src/language-server/validator/datamodel-validator.ts | - Removed `getLiteral` import.<br>- Updated `parseRelation` for better error handling and control flow.<br>- Modified `isSelfRelation` method signature.<br>- Refined error messages in validation methods. |
| packages/schema/tests/schema/validation/datamodel-validation.test.ts | - Added new test cases for error handling and edge cases.<br>- Updated error messages for clarity.<br>- Expanded relation handling tests.<br>- Added tests for abstract and delegate models. |

## Possibly related PRs
- **#1430**: This PR modifies the `DataModelValidator` class in `datamodel-validator.ts`, which is directly related to the changes made in the main PR regarding validation logic and error messages for relation fields.

</details>

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 93e6150 and 10c2f7b.

📒 Files selected for processing (1)
  • packages/schema/src/language-server/validator/datamodel-validator.ts (4 hunks)
🧰 Additional context used
🔇 Additional comments (3)
packages/schema/src/language-server/validator/datamodel-validator.ts (3)

144-152: Verify the validation logic when both 'fields' and 'references' are missing

In the parseRelation method, when both fields and references are absent, the method returns with valid: true. Please confirm that this behavior is intentional, as it allows relations without fields and references to be considered valid. This may impact how such relations are validated elsewhere in the codebase.


200-201: Removed unused parameter from isSelfRelation method

Great job simplifying the isSelfRelation method by removing the unused relationName parameter. This improves code clarity and maintainability.


301-307: Correctly exclude self-relations from validation error

By adding the condition if (!this.isSelfRelation(f)), self-relations are properly excluded from the error that requires one side of the relation to carry the @relation attribute with both fields and references. This adjustment ensures accurate validation logic for self-relations.


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 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: 1

🧹 Outside diff range and nitpick comments (3)
packages/schema/src/language-server/validator/datamodel-validator.ts (1)

309-309: Improve clarity of error message

Consider rephrasing the error message for better clarity and grammatical correctness. Suggested change:

-'Field for one side of relation must carry @relation attribute with both "fields" and "references"'
+'A field on one side of a relation must have a @relation attribute with both "fields" and "references" specified.'
packages/schema/tests/schema/validation/datamodel-validation.test.ts (2)

454-454: Consider providing more specific error messages for clarity

The error message "fields" and "references" must be provided together could be enhanced by including the model and field names to help users quickly identify where the issue occurs.

Consider updating the error message to include model and field context:

- ).toMatchObject(errorLike(`"fields" and "references" must be provided together`));
+ ).toMatchObject(errorLike(`Model "B", field "a": "fields" and "references" must be provided together`));

544-544: Enhance error message with model and field details

The error message Field for one side of relation must carry @relation attribute with both "fields" and "references" may be more helpful if it specifies the exact field and model involved. This aids in quicker debugging and improves user experience.

Consider revising the error message:

-                 `Field for one side of relation must carry @relation attribute with both "fields" and "references"`
+                 `Field "a" in model "B" must have a @relation attribute with both "fields" and "references"`
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c39f596 and 492dd36.

📒 Files selected for processing (2)
  • packages/schema/src/language-server/validator/datamodel-validator.ts (4 hunks)
  • packages/schema/tests/schema/validation/datamodel-validation.test.ts (2 hunks)
🧰 Additional context used
🔇 Additional comments (1)
packages/schema/src/language-server/validator/datamodel-validator.ts (1)

144-147: Early return in parseRelation method simplifies control flow

The early return when both fields and references are absent correctly simplifies the method and avoids unnecessary validation, ensuring that only relevant cases are processed further.

Also applies to: 149-152

@ymc9 ymc9 merged commit ed6ea50 into dev Oct 21, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/wrong-self-relation-check branch October 21, 2024 01:12
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