admin-manifest: Fix url query param issue #38755
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
noahtallen
added
the
[Type] Bug
|
Size Change: +114 B (0%) Total Size: 1.15 MB
ℹ️ View Unchanged
|
This reverts commit 697c5a41ab6c782d641c421512e83a23cbc9b6d5.
noahtallen
force-pushed
the
fix/manifest-url-query-param-issue
branch
from
8034400
to
3bdc8d1
Compare
fullofcaffeine
approved these changes
Feb 15, 2022
There was a problem hiding this comment.
This tests well! As a sanity-check, I checked the output for addQueryArgs for a couple of scenarios, and all of them correctly loaded the service worker JSON.
addQueryArgs( "http://localhost:8888/wp-admin", { "service-worker": true } )
"http://localhost:8888/wp-admin?service-worker=true"
addQueryArgs( "http://localhost:8888/wp-admin?something", { "service-worker": true } )
"http://localhost:8888/wp-admin?something=&service-worker=true"
addQueryArgs( "http://localhost:8888/wp-admin?something=true", { "service-worker": true } )
"http://localhost:8888/wp-admin?something=true&service-worker=true"
addQueryArgs( "http://localhost:8888/wp-admin?something=true&another=true", { "service-worker": true } )
"http://localhost:8888/wp-admin?something=true&another=true&service-worker=true"Just curious, whenever this error happened, that meant the service worker wasn't loaded nor set up, which means the consequences went beyond just an error message in the console, right? 😬
Correct. Whatever features the service worker provides wouldn't have been available. |
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.
Description
It is possible for the
adminUrlto already have a query parameter, in which case the URL can be set to something likeexample.com/wp-admin/?something=true?service-worker. If that happens, the service worker fails to register, as the URL doesn't return the expected JSON. The fix is to add the query param in the "canonical" way, with the URL package.Testing Instructions
I am unsure how to test the admin manifest package, but I don't expect this to change anything in most cases.
You could test visiting these URLs to verify that the fix would work. (These URLs operate the same way before and after the PR. We're just changing the code to load the second URL instead of the first.)
localhost:8888/wp-admin?foo=true?service-worker. This will not return JSON.localhost:8888/wp-admin?foo=true&service-worker=true. This will return JSON.Screenshots
Types of changes
Bug fix
Checklist:
*.native.jsfiles for terms that need renaming or removal).