fix: explicitly set publicPath for static assets #5
Annotations
1 error
|
commitlint
You have commit messages with errors
⧗ input: Remove unused STATIC_PATH from webpack config
STATIC_PATH was introduced back in 2019 [1] as a way to allow consumers of
scratch-gui (like ourselves) to customize the publicPath (where assets are
served from when the JS is run in the browser).
However it looks like this feature was removed/commented out [2] when they
migrated to using the shared webpack config (from the npm package
`scratch-webpack-configuration`).
We would like to re-introduce this feature in order to fix an issue we have
noticed with image assets failing to load as the browser is attempting to load
thse assets from URLs relative to the webpack entry point (rather than from the
root or `/scratch-gui`).
Therefore I am removing this commented out code to make the existing config less
confusing.
[1] e2a2dcf0f
[2] f1438f73e
Co-Authored-By: Chris Lowis <[email protected]>
✖ subject may not be empty [subject-empty]
✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
⧗ input: Group webpack config which is specific for loading assets
The existing webpack config customizes the filenames of any assets we import
which have not been inlined using the `assetModuleFilename`.
This config option is defined at the global level, however it only applies to
assets that are processed by the Asset module definition.
Rather than configuring this globally, I have opted for defining it within the
Asset module definition (nested under the `generator` option) as that makes it
clearer that this option is only relevant for those assets thus making it easier
for future developers to understand and make changes in the future, especially
for those who are less familiar with the intricacies of webpack config.
[1] https://webpack.js.org/guides/asset-modules/
Co-Authored-By: Chris Lowis <[email protected]>
✖ subject may not be empty [subject-empty]
✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
⧗ input: Explicitly set publicPath for static assets
https://github.com/RaspberryPiFoundation/experience-cs/issues/23
We recently embedded the scratch-gui within our Experience CS app.
We have since noticed a number of issues with assets failing to load within the
browser, for example the browser is attempting to load assets from URLs relative
to the webpack entry point (rather than from the root or from `/scratch-gui/`).
After some investigation it turns out that is due to the fact that the webpack
option `publicPath` had not been explicity set [1] (which apparently default to
`auto`).
From digging into the webpack docs [2], it looks like when `publicPath` is set
to `auto` it will attempt to load assets relative to the entrypoint which is not
what we want.
For our purposes we want assets to be served from `/scratch-gui`, and I can't
see the need to make this configurable at this stage, therefore I have hardcoded
this value for now as that also makes building the package less prone to error.
However if we were to push changes upstream, then I think it would make sense to
use an ASSET_PATH environment variable.
Rather than configuring this globally, I have opted for defining it within the
Asset module definition (nested under the `generator` option) as that makes it
clearer that this option is only really relevant for those assets thus making it
easier for future developers to understand and make changes in the future,
especially for those who are less familiar with the intricacies of webpack
config.
I also dug into the latest version of scratch-gui and
scratch-webpack-configuration and can confirm that this would still be an issue
even with the latest releases, but at least they are now explicit about setting
`publicPath` to `auto`, rather than the config option missing entirely and
falling back to the default value of `auto` [3].
[1] https://github.com/scratchfoundation/scratch-webp
|