PERF: Improve workbox loading strategy #22019
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
Previously workbox JS was vendored into our git repository, and would be loaded from the `public/javascripts` directory with a 1 day cache lifetime. The main aim of this commit is to add 'cachebuster' to the workbox URL so that the cache lifetime can be increased.
- Remove vendored copies of workbox.
- Use ember-cli/broccoli to collect workbox files from node_modules into assets/workbox-{digest}
- Add assets to sprockets manifest so that they're collected from the ember-cli output directory (and uploaded to s3 when configured)
Some of the sprockets-related changes in this commit are not ideal, but we hope to remove sprockets in the not-too-distant future.
ZogStriP
reviewed
Jun 9, 2023
| @@ -1,9 +1,21 @@ | |||
| 'use strict'; | |||
|
|
|||
| importScripts("<%= "#{Discourse.asset_host}#{Discourse.base_path}/javascripts/workbox/workbox-sw.js" %>"); | |||
| <% | |||
| base = if GlobalSetting.use_s3? && GlobalSetting.s3_cdn_url | |||
There was a problem hiding this comment.
We don't have a method that does this already?
There was a problem hiding this comment.
We kinda do - ApplicationHelper#script_asset_path. But, it doesn't work here for a few reasons
- It only works with files, but here we need a directory path
- It checks the manifest to see whether a given asset exists. But when we're building the service-worker, the manifest hasn't yet been written
- It adds
.gzand.brextensions based on request headers. We don't want that here - workbox doesn't support it, and also we're baking the URLs into the compiled service-worker, so it cannot vary based on request headers
I considered trying to refactor #script_asset_path to extract this logic, but in the end I decided it was too specific to the workbox situation to justify complicating ApplicationHelper any further.
jjaffeux
reviewed
Jun 9, 2023
Comment on lines
+52
to
+61
|
|
||
| # Skip digest path for workbox assets. They are already in a folder with a digest in the name. | ||
| Sprockets::Asset.prepend( | ||
| Module.new do | ||
| def digest_path | ||
| return logical_path if logical_path.match?(%r{^workbox-.*/}) | ||
| super | ||
| end | ||
| end, | ||
| ) |
There was a problem hiding this comment.
Wonder if we make a note of this in workbox-tree-builder.js ?
There was a problem hiding this comment.
Good call - added
jjaffeux
approved these changes
Jun 9, 2023
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.
Previously workbox JS was vendored into our git repository, and would be loaded from the
public/javascriptsdirectory with a 1 day cache lifetime. The main aim of this commit is to add 'cachebuster' to the workbox URL so that the cache lifetime can be increased.Some of the sprockets-related changes in this commit are not ideal, but we hope to remove sprockets in the not-too-distant future.