storage: properly read files with Content-Encoding gzip

Dictated by Cloud Storage's "decompressive transcoding" advisory:
    https://cloud.google.com/storage/docs/transcoding

If a file is stored with
    "Content-Encoding": "gzip"
that file is stored on Cloud Storage in the compressed form but when
downloaded by clients it will be decompressed on the fly and
served in the decompressed form.

That also means that range requests for such files are ignored by Cloud Storage.

This change removes the prior assumption that EVERY range
request would result in a 206 Partial Content response,
yet in this case a whole file is always served regardless
of the range for files with "Content-Encoding": "gzip".
Instead such files are served back with a 200 status code.

Due to the consequence of files being served wholly by Cloud Storage
irregardless of the range request, we manually consume "seen" bytes from
retried bodies so that we only send back the caller the remaining bytes.

This change adds both integration and behavioral/mocking tests
to ensure that the behavior is always the same when dealing with
such files.

Also manually verified by testing out a repro that was created
for the issue and checksumming the response. The reproducer isn't
included in the tests because it requires the server to panic,
causing an HTTP/2 stream error, then perfom the retry. However,
the results of serving the retried file, after MD5 checksumming a file
containing 1 million lines of "I am a line\n":

    GotMD5:  90d6ab70c7e44d6b3ccdec8658b56f69
    WantMD5: 90d6ab70c7e44d6b3ccdec8658b56f69

Fixes #1800

Change-Id: I858e547e5faa5d2caa70b18b64f4d03dcaac8270
Reviewed-on: https://code-review.googlesource.com/c/gocloud/+/54791
Reviewed-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Chris Cotter <cjcotter@google.com>
Reviewed-by: Tyler Bui-Palsulich <tbp@google.com>
Reviewed-by: Frank Natividad <franknatividad@google.com>
3 files changed
tree: 9e6a4fd7226b02ffde13a932b459cf73f7801851
  1. .github/
  2. asset/
  3. automl/
  4. bigquery/
  5. bigtable/
  6. billing/
  7. civil/
  8. cloudbuild/
  9. cloudtasks/
  10. cmd/
  11. compute/
  12. container/
  13. containeranalysis/
  14. datacatalog/
  15. dataproc/
  16. datastore/
  17. debugger/
  18. dialogflow/
  19. dlp/
  20. errorreporting/
  21. expr/
  22. firestore/
  23. functions/
  24. grafeas/
  25. httpreplay/
  26. iam/
  27. internal/
  28. iot/
  29. irm/
  30. kms/
  31. language/
  32. logging/
  33. longrunning/
  34. memcache/
  35. monitoring/
  36. osconfig/
  37. oslogin/
  38. phishingprotection/
  39. profiler/
  40. pubsub/
  41. recaptchaenterprise/
  42. recommender/
  43. redis/
  44. rpcreplay/
  45. scheduler/
  46. secretmanager/
  47. securitycenter/
  48. servicedirectory/
  49. spanner/
  50. speech/
  51. storage/
  52. talent/
  53. texttospeech/
  54. trace/
  55. translate/
  56. videointelligence/
  57. vision/
  58. webrisk/
  59. .gitignore
  60. CHANGES.md
  61. CODE_OF_CONDUCT.md
  62. CONTRIBUTING.md
  63. doc.go
  64. examples_test.go
  65. go.mod
  66. go.sum
  67. LICENSE
  68. license_test.go
  69. README.md
  70. RELEASING.md
  71. tools.go
README.md

Google Cloud Client Libraries for Go

GoDoc

Go packages for Google Cloud Platform services.

import "cloud.google.com/go"

To install the packages on your system, do not clone the repo. Instead:

  1. Change to your project directory:

    cd /my/cloud/project
    
  2. Get the package you want to use. Some products have their own module, so it's best to go get the package(s) you want to use:

    $ go get cloud.google.com/go/firestore # Replace with the package you want to use.
    

NOTE: Some of these packages are under development, and may occasionally make backwards-incompatible changes.

NOTE: Github repo is a mirror of https://code.googlesource.com/gocloud.

