Skip to content

fix: explicitly set publicPath for static assets #7

fix: explicitly set publicPath for static assets

fix: explicitly set publicPath for static assets #7

Triggered via pull request April 16, 2025 09:26
Status Failure
Total duration 26s
Artifacts

commitlint.yml

on: pull_request
commitlint
15s
commitlint
Fit to window
Zoom out
Zoom in

Annotations

1 error
commitlint
You have commit messages with errors ⧗ input: fix: 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-webpack-configuration/blob/v1.5.1/src/index.cjs#L71 https://github.com/RaspberryPiFoundation/scratch-gui/blob/b723be4d13ec3348045335cfee75d6710f600236/webpack.config.js#L20 [2] https://webpack.js.org/guides/public-path/ ``` **Automatic publicPath** There are chances that you don't know what the publicPath will be in advance, and webpack can handle it automatically for you by determining the public path from variables like import.meta.url, document.currentScript, script.src or self.location. ``` [3] https://github.com/scratchfoundation/scratch-gui/blob/853caca41ac07b76298b8d371f7066311d95588e/webpack.config.js#L29 Co-Authored-By: Chris Lowis <chris.lowis@gofreerange.com> ✖ footer's lines must not be longer than 100 characters [footer-max-line-length] ✖ found 1 problems, 0 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint