Fix required tag interpretation for map fields by hi-rai · Pull Request #15 · Hypersequent/zen

hi-rai · 2025-03-17T10:11:22Z

By default map fields are considered nullable. With 'required', they are not nullable but can be empty. But the current implementation enforced 'required' maps to be non-empty.

Summary by CodeRabbit

Refactor
- Streamlined validation by removing redundant checks for collection requirements, ensuring that map validations now only enforce minimum and maximum size constraints.
Tests
- Updated tests to align with the simplified validation rules.

By default map fields are considered nullable. With 'required', they are not nullable but can be empty. But the current implementation enforced 'required' maps to be non-empty.

coderabbitai · 2025-03-17T10:11:32Z

Walkthrough

The changes remove specific validation checks for the "required" tag in both the primary validation logic and its tests. Specifically, in zod.go, the switch-case branch for "required" validation in arrays/slices and the additional non-empty map check are eliminated. In zod_test.go, the validations for the Map and MetadataLength fields are updated to remove non-empty checks, retaining only the necessary length constraints.

Changes

File(s)	Change Summary
`zod.go`	Removed "required" tag handling from slice/array switch-case and eliminated non-empty map refinement.
`zod_test.go`	Simplified validations: removed the non-empty refinement for the `Map` field in `RequiredSchema` and for the `MetadataLength` field in `UserSchema`, now relying solely on length constraints.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Validation Caller
    participant Validator as zod.go Validator
    participant TestSuite as zod_test.go Tests

    Caller->>Validator: Request field validation ("required" tag)
    Validator->>Validator: Process validation tags (switch-case)
    Note right of Validator: "required" branch removed
    Validator->>Caller: Return default validation result
    TestSuite->>Validator: Execute schema validations (Map & MetadataLength)
    Validator->>TestSuite: Return simplified validation outcomes

Possibly related PRs

Add support for custom validation tags #14: Addresses similar changes in test cases by simplifying validations for maps, closely aligning with the modifications here.
Remove nonempty() for required slice fields #13: Involves the removal of "required" tag validation for collection fields, mirroring the changes implemented in the main PR.

Suggested reviewers

ramilamparo
gornostay25
ElenaGrasovskaya
satvik007

Poem

I'm a rabbit hopping by,
Code paths clear beneath the sky.
"Required" checks have hopped away,
Leaving simpler rules to play.
Carrots crunch and code runs free—yay!
Happy hops and streamlined spree!
🥕🐇

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 3da7737 and fbdb02a.

📒 Files selected for processing (2)

zod.go (0 hunks)
zod_test.go (2 hunks)

💤 Files with no reviewable changes (1)

zod.go

🔇 Additional comments (2)

zod_test.go (2)

1333-1333: Properly fixed the 'required' tag interpretation for map fields

The removal of the non-emptiness check (refine((val) => Object.keys(val).length > 0, 'Empty map')) correctly implements the intended behavior for the 'required' tag on map fields. Now, a 'required' map field means it should not be nullable but can still be empty, which aligns with the expected behavior.

1723-1723: Removed redundant non-emptiness check on MetadataLength validation

Correctly removed the redundant non-emptiness check while preserving the meaningful constraints. The field still validates that the map has at least 1 item and at most 10 items, but no longer has the additional check that was redundant with the minimum length validation.

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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.

hi-rai · 2025-03-17T10:12:25Z

zod.go

 		} else {
 			if valValue != "" {
 				switch valName {
-				case "required":


This was missed in the previous refactoring (it is not expected here as required tag doesn't have a value)

satvik007

Thanks @hi-rai
Not sure how I got it wrong in the very beginning.

Fix required tag interpretation for map fields

fbdb02a

By default map fields are considered nullable. With 'required', they are not nullable but can be empty. But the current implementation enforced 'required' maps to be non-empty.

hi-rai requested review from AndrianBdn and satvik007 March 17, 2025 10:11

hi-rai self-assigned this Mar 17, 2025

hi-rai commented Mar 17, 2025

View reviewed changes

satvik007 approved these changes Mar 17, 2025

View reviewed changes

hi-rai merged commit f521ea1 into main Mar 17, 2025
1 check passed

hi-rai deleted the fix-required-map-fields branch March 17, 2025 11:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix required tag interpretation for map fields#15

Fix required tag interpretation for map fields#15
hi-rai merged 1 commit intomainfrom
fix-required-map-fields

hi-rai commented Mar 17, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Mar 17, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

hi-rai Mar 17, 2025

Uh oh!

satvik007 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

hi-rai commented Mar 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

hi-rai Mar 17, 2025

Choose a reason for hiding this comment

Uh oh!

satvik007 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hi-rai commented Mar 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)