Supported APIs

Google APIStatusPackage
Assetstablecloud.google.com/go/asset/apiv1
Automlstablecloud.google.com/go/automl/apiv1
BigQuerystablecloud.google.com/go/bigquery
Bigtablestablecloud.google.com/go/bigtable
Cloudbuildstablecloud.google.com/go/cloudbuild/apiv1
Cloudtasksstablecloud.google.com/go/cloudtasks/apiv2
Containerstablecloud.google.com/go/container/apiv1
ContainerAnalysisbetacloud.google.com/go/containeranalysis/apiv1
Dataprocstablecloud.google.com/go/dataproc/apiv1
Datastorestablecloud.google.com/go/datastore
Debuggerstablecloud.google.com/go/debugger/apiv2
Dialogflowstablecloud.google.com/go/dialogflow/apiv2
Data Loss Preventionstablecloud.google.com/go/dlp/apiv2
ErrorReportingalphacloud.google.com/go/errorreporting
Firestorestablecloud.google.com/go/firestore
IAMstablecloud.google.com/go/iam
IoTstablecloud.google.com/go/iot/apiv1
IRMalphacloud.google.com/go/irm/apiv1alpha2
KMSstablecloud.google.com/go/kms/apiv1
Natural Languagestablecloud.google.com/go/language/apiv1
Loggingstablecloud.google.com/go/logging
Memorystorealphacloud.google.com/go/redis/apiv1
Monitoringstablecloud.google.com/go/monitoring/apiv3
OS Loginstablecloud.google.com/go/oslogin/apiv1
Pub/Substablecloud.google.com/go/pubsub
Phishing Protectionalphacloud.google.com/go/phishingprotection/apiv1beta1
reCAPTCHA Enterprisealphacloud.google.com/go/recaptchaenterprise/apiv1beta1
Recommenderbetacloud.google.com/go/recommender/apiv1beta1
Schedulerstablecloud.google.com/go/scheduler/apiv1
Securitycenterstablecloud.google.com/go/securitycenter/apiv1
Spannerstablecloud.google.com/go/spanner
Speechstablecloud.google.com/go/speech/apiv1
Storagestablecloud.google.com/go/storage
Talentalphacloud.google.com/go/talent/apiv4beta1
Text To Speechstablecloud.google.com/go/texttospeech/apiv1
Tracestablecloud.google.com/go/trace/apiv2
Translatestablecloud.google.com/go/translate
Video Intelligencebetacloud.google.com/go/videointelligence/apiv1beta2
Visionstablecloud.google.com/go/vision/apiv1
Webriskalphacloud.google.com/go/webrisk/apiv1beta1

Alpha status: the API is still being actively developed. As a result, it might change in backward-incompatible ways and is not recommended for production use.

Beta status: the API is largely complete, but still has outstanding features and bugs to be addressed. There may be minor backwards-incompatible changes where necessary.

Stable status: the API is mature and ready for production use. We will continue addressing bugs and feature requests.

Documentation and examples are available at pkg.go.dev/cloud.google.com/go

Go Versions Supported

We support the two most recent major versions of Go. If Google App Engine uses an older version, we support that as well.

Authorization

By default, each API will use Google Application Default Credentials for authorization credentials used in calling the API endpoints. This will allow your application to run in many environments without requiring explicit configuration.

client, err := storage.NewClient(ctx)

To authorize using a JSON key file, pass option.WithCredentialsFile to the NewClient function of the desired package. For example:

client, err := storage.NewClient(ctx, option.WithCredentialsFile("path/to/keyfile.json"))

You can exert more control over authorization by using the golang.org/x/oauth2 package to create an oauth2.TokenSource. Then pass option.WithTokenSource to the NewClient function: snip:# (auth-ts)

tokenSource := ...
client, err := storage.NewClient(ctx, option.WithTokenSource(tokenSource))

Contributing

Contributions are welcome. Please, see the CONTRIBUTING document for details. We‘re using Gerrit for our code reviews. Please don’t open pull requests against this repo, new pull requests will be automatically closed.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Contributor Code of Conduct for more information.