feat(storage): add user_project option by joshuatants · Pull Request #5490 · googleapis/google-cloud-rust

joshuatants · 2026-04-22T06:23:51Z

Adds a with_user_project method to Storage and StorageControl request builders to support Requester Pays buckets. When set, the internal gRPC and HTTP transports emit an x-goog-user-project header which takes precedence over any quota_project_id configured in the client credentials.

For #3189 and #3306.

codecov · 2026-04-22T06:34:17Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.73%. Comparing base (e519784) to head (3a8efbc).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5490   +/-   ##
=======================================
  Coverage   97.73%   97.73%           
=======================================
  Files         218      218           
  Lines       49043    49070   +27     
=======================================
+ Hits        47932    47961   +29     
+ Misses       1111     1109    -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

joshuatants · 2026-04-22T07:00:06Z

Hi @googleapis/cloud-sdk-rust-team in this PR I add functionality to gax to support the request level setting of the UserProject. This seems like it should require a bump in the minor number (hence the failing minimal-versions checks). Looking around it seems that this is handled automatically by the tooling. I'm wondering what I should do here?

Split this PR into two: one for the gax change which goes in first, another for the storage change.
Keep the PR as in but add another feat(storage) line to cover storage.

Thank you for the advice.

dbolduc · 2026-04-22T16:38:06Z

I'm wondering what I should do here?

The tests are failing because there is new logic in gax-internal that is not present in the latest released gax-internal.

The tests should pass if you bump the gax-internal version for the crate:

google-cloud-rust/src/gax-internal/Cargo.toml

Line 17 in 562640d

version = "0.7.12"

... as well as the minimum version of gax-internal set in the workspace (which is being used by storage in the failing tests):

google-cloud-rust/Cargo.toml

Line 473 in 562640d

    
           gaxi                     = { default-features = false, version = "0.7.12", path = "src/gax-internal", package = "google-cloud-gax-internal" }

The change is purely additive, so make the version 0.7.13.

(The same would have been true for adding a public API to gax but note that we already did one of these version bumps since the latest release in #5421)

coryan · 2026-04-22T16:50:27Z

The change is purely additive, so make the version 0.7.13.

(The same would have been true for adding a public API to gax but note that we already did one of these version bumps since the latest release in #5421)

I would prefer if we split these changes to gax and gax-internal to separate PRs. Purely because it will make it easier to grok the history of the changes, not because it would fix any builds or anything.

dbolduc

Split this PR into two

This is typically a good idea. I would be grateful if you did this.

I did not look at the storage changes because I have enough feedback on the gax half.

dbolduc · 2026-04-22T16:45:32Z

+    /// provider would have emitted from its configured `quota_project_id`,
+    /// so the wire carries exactly one `x-goog-user-project`.
+    #[derive(Debug, Clone, PartialEq)]
+    pub struct UserProject(http::HeaderValue);


I don't want to plumb this via the extensions. Can you just add a field + setters/getters similar to user_agent, user_agent(), set_user_agent(), with_user_agent() ?

dbolduc · 2026-04-22T16:45:58Z

+        /// # Panics
+        ///
+        /// Panics if the project ID contains non-visible ASCII characters.


This is valid, but not customary for us. I think we can avoid it if we treat it like a user agent. The error may be less helpful, but eh.

dbolduc · 2026-04-22T17:00:39Z

            unreachable!("headers are not cached");
        };

+        if let Some(up) = options.get_extension::<UserProject>() {


Meh, don't love that this is here. But it's fine.

If we keep this, can you add a comment like:

// The client-supplied user project must override the credential's user project. So we insert it after setting the credential's headers.

But I think I would prefer is to add this logic to Self::make_headers()

And then we just flip this to:

// Note that client headers override credential headers (e.g. for the `x-goog-user-project`). data.extend(headers); Ok(data)

dbolduc · 2026-04-22T17:03:58Z

+                if let Some(up) = options.get_extension::<UserProject>() {
+                    data.insert(X_GOOG_USER_PROJECT, up.as_value().clone());
+                }
+                builder.headers(data)


The logic doesn't belong in the match statement. Add a block like the user agent block right after this.

Note that you need to use the builder.headers() method to insert the key and overwrite the previous entry. builder.header() is an append 🫨

optional: at this point, we might want to construct a http::HeaderMap and call builder.headers() once. 🤷

alvarowolfx · 2026-04-22T18:09:49Z

+            }
            Ok(CacheableResource::NotModified) => unreachable!("headers are not cached"),
        };
        builder.build().map_err(map_send_error)


