Add Find to Routes interface

[joeriddles]

Background

I am working on adding a middleware for OpenTelemetry to a Chi-based service that needs to send a metric before the request has executed. We need to include a string for the API endpoint, like the route pattern, in the metric. This is currently not possible due to the way request route patterns are resolved using Chi's trie-based router, as noted by the maintainer in this issue #692 (comment).

Description

This PR proposes adding a Find function to the Routes interface. This Find method closely mirrors the Match function that already exists. Unlike Match, which returns a boolean value if a route exists for the path/HTTP method combination, Find returns the pattern that was matched.

Unit tests have been added for Find, as well as new tests added for Match. I refactored Match to use Find under the hood, since they are both doing almost the same thing.

This PR also adds a new middleware, FindPattern, which allows the user to pass a callback function that will receive the fully resolved route pattern from the HTTP request.

Examples

A basic example of using Find in a middleware before the request is handled can be found here: https://github.com/joeriddles/chi-api-middleware, specifically this function https://github.com/joeriddles/chi-api-middleware/blob/main/main.go#L37.

A smaller example has also been added to the _examples folder.

[Pipello]

That's cool feature 💯

[pkieltyka]

hi @joeriddles what will be the official middleware repo for your package?

[joeriddles]

Thanks for the review @pkieltyka! I have renamed the file and variables you requested in this commit: 5cf9bc3

hi @joeriddles what will be the official middleware repo for your package?

Do you mean I should add a new middleware file, like middlewares/find.go? I can add something like this that allows the user to pass a function that should be called with the found route pattern.

[joeriddles]

@pkieltyka I have added a new middleware here: f6c1df8. I also updated the example I added to use the new FindPattern middleware. Thanks again for reviewing!

[casoetan]

👀 🙌🏾

[batazor]

any news?