rework the graph walking functions with functional options #42
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
This commit: - reduce the API to 2 simpler functions - add consistent and clear control over if the root should be visited - add control over the concurrency factor
MichaelMure
commented
Jul 18, 2019
merkledag.go
Outdated
| // | ||
| // NOTE: It *does not* make multiple concurrent calls to the passed `visit` function. | ||
| func WalkParallelDepth(ctx context.Context, getLinks GetLinks, c cid.Cid, startDepth int, visit func(cid.Cid, int) bool) error { | ||
| func parallelWalkDepth(ctx context.Context, getLinks GetLinks, root cid.Cid, visit func(cid.Cid, int) bool, options *WalkOptions) error { |
There was a problem hiding this comment.
note: I kept this function at the same place as before for an easier review, but it would make sense to move it just after sequentialWalkDepth.
This was referenced Jul 18, 2019
Stebalien
reviewed
Jul 18, 2019
merkledag.go
Outdated
| } | ||
|
|
||
| links, err := getLinks(ctx, root) | ||
| if err != nil { | ||
| if err != nil && !options.IgnoreErrors { |
There was a problem hiding this comment.
So, the idea is that getLinks should this internally. But I agree this option is convenient.
What if we changed this to an error handler (func(cid.Cid, error) error)? That way, we can provide options like:
IgnoreErrors()
IgnoreMissing() // only ignores ipld.ErrorNotFound.
OnMissing(func(c cid.Cid))
There was a problem hiding this comment.
Good idea, I'll add a generic OnError(func(err error, c cid.Cid) bool) as well.
merkledag.go
Outdated
| const defaultConcurrentFetch = 32 | ||
|
|
||
| // WalkOptions represent the parameters of a graph walking algorithm | ||
| type WalkOptions struct { |
There was a problem hiding this comment.
Let's make this private (or at least make the fields private). Yeah, I know I don't usually do that but that was a mistake.
|
It should be good now. |
Stebalien
approved these changes
Jul 22, 2019
|
Thanks! |
Jorropo
pushed a commit
to ipfs/boxo
that referenced
this pull request
Mar 15, 2023
…nal-opts rework the graph walking functions with functional options This commit was moved from ipfs/go-merkledag@89dd2ad
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.
This PR:
I also want to implement a
IgnoreBadBlock()options to continue walking even when a bad block is read.Note:
FetchGraphWithDepthLimitcould be made simpler with aDepthLimit()option as well.@Stebalien