fix(zmodel): clean up logic for detecting what attributes should be inherited from base models

[ymc9]

Fixes #1243

Summary by CodeRabbit

• New Features

  • Enhanced attribute filtering in base model merging to exclude certain inherited attributes and handle delegate scenarios more effectively.
  • Expanded search functionality in SDK utilities to include base models when identifying unique and ID fields.

• Bug Fixes

  • Refined merging logic to accurately exclude specific attribute types during inheritance.

• Tests

  • Added new test cases for handling multiple ID fields and uninheritable attributes in schemas.
  • Introduced regression tests related to specific inheritance issues in schemas.

[coderabbitai]

Walkthrough

Walkthrough

The recent code updates focus on refining inheritance and delegation mechanisms in schema models. Key enhancements include filtering inherited attributes, extending search functionalities for unique and ID fields in base models, and introducing tests for handling complex inheritance scenarios such as uninheritable fields and multiple ID fields.

Changes

File Path	Changes
.../ast-utils.ts	Updated mergeBaseModel to filter attributes using filterBaseAttribute, excluding certain inherited attributes and refining attribute merging logic.
.../utils.ts	Enhanced getModelIdFields and getModelUniqueFields to search for @@id and @@unique in base models.
.../abstract.test.ts & .../issue-1243.test.ts	Added tests for handling multiple ID fields and regression related to uninheritable fields.

Assessment against linked issues

Objective	Addressed	Explanation
Use @@map() without errors in delegating models (#1167)	❌	The changes do not address issues related to @@map() usage in delegating models.
Handle @@index with @@delegate without errors (#1243)	✅
Prevent cyclic dependencies in model inheritance (#1229)	❌	The changes do not include any mechanism for detecting or preventing cyclic dependencies.
Resolve validation error with multiple fields referencing the same model (#653)	❌	The changes do not address issues related to multiple fields referencing the same model.

Possibly related issues

• Issue Delegating models can't use @@map() #1167: Although the PR does not directly address @@map() errors with delegating models, the refinements in inheritance and delegation mechanisms could indirectly influence related functionalities.
• Issue Model inheritance doesn't check for cycles #1229: This issue could benefit from the tests added for complex inheritance scenarios, suggesting a potential link to the PR for further investigation into handling cyclic dependencies.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2a8db68 and 1d723b2.

Files selected for processing (4)

• packages/schema/src/utils/ast-utils.ts (3 hunks)
• packages/schema/tests/schema/abstract.test.ts (1 hunks)
• packages/sdk/src/utils.ts (1 hunks)
• tests/integration/tests/enhancements/with-delegate/issue-1243.test.ts (1 hunks)

Additional comments not posted (6)

tests/integration/tests/enhancements/with-delegate/issue-1243.test.ts (2)

3-29: The test case 'uninheritable fields' correctly sets up a schema with delegate and index attributes and tests the schema loading. Ensure that the schema defined matches the intended structure for the test.

---

31-54: The test case 'multiple id fields' is well-structured to test the handling of multiple ID fields in a base model. This is crucial for ensuring that the inheritance logic handles complex ID configurations correctly.

packages/schema/tests/schema/abstract.test.ts (1)

65-83: The new test case 'multiple id fields from base' effectively tests the handling of multiple ID fields in an abstract base model. This is important for ensuring that the schema logic correctly interprets and handles ID configurations in inheritance scenarios.

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

79-107: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [67-103]

The updated mergeBaseModel function and the new filterBaseAttribute function enhance the attribute inheritance logic by excluding specific attributes like @@delegate and @@map. This is crucial for preventing inheritance errors in delegate scenarios. The logic appears robust and well-suited for the intended enhancements.

packages/sdk/src/utils.ts (2)

179-199: The updated getModelIdFields function now correctly searches for @@id attributes in base models, which is essential for ensuring that all relevant ID fields are considered in the model's context. This change supports more robust model validation and handling.

---

203-223: Similarly, the getModelUniqueFields function has been enhanced to search for @@unique attributes in base models. This improvement is crucial for accurately identifying unique constraints across inherited models, thereby enhancing data integrity checks.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

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