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

[ENH] Make block and sparse index caches use persistent type. #2904

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rescrv
Copy link
Contributor

@rescrv rescrv commented Oct 4, 2024

End-to-end tests confirm that with this change foyer will initialize the disk path (assuming it's writable) and instantiate a disk. A memory cache will also instantiate.

Note that the PersistentCache type means that the key and value implement StorageKey and StorageValue, so it's totally acceptable for every non-persistent cache to implement the trait. This means that any place that takes a persistent cache will also take the non-persistent versions. It's trait logic, not "is a".

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • ...
  • New functionality
    • ...

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

End-to-end tests confirm that with this change foyer will initialize the
disk path (assuming it's writable) and instantiate a disk.  A memory
cache will also instantiate.

Note that the PersistentCache type means that the key and value
implement StorageKey and StorageValue, so it's totally acceptable for
every non-persistent cache to implement the trait.  This means that any
place that takes a persistent cache will also take the non-persistent
versions.  It's trait logic, not "is a".
@rescrv rescrv requested a review from HammadB October 4, 2024 23:36
Copy link

github-actions bot commented Oct 4, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

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.

1 participant