Decouple Router~handleRequest from events #1682
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
philipwalton
added
workbox-routing
workbox-strategies
Breaking Change
philipwalton
force-pushed
the
routing-additions
branch
2 times, most recently
from
7e20042
to
6a2289d
Compare
jeffposnick
approved these changes
Oct 8, 2018
| * @param {URL} options.url | ||
| * @param {Request} options.request | ||
| * @param {Event} [options.event] |
There was a problem hiding this comment.
Remove options.event from the JSDoc.
| let handler = null; | ||
| let params = null; | ||
| let debugMessages = []; | ||
| let {params, route} = this.findMatchingRoute({url, request, event}); |
There was a problem hiding this comment.
Looks like all these lets can be changed to const after your refactoring.
There was a problem hiding this comment.
route gets reassigned and params doesn't, but since one of them does, in order to use destructuring I had to do both as let...
philipwalton
force-pushed
the
routing-additions
branch
from
6a2289d
to
cd5c5e6
Compare
philipwalton
force-pushed
the
routing-additions
branch
from
cd5c5e6
to
6e5dd96
Compare
PR-Bot Size PluginChanged File Sizes
New FilesNo new files have been added. All File SizesView Table
Workbox Aggregate Size Plugin9.43KB gzip'ed (63% of limit) |
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.
R: @jeffposnick
Fixes #1630
This PR updates the routing and strategy packages in a few ways.
Breaking changes:
the
Router~handleRequest()method from just taking anEventobject, to taking anoptionsobject whereoptions.requestis required andoptions.eventis optional. Note that technically this change is mostly backwards compatible with the previous version since fetch events have arequestproperty. One thing to watch out for, though, is if people were using this method directly and passing an event, no strategies or handlers would be able to callevent.waitUntil(). We could support both aFetchEventargument as well an optionsObjectargument -- or we could just consider this a breaking change and provide upgrade instructions.The strategy classes'
handle()methods no longer require anoptions.eventparameter, and they now work essentially the same as theirmakeRequestmethods. With this change, we don't really need two separate methods, so we may want to consider getting rid of one of them.The
matchandhandlercallbacks are now also passed anoptions.requestin addition tooptions.url, and optionallyoptions.event. I'm not sure if anyone was ever using theoptions.eventproperty, but sinceRouter~handleRequest()can now be called without an event,options.eventwill now sometimes not be present and so is thus documented as an optional argument.Probably more of a bug fix than a breaking change, but previous if a match callback returned a truthy string, that string would be passed as the
options.paramsargument to the handler. I'm assuming this wasn't intentional, so I've now updated that logic to only passoptions.paramsif the return value is a non-empty object or array.Non-breaking changes:
Router~_findHandlerAndParams()method and renamed it tofindMatchingRoute(), meaning it's now a public method. I figure it may be useful for someone who wants to use the router without executing a handler right away.