Use unique cache directory for coil image caching #6002
Merged
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.



🎯 Goal
There is a possibility if a customer is using
coil2while using the Chat SDK (which usescoil3) for a race condition: Bothcoil2andcoil3use the same cache directory (image_cache) for storing image data, however they have slightly different output format. So if one version of coil writes to this cache, but is read by the different one, the parsing will fail and image will fail to load.🛠 Implementation details
Use a Stream specific cache dir for the
coil3instance to avoid potential clash with the default (image_cache) from the customer coil instance:stream_coil3_image_cache.🎨 UI Changes
NA
🧪 Testing
It is a bit difficult to reproduce as it is caused by a race condition. It most often happens when the same image (from same URL resource) is rendered both via
coil2andcoil3. The result is that one of the image views will fail to render.To test the more common scenario, ensure that none of the current features which include images are not broken. Ex. media attachments, media gallery, channel media attachments gallery...