Introduce TTL per item along with value serialization #91
Conversation
This file contains 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
boesing
added a commit
to boesing/laminas-cache
that referenced
this pull request
Jul 9, 2024
Ref: laminas/laminas-cache-storage-adapter-filesystem#91 Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
boesing
commented
Jul 9, 2024
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| protected function internalGetItems(array $normalizedKeys): array |
There was a problem hiding this comment.
Might be problematic, haven't had a proper test yet but I could imagine that due to the block logic, this method was actually able to re-read a blocked cache item. I am not 100% sure if this will continue work but that would be a problem for a single read as well, which should then be addressed there which fixes both.
The abstract cache adapter itself does internally loop over those keys and reads them one-by-one and thats why having a fix there would be the better option IMHO. WDYT?
This patch introduces TTL per item. The `Filesystem` adapter now may consume a `ClockInterface` which provides the current timestamp. When a cache item is written to the filesystem, an expiry date is being calculated which is written together with the cache value to the cache file. The cache value is serialized before written to the cache file which also adds more accurate type support to the `Filesystem` adapter. By having data serialized, we also introduced a new `Filesystem` option: `unserializable_classes`. This option is set to `true` by default which means that every object written to a cache file is properly unserialized after. Due to security implications, we recommend setting specific classes to be allowed to get unserialized. Unserialization of objects can also be disabled by providing `false` via the filesystem options. By having serialization within the `Filesystem` adapter itself, the `Serializer` plugin is not needed anymore. The plugin will still work but every cache read/write will serialize twice. Since the cache file format has been changed, we are dropping the options to modify both `suffix` and `tag_suffix` via `FilesystemOptions`. The `tag` suffix will remain as before while the cache file suffix (`suffix`) got replaced with `cache` to ensure that projects may not end up with corrupted cache files. Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
boesing
force-pushed
the
feature/ttl-per-item
branch
from
e63a662
to
3eec18d
Compare
gsteel
approved these changes
Jul 10, 2024
This was referenced Jul 10, 2024
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.
Description
This patch introduces TTL per item. The
Filesystemadapter now may consume aClockInterfacewhich provides the current timestamp. When a cache item is written to the filesystem, an expiry date is being calculated which is written together with the cache value to the cache file. The cache value is serialized before written to the cache file which also adds more accurate type support to theFilesystemadapter. By having data serialized, we also introduced a newFilesystemoption:unserializable_classes. This option is set totrueby default which means that every object written to a cache file is properly unserialized after. Due to security implications, we recommend setting specific classes to be allowed to get unserialized. Unserialization of objects can also be disabled by providingfalsevia the filesystem options.By having serialization within the
Filesystemadapter itself, theSerializerplugin is not needed anymore. The plugin will still work but every cache read/write will serialize twice.Since the cache file format has been changed, we are dropping the options to modify both
suffixandtag_suffixviaFilesystemOptions. Thetagsuffix will remain as before while the cache file suffix (suffix) got replaced withcacheto ensure that projects may not end up with corrupted cache files.This patch will fully support PSR-6 and PSR-16 for the
Filesystemadapter.closes #7