Skip to content
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

Jump to bottom

Fix context leak in tests #5377

Merged
merged 3 commits into from
Feb 14, 2024
Merged

Fix context leak in tests #5377

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49ac41e
Comment: Added a call to defer to fix a possible context leak in code.
munahaf Aug 11, 2023
23ff9d6
Comment: Added deferred cancel outside createContext method.
openrefactory Jan 23, 2024
99dc1a3
Merge branch 'master' into munahaf-patch-1
Shaddoll Feb 14, 2024
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
3 changes: 2 additions & 1 deletion host/taskpoller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,8 @@ func (p *TaskPoller) PollAndProcessActivityTaskWithID(dropTask bool) error {
}

func createContext() context.Context {
ctx, _ := context.WithTimeout(context.Background(), 90*time.Second)
ctx, cancel := context.WithTimeout(context.Background(), 90*time.Second)
defer cancel()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the context will be cancelled immediately after this function returns. We should also return cancel and let caller to call cancel.
BTW, this code is only used in our integration test. It's not good but it's ok.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you run "go vet" over your code, it should point out mistakes of this kind. For example:
https://go.dev/play/p/1zlF7qFbzhY

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @adonovan, the proper fix would be to return cancel callback and change all the callers with defer cancel(). Do you want to proceed with that? Otherwise let's close this PR and we will find someone else to address it

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have prepared an updated patch. However, I am traveling now and cannot access the GitHub account used to create the pull request. I will address this in about a week.

return ctx
}

Expand Down