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

fix: propagate timeout in BlobWriter #1186

Merged
merged 3 commits into from
Dec 4, 2023
Merged

fix: propagate timeout in BlobWriter #1186

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7b2271
fix: propagate timeout in BlobWriter
cojenco Nov 17, 2023
580ee13
append timeout if explicitly specified
cojenco Nov 27, 2023
4b06b23
Merge branch 'main' into read-timeout
cojenco Dec 4, 2023
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
8 changes: 7 additions & 1 deletion google/cloud/storage/fileio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,9 +406,15 @@ def _upload_chunks_from_buffer(self, num_chunks):

upload, transport = self._upload_and_transport

# Attach timeout if specified in the keyword arguments.
# Otherwise, the default timeout will be used from the media library.
kwargs = {}
if self._upload_kwargs.get("timeout"):
cojenco marked this conversation as resolved.
Show resolved Hide resolved
kwargs = {"timeout": self._upload_kwargs.get("timeout")}

# Upload chunks. The SlidingBuffer class will manage seek position.
for _ in range(num_chunks):
upload.transmit_next_chunk(transport)
upload.transmit_next_chunk(transport, **kwargs)

# Wipe the buffer of chunks uploaded, preserving any remaining data.
self._buffer.flush()
Expand Down
10 changes: 7 additions & 3 deletions tests/unit/test_fileio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,7 @@ def test_write(self, mock_warn):
blob = mock.Mock()
upload = mock.Mock()
transport = mock.Mock()
timeout = 600

blob._initiate_resumable_upload.return_value = (upload, transport)

Expand All @@ -354,7 +355,10 @@ def test_write(self, mock_warn):
# arguments are used.
# It would be normal to use a context manager here, but not doing so
# gives us more control over close() for test purposes.
upload_kwargs = {"if_metageneration_match": 1}
upload_kwargs = {
"if_metageneration_match": 1,
"timeout": timeout,
}
chunk_size = 8 # Note: Real upload requires a multiple of 256KiB.
writer = self._make_blob_writer(
blob,
Expand All @@ -366,7 +370,7 @@ def test_write(self, mock_warn):

# The transmit_next_chunk method must actually consume bytes from the
# sliding buffer for the flush() feature to work properly.
upload.transmit_next_chunk.side_effect = lambda _: writer._buffer.read(
upload.transmit_next_chunk.side_effect = lambda _, timeout: writer._buffer.read(
chunk_size
)

Expand All @@ -388,7 +392,7 @@ def test_write(self, mock_warn):
retry=None,
**upload_kwargs
)
upload.transmit_next_chunk.assert_called_with(transport)
upload.transmit_next_chunk.assert_called_with(transport, timeout=timeout)
self.assertEqual(upload.transmit_next_chunk.call_count, 4)

# Write another byte, finalize and close.
Expand Down