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

feat: add request remote address to context #447

Merged
merged 1 commit into from
May 20, 2024
Merged

Conversation

danielgtaylor
Copy link
Owner

@danielgtaylor danielgtaylor commented May 20, 2024

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.

Copy link

coderabbitai bot commented May 20, 2024

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

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 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 May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #447   +/-   ##
=======================================
  Coverage   92.77%   92.77%           
=======================================
  Files          21       21           
  Lines        3571     3571           
=======================================
  Hits         3313     3313           
  Misses        220      220           
  Partials       38       38           

☔ 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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1b6a3e5 and 48c4d1a.
Files selected for processing (10)
  • adapters/humabunrouter/humabunrouter.go (2 hunks)
  • adapters/humachi/humachi.go (1 hunks)
  • adapters/humaecho/humaecho.go (1 hunks)
  • adapters/humafiber/humafiber.go (1 hunks)
  • adapters/humaflow/humaflow.go (1 hunks)
  • adapters/humagin/humagin.go (1 hunks)
  • adapters/humago/humago.go (1 hunks)
  • adapters/humahttprouter/humahttprouter.go (1 hunks)
  • adapters/humamux/humamux.go (1 hunks)
  • api.go (1 hunks)
Additional comments not posted (11)
adapters/humamux/humamux.go (1)

46-48: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humahttprouter/humahttprouter.go (1)

48-50: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humachi/humachi.go (1)

46-48: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humagin/humagin.go (1)

45-47: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humaecho/humaecho.go (1)

45-47: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humafiber/humafiber.go (1)

46-48: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humaflow/humaflow.go (1)

44-46: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humago/humago.go (1)

46-48: Implementation of RemoteAddr() correctly returns the remote address from the HTTP request.

adapters/humabunrouter/humabunrouter.go (2)

48-50: The implementation of RemoteAddr() in bunContext is straightforward and correctly retrieves the remote address from the request.


138-140: The implementation of RemoteAddr() in bunCompatContext is consistent with bunContext, correctly retrieving the remote address from the request.

api.go (1)

75-77: The addition of RemoteAddr() to the Context interface aligns with the PR objectives and correctly provides a method to access the client's remote address.

@danielgtaylor danielgtaylor merged commit b318810 into main May 20, 2024
4 checks passed
@danielgtaylor danielgtaylor deleted the ctx-remote-addr branch May 20, 2024 16:53
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.

Any sample code to get http.Request.RemoteAddr in huma.context
1 participant