fix(bigquery): add close() method to client for releasing open sockets - #9894
Merged
tswast merged 5 commits intoNov 27, 2019
Merged
fix(bigquery): add close() method to client for releasing open sockets#9894tswast merged 5 commits into
tswast merged 5 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
tswast
reviewed
Nov 27, 2019
tswast
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Tests look great! A few suggestions.
Sorry, something went wrong.
A single common cleanup point at the end makes it much less likely to accidentally re-introduce an open socket leak.
plamut
commented
Nov 27, 2019
Comment thread
bigquery/noxfile.py
Copy link
Copy Markdown
Contributor
Author
|
@tswast Another thought - since the cleanup only happens if the user calls .close(), we should probably update our code samples to include the client.close() line at the end. Otherwise I presume that many users will simply forget or not know about this. |
Sorry, something went wrong.
tswast
approved these changes
Nov 27, 2019
Copy link
Copy Markdown
Contributor
|
I'm working on a proposal to add close() to all clients and make clients act as a context manager. Once this is done, we'll likely need to update our sample rubric to account for this. |
Sorry, something went wrong.
This was referenced Jan 29, 2020
[CHANGE ME] Re-generated container to pick up changes in the API or client library generator.
#10256
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #9790.
This PR fixes the client leaking open sockets by adding a close() method to the client for cleaning up after itself. It also fixes a similar leak in IPython magics - even if bqstorage client is used - when cell magic is run.
How to test
Run both code samples from the issue description, i.e. the one using magics, and the other one using a regular BigQuery client. In both cases the number of open connections at the end should be the same as at the beginning, meaning that no connections (sockets) are leaked.
Misc.
The magics._cell_magic() needs refactoring, it's very long and several helper methods should be extracted from it. But that's out of this PR's scope.
PR checklist