Expose selector traversal options for SelectiveCar #251
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
Using the new traversal budget feature of go-ipld-prime
masih
approved these changes
Oct 1, 2021
masih
approved these changes
Oct 1, 2021
Jorropo
pushed a commit
to ipfs/boxo
that referenced
this pull request
Mar 22, 2023
…l-options Expose selector traversal options for SelectiveCar This commit was moved from ipld/go-car@c93f536
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.
Expose
OptionsforNewSelectiveCar()for two new features available in go-ipld-prime:traversal.LinkVisitOnlyOncewhich I've calledTraverseLinksOnlyOncehere - defaulting tofalsetraversal.Budget#LinkBudgetwhich I've calledMaxTraversalLinkshere - defaulting to disabledI've gone with the same
Optionspattern as in v2 and taken @masih's advice here to keep it generic (rather than useSelectiveCarOptions) so the same pattern can be used for the non-selective CAR usage functions. We'll just have to be clear about what options apply to what functions I suppose.I've put
Traversein both option names for this reason - to try and make it clear that they are for selector traversal. But, in the future we could retire the merkledagWalkuse here and replace it with ipld-prime's traversal (but withLinkVisitOnlyOnceenabled by default which would make it equivalent in functionality). So both of these options would make sense for that case too. I'm open to critique of the naming if anyone has stronger opinions.I also extracted
TestRoundtripSelectiveto the newselectivecar_test.go, but the other two top-level tests in there are new.