fix(gensupport): Refactor and fix chunk upload logic for robust timeout handling. #3208
Conversation
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
BrennaEpp
reviewed
Jun 27, 2025
BrennaEpp
reviewed
Jul 2, 2025
…quest The `ChunkTransferTimeout` was previously initiated before reading the media chunk via `Media.Chunk()`. This caused the timeout to incorrectly include the media read time, leading to premature timeouts for uploads with slow media sources (e.g., slow disk I/O or slow write from application). This change refactors the upload logic to apply the timeout only to the network request portion of the chunk transfer. The `context.WithTimeout` is now created within the `transferChunk` function, immediately before the `doUploadRequest` call, ensuring its scope is limited to the network round trip. Additionally, this commit introduces a new table-driven test, `TestChunkTransferTimeout`, to validate the fix and prevent regressions. The test uses mocks to simulate: - A slow media read, which should now succeed. - A slow network response, which correctly continues to fail with a timeout. Intenal Bug: 427490995
meet2mky
changed the title
meet2mky
changed the title
meet2mky
force-pushed
the
main
branch
2 times, most recently
from
43496af to
1ed7aaf
Compare
|
@tritone @BrennaEpp Testing is completed and this is ready for review now. |
tritone
reviewed
Jul 21, 2025
codyoss
added
the
kokoro:force-run
kokoro-team
removed
the
kokoro:force-run
codyoss
added
the
automerge
gcf-merge-on-green
bot
removed
the
automerge
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Jul 22, 2025
🤖 I have created a release *beep* *boop* --- ## [0.243.0](https://togithub.com/googleapis/google-api-go-client/compare/v0.242.0...v0.243.0) (2025-07-22) ### Features * **all:** Auto-regenerate discovery clients ([#3233](https://togithub.com/googleapis/google-api-go-client/issues/3233)) ([a269dca](https://togithub.com/googleapis/google-api-go-client/commit/a269dca39e5315e9bfc77cc05b3dbd64af9baa25)) * **all:** Auto-regenerate discovery clients ([#3235](https://togithub.com/googleapis/google-api-go-client/issues/3235)) ([b656000](https://togithub.com/googleapis/google-api-go-client/commit/b656000d19f9627de3e2817451f82c339ce4e4bb)) * **all:** Auto-regenerate discovery clients ([#3236](https://togithub.com/googleapis/google-api-go-client/issues/3236)) ([971135a](https://togithub.com/googleapis/google-api-go-client/commit/971135a0223f558b99071a3830cd73cd9f2af2e8)) * **all:** Auto-regenerate discovery clients ([#3237](https://togithub.com/googleapis/google-api-go-client/issues/3237)) ([be7e601](https://togithub.com/googleapis/google-api-go-client/commit/be7e601cede79ed6f259689857634f59c1098060)) * **all:** Auto-regenerate discovery clients ([#3239](https://togithub.com/googleapis/google-api-go-client/issues/3239)) ([b2202ca](https://togithub.com/googleapis/google-api-go-client/commit/b2202ca5711c4fd4221afc678f93ae2b550d62d0)) * **all:** Auto-regenerate discovery clients ([#3240](https://togithub.com/googleapis/google-api-go-client/issues/3240)) ([ceceb79](https://togithub.com/googleapis/google-api-go-client/commit/ceceb79c861a39d376f1576e0c40ca557f5c3293)) ### Bug Fixes * **gensupport:** Update chunk upload logic for robust timeout handling. ([#3208](https://togithub.com/googleapis/google-api-go-client/issues/3208)) ([93865aa](https://togithub.com/googleapis/google-api-go-client/commit/93865aac32e7400c2485d2e15776764110cb4df0)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
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.
The
ChunkTransferTimeoutwas previously initiated before reading the media chunk viaMedia.Chunk(). This caused the timeout to incorrectly include the media read time, leading to premature timeouts for uploads with slow media sources (e.g., slow disk I/O or slow write from application).This change refactors the upload logic to apply the chunkRetryDeadline timer after the chunk has been read from
Media.Chunk()and chunkTransferTimeout timeout only applies to the network request portion of the chunk transfer. Thecontext.WithTimeoutis now created within thetransferChunkfunction, immediately before thedoUploadRequestcall, ensuring its scope is limited to the network round trip.Additionally, this commit introduces additional unit test to validate the fix and prevent regressions:
Note: Testing of storage (unit tests, emulator test, integration tests) is done and results are attached in the bug.
Intenal Bug: 427490995