Skip to content
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

fix: marking visited types in findInType #641

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

danielgtaylor
Copy link
Owner

@danielgtaylor danielgtaylor commented Nov 6, 2024

This fixes a bug where findInType would skip fields of a type it had already seen, when the correct behavior is only to skip fields in a recursive chain it had already seen. This moves the visited map modification tightly around the recursive case and adds a test to ensure multiple defaults for the same type used in different fields are indeed set correctly.

Fixes #630.

Summary by CodeRabbit

  • New Features

    • Enhanced parameter finding and validation logic for nested and complex types.
    • Introduced a new struct with default field values for improved request handling.
  • Bug Fixes

    • Improved handling of visited types to prevent infinite loops during recursive processing.
    • Enhanced error handling and validation checks for parameters.
  • Tests

    • Added tests for new struct behavior and default values, ensuring correct integration with request bodies and middleware.

Copy link

coderabbitai bot commented Nov 6, 2024

Walkthrough

The changes in this pull request primarily involve modifications to the huma.go and huma_test.go files. The findInType function's logic has been refined to improve how struct fields are processed, particularly concerning visited types and error handling. Additionally, a new struct StructWithDefaultField has been introduced in the test file to validate default values in request bodies, enhancing the testing of middleware and parameter handling.

Changes

File Change Summary
huma.go Updated findInType function logic for handling visited types and improved error handling. Modified Every method in findResult struct for better invalid value handling.
huma_test.go Added StructWithDefaultField struct for testing default values in request bodies. Enhanced test cases for middleware and parameter validation.

Assessment against linked issues

Objective Addressed Explanation
Ensure default values are set correctly for nested structs (issue #630)

Possibly related PRs

🐇 In the code where structs reside,
Defaults now set with pride.
Fields once lost, now found anew,
Huma's logic shines right through!
Tests are strong, no need to fret,
Nested defaults? You can bet! 🥕


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

Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.70%. Comparing base (a74067b) to head (3b66c5c).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #641   +/-   ##
=======================================
  Coverage   92.70%   92.70%           
=======================================
  Files          22       22           
  Lines        4879     4880    +1     
=======================================
+ Hits         4523     4524    +1     
  Misses        308      308           
  Partials       48       48           

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a74067b and 3b66c5c.

📒 Files selected for processing (2)
  • huma.go (1 hunks)
  • huma_test.go (3 hunks)
🔇 Additional comments (2)
huma_test.go (2)

75-77: LGTM: Well-structured struct definition.

The struct follows Go conventions and has appropriate JSON tags and default value configuration.


Line range hint 635-649: LGTM: Comprehensive test coverage for default values.

The test case effectively verifies that default values are correctly set for multiple instances of the same struct type, which directly addresses the issue described in #630. The test is well-documented and includes clear assertions.

huma.go Show resolved Hide resolved
@danielgtaylor danielgtaylor merged commit d5a374c into main Nov 7, 2024
7 checks passed
@danielgtaylor danielgtaylor deleted the fix-find-in-type-visited branch November 7, 2024 21:46
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.

default tag sets default correctly on first nested object but not the second
1 participant