[AssetMapper] Bug fix for paths that start with the same string #50355
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
stof
reviewed
May 17, 2023
| @@ -76,7 +76,7 @@ public function findLogicalPath(string $filesystemPath): ?string | |||
| } | |||
|
|
|||
| foreach ($this->getDirectories() as $path => $namespace) { | |||
| if (!str_starts_with($filesystemPath, $path)) { | |||
| if (!str_starts_with($filesystemPath, $path.'/')) { | |||
There was a problem hiding this comment.
Be careful. Import map paths might already have a trailing /: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap#mapping_path_prefixes
There was a problem hiding this comment.
I think we're ok. These are all comparing filesystem paths - not the actual paths that are exposed to the user / importmap.
weaverryan
force-pushed
the
asset-mapper-import-map-absolute-paths
branch
from
9f35611 to
9158f05
Compare
weaverryan
changed the title
carsonbot
changed the title
|
I've just simplified this - it's now just a simple bug fix. The "absolute path" thing might be cool. But in practice, during a UX bundle install, we'll use |
carsonbot
changed the title
|
Thank you @weaverryan. |
nicolas-grekas
added a commit
that referenced
this pull request
May 19, 2023
…yan)
This PR was squashed before being merged into the 6.3 branch.
Discussion
----------
Bug fix for paths that start with the same string
| Q | A
| ------------- | ---
| Branch? | 6.3
| Bug fix? | yes
| New feature? | no
| Deprecations? | no
| Tickets | None
| License | MIT
| Doc PR | Still TODO
Hi!
This should be minor:
1) Fixed a bug where if 1 asset path directory is a substring of another (e.g. `assets/dir` and `assets/dir2`), when you called `AssetMapperRepository::findLogicalPath()` passing a filesystem path pointed at `assets/dir2`, it would incorrectly match something in `assets/dir`.
~~2) Allowed `importmap.php` paths to be absolute. The use-case is for UX libraries. UX libraries WILL automatically add a "namespaced path" to the asset mapper. For example, the StimulusBundle I'm working on will likely expose a `symfony/stimulus-bundle` asset mapper namespace that points to the `assets/` directory of that bundle. But, for users, I don't want this to be "another thing you need to know". So, the result of this PR is that, in the user's `importmap.php`:~~
```diff
'`@symfony`/stimulus-bundle' => [
- // "symfony/stimulus-bundle" is an asset path that points into that bundle
- 'path' => 'symfony/stimulus-bundle/loader.js',
+ 'path' => __DIR__.'/../../assets/loader.js',
],
```
~~The user points to the absolute file, WE figure out which "asset path" that's in, and everything works nicely.~~
UPDATE: I've removed this.
Cheers!
Commits
-------
51b9246 Bug fix for paths that start with the same string
nicolas-grekas
force-pushed
the
asset-mapper-import-map-absolute-paths
branch
from
97a03c2 to
51b9246
Compare
Merged
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.
Suggestion cannot be applied right now. Please check back later.
Hi!
This should be minor:
assets/dirandassets/dir2), when you calledAssetMapperRepository::findLogicalPath()passing a filesystem path pointed atassets/dir2, it would incorrectly match something inassets/dir.2) Allowedimportmap.phppaths to be absolute. The use-case is for UX libraries. UX libraries WILL automatically add a "namespaced path" to the asset mapper. For example, the StimulusBundle I'm working on will likely expose asymfony/stimulus-bundleasset mapper namespace that points to theassets/directory of that bundle. But, for users, I don't want this to be "another thing you need to know". So, the result of this PR is that, in the user'simportmap.php:The user points to the absolute file, WE figure out which "asset path" that's in, and everything works nicely.UPDATE: I've removed this.
Cheers!