feat: add request remote address to context

danielgtaylor commented 4 months ago

Based on several user requests, this adds access to the remote address from the client request to the Huma context so you can use it in middleware and resolvers.

Fixes #445.

Summary by CodeRabbit

New Features
- Added the ability to retrieve the remote address of the client in various context structs across multiple adapters.
- Introduced a new RemoteAddr() method to the Context interface, enhancing the ability to access the client's remote address.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent changes introduce a new method RemoteAddr() to various context structs across multiple files. This method allows retrieving the remote address of the client making the request. Additionally, the RemoteAddr() method has been added to the Context interface, ensuring a consistent way to access the client's remote address across different implementations.

Changes

Files	Change Summary
`adapters/humabunrouter/humabunrouter.go`	Added `RemoteAddr()` method to `bunContext` and `bunCompatContext` structs.
`adapters/humachi/humachi.go`	Added `RemoteAddr()` method to `chiContext` struct.
`adapters/humaecho/humaecho.go`	Added `RemoteAddr()` method to `echoCtx` struct.
`adapters/humafiber/humafiber.go`	Added `RemoteAddr()` method to `fiberCtx` struct.
`adapters/humaflow/humaflow.go`	Added `RemoteAddr()` method to `goContext` struct.
`adapters/humagin/humagin.go`	Added `RemoteAddr()` method to `ginCtx` struct.
`adapters/humago/humago.go`	Added `RemoteAddr()` method to `goContext` struct.
`adapters/humahttprouter/humahttprouter.go`	Added `RemoteAddr()` method to `httprouterContext` struct.
`adapters/humamux/humamux.go`	Added `RemoteAddr()` method to `gmuxContext` struct.
`api.go`	Added `RemoteAddr()` method to the `Context` interface, allowing all context implementations to retrieve the client’s remote address.

Assessment against linked issues

Objective	Addressed	Explanation
Provide a way to get the client's remote address from `huma.Context` (#445)	✅

In the world of code, where bytes do race,
A rabbit hops with gentle grace.
Remote addresses now in sight,
Contexts gleam with newfound light.
From bun to mux, the change is clear,
The client's path is now held dear.
With every hop, the code's delight! 🌟

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.77%. Comparing base (1b6a3e5) to head (48c4d1a).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #447 +/- ## ======================================= Coverage 92.77% 92.77% ======================================= Files 21 21 Lines 3571 3571 ======================================= Hits 3313 3313 Misses 220 220 Partials 38 38 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

danielgtaylor / huma