Skip to content

Fix potential lock on context cancel #391

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
merged 1 commit into from
Oct 4, 2022
Merged

Fix potential lock on context cancel #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions requestmanager/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,8 @@ func (rm *RequestManager) NewRequest(ctx context.Context,
select {
case <-rm.ctx.Done():
return rm.emptyResponse()
case <-ctx.Done():
return rm.emptyResponse()
case receivedInProgressRequest = <-inProgressRequestChan:
}

Expand Down Expand Up @@ -284,6 +286,8 @@ func (rm *RequestManager) CancelRequest(ctx context.Context, requestID graphsync
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-terminated:
return err
}
Expand All @@ -306,6 +310,8 @@ func (rm *RequestManager) UnpauseRequest(ctx context.Context, requestID graphsyn
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand All @@ -318,6 +324,8 @@ func (rm *RequestManager) PauseRequest(ctx context.Context, requestID graphsync.
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand All @@ -330,6 +338,8 @@ func (rm *RequestManager) UpdateRequest(ctx context.Context, requestID graphsync
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand Down
15 changes: 15 additions & 0 deletions requestmanager/requestmanager_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,21 @@ func TestCancelRequestImperativeNoMoreBlocks(t *testing.T) {
require.True(t, ok)
}

func TestCommandsWithCancelledContext(t *testing.T) {
ctx := context.Background()
managerCtx, managerCancel := context.WithCancel(ctx)
defer managerCancel()
td := newTestData(managerCtx, t)
peers := testutil.GeneratePeers(1)

cancelledCtx, cancel := context.WithCancel(ctx)
cancel()

returnedResponseChan, returnedErrorChan := td.requestManager.NewRequest(cancelledCtx, peers[0], td.blockChain.TipLink, td.blockChain.Selector())
testutil.VerifyEmptyErrors(managerCtx, t, returnedErrorChan)
testutil.VerifyEmptyResponse(managerCtx, t, returnedResponseChan)
}

func TestCancelManagerExitsGracefully(t *testing.T) {
ctx := context.Background()
managerCtx, managerCancel := context.WithCancel(ctx)
Expand Down
8 changes: 8 additions & 0 deletions responsemanager/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ func (rm *ResponseManager) UnpauseResponse(ctx context.Context, requestID graphs
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand All @@ -176,6 +178,8 @@ func (rm *ResponseManager) PauseResponse(ctx context.Context, requestID graphsyn
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand All @@ -188,6 +192,8 @@ func (rm *ResponseManager) CancelResponse(ctx context.Context, requestID graphsy
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand All @@ -200,6 +206,8 @@ func (rm *ResponseManager) UpdateResponse(ctx context.Context, requestID graphsy
select {
case <-rm.ctx.Done():
return errors.New("context cancelled")
case <-ctx.Done():
return errors.New("context cancelled")
case err := <-response:
return err
}
Expand Down