fix: support non-addressable resolver values

[danielgtaylor]

This fixes a bug where non-addressable values which implement resolver types could not be used.

Fixes #558

Summary by CodeRabbit

• New Features

  • Improved handling of resolvers in the registration process for better robustness.
  • Introduced a new custom type, CustomMapValue, enhancing API capabilities to handle specific data types.

• Tests

  • Added tests to validate the behavior of the new custom type and ensure type safety in API requests.

[coderabbitai]

Walkthrough

The changes in this pull request enhance the handling of resolvers in the Register function by improving how addressability is determined for items. A new pointer is created for non-addressable items, allowing resolvers to be invoked correctly. Additionally, a new custom type CustomMapValue is introduced, which implements a Resolve method. A corresponding test function validates the API's handling of this type, ensuring robustness and type safety.

Changes

Files	Change Summary
huma.go, huma_test.go	Enhanced resolver handling by creating pointers for non-addressable items; introduced CustomMapValue type with a Resolve method and added a test function for API validation.

Assessment against linked issues

Objective	Addressed	Explanation
Faced unexpected panicking on types with Resolve implementation (#558)	✅

Possibly related PRs

• Allow using pointers for non param fields in input structs #565: This PR also enhances the handling of pointers within the resolver mechanism, indicating a shared goal of improving pointer management in the Huma framework.

Suggested reviewers

• danielgtaylor

Poem

In the garden where bunnies hop,
Resolvers now won't ever stop!
With pointers made for every type,
Our code is clean, it feels just right.
Custom values, we cheer and play,
Hooray for changes, hip-hip-hooray! 🐇✨

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.78%. Comparing base (3649df3) to head (40fddbd).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #580      +/-   ##
==========================================
+ Coverage   92.76%   92.78%   +0.01%     
==========================================
  Files          22       22              
  Lines        3886     3893       +7     
==========================================
+ Hits         3605     3612       +7     
  Misses        236      236              
  Partials       45       45              

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

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3649df3 and 40fddbd.

Files selected for processing (2)

• huma.go (1 hunks)
• huma_test.go (1 hunks)

Additional comments not posted (2)

huma_test.go (2)

2280-2284: LGTM!

The definition of CustomMapValue as a string type and its Resolve method appropriately handle non-addressable values implementing resolver types.

---

2286-2299: Test effectively verifies handling of non-addressable resolver values.

The TestResolverCustomTypePrimitive function correctly tests that non-addressable values implementing resolver types do not cause a panic, addressing issue #558.