Skip to content

fix(zod): Required fields with a default value should be optional in Typed JSON cases #2044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025

Conversation

diesal11
Copy link
Contributor

I believe this is just an edge case with Typed JSON fields again, but it did surface what appears to be a legitimate bug in the zod generator code. So I've tidied that section up slightly to fix the issue and improve readability a touch.

Apologies for not catching this with the last PR.

Copy link
Contributor

coderabbitai bot commented Mar 13, 2025

📝 Walkthrough

Walkthrough

The changes refactor the logic in the Transformer class’s generateObjectSchemaField method. Optionality is now handled in a separate conditional block after the initial schema string assignment, rather than being appended immediately. Additionally, assignment for single alternatives is simplified to directly use the first alternative. A new integration test was also introduced to verify that JSON fields with default values are treated as optional in the generated Zod schemas.

Changes

File(s) Summary
packages/schema/src/plugins/zod/transformer.ts Refactored the generateObjectSchemaField method to separate optionality handling from alternative assignment and simplified assignment logic when a single alternative exists.
tests/integration/tests/plugins/zod.test.ts Added a new test case to ensure that JSON fields with default values are correctly treated as optional in the generated Zod schemas.

Sequence Diagram(s)

sequenceDiagram
    participant T as Transformer
    participant F as Field Metadata
    participant S as Schema String

    T->>F: Receive field information
    alt Single Alternative
        T-->>S: Directly assign the alternative to schema string
    else Multiple Alternatives
        T-->>S: Join alternatives into schema string
    end
    T->>S: Check if field.isRequired is false
    alt Field is Optional
        T-->>S: Append ".optional()" to schema string
    end
    T-->>F: Return constructed schema string
Loading

Possibly related PRs

Suggested Reviewers

  • ymc9

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a4acf35 and f642aff.

📒 Files selected for processing (2)
  • packages/schema/src/plugins/zod/transformer.ts (1 hunks)
  • tests/integration/tests/plugins/zod.test.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: OSSAR-Scan
🔇 Additional comments (2)
packages/schema/src/plugins/zod/transformer.ts (1)

286-301: Improved logic for handling field optionality.

The refactoring properly separates schema creation from optionality handling, making the code more maintainable and fixing the bug where JSON fields with default values weren't properly marked as optional. Now, the .optional() property is consistently applied in a separate conditional block after the schema string is assigned.

The simplification for single alternatives is also a good improvement - directly using the first alternative instead of unnecessary string operations.

tests/integration/tests/plugins/zod.test.ts (1)

1101-1123: Good test coverage for the fixed bug.

This test case effectively verifies that fields marked with @json and having @default values are correctly treated as optional in the generated Zod schemas. The test creates a model with JSON fields that have default values and then confirms that the schema can successfully parse an empty object, demonstrating the fields are properly optional.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
  • @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.

@diesal11 diesal11 changed the title fix(zod): Required fields with a default value should be optional fix(zod): Required fields with a default value should be optional in Typed JSON cases Mar 13, 2025
@diesal11 diesal11 changed the base branch from main to dev March 13, 2025 13:01
Copy link
Member

@ymc9 ymc9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @diesal11 . The change looks good to me. It'll be part of the next release!

@ymc9 ymc9 merged commit 606adb5 into zenstackhq:dev Mar 18, 2025
11 checks passed
@diesal11 diesal11 deleted the fix/issue-2044 branch March 22, 2025 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants