Skip to content

Support for TCP upgrade#1130

Merged
aanand merged 14 commits intodocker:masterfrom
aanand:support-tcp-upgrade
Jul 18, 2016
Merged

Support for TCP upgrade#1130
aanand merged 14 commits intodocker:masterfrom
aanand:support-tcp-upgrade

Conversation

@aanand
Copy link
Copy Markdown
Contributor

@aanand aanand commented Jul 13, 2016

Fixes #1123

ping @dnephin

@aanand aanand force-pushed the support-tcp-upgrade branch from 4f40259 to 96b08f5 Compare July 13, 2016 21:07
dgageot and others added 12 commits July 13, 2016 17:08
@dgageot @aanand
Add hijack hints for attach api calls
6dec639 
Signed-off-by: David Gageot <david@gageot.net>
@dgageot @aanand
Add hijack hints for non-detached exec api calls
5464cf2 
Signed-off-by: David Gageot <david@gageot.net>
@shin- @aanand
Read from socket after sending TCP upgrade headers.
76ed9c3 
Signed-off-by: Joffrey F <joffrey@docker.com>
@shin- @aanand
Mock read_from_socket method
e64ba8f 
Signed-off-by: Joffrey F <joffrey@docker.com>
@aanand
Move socket-reading test helpers into docker.utils.socket
73f06e3 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Remove duplicated methods from container.py
b100666 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Move read_loop() into docker.utils.socket.read_iter()
43158cf 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Refactors
3e2f4a6 
- `read_data()` raises an exception instead of asserting `False`
- `next_packet_size()` uses `read_data()`
- Renamed `packet_size` arg to `n` for consistency

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Document all socket utility methods
ce2b60e 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Remove unused imports
472a7ff 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Reorder socket.py methods
456bfa1 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Rename next_packet_size to next_frame_size
9fb2cae 
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand aanand force-pushed the support-tcp-upgrade branch from 96b08f5 to 9fb2cae Compare July 13, 2016 21:08
aanand added 2 commits July 13, 2016 17:41
@aanand
Rename read_iter() to frames_iter()
6983262 
This makes it more clearly high-level and distinct from the raw
data-reading functions

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
@aanand
Rename read methods for clarity
267021e 
read_socket() is now just read(), because its behaviour is consistent
with `os.read` et al.

Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
dnephin
dnephin reviewed Jul 14, 2016
View reviewed changes
docker/api/exec_api.py
self._url('/exec/{0}/start', exec_id),
headers=headers,
data=data,
stream=True
Copy link
Copy Markdown
Contributor

@dnephin dnephin Jul 14, 2016

Choose a reason for hiding this comment

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

stream changed here to always True. Is that correct?

Copy link
Copy Markdown
Contributor

@shin- shin- Jul 25, 2016

Choose a reason for hiding this comment

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

Late answer, but yes, that's intentional. Without it, _read_from_socket cannot work properly. As far as the user is concerned, the output will still be presented according to their choice.

@dnephin
Copy link
Copy Markdown
Contributor

dnephin commented Jul 14, 2016

code LGTM, waiting on janky

@aanand aanand merged commit e15ba74 into docker:master Jul 18, 2016
@aanand aanand deleted the support-tcp-upgrade branch July 18, 2016 16:03
This was referenced Jul 22, 2016
Closed
Closed
@shin- shin- added this to the 1.10.0 milestone Jul 26, 2016
Lekensteyn added a commit to Lekensteyn/docker-py that referenced this pull request Apr 26, 2019
@Lekensteyn
exec: fix file handle leak with container.exec_* APIs
c7bc674 
Requests with stream=True MUST be closed or else the connection will
never be returned to the connection pool. Both ContainerApiMixin.attach
and ExecApiMixin.exec_start were leaking in the stream=False case.
exec_start was modified to follow attach for the stream=True case as
that allows the caller to close the stream when done (untested).

Tested with:

    # Test exec_run (stream=False) - observe one less leak
    make integration-test-py3 file=models_containers_test.py' -k test_exec_run_success -vs -W error::ResourceWarning'
    # Test exec_start (stream=True, fully reads from CancellableStream)
    make integration-test-py3 file=api_exec_test.py' -k test_execute_command -vs -W error::ResourceWarning'

After this change, one resource leak is removed, the remaining resource
leaks occur because none of the tests call client.close().

