fix(zmodel): member access from auth() is not properly resolved when the auth model is imported

[ymc9]

• Fixes auth() with import causes linking-error #1257
• Improve CLI error reporting

Summary by CodeRabbit

• Refactor

  • Enhanced error handling and diagnostic processing in CLI utilities.
  • Improved reference error handling in expression validation.
  • Updated data retrieval logic in schema validation to include imports.

• New Features

  • Introduced better handling of data and authentication models in language server tools.

• Bug Fixes

  • Refined error messages in attribute validation tests for clearer reference resolution failures.

• Tests

  • Added a new integration test case to ensure proper loading of schemas with complex imports and definitions.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes encompass improvements in schema definition, error handling, and validation logic across various modules. These enhancements focus on refining error messages, diagnostic processing, and import handling to bolster the robustness and clarity of the codebase.

Changes

File Path	Change Summary
.../prisma/schema.prisma	Indentation reformatting, alignment adjustments, and field reordering in User and Post models.
.../cli/cli-util.ts	Enhanced diagnostic processing in the loadDocument function.
.../validator/expression-validator.ts	Updated error handling for reference resolution in expressions.
.../validator/schema-validator.ts	Improved import handling in the SchemaValidator class.
.../language-server/zmodel-linker.ts	Enhanced data model and authentication model handling.
.../utils/ast-utils.ts	Renamed and added functions for better declaration and data model handling.
.../tests/schema/validation/attribute-validation.test.ts	Updated an error message in an attribute validation test.
.../tests/regression/issue-1257.test.ts	Added a test case for loading schemas with imports and definitions related to user roles and database configuration.

Assessment against linked issues

Objective	Addressed	Explanation
Allow auth() fields to resolve when User model is imported (#1257)	✅
Ensure that fields like createdBy, updatedBy, and author can reference User model (#653)	❌	No changes related to multiple field references to the same model were noted in the PR.
Fix errors related to @@map() with delegating models (#1167)	❌	The PR does not address issues with @@map() or delegation setup in models.
Address auth() expressions in access policy rules and user context object handling (#820)	❌	The changes do not cover enhancements to auth() expressions or user context object handling.

Possibly related issues

• Zenstack does not let me define multiple fields that are referencing the same model #653: Although not directly addressed, the focus on schema validation and import handling might indirectly influence future resolutions for multiple model references.
• Delegating models can't use @@map() #1167: Given the focus on schema and validation, future updates might consider addressing delegation errors.
• [Feature Request] Automatically do a database fetch if the policy rules use fields not provided in the user context object #820: Enhancements to auth() function handling in this PR could lay groundwork for resolving issues with auth() expressions in access policy rules.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 4a2681e and 8962e89.

Files selected for processing (2)

• packages/schema/src/language-server/zmodel-scope.ts (5 hunks)
• tests/integration/tests/regression/issue-756.test.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• packages/schema/src/language-server/zmodel-scope.ts

Additional comments not posted (1)

tests/integration/tests/regression/issue-756.test.ts (1)

31-31: The updated error message is more specific and informative, which should help in diagnosing the issue more effectively.

---

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.