Fix: Sanitize cache keys to avoid reserved characters validation error #39
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.
Problem
When uploading files to subfolders (e.g.,
user-uploads/2024/image.jpg), cache keys generated byMediaPropertyAccessorandMediaVariationPropertyAccessorcontain forward slashes (/), which are reserved characters in PSR-6 cache implementations.This causes errors like:
This causes validation errors with real cache adapters:
Cache key "joli_media_property_default_subfolder/file.jpg_lastModified" contains reserved characters "{}()/:"Solution
CacheKeySanitizerhelper class to sanitize cache keys by replacing PSR-6 reserved characters ({}()/\@:) with underscoreslibraryName,path, andvariation->getName()in cache key generationTesting
To test with a real cache adapter, replace the mock in
tests/src/BaseTestCase.phpwith:This will show the cache key validation errors before the fix, and confirm they're resolved after.