-
Notifications
You must be signed in to change notification settings - Fork 1
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
ipfs: remove wrapping blockservice and add ToBlockServiceBlocker helper #35
Open
Jorropo
wants to merge
1
commit into
ipfs-shipyard:master
Choose a base branch
from
Jorropo:new-blockservice-blocker
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,22 @@ | ||
| package ipfs | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/ipfs-shipyard/nopfs" | ||
| blockservice "github.com/ipfs/boxo/blockservice" | ||
| blockstore "github.com/ipfs/boxo/blockstore" | ||
| exchange "github.com/ipfs/boxo/exchange" | ||
| blocks "github.com/ipfs/go-block-format" | ||
| "github.com/ipfs/go-cid" | ||
| ) | ||
|
|
||
| var _ blockservice.BlockService = (*BlockService)(nil) | ||
|
|
||
| // BlockService implements a blocking BlockService. | ||
| type BlockService struct { | ||
| blocker *nopfs.Blocker | ||
| bs blockservice.BlockService | ||
| } | ||
|
|
||
| // WrapBlockService wraps the given BlockService with a content-blocking layer | ||
| // for Get and Add operations. | ||
| func WrapBlockService(bs blockservice.BlockService, blocker *nopfs.Blocker) blockservice.BlockService { | ||
| logger.Debug("BlockService wrapped with content blocker") | ||
|
|
||
| return &BlockService{ | ||
| blocker: blocker, | ||
| bs: bs, | ||
| } | ||
| } | ||
|
|
||
| // Closes the BlockService and the Blocker. | ||
| func (nbs *BlockService) Close() error { | ||
| nbs.blocker.Close() | ||
| return nbs.bs.Close() | ||
| } | ||
|
|
||
| // Gets a block unless CID has been blocked. | ||
| func (nbs *BlockService) GetBlock(ctx context.Context, c cid.Cid) (blocks.Block, error) { | ||
| if err := nbs.blocker.IsCidBlocked(c).ToError(); err != nil { | ||
| logger.Warn(err.Response) | ||
| return nil, err | ||
| } | ||
| return nbs.bs.GetBlock(ctx, c) | ||
| } | ||
|
|
||
| // GetsBlocks reads several blocks. Blocked CIDs are filtered out of ks. | ||
| func (nbs *BlockService) GetBlocks(ctx context.Context, ks []cid.Cid) <-chan blocks.Block { | ||
| var filtered []cid.Cid | ||
| for _, c := range ks { | ||
| if err := nbs.blocker.IsCidBlocked(c).ToError(); err != nil { | ||
| logger.Warn(err.Response) | ||
| logger.Warnf("GetBlocks dropped blocked block: %s", err) | ||
| } else { | ||
| filtered = append(filtered, c) | ||
| func ToBlockServiceBlocker(blocker *nopfs.Blocker) blockservice.Blocker { | ||
| return func(c cid.Cid) error { | ||
| err := blocker.IsCidBlocked(c).ToError() | ||
| if err != nil { | ||
| logger.Warnf("blocked blocks for blockservice: (%s) %s", c, err) | ||
| } | ||
| } | ||
| return nbs.bs.GetBlocks(ctx, filtered) | ||
| } | ||
|
|
||
| // Blockstore returns the underlying Blockstore. | ||
| func (nbs *BlockService) Blockstore() blockstore.Blockstore { | ||
| return nbs.bs.Blockstore() | ||
| } | ||
|
|
||
| // Exchange returns the underlying Exchange. | ||
| func (nbs *BlockService) Exchange() exchange.Interface { | ||
| return nbs.bs.Exchange() | ||
| } | ||
|
|
||
| // AddBlock adds a block unless the CID is blocked. | ||
| func (nbs *BlockService) AddBlock(ctx context.Context, o blocks.Block) error { | ||
| if err := nbs.blocker.IsCidBlocked(o.Cid()).ToError(); err != nil { | ||
| logger.Warn(err.Response) | ||
| return err | ||
| } | ||
| return nbs.bs.AddBlock(ctx, o) | ||
| } | ||
|
|
||
| // AddBlocks adds multiple blocks. Blocks with blocked CIDs are dropped. | ||
| func (nbs *BlockService) AddBlocks(ctx context.Context, bs []blocks.Block) error { | ||
| var filtered []blocks.Block | ||
| for _, o := range bs { | ||
| if err := nbs.blocker.IsCidBlocked(o.Cid()).ToError(); err != nil { | ||
| logger.Warn(err.Response) | ||
| logger.Warnf("AddBlocks dropped blocked block: %s", err) | ||
| } else { | ||
| filtered = append(filtered, o) | ||
| } | ||
| } | ||
| return nbs.bs.AddBlocks(ctx, filtered) | ||
| } | ||
|
|
||
| // DeleteBlock deletes a block. | ||
| func (nbs *BlockService) DeleteBlock(ctx context.Context, o cid.Cid) error { | ||
| return nbs.bs.DeleteBlock(ctx, o) | ||
| // Deprecated: This is broken, it discard previous [blockservice.Option] passed in, use [ToBlockServiceBlocker] and pass [blockservice.WithContentBlocker] option when constructing your own blockservice instead. | ||
| func WrapBlockService(bs blockservice.BlockService, blocker *nopfs.Blocker) blockservice.BlockService { | ||
| return blockservice.New(bs.Blockstore(), bs.Exchange(), blockservice.WithContentBlocker(ToBlockServiceBlocker(blocker))) | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This loose other options passed in like WriteThrough or custom allowlist. Might be worth fully breaking the API. Outside of Rainbow and Kubo I don't know of nopfs consumers.