Fix default icon path detection for Rails asset pipelines #7585
Conversation
|
Ok, so this is an attempt to fix a specific instance of the default icon path detection (#4968 / #7092 / #6496). I'm... unsure about this. Generally, Leaflet tries to focus on vanilla JS only, so a fix for a specific build toolchain seems out of place. On the other hand, this change shouldn't break anything. So I'm conflicted on merging this. (I wish we'd rather spend some time on #7203) |
|
#7203 would also be a good alternative, I think. I understand this fix is very specifically related to Rails' builde pipeline. Even though it doesn't break existing code, it might not come in very handy. Nevertheless, we'd somehow need a solution that doesn't break any build toolchains by default. My current status is fine, I have a local leaflet package set up and don't have the deep urge to get an immediate change on this. Would just be a possible solution. You should focus on what you consider more important. |
Falke-Design
added
compatibility
In Rails applications you would usually use the asset pipeline or the webpacker gem for bundling assets together. As all assets are fingerprinted with a SHA hash to enable effective caching, which results in output files that are named differently than in the project structure. This also applies to image files. When importing/requiring leaflet over yarn (npm), the bundling process also affects the default icon files in
dist/imagesas these also need to be imported due to the reference in the stylesheet. Webpacker then adds the fingerprint to the filename, resulting in e.g.marker-icon-2273e3d8.pnginstead ofmarker-icon.png. It also replaces the corresponding URL occurences in the stylesheet which define the default icon paths over styles. This breaks line 55 ofsrc/layer/marker/Icon.Default.jsbecause the RegExp replaces the hardcoded filename with an empty string. In case of a fingerprinted file, it consequently doesn't match, leading to a broken path which errors in the console.The fix introduces support for Webpacker and the Rails asset pipeline (Sprockets) without breaking the detection of the initial filename (without any fingerprints).