fix(zmodel): check cyclic inheritance

[ymc9]

fixes #1229

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces enhanced validation for circular inheritance in data models. The changes span multiple files, focusing on detecting and preventing circular inheritance scenarios. A new method validateInheritance is added to the DataModelValidator class to perform breadth-first search and identify circular dependencies between data models. Corresponding test cases are added to verify the inheritance validation logic, and the getRecursiveBases utility function is updated to prevent infinite recursion during inheritance traversal.

Changes

File	Change Summary
packages/schema/src/language-server/validator/datamodel-validator.ts	Added validateInheritance method to check for circular inheritance in data models
packages/schema/tests/schema/validation/cyclic-inheritance.test.ts	Added test suite for validating circular inheritance scenarios in abstract and delegated models
packages/sdk/src/utils.ts	Updated getRecursiveBases function to prevent infinite recursion with a seen set parameter

Sequence Diagram

sequenceDiagram
    participant DM as DataModelValidator
    participant Utils as RecursiveBasesUtil
    participant Model as DataModel

    DM->>Model: Start inheritance validation
    Model-->>DM: Provide super types
    DM->>Utils: Get recursive base models
    Utils->>Utils: Track seen models
    Utils-->>DM: Return base models
    DM->>DM: Check for circular inheritance
    alt Circular Inheritance Detected
        DM->>DM: Report validation error
    end

Loading

Possibly Related PRs

• fix(cli): regular relation fields are incorrectly recognized as self-relation #1790: Modifications to DataModelValidator class validation logic
• feat: support @@validate in type declarations #1868: Function invocation validation changes
• feat(zmodel): add new functions currentModel and currentOperation #1925: New validation functions for model operations

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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:

‼️ 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

547-564: Consider clarifying recursion approach and naming

The new seen set parameter works well to prevent infinite recursion. One minor enhancement is to rename seen to visited and mention in a docstring that this is effectively a DFS traversal for clarity.

packages/schema/src/language-server/validator/datamodel-validator.ts (1)

414-433: Validate edge cases when superType references are undefined

The BFS-like approach to detect circular inheritance works well. However, consider gracefully handling cases where superType.ref might be undefined (e.g., if references are unresolved for any reason). Doing so can prevent possible runtime errors in rare scenarios.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f609c86 and 285cd43.

📒 Files selected for processing (3)

• packages/schema/src/language-server/validator/datamodel-validator.ts (2 hunks)
• packages/schema/tests/schema/validation/cyclic-inheritance.test.ts (1 hunks)
• packages/sdk/src/utils.ts (1 hunks)

🔇 Additional comments (2)

packages/schema/tests/schema/validation/cyclic-inheritance.test.ts (1)

1-39: Tests cover circular inheritance effectively

Both test cases provide robust coverage for detecting circular inheritance. The use of toContain with the expected error messages is straightforward and ensures that the error output is validated properly. Overall, this test suite is well-structured and accurate.

packages/schema/src/language-server/validator/datamodel-validator.ts (1)

36-39: Inheritance check trigger is correct

Invoking validateInheritance only when superTypes.length > 0 is an efficient check. This ensures we skip unnecessary processing for models without super types.