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

feat: Support explict modes for read fallbacks and caching #104

Merged
merged 8 commits into from
Aug 29, 2024

Conversation

epociask
Copy link
Collaborator

@epociask epociask commented Aug 25, 2024

Fixes Issue

Fixes NA

Changes proposed

TLDR Modularized storage backend providers to allow for easy addition in the future. Additionally added explicit support for optional read fallback and caching that allows a user to construct custom configurations of proxy based on their individual risk tolerance / requirement for decentralization. E.g, I'm a customer and want caching with redis and read fallback with S3 - I can now do that (excluding redis cuz we haven't implemented yet).

Verbose Summary

  • Two interfaces to differentiate between storage backends
  • Modularized routing logic to easily support the addition of new backend types in the future
  • Support caching mode which takes in list of supported backend storage strings (i.e, read before referencing eigenda)
  • Support fallback mode which takes in list of supported backend storage strings (i.e, read only when eigenda cannot be read from)
  • Extended E2E tests to verify both system flows
  • Extended config rep and added tests for verification

Screenshots (Optional)

Note to reviewers

We can probably create a definition object for each storage backend to describe its allowed modes but this likely isn't necessary unless we envision support for 10+ backends with additional secondary modes outside of read-fallback, cache. We could also support many instance configurations (e.g, a separate S3 bucket for caching vs. fallback) if this is something that customers want down the line. All sensitive flows should be tested, but please review diligently.

NOTE: This PR also allows us to scale memstore in the future as well. E.g, if we have redis we can configure it as a read-fallback target when doing node development to ensure we can still reference old memory state after rebooting the proxy instance.

@epociask epociask changed the title feat: Support explict modes for read fallback and caching feat: Support explict modes for read fallbacks and caching Aug 26, 2024
@epociask epociask requested a review from hopeyen August 26, 2024 06:38
store/store.go Show resolved Hide resolved
server/load_store.go Show resolved Hide resolved
server/load_store.go Show resolved Hide resolved
server/config.go Outdated Show resolved Hide resolved
utils/utils.go Outdated Show resolved Hide resolved
store/router.go Show resolved Hide resolved
Copy link
Collaborator

@samlaf samlaf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. added some small nits

README.md Outdated Show resolved Hide resolved
store/eigenda.go Outdated Show resolved Hide resolved
store/eigenda.go Show resolved Hide resolved
store/store.go Outdated Show resolved Hide resolved
store/store.go Outdated Show resolved Hide resolved
store/store.go Show resolved Hide resolved
@epociask epociask merged commit bb493d8 into main Aug 29, 2024
8 checks passed
@epociask epociask deleted the epociask--feat-explicit-caching-and-fallbacks branch August 29, 2024 02:26
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