Make TrieRouter register/unregister receive URLs 📒
#246
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When we updated `Router` and ``RouteHandler` to have an additional `R: Routable` associated type, we also migrated all public `TrieRouter` APIs to receive an `R` instance, replacing `URL`. However, the main purpose of the new `R: Routable` is to allow having more data when effectively _being routed_ (i.e. in `route()`), and not on all other "events", like registering/unregistering routes. So, if we for instance define `R` as being some sort of HTTP request type (which makes total sense to be routed), it doesn't make much sense to use that same type to register/unregister routes, because it forces us to create "dummy" requests only for those purposes. With that in mind, `TrieRouter` `register()` and `unregister()` now expect (annotated) URLs like before, and only receive an `R` instance in `route()`. ## Changes - Update `TrieRouter` `register()` and `unregister()` receive a `URL` route. - Update some `TrieRouter` public API documentation.
filipe-lemos
approved these changes
Sep 1, 2021
Codecov Report
@@ Coverage Diff @@
## master #246 +/- ##
=======================================
Coverage 94.94% 94.94%
=======================================
Files 97 97
Lines 3266 3266
=======================================
Hits 3101 3101
Misses 165 165
Continue to review full report at Codecov.
|
|
Thanks for the supersonic review @filipe-lemos! 🙇🏼 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
masterMotivation and Context
When we updated
RouterandRouteHandlerto have an additionalR: Routableassociated type, we also migrated all publicTrieRouterAPIs to receive anRinstance, replacingURL.However, the main purpose of the new
R: Routableis to allow having more data when effectively being routed (i.e. inroute()), and not on all other "events", like registering/unregistering routes.So, if we for instance define
Ras being some sort of HTTP request type (which makes total sense to be routed), it doesn't make much sense to use that same type to register/unregister routes, because it forces us to create "dummy" requests only for those purposes.With that in mind,
TrieRouterregister()andunregister()now expect (annotated) URLs like before, and only receive anRinstance inroute().Description
Update
TrieRouterregister()andunregister()receive aURLroute.Update some
TrieRouterpublic API documentation.