Skip to content

attach: don't return context cancelled error - #5295

Merged
thaJeztah merged 1 commit into
docker:masterfrom
laurazard:fix-context-cancel-attach
Jul 25, 2024
Merged

attach: don't return context cancelled error#5295
thaJeztah merged 1 commit into
docker:masterfrom
laurazard:fix-context-cancel-attach

Conversation

@laurazard

@laurazardlaurazard commented Jul 24, 2024

Copy link
Copy Markdown
Member

closes#5294

- What I did

In #4993 we introduced a global signal handler and made sure all the contexts passed into command execution get (appropriately) cancelled when we get a SIGINT.

Due to how we use this context in docker attach, this caused us to start returning a context cancelation error when a user signals the running docker attach.

Since this is the intended behavior, we shouldn't return an error, so this commit adds checks to ignore this specific error in this case.

Also adds a regression test.

- How to verify it

Run the added test:

TESTDIRS="./e2e/container/..." TESTFLAGS="-test.run=TestAttachInterrupt" make -f docker.Makefile test-e2e-non-experimental

- Description for the changelog

Fix `docker attach` printing a spurious `context cancelled` error message.

- A picture of a cute animal (not mandatory but encouraged)

In 3f0d90a we introduced a global
signal handler and made sure all the contexts passed into command
execution get (appropriately) cancelled when we get a SIGINT.
Due to that change, and how we use this context during `docker attach`,
we started to return the context cancelation error when a user signals
the running `docker attach`.
Since this is the intended behavior, we shouldn't return an error, so
this commit adds checks to ignore this specific error in this case.
Also adds a regression test.
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
@laurazard
laurazardforce-pushed the fix-context-cancel-attach branch from 53433e1 to 66aa0f6CompareJuly 24, 2024 23:49
@codecov-commenter

codecov-commenter commented Jul 24, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 61.46%. Comparing base (1e0f669) to head (66aa0f6).
Report is 2 commits behind head on master.

Additional details and impacted files
@@ Coverage Diff @@## master #5295 +/- ##
==========================================
+ Coverage 60.99% 61.46% +0.46% 
==========================================
Files 296 299 +3 Lines 20846 20856 +10 ==========================================
+ Hits 12716 12820 +104 + Misses 7212 7120 -92 + Partials 918 916 -2 

@thaJeztahthaJeztah added kind/bugfix PR's that fix bugs and removed kind/bug labels Jul 24, 2024
@thaJeztah

Copy link
Copy Markdown
Member

FWIW, I recall we also added a utility to errdefs, but not sure if we also must ignore the other context error for these

funcIsContext(errerror) bool {

@thaJeztahthaJeztah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks!

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

terminating docker attach container prints context canceled error

4 participants

@laurazard@codecov-commenter@thaJeztah@vvoland