perf: fix performance issue for service workers that don't handle requests #28900
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
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
MikeMcC399
approved these changes
Feb 16, 2024
ryanthemanuel
approved these changes
Feb 28, 2024
cacieprins
requested changes
Mar 1, 2024
packages/proxy/test/unit/http/util/service-worker-injector.spec.ts
Outdated
Show resolved
Hide resolved
packages/proxy/test/unit/http/util/service-worker-manager.spec.ts
Outdated
Show resolved
Hide resolved
packages/proxy/test/unit/http/util/service-worker-manager.spec.ts
Outdated
Show resolved
Hide resolved
cacieprins
approved these changes
Mar 5, 2024
|
Released in This comment thread has been locked. If you are still experiencing this issue after upgrading to |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Additional details
We fixed an issue in 13.6.3 involving service workers to ensure that we could capture those requests properly for Test Replay and intercepts. Currently, when a service worker is registered, we incorrectly assumed that all requests would be handled by the service worker. Thus, if a request was not handled, the proxy would fail to correlate causing a timeout.
In order to resolve the issue, we are now overriding the fetch event and respondWith methods within the service worker to determine if
respondWithwas called.MaybeInjectServiceWorkerresponse middleware that injects code into the top of the service worker to overwrite theaddEventListener,removeEventListener,onfetch, andrespondWithfunctions.addEventListenerandonfetchfunctions will now determine ifrespondWithwas called and call the CDP binding to inform theServiceWorkerManagerwhether or not the service worker handled the request.removeEventListenerfunction is needed to appropriately remove the added listeners__cypressServiceWorkerClientEventthat is used to communicate the events from the clientServiceWorkerManagerwill now wait until it is notified by the client if the service worker is handling the request before communicating to the proxy to ignore the browser's pre-requestSteps to test
How has the user experience changed?
Unhandled service worker requests will no longer hit the 2 second correlation timeout.
PR Tasks
cypress-documentation?type definitions?