feat: Supports environment variable quota project ID. #2228
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
Contributor
amanda-tarafa
commented
Oct 10, 2022
amanda-tarafa
commented
- If set, the value on the environment variable is always applied to ADC.
- A helper method is provided to apply this value to any credential.
Contributor
Author
|
@jskeet FYI. This would be my prefered approach. GAX PR coming now. |
jskeet
reviewed
Oct 10, 2022
Collaborator
jskeet
left a comment
jskeet
left a comment
There was a problem hiding this comment.
Yes, I like this approach.
Contributor
Author
|
@jskeet this is ready for review. Thanks! @sai-sunder-s If the design we agreed on is final, and after @jskeet approval, we can merge this. Thanks! |
jskeet
approved these changes
Oct 18, 2022
| if (!string.IsNullOrWhiteSpace(credentialPath)) | ||
| GoogleCredential credential = | ||
| // 1. First try the environment variable. | ||
| await GetADCFromEnvironmentVariableAsync().ConfigureAwait(false) |
Collaborator
There was a problem hiding this comment.
Very minor nit that can definitely be ignored for now - I'd use GetAdcFromEnvironmentVariable (so ADC => Adc).
It's only local methods though, so trivial to change later.
| public virtual GoogleCredential CreateWithQuotaProject(string quotaProject) => | ||
| new GoogleCredential(credential.WithQuotaProject(quotaProject)); | ||
|
|
||
| /// <summary> |
Collaborator
There was a problem hiding this comment.
So if the existing credential has a quota project in, then this can change it to a new value, but can never "remove" the quota project. That's probably fine, but it might be worth highlighting in remarks - again, doesn't have to be right now.
Contributor
Author
There was a problem hiding this comment.
Yes, I've confirmed this behaviour with the Auth team. I'm adding remarks.
amanda-tarafa
force-pushed
the
quota-project-env-var
branch
from
050ec71 to
2e2260f
Compare
- If set, the value on the environment variable is always applied to ADC. - A helper method is provided to apply this value to any credential.
amanda-tarafa
force-pushed
the
quota-project-env-var
branch
from
2e2260f to
f2e9f02
Compare
amanda-tarafa
commented
Oct 18, 2022
Contributor
Author
amanda-tarafa
left a comment
amanda-tarafa
left a comment
There was a problem hiding this comment.
@jskeet Addressed both your comments. Thanks!
| if (!string.IsNullOrWhiteSpace(credentialPath)) | ||
| GoogleCredential credential = | ||
| // 1. First try the environment variable. | ||
| await GetADCFromEnvironmentVariableAsync().ConfigureAwait(false) |
| public virtual GoogleCredential CreateWithQuotaProject(string quotaProject) => | ||
| new GoogleCredential(credential.WithQuotaProject(quotaProject)); | ||
|
|
||
| /// <summary> |
Contributor
Author
There was a problem hiding this comment.
Yes, I've confirmed this behaviour with the Auth team. I'm adding remarks.
amanda-tarafa
added a commit
to amanda-tarafa/google-api-dotnet-client
that referenced
this pull request
Oct 18, 2022
Features - googleapis#2228 Supports Quota Project environment variable for ADC. - googleapis#2219 Removes obsolete OOB code. BREAKING CHANGE: We have removed OOB support from the library because the feature is not supported by Google OAuth as of October 3rd 2022. See the [official announcement](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob) for more information. - googleapis#2216 Log errors when trying to reach Compute's metadata server. - googleapis#2177, googleapis#2197, googleapis#2200, googleapis#2206, googleapis#2215, googleapis#2235 Support for Workload Identity Federation and Worforce Identity Federation. - googleapis#2103 Compute credentials support explicit scopes. - googleapis#2096 Improves deserialization error handling.
amanda-tarafa
added a commit
that referenced
this pull request
Oct 18, 2022
Features - #2228 Supports Quota Project environment variable for ADC. - #2219 Removes obsolete OOB code. BREAKING CHANGE: We have removed OOB support from the library because the feature is not supported by Google OAuth as of October 3rd 2022. See the [official announcement](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob) for more information. - #2216 Log errors when trying to reach Compute's metadata server. - #2177, #2197, #2200, #2206, #2215, #2235 Support for Workload Identity Federation and Worforce Identity Federation. - #2103 Compute credentials support explicit scopes. - #2096 Improves deserialization error handling.
amanda-tarafa
added a commit
to amanda-tarafa/google-api-dotnet-client
that referenced
this pull request
Nov 30, 2022
And support version: 1.58.0-beta02 => 1.58.0 Bug fixes: - googleapis#2273 Don't attempt to use an empty/null media type in batch responses - googleapis#2251 Which fixes a typo on then name of one of the AWS Credential environment variables. - googleapis#2264 Which adds a missing line break in AWS Credential canonical request. Features - googleapis#2269 Support per-request max retry configuration. - googleapis#2228 Supports Quota Project environment variable for ADC. - googleapis#2219 Removes obsolete OOB code. BREAKING CHANGE: We have removed OOB support from the library because the feature is not supported by Google OAuth as of October 3rd 2022. See the [official announcement](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob) for more information. - googleapis#2216 Log errors when trying to reach Compute's metadata server. - googleapis#2177, googleapis#2197, googleapis#2200, googleapis#2206, googleapis#2215, googleapis#2235 Support for Workload Identity Federation and Worforce Identity Federation. - googleapis#2103 Compute credentials support explicit scopes. - googleapis#2096 Improves deserialization error handling.
amanda-tarafa
added a commit
to amanda-tarafa/google-api-dotnet-client
that referenced
this pull request
Nov 30, 2022
And support version: 1.58.0-beta02 => 1.58.0 Dependencies: - Client libraries no longer target netstandard1.0 or net40. Bug fixes: - googleapis#2273 Don't attempt to use an empty/null media type in batch responses - googleapis#2251 Which fixes a typo on then name of one of the AWS Credential environment variables. - googleapis#2264 Which adds a missing line break in AWS Credential canonical request. Features - googleapis#2269 Support per-request max retry configuration. - googleapis#2228 Supports Quota Project environment variable for ADC. - googleapis#2219 Removes obsolete OOB code. BREAKING CHANGE: We have removed OOB support from the library because the feature is not supported by Google OAuth as of October 3rd 2022. See the [official announcement](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob) for more information. - googleapis#2216 Log errors when trying to reach Compute's metadata server. - googleapis#2177, googleapis#2197, googleapis#2200, googleapis#2206, googleapis#2215, googleapis#2235 Support for Workload Identity Federation and Worforce Identity Federation. - googleapis#2103 Compute credentials support explicit scopes. - googleapis#2096 Improves deserialization error handling.
amanda-tarafa
added a commit
that referenced
this pull request
Nov 30, 2022
And support version: 1.58.0-beta02 => 1.58.0 Dependencies: - Client libraries no longer target netstandard1.0 or net40. Bug fixes: - #2273 Don't attempt to use an empty/null media type in batch responses - #2251 Which fixes a typo on then name of one of the AWS Credential environment variables. - #2264 Which adds a missing line break in AWS Credential canonical request. Features - #2269 Support per-request max retry configuration. - #2228 Supports Quota Project environment variable for ADC. - #2219 Removes obsolete OOB code. BREAKING CHANGE: We have removed OOB support from the library because the feature is not supported by Google OAuth as of October 3rd 2022. See the [official announcement](https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob) for more information. - #2216 Log errors when trying to reach Compute's metadata server. - #2177, #2197, #2200, #2206, #2215, #2235 Support for Workload Identity Federation and Worforce Identity Federation. - #2103 Compute credentials support explicit scopes. - #2096 Improves deserialization error handling.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.