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

Fixes ActiveSupport::Cache::FileStore#cleanup bug which prevented it from removing expired entries #30789

Merged
merged 1 commit into from Oct 8, 2017

Conversation

Projects
None yet
3 participants
@erichmachado
Contributor

erichmachado commented Oct 3, 2017

Summary

ActiveSupport::Cache::FileStore#cleanup implementation was silently failing to remove expired entries from the cache storage directory. This was due to the implementation itself failing to read the entry properly during the cleanup call:

def cleanup(options = nil)
  options = merged_options(options)
  search_dir(cache_path) do |fname|
    key = file_path_key(fname)
    entry = read_entry(key, options)
    delete_entry(key, options) if entry && entry.expired?
  end
end

The read_entry method here should receive the actual fname instead of key to retrieve this entry, otherwise it will just return nil and never calls delete_entry.

This was already reported here.

@rails-bot

This comment has been minimized.

Show comment
Hide comment
@rails-bot

rails-bot Oct 3, 2017

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @georgeclaghorn (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

rails-bot commented Oct 3, 2017

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @georgeclaghorn (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

Fixes ActiveSupport::Cache::FileStore#cleanup bug which prevented it …
…from cleaning up the expired cache keys

@erichmachado erichmachado changed the title from Fixes ActiveSupport::Cache::FileStore#cleanup bug which prevented it … to Fixes ActiveSupport::Cache::FileStore#cleanup bug which prevented it from removing expired entries Oct 3, 2017

@georgeclaghorn georgeclaghorn merged commit 1f0e4eb into rails:master Oct 8, 2017

2 checks passed

codeclimate All good!
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@erichmachado erichmachado deleted the erichmachado:file-store-cache-cleanup-fix branch Oct 18, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment