feat(dag-protobuf): cache dag pb directory structure and block indexes #147
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
fforbeck
force-pushed
the
feat/cache-dag-pb
branch
from
7d150c9 to
de83b8c
Compare
fforbeck
force-pushed
the
feat/cache-dag-pb
branch
from
de83b8c to
272a02c
Compare
fforbeck
changed the title
hannahhoward
approved these changes
Jan 24, 2025
alanshaw
requested changes
Jan 24, 2025
alanshaw
previously requested changes
Jan 24, 2025
fforbeck
commented
Jan 27, 2025
| port: 8787, | ||
| inspectorPort: 9898, | ||
| log: new Log(LogLevel.INFO), | ||
| cache: false, // Disable Worker Global Cache to test cache middlewares |
There was a problem hiding this comment.
If we don't disable this global cache in test the requests won't reach the Content Claim Dagula middleware where we have the KV cache.
fforbeck
force-pushed
the
feat/cache-dag-pb
branch
from
814a4f4 to
03a7f78
Compare
hannahhoward
approved these changes
Jan 27, 2025
fforbeck
pushed a commit
that referenced
this pull request
Jan 28, 2025
🤖 I have created a release *beep* *boop* --- ## [2.25.0](v2.24.0...v2.25.0) (2025-01-28) ### Features * **dag-protobuf:** cache dag pb directory structure and block indexes ([#147](#147)) ([e367852](e367852)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
Context
The requests to fetch a DAG Protobuf directory structure using a CID execute the following steps:
bafy...cid- which represents the folder containing the target file, so that we can determine the verifiable cid for the file (let's call thatbafy...file)bafy...fileto get the root block of the file, which in UnixFS contains NO raw data, but rather is a list of sub-blocks that contain the file (let's call thosebafy...bytes1andbafy...bytes2)This PR enables the caching strategy for steps 2 to 4 where instead of fetching the directory structure from the locator and navigating the DAG for every request, it caches the DAGs if they have a Protobuf structure and content size <= 2MB.
Changes
withContentClaimsDagulamiddleware to cache DAG PB content requestsDAGPB_CONTENT_CACHEFF_DAGPB_CONTENT_CACHE_TTL_SECONDS: The number that represents when to expire the key-value pair in seconds from now. The minimum value is 60 seconds. Any value less than 60MB will not be used. We will use 30 days TTL by default for Production environment.FF_DAGPB_CONTENT_CACHE_MAX_SIZE_MB: The maximum size of the key-value pair in MB. The minimum value is 1 MB. Any value less than 1MB will not be used. We will use 2MB max file size by default.FF_DAGPB_CONTENT_CACHE_ENABLED: The flag that enables the DAGPB content cache. The cache is disabled in prod by default.Samples
2MB file - no cache
2MB file - cached
KV Limits
resolves storacha/project-tracking#301