fix(schema): proper minLength, maxLength in generated schemas.

[superstas]

It fixes #512

Summary by CodeRabbit

• New Features

  • Enhanced schema handling to conditionally assign minimum and maximum length constraints based on tag presence, providing more flexible schema definitions.

• Tests

  • Introduced new test cases for custom length constraints on strings, validating functionality across various scenarios, including slices and pointer fields.

[coderabbitai]

Walkthrough

The SchemaFromField function in schema.go has been enhanced to conditionally assign minLength and maxLength fields based on the presence of tags, promoting consistent schema generation. Additionally, schema_test.go introduces new types and test cases aimed at validating these adjustments, specifically for strings with custom length constraints.

Changes

File	Change Summary
schema.go	Modified SchemaFromField for conditional assignment of minLength and maxLength fields.
schema_test.go	Added TypedStringWithCustomLength type and corresponding test cases for length constraints.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure consistent schema generation for special string types (#512)	✅
Validate custom length constraints for fields and slices (#512)	✅

In the code where schemas grow,
Min and max now ebb and flow.
Strings with lengths both near and far,
Are tested well, like shining stars.
Consistency's the name we sing,
As changes to the schemas bring. 🐇✨

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 9bf5661 and 2cd3b69.

Files selected for processing (2)

• schema.go (1 hunks)
• schema_test.go (2 hunks)

Additional comments not posted (7)

schema.go (2)

558-560: Conditional assignment for minLength looks good.

The conditional assignment ensures that minLength is only set if the tag is present, which aligns with the intended behavior.

---

562-564: Conditional assignment for maxLength looks good.

The conditional assignment ensures that maxLength is only set if the tag is present, which aligns with the intended behavior.

schema_test.go (5)

76-77: New type TypedStringWithCustomLength looks good.

The type definition is straightforward and prepares for the custom schema method.

---

78-85: Custom schema method for TypedStringWithCustomLength looks good.

The method correctly defines a schema with minLength and maxLength constraints.

---

860-880: Test case for field-custom-length-string-in-slice looks good.

The test case correctly validates the schema generation for a slice of TypedStringWithCustomLength with minLength and maxLength constraints.

---

882-898: Test case for field-custom-length-string looks good.

The test case correctly validates the schema generation for a field of TypedStringWithCustomLength with minLength and maxLength constraints.

---

900-916: Test case for field-ptr-to-custom-length-string looks good.

The test case correctly validates the schema generation for a pointer to TypedStringWithCustomLength with minLength and maxLength constraints.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.83%. Comparing base (9bf5661) to head (c69a113).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #513   +/-   ##
=======================================
  Coverage   92.83%   92.83%           
=======================================
  Files          22       22           
  Lines        3838     3840    +2     
=======================================
+ Hits         3563     3565    +2     
  Misses        230      230           
  Partials       45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[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 2cd3b69 and c69a113.

Files selected for processing (1)

• schema_test.go (2 hunks)

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

• schema_test.go

[danielgtaylor]

Nice find, thanks for the fix 👍