feat(resources-introspection): initial support for route and HTTP method introspection #3594
Conversation
…oval and fix test failures
…nto introspection
…nto introspection
…nto introspection
|
Hi, @robjtede Here's a limited-scope approach for listing routes and methods from the Please review and let me know your thoughts! |
… usage - Added `GuardDetail` enum to encapsulate various introspection details of a guard. - Refactored `HttpMethodsExtractor` implementation to use `GuardDetail` instead of `downcast_ref`.
… usage - Added `GuardDetail` enum to encapsulate various introspection details of a guard. - Refactored `HttpMethodsExtractor` implementation to use `GuardDetail` instead of `downcast_ref`.
…nto introspection
| @@ -128,6 +128,9 @@ compat = [ | |||
| # Opt-out forwards-compatibility for handler visibility inheritance fix. | |||
| compat-routing-macros-force-pub = ["actix-web-codegen?/compat-routing-macros-force-pub"] | |||
|
|
|||
| # Enabling the retrieval of metadata for initialized resources, including path and HTTP method. | |||
| resources-introspection = [] | |||
There was a problem hiding this comment.
Can you suggest a better name for the feature flag? Another option could be experimental-introspection to better reflect its current state of development. Open to other naming suggestions that capture the intent of the feature.
| @@ -105,6 +126,11 @@ where | |||
| let rmap = Rc::new(rmap); | |||
| ResourceMap::finish(&rmap); | |||
|
|
|||
| #[cfg(feature = "resources-introspection")] | |||
| { | |||
| crate::introspection::process_introspection(Rc::clone(&rmap), rdef_methods); | |||
There was a problem hiding this comment.
Surely there is a better place to make the call to introspection::process_introspection. This observation applies to all locations where I am currently making this call, including scope.rs, route.rs, resource.rs, and app_service.rs. Given some time, I can improve this implementation, always aiming to minimize breaking changes. Any ideas?
dertin
changed the title
PR Type
Feature
PR Checklist
Overview
Hello, this is my first contribution to the project. This PR introduces a new resource introspection feature for actix-web that allows retrieving all configured route paths along with their associated HTTP methods after the server has started. Currently, it supports only basic
Guardsthat determine HTTP methods. The feature is activated using theresources-introspectionfeature flag.The main method is
actix_web::introspection::get_registered_resources(), which returns a vector ofResourceIntrospectionobjects. This method can be executed in an async task alongside the actix-web server or on a separate thread.I developed this feature because it's extremely useful for auditing services with many route paths that change constantly. I hope it proves valuable for others as well, and I welcome any feedback or suggestions for improvement.
Closes #1462
Closes #2677