Make Router generic over its route 🚏
#240
Merged
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
p4checo
force-pushed
the
generic-route-in-router
branch
from
d35d89e
to
e7afab7
Compare
Our `Router` and `RouteHandler` infrastructure was designed to work with plain `URL`'s on its main APIs. Despite URLs being the critical piece of information to route (e.g. in our `TrieRouter`), in certain situations the URL doesn't contain all the information, which limits the Routing infrastructure capabilities. One such example would be in a server middleware router, where the HTTP method would likely be required information to pass on to handlers to perform adequate routing. To remove this restriction, a new `Routable` protocol was created to represent a routable type, which only needs to provide a `url` and is forwarded by the router to the handler upon a successful match. To make it easier to unpack any additional information on the handlers and have more type safety, it was made an `associatedtype` of both `Router` and `RouteHandler`, effectively turning it into a new generic `R`. ## Changes - Add new `Routable` protocol, add default conformance to `URL`. - Add new `associatedtype R: Routable` to `Router` and `RouteHandler`. - Update `Router` and `RouterHandler` APIs to receive a route of type `R`. - Add new `RouteHandler.eraseToAnyRouteHandler` helper.
p4checo
force-pushed
the
generic-route-in-router
branch
from
e7afab7
to
120be87
Compare
Codecov Report
@@ Coverage Diff @@
## master #240 +/- ##
=======================================
Coverage 94.94% 94.94%
=======================================
Files 96 97 +1
Lines 3264 3266 +2
=======================================
+ Hits 3099 3101 +2
Misses 165 165
Continue to review full report at Codecov.
|
aclima93
approved these changes
Jul 26, 2021
literallysofia
approved these changes
Jul 26, 2021
diogoeiras
approved these changes
Jul 26, 2021
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
Our
RouterandRouteHandlerinfrastructure was designed to work with plainURL's on its main APIs. Despite URLs being the critical piece of information to route (e.g. in ourTrieRouter), in certain situations the URL doesn't contain all the information, which limits the Routing infrastructure capabilities. One such example would be in a server middleware router, where the HTTP method would likely be required information to pass on to handlers to perform adequate routing.To remove this restriction, a new
Routableprotocol was created to represent a routable type, which only needs to provide aurland is forwarded by the router to the handler upon a successful match. To make it easier to unpack any additional information on the handlers and have more type safety, it was made anassociatedtypeof bothRouterandRouteHandler, effectively turning it into a new genericR.Description
Add new
Routableprotocol, add default conformance toURL.Add new
associatedtype R: RoutabletoRouterandRouteHandler.Update
RouterandRouterHandlerAPIs to receive a route of typeR.Add new
RouteHandler.eraseToAnyRouteHandlerhelper.