Skip to content

bitswap/client: propagate trace state when calling GetBlocks #1060

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.

Sign up for GitHub

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

Merged
gammazero merged 2 commits into from
Oct 28, 2025
Merged

bitswap/client: propagate trace state when calling GetBlocks #1060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee638fe
Propagate trace state when calling GetBlocks
gammazero Oct 28, 2025
a7d795a
update changelog
gammazero Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The following emojis are used to highlight certain changes:

- `gateway`: Fixed duplicate peer IDs appearing in retrieval timeout error messages
- `bitswap/client`: fix tracing by using context to pass trace and retrieval state to session [#1059](https://github.com/ipfs/boxo/pull/1059)
- `bitswap/client`: propagate trace state when calling GetBlocks [#1060](https://github.com/ipfs/boxo/pull/1060)

### Security

Expand Down
14 changes: 7 additions & 7 deletions bitswap/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (
"github.com/ipfs/boxo/bitswap/tracer"
blockstore "github.com/ipfs/boxo/blockstore"
exchange "github.com/ipfs/boxo/exchange"
"github.com/ipfs/boxo/retrieval"
rpqm "github.com/ipfs/boxo/routing/providerquerymanager"
blocks "github.com/ipfs/go-block-format"
"github.com/ipfs/go-cid"
Expand Down Expand Up @@ -446,13 +445,10 @@ func (bs *Client) GetBlocks(ctx context.Context, keys []cid.Cid) (<-chan blocks.
ctx, span := internal.StartSpan(ctx, "GetBlocks", trace.WithAttributes(attribute.Int("NumKeys", len(keys))))
defer span.End()

// Temporary session closed indepentendly of cancellation ctx.
sessCtx, cancelSession := context.WithCancel(context.Background())
// Create a session context for the goroutine created here to use to close
// the session after reading all blocks.
sessCtx, cancelSession := context.WithCancel(ctx)

// Preserve retrieval.State from the original request context if present
if retrievalState := retrieval.StateFromContext(ctx); retrievalState != nil {
sessCtx = context.WithValue(sessCtx, retrieval.ContextKey, retrievalState)
}
session := bs.sm.NewSession(sessCtx, bs.provSearchDelay, bs.rebroadcastDelay)

blocksChan, err := session.GetBlocks(ctx, keys)
Expand All @@ -461,6 +457,10 @@ func (bs *Client) GetBlocks(ctx context.Context, keys []cid.Cid) (<-chan blocks.
return nil, err
}

// The purpose of creating this goroutine to read the blocks from one
// channel and then put them on another channel, instead of simply
// returning the first channel, is to ensure that the session created here
// is closed after reading the blocks.
out := make(chan blocks.Block)
go func() {
defer func() {
Expand Down
Loading