Skip to content

Add option to customize the Gorilla Mux route #810

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

Merged
merged 3 commits into from
May 9, 2025

Conversation

RangelReale
Copy link
Contributor

This MR adds an option to the Gorilla mux adapter, allowing customizing the mux route.

This allows, for example, adding standard HTTP handlers per route, maybe using huma.Operation.Metadata as input parameters.

@RangelReale
Copy link
Contributor Author

my usecase is using http.TimeoutHandler per route, it changes the ResponseWriter, so it is impossible to do with Huma middleware.

@danielgtaylor danielgtaylor requested a review from Copilot May 9, 2025 23:37
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds an option to customize the Gorilla mux route by introducing a new Option type and a WithRouteCustomizer function.

  • Introduces WithRouteCustomizer in options.go for customizing routes.
  • Embeds the options into the gMux struct in humamux.go and applies the route customizer in the Handle method.
  • Adds tests in humagmux_test.go to verify middleware customization.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
adapters/humamux/options.go Adds an Option type and WithRouteCustomizer for route customization.
adapters/humamux/humamux.go Updates the gMux struct to embed options and apply route customization in Handle.
adapters/humamux/humagmux_test.go Provides tests validating the custom middleware functionality.

Copy link

codecov bot commented May 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.08%. Comparing base (eb497ee) to head (73376c6).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #810   +/-   ##
=======================================
  Coverage   93.08%   93.08%           
=======================================
  Files          23       23           
  Lines        5307     5307           
=======================================
  Hits         4940     4940           
  Misses        314      314           
  Partials       53       53           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Owner

@danielgtaylor danielgtaylor left a comment

Choose a reason for hiding this comment

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

Thanks! 👍

@danielgtaylor danielgtaylor merged commit 21709a0 into danielgtaylor:main May 9, 2025
5 checks passed
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.

2 participants