Fixes docker#1293
(Regression from docker#1130)

Signed-off-by: Peter Wu <pwu@cloudflare.com>
@Lekensteyn Lekensteyn mentioned this pull request Apr 26, 2019
Merged
Lekensteyn added a commit to Lekensteyn/docker-py that referenced this pull request Apr 26, 2019
@Lekensteyn
exec: fix file handle leak with container.exec_* APIs
c9072fc 
Requests with stream=True MUST be closed or else the connection will
never be returned to the connection pool. Both ContainerApiMixin.attach
and ExecApiMixin.exec_start were leaking in the stream=False case.
exec_start was modified to follow attach for the stream=True case as
that allows the caller to close the stream when done (untested).

Tested with:

    # Test exec_run (stream=False) - observe one less leak
    make integration-test-py3 file=models_containers_test.py' -k test_exec_run_success -vs -W error::ResourceWarning'
    # Test exec_start (stream=True, fully reads from CancellableStream)
    make integration-test-py3 file=api_exec_test.py' -k test_execute_command -vs -W error::ResourceWarning'

After this change, one resource leak is removed, the remaining resource
leaks occur because none of the tests call client.close().

Fixes docker#1293
(Regression from docker#1130)

Signed-off-by: Peter Wu <pwu@cloudflare.com>
riyad pushed a commit to riyad/docker-py that referenced this pull request Jan 7, 2022
@Lekensteyn @riyad
exec: fix file handle leak with container.exec_* APIs
051ed4b 
Requests with stream=True MUST be closed or else the connection will
never be returned to the connection pool. Both ContainerApiMixin.attach
and ExecApiMixin.exec_start were leaking in the stream=False case.
exec_start was modified to follow attach for the stream=True case as
that allows the caller to close the stream when done (untested).

Tested with:

    # Test exec_run (stream=False) - observe one less leak
    make integration-test-py3 file=models_containers_test.py' -k test_exec_run_success -vs -W error::ResourceWarning'
    # Test exec_start (stream=True, fully reads from CancellableStream)
    make integration-test-py3 file=api_exec_test.py' -k test_execute_command -vs -W error::ResourceWarning'

After this change, one resource leak is removed, the remaining resource
leaks occur because none of the tests call client.close().

Fixes docker#1293
(Regression from docker#1130)

Signed-off-by: Peter Wu <pwu@cloudflare.com>
@Nitrooo Nitrooo mentioned this pull request Jul 4, 2022
Merged
milas added a commit that referenced this pull request Jan 13, 2023
@Lekensteyn @milas
exec: fix file handle leak with container.exec_* APIs (#2320)
34e6829 
Requests with stream=True MUST be closed or else the connection will
never be returned to the connection pool. Both ContainerApiMixin.attach
and ExecApiMixin.exec_start were leaking in the stream=False case.
exec_start was modified to follow attach for the stream=True case as
that allows the caller to close the stream when done (untested).

Tested with:

    # Test exec_run (stream=False) - observe one less leak
    make integration-test-py3 file=models_containers_test.py' -k test_exec_run_success -vs -W error::ResourceWarning'
    # Test exec_start (stream=True, fully reads from CancellableStream)
    make integration-test-py3 file=api_exec_test.py' -k test_execute_command -vs -W error::ResourceWarning'

After this change, one resource leak is removed, the remaining resource
leaks occur because none of the tests call client.close().

Fixes #1293
(Regression from #1130)

Signed-off-by: Peter Wu <pwu@cloudflare.com>
Co-authored-by: Milas Bowman <milas.bowman@docker.com>
felixfontein added a commit to felixfontein/community.docker that referenced this pull request Feb 11, 2023
@felixfontein @Lekensteyn @milas
exec: fix file handle leak with container.exec_* APIs (docker/docker-…
27df652 
…py#2320)

Requests with stream=True MUST be closed or else the connection will
never be returned to the connection pool. Both ContainerApiMixin.attach
and ExecApiMixin.exec_start were leaking in the stream=False case.
exec_start was modified to follow attach for the stream=True case as
that allows the caller to close the stream when done (untested).

Tested with:

    # Test exec_run (stream=False) - observe one less leak
    make integration-test-py3 file=models_containers_test.py' -k test_exec_run_success -vs -W error::ResourceWarning'
    # Test exec_start (stream=True, fully reads from CancellableStream)
    make integration-test-py3 file=api_exec_test.py' -k test_execute_command -vs -W error::ResourceWarning'

After this change, one resource leak is removed, the remaining resource
leaks occur because none of the tests call client.close().

Fixes docker/docker-py#1293
(Regression from docker/docker-py#1130)

Cherry-picked from docker/docker-py@34e6829

Co-authored-by: Peter Wu <pwu@cloudflare.com>
Co-authored-by: Milas Bowman <milas.bowman@docker.com>
felixfontein added a commit to ansible-collections/community.docker that referenced this pull request Feb 12, 2023
@felixfontein @Lekensteyn @milas
exec: fix file handle leak with container.exec_* APIs (docker/docker-…
983b2b4 
…py#2320) (#582)

Requests with stream=True MUST be closed or else the connection will
never be returned to the connection pool. Both ContainerApiMixin.attach
and ExecApiMixin.exec_start were leaking in the stream=False case.
exec_start was modified to follow attach for the stream=True case as
that allows the caller to close the stream when done (untested).

Tested with:

    # Test exec_run (stream=False) - observe one less leak
    make integration-test-py3 file=models_containers_test.py' -k test_exec_run_success -vs -W error::ResourceWarning'
    # Test exec_start (stream=True, fully reads from CancellableStream)
    make integration-test-py3 file=api_exec_test.py' -k test_execute_command -vs -W error::ResourceWarning'

After this change, one resource leak is removed, the remaining resource
leaks occur because none of the tests call client.close().

Fixes docker/docker-py#1293
(Regression from docker/docker-py#1130)

Cherry-picked from docker/docker-py@34e6829

Co-authored-by: Peter Wu <pwu@cloudflare.com>
Co-authored-by: Milas Bowman <milas.bowman@docker.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

status/0-triage

Projects

None yet

Milestone

1.10.0

Development

Successfully merging this pull request may close these issues.

5 participants

@aanand @dnephin @shin- @GordonTheTurtle @dgageot