fix(cli): fixes the issue that enhancer ignores zod schemas if it's explicitly configured in ZModel

[ymc9]

Fixes #1562

[coderabbitai]

Walkthrough

Walkthrough

The changes made enhance the PluginRunner class to ensure Zod schemas are loaded correctly based on validation rules. The loadSchema function has been simplified by removing unnecessary parameters, streamlining its input handling. Additionally, a regression test was added to validate that the integration of the enhancer plugin does not interfere with the validation checks enforced by the Zod plugin. These modifications collectively improve the robustness and clarity of the schema loading process.

Changes

File(s)	Change Summary
packages/schema/src/cli/plugin-runner.ts	Enhanced PluginRunner to conditionally load Zod schemas based on validation rules, ensuring that existing and new enhancers respect the withZodSchemas option.
packages/testtools/src/schema.ts	Simplified loadSchema function by removing unnecessary parameters (policy, modelMeta, zodSchemas) from the options object, improving clarity and performance.
tests/regression/tests/issue-1562.test.ts	Introduced regression test for issue 1562, validating that the addition of the enhancer plugin does not disable regex validation on the User.name field in the schema.

Assessment against linked issues

Objective	Addressed	Explanation
Validate that adding the enhancer plugin does not break validation checks for the Zod plugin (#[1562])	✅
Ensure that Zod schemas are loaded based on presence of validation rules (#[1562])	✅
Simplify the loadSchema function to enhance usability and clarity (#[1562])	✅
Confirm that the previous functionality of validation checks is maintained post-changes (#[1562])	❓	Impact on existing validation checks needs further verification.

---

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

[coderabbitai]

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 3d7678a and f47c1d4.

Files selected for processing (3)

• packages/schema/src/cli/plugin-runner.ts (1 hunks)
• packages/testtools/src/schema.ts (1 hunks)
• tests/regression/tests/issue-1562.test.ts (1 hunks)

Additional comments not posted (3)

tests/regression/tests/issue-1562.test.ts (1)

1-45: LGTM! Ensure the schema is loaded correctly.

The new regression test case for issue #1562 is well-structured and covers the necessary aspects to validate the fix. Ensure that the loadSchema function correctly loads the schema and that the enhance plugin works as expected with the zod plugin.

To verify the correctness of the schema loading, you can run the test case and ensure it passes.

packages/testtools/src/schema.ts (1)

Line range hint 1-1:
LGTM! Verify the function's correctness.

The loadSchema function has been simplified by removing the policy, modelMeta, and zodSchemas parameters from the destructured options object. Ensure that the function still operates correctly without these parameters.

To verify the function's correctness, you can run the test cases that involve the loadSchema function and ensure they pass.

packages/schema/src/cli/plugin-runner.ts (1)

186-194: LGTM! Verify the schema loading logic.

The PluginRunner class has been enhanced to ensure that Zod schemas are loaded appropriately based on the presence of validation rules. This improves the plugin's adaptability to different validation scenarios.

To verify the correctness of the schema loading logic, you can run the test cases that involve the PluginRunner class and ensure they pass.