-
Notifications
You must be signed in to change notification settings - Fork 124
feat(storage): add user_project option #5490
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.
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
Open
joshuatants
wants to merge
2
commits into
googleapis:main
Choose a base branch
from
joshuatants:upload_project
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| mod mock_credentials; | ||
|
|
||
| #[cfg(all(test, feature = "_internal-grpc-client"))] | ||
| mod tests { | ||
| use super::mock_credentials::{MockCredentials, mock_credentials}; | ||
| use google_cloud_auth::credentials::{CacheableResource, Credentials, EntityTag}; | ||
| use google_cloud_gax::Result; | ||
| use google_cloud_gax::options::RequestOptions; | ||
| use google_cloud_gax_internal::grpc; | ||
| use grpc_server::{builder, google, start_echo_server}; | ||
| use http::{HeaderMap, HeaderValue}; | ||
|
|
||
| const X_GOOG_USER_PROJECT: &str = "x-goog-user-project"; | ||
| const CRED_QUOTA_PROJECT: &str = "cred_quota_project"; | ||
| const USER_PROJECT_NAME: &str = "project_lazy_dog"; | ||
|
|
||
| #[tokio::test(flavor = "multi_thread", worker_threads = 2)] | ||
| async fn user_project_emits_header() -> anyhow::Result<()> { | ||
| let (endpoint, _server) = start_echo_server().await?; | ||
| let client = builder(endpoint) | ||
| .with_credentials(mock_credentials()) | ||
| .build() | ||
| .await?; | ||
|
|
||
| let mut options = RequestOptions::default(); | ||
| options.set_user_project(USER_PROJECT_NAME); | ||
| let response = send_request(client, options).await?; | ||
| assert_eq!( | ||
| response | ||
| .metadata | ||
| .get(X_GOOG_USER_PROJECT) | ||
| .map(String::as_str), | ||
| Some(USER_PROJECT_NAME) | ||
| ); | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[tokio::test(flavor = "multi_thread", worker_threads = 2)] | ||
| async fn no_user_project_no_header() -> anyhow::Result<()> { | ||
| let (endpoint, _server) = start_echo_server().await?; | ||
| let client = builder(endpoint) | ||
| .with_credentials(mock_credentials()) | ||
| .build() | ||
| .await?; | ||
|
|
||
| let response = send_request(client, RequestOptions::default()).await?; | ||
| assert!( | ||
| !response.metadata.contains_key(X_GOOG_USER_PROJECT), | ||
| "{:?}", | ||
| response.metadata | ||
| ); | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[tokio::test(flavor = "multi_thread", worker_threads = 2)] | ||
| async fn user_project_strips_credential_quota_project() -> anyhow::Result<()> { | ||
| let (endpoint, _server) = start_echo_server().await?; | ||
|
|
||
| let mut mock = MockCredentials::new(); | ||
| mock.expect_headers().returning(|_exts| { | ||
| let mut map = HeaderMap::new(); | ||
| map.insert( | ||
| http::header::AUTHORIZATION, | ||
| HeaderValue::from_static("Bearer test-token"), | ||
| ); | ||
| map.insert( | ||
| X_GOOG_USER_PROJECT, | ||
| HeaderValue::from_static(CRED_QUOTA_PROJECT), | ||
| ); | ||
| Ok(CacheableResource::New { | ||
| data: map, | ||
| entity_tag: EntityTag::default(), | ||
| }) | ||
| }); | ||
| mock.expect_universe_domain().returning(|| None); | ||
|
|
||
| let client = builder(endpoint) | ||
| .with_credentials(Credentials::from(mock)) | ||
| .build() | ||
| .await?; | ||
|
|
||
| let mut options = RequestOptions::default(); | ||
| options.set_user_project(USER_PROJECT_NAME); | ||
| let response = send_request(client, options).await?; | ||
|
|
||
| assert_eq!( | ||
| response | ||
| .metadata | ||
| .get(X_GOOG_USER_PROJECT) | ||
| .map(String::as_str), | ||
| Some(USER_PROJECT_NAME) | ||
| ); | ||
| assert!( | ||
| !response.metadata.values().any(|v| v == CRED_QUOTA_PROJECT), | ||
| "credential's quota_project value leaked onto the wire: {:?}", | ||
| response.metadata | ||
| ); | ||
| Ok(()) | ||
| } | ||
|
|
||
| async fn send_request( | ||
| client: grpc::Client, | ||
| options: RequestOptions, | ||
| ) -> Result<google::test::v1::EchoResponse> { | ||
| let extensions = { | ||
| let mut e = tonic::Extensions::new(); | ||
| e.insert(tonic::GrpcMethod::new( | ||
| "google.test.v1.EchoServices", | ||
| "Echo", | ||
| )); | ||
| e | ||
| }; | ||
| let request = google::test::v1::EchoRequest { | ||
| message: "message".into(), | ||
| ..google::test::v1::EchoRequest::default() | ||
| }; | ||
| client | ||
| .execute( | ||
| extensions, | ||
| http::uri::PathAndQuery::from_static("/google.test.v1.EchoService/Echo"), | ||
| request, | ||
| options, | ||
| "test-only-api-client/1.0", | ||
| "", | ||
| ) | ||
| .await | ||
| .map(tonic::Response::into_inner) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done