Set web worker startup options with messages instead of query strings #1574
Conversation
This file contains hidden or 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
bgrgicak added [Type] Enhancement Closed
adamziel changed the title 
| I adjusted the title and description – it talked about the service worker, but it's actual about the regular web worker. The PR looks good, thank you @bgrgicak! |
| Ah, I merged and then realized it's the topmost of the three stacked PRs and now #1573 contains these changes. |
| It seems like we remove the startupOptions from the worker URL now: -workerUrl = addQueryParams(workerUrl, startupOptions); const worker = new Worker(workerUrl, { type: 'module' }); |
I did it now in 7c886d4. I wasn't sure if there is any value in keeping it around. |
adamziel added a commit that referenced this pull request Jul 15, 2024
[For offline support](#1600) we need to load the service worker as early as possible in the boot process. Booting early will allow fetch caching to cache more files on the first making the backfill of assets simpler. Read the full research recap here #1600 (review) ## Implementation details To move `registerServiceWorker` to the start of the boot process we had to generate the scope in `bootPlaygroundRemote` and pass it to the PHP worker thread together with other startup options. The service worker had to be registered before spawning the PHP worker thread to ensure WP and PHP assets were cached. But the service worker also depends on the `phpApi` returned by `spawnPHPWorkerThread`. We had to register the service worker first, after that, spawn the PHP worker thread, and then set the `phpApi`. This PR also includes changes from #1574 because they allow us to pass the scope. ## Testing Instructions (or ideally a Blueprint) - Ensure all tests pass --------- Co-authored-by: Adam Zieliński <adam@adamziel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Motivation for the change, related issues
When the web worker is loaded from browser storage it loses the query string context we use to send startup options like WP and PHP version.
To enable offline support, this PR changes how the worker obtains startup options to ensure it works when cached.
Implementation details
Instead of fetching startup options from the query string,
spawnPHPWorkerThreadwill post startup options as a message to the worker.When
worker-utilsloads it will await thestartup-optionsmessage and continue once it receives the data.Testing Instructions (or ideally a Blueprint)
@brandonpayton @adamziel I'm not sure about this solution. It works, but I'm not happy with it. How does it look to you?