fix(zod): generated schemas fail to compile when a delegate discrimin ator field has default value

[ymc9]

Fixes #1693

[coderabbitai]

Walkthrough

Walkthrough

The changes in this pull request focus on improving the handling of discriminator fields in the schema generation logic for the ZenStack framework. Key modifications include renaming variables for clarity and adjusting logic to ensure proper exclusion of discriminator fields from mutation schemas and optional fields. Additionally, a new regression test has been introduced to validate the schema loading functionality, particularly in the context of model inheritance and delegation.

Changes

File	Change Summary
packages/schema/src/plugins/zod/generator.ts	Renamed delegateFields to delegateDiscriminatorFields for clarity; adjusted logic to manage discriminator fields in schema generation.
tests/regression/tests/issue-1693.test.ts	Added a regression test to validate schema loading functionality with inheritance and delegation.

Assessment against linked issues

Objective	Addressed	Explanation
Typescript types broken on Zod schema plugin on delegated tables (1693)	✅

Possibly related PRs

• fix(zod): support @default for BigInt values #1486: Addresses handling of default values for BigInt fields in Zod schemas, relevant to schema generation logic.
• fix(delegate): generated logical prisma schema has errors when abstra… #1490: Modifies logic for processing inherited fields in the schema, related to the treatment of discriminator fields.
• fix(zmodel): fields from base model cannot be accessed from future(). #1704: Fixes issues with accessing fields from a base model in the context of future(), pertinent to schema generation and validation.

---

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

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

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

1-20: Add assertions to strengthen the test case.

The test case is well-structured and effectively reproduces the scenario related to issue #1693. However, to provide better coverage and ensure the correctness of the fix, consider adding assertions to verify the following:

1. The schema is loaded successfully without any compilation errors.
2. The generated Zod schemas for the Animal and Dog models have the expected structure and field types.
3. The default value for the animalType field is correctly applied in the generated Zod schema.

By including these assertions, the test case will not only ensure that the schema loading process completes without errors but also validate that the generated Zod schemas are accurate and match the expected behavior.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1395892 and bf039c7.

Files selected for processing (2)

• packages/schema/src/plugins/zod/generator.ts (2 hunks)
• tests/regression/tests/issue-1693.test.ts (1 hunks)

Additional comments not posted (2)

packages/schema/src/plugins/zod/generator.ts (2)

373-376: LGTM!

The renaming of delegateFields to delegateDiscriminatorFields improves clarity by emphasizing that the variable specifically pertains to discriminator fields. The logic correctly ensures that only the relevant discriminator fields are excluded from mutation schemas.

---

488-492: LGTM!

The adjustment to the logic for marking fields with defaults as optional correctly filters out discriminator fields from being made partial. This change ensures that the schema remains valid and compiles correctly, as the discriminator fields are omitted from the base schema.