same as @dbolduc, I think we should add a method to the builder to allow overriding request level quota/user project. And maybe some similar code can be used in the gRPC part.

builder = quota_project(options) .into_iter() .fold(builder, |b, qp| b.header(X_GOOG_USER_PROJECT, qp)); fn quota_project(options: &crate::options::RequestOptions){ options.get_extension::<UserProject>() }

joshuatants · 2026-04-23T06:04:45Z

Thank you all for the feedback. Will split the PR and address the comments. ETA for the gax changes is early next week.

Adds a `with_user_project` method to `Storage` and `StorageControl` request builders to support Requester Pays buckets. When set, the internal gRPC and HTTP transports emit an `x-goog-user-project` header which takes precedence over any `quota_project_id` configured in the client credentials.

joshuatants · 2026-04-24T08:17:15Z

@dbolduc @alvarowolfx I've split the PR into two and kept only the gax changes in this PR.

gcb-pr-semver-checks is failing but I'm not sure how to fix it. By my understanding the default implementation the semver checker is complaining about is provided in impl<T> RequestOptionsBuilder for T where T: internal::RequestBuilder. Is that correct?

dbolduc · 2026-04-24T16:22:06Z

@joshuatants - Sorry, you're right. I offered a bad suggestion.

gcb-pr-semver-checks is failing but I'm not sure how to fix it.

It is going to be a tough fix. Let me think about it for a bit and get back to you with a plan.

By my understanding the default implementation the semver checker is complaining about is provided in impl<T> RequestOptionsBuilder for T where T: internal::RequestBuilder. Is that correct?

Yep. This was my mistake. At the time I thought I could make "breaking changes" such as adding a new trait function to public types marked as internal. Since then, we have learned that if a type is public, it is public. It doesn't matter if we hide a module from the documentation and tell external crates not to use it -- breaking the interface costs us a major version bump.

dbolduc · 2026-04-24T19:26:14Z

It is going to be a tough fix.

Actually, I found an easy fix, and wrote it up in go/cloud-rust:adding-request-options

Basically, I think we can provide a default implementation for any new fns we add to RequestOptionsBuilder and specialize them.

So we would say like:

pub trait RequestOptionsBuilder : internal::RequestBuilder {
    // <current fns omitted...>

    fn with_user_project<V: Into<String>>(self, _v: V) -> Self
    where Self: Sized { self }
}

instead of:

pub trait RequestOptionsBuilder : internal::RequestBuilder {
    // <current fns omitted...>

    fn with_user_project<V: Into<String>>(self, v: V) -> Self;
}

... but maybe hold off on making changes in this PR until that doc gets approved. My team often thinks of things that I missed.

joshuatants · 2026-04-27T01:52:22Z

Thanks for the help, will wait for updates.

product-auto-label Bot added the api: storage Issues related to the Cloud Storage API. label Apr 22, 2026

joshuatants requested review from vsharonlynn and xlai20 April 22, 2026 06:25

joshuatants marked this pull request as ready for review April 22, 2026 07:00

joshuatants requested review from a team as code owners April 22, 2026 07:00

dbolduc requested changes Apr 22, 2026

View reviewed changes

alvarowolfx reviewed Apr 22, 2026

View reviewed changes

joshuatants force-pushed the upload_project branch from 3cb6db2 to 521ba73 Compare April 24, 2026 04:02

joshuatants force-pushed the upload_project branch 2 times, most recently from 142e614 to 26d351c Compare April 24, 2026 07:03

focus on gax changes only. address review feedback

3a8efbc

joshuatants force-pushed the upload_project branch from 26d351c to 3a8efbc Compare April 24, 2026 07:19

Conversation

joshuatants commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

joshuatants commented Apr 22, 2026

Uh oh!

dbolduc commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coryan commented Apr 22, 2026

Uh oh!

dbolduc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbolduc Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alvarowolfx Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joshuatants commented Apr 23, 2026

Uh oh!

joshuatants commented Apr 24, 2026

Uh oh!

dbolduc commented Apr 24, 2026

Uh oh!

dbolduc commented Apr 24, 2026

Uh oh!

joshuatants commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joshuatants commented Apr 22, 2026 •

edited

Loading

codecov Bot commented Apr 22, 2026 •

edited

Loading

dbolduc commented Apr 22, 2026 •

edited

Loading

dbolduc Apr 22, 2026 •

edited

Loading

alvarowolfx Apr 22, 2026 •

edited

Loading

joshuatants commented Apr 27, 2026 •

edited

Loading