Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Update the Caveats section #529

Merged
merged 2 commits into from
Jan 18, 2023
Merged

README: Update the Caveats section #529

merged 2 commits into from
Jan 18, 2023

Conversation

dylanahsmith
Copy link
Contributor

The Caveats section of the README contained some stale information, which I removed. For example,

If an after_commit fails before the cache expiry after_commit the cache will not be expired and you will be left with stale data.

is no longer true after #471.

Since everything is being marshalled and unmarshalled from Memcached changing Ruby or Rails versions could mean your objects cannot be unmarshalled from Memcached.

is no longer true after #242


I've also turned the brief descriptions of ways in which cache invalidations can be lost into a list. This should help a reader looking for the potential source of lost cache invalidations as well as for us to easily add to. I've also added 2 additional ways cache invalidations can be lost to the list that didn't seem to be documented, one that can occur during cache flushing and another that can occur during cache namespace changes.

I also wanted the caveats to explicitly discourage the use of Identity Cache for write requests.

Lastly, I wanted to document the problem with queuing background jobs with ids for uncommitted database records and how can lead to nil being cached for these records.

@dylanahsmith dylanahsmith merged commit 328b52f into main Jan 18, 2023
@dylanahsmith dylanahsmith deleted the update-caveats branch January 18, 2023 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants