feat(gax): add API key authentication to ClientSettings #3137

ldetmer · 2024-08-28T13:04:55Z

Allow gax client libraries to authenticate using API key via setApiKey method exposed from ClientSettings. Also added deduping to GRPC calls for api key headers.

Tested using LanguageServiceSettings

cc @westarle

conventional-commit-lint-gcf · 2024-08-28T13:05:01Z

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

…dentials are provided

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

lqiu96 · 2024-09-30T16:43:16Z

...owcase/src/test/java/com/google/showcase/v1beta1/it/util/GrpcCapturingClientInterceptor.java

+import io.grpc.Status;
+
+/** Implements a client interceptor to retrieve the metadata from a GRPC client request. */
+public class GrpcCapturingClientInterceptor implements ClientInterceptor {


Thanks! I like this. I think we had this in our backlog a while back: #2743

Probably can mark this as closed once this PR is in.

gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java

blakeli0 · 2024-09-30T21:45:34Z

gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java

+   * @return list of provided headers that will be sent with GRPC call with any duplicates removed
+   *     see {@link #removeCredentialDuplicateHeaders()}
+   */
+  public Map<String, String> getHeadersWithDuplicatesRemoved() {


Is this only used in tests? If it is, we can make this package private and mark it as @VisibleForTesting? Or we don't have to expose another method, just make removeCredentialDuplicateHeaders package privare.

lqiu96

LGTM

blakeli0 · 2024-10-01T18:59:42Z

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

+   * a GDC-H audience
+   */
+  @VisibleForTesting
+  public static GdchCredentials getGdchCredentials(


I know it is already marked as @VisibleForTesting, can we make it package private as well? As long as it is public, customers may still use it, either accidentally or intentionally.

blakeli0 · 2024-10-01T19:00:56Z

gax-java/gax/src/test/java/com/google/api/gax/rpc/ClientContextTest.java

@@ -1074,4 +1072,46 @@ public void testStreamWatchdogInterval_backportMethodsBehaveCorrectly() {
        ct -> ct.getStreamWatchdogCheckIntervalDuration(),
        ct -> ct.getStreamWatchdogCheckInterval());
  }
+
+  @Test
+  public void testSetApiKey_createsApiCredentials() throws IOException {


nit: These test methods don't have to be public anymore after we migrated to junit 5.

ah thanks! done

…or them

sonarcloud · 2024-10-02T13:29:20Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
47 New issues
0 Accepted issues

Measures
0 Security Hotspots
94.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarcloud · 2024-10-02T13:32:45Z

Quality Gate passed for 'java_showcase_integration_tests'

Issues
52 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

🤖 I have created a release *beep* *boop* --- <details><summary>2.47.0</summary> ## [2.47.0](v2.46.1...v2.47.0) (2024-10-04) ### Features * **gax:** add API key authentication to ClientSettings ([#3137](#3137)) ([df08956](df08956)) * **gax:** append cred-type header for auth metrics ([#3186](#3186)) ([ca3ec24](ca3ec24)) ### Bug Fixes * address incorrect universe domain validation when quota project id is set ([#3257](#3257)) ([6e70c37](6e70c37)), closes [#3256](#3256) * Disable automatically retrieving Universe Domain from Metadata Server ([#3272](#3272)) ([f4402bf](f4402bf)) ### Dependencies * update dependency com.fasterxml.jackson:jackson-bom to v2.18.0 ([#3248](#3248)) ([821e83d](821e83d)) * update dependency com.google.errorprone:error_prone_annotations to v2.33.0 ([#3265](#3265)) ([94450a9](94450a9)) * update dependency com.google.errorprone:error_prone_annotations to v2.33.0 ([#3266](#3266)) ([8235463](8235463)) * update dependency com.google.guava:guava to v33.3.1-jre ([#3228](#3228)) ([4e76207](4e76207)) * update dependency net.bytebuddy:byte-buddy to v1.15.3 ([#3246](#3246)) ([2aad71d](2aad71d)) * update google api dependencies ([#3242](#3242)) ([02aae9d](02aae9d)) * update google auth library dependencies to v1.28.0 ([#3267](#3267)) ([6d85864](6d85864)) * update googleapis/java-cloud-bom digest to 0cd97b7 ([#3260](#3260)) ([2d54a5d](2d54a5d)) * update grpc dependencies to v1.67.1 ([#3258](#3258)) ([e08906c](e08906c)) * update grpc dependencies to v1.67.1 in dependencies.properties ([#3279](#3279)) ([5b46e70](5b46e70)) * update junit5 monorepo to v5.11.2 ([#3276](#3276)) ([6b10f94](6b10f94)) * update netty dependencies to v4.1.114.final ([#3263](#3263)) ([8bd83d9](8bd83d9)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

added setApiKey() method to client settings

558af8e

product-auto-label bot added the size: s Pull request size is small. label Aug 28, 2024

ldetmer added 2 commits August 28, 2024 10:29

cleaned up and added logic for throwing error if both api key and cre…

dad48d4

…dentials are provided

fixed formatting

f6afbef

product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Aug 28, 2024

fixed formatting

a516d95

ldetmer requested review from lqiu96 and blakeli0 August 28, 2024 18:22

ldetmer added 3 commits September 12, 2024 16:12

wip

f7ec0fa

wip

db1674b

wip

9a13951

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Sep 17, 2024

ldetmer force-pushed the api-keys branch from 138ee61 to 9a13951 Compare September 17, 2024 14:49

product-auto-label bot added size: m Pull request size is medium. and removed size: l Pull request size is large. labels Sep 17, 2024

ldetmer and others added 3 commits September 17, 2024 10:57

clean up

62a3956

Merge branch 'main' into api-keys

f0a98e0

clean up

fa251cf

ldetmer commented Sep 19, 2024

View reviewed changes

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java Outdated Show resolved Hide resolved

ldetmer commented Sep 19, 2024

View reviewed changes

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java Show resolved Hide resolved

ldetmer changed the title ~~POC: add setApiKey() method to client settings~~ feat: add API key authentication to Clientettings Sep 19, 2024

ldetmer changed the title ~~feat: add API key authentication to Clientettings~~ feat: add API key authentication to ClientSettings Sep 19, 2024

ldetmer changed the title ~~feat: add API key authentication to ClientSettings~~ feat(gax): add API key authentication to ClientSettings Sep 19, 2024

ldetmer added 2 commits September 19, 2024 11:24

cleaned up tests/logic

334a4e8

cleaned up formatting

edb658f

ldetmer marked this pull request as ready for review September 19, 2024 15:26

updated to use assertThrows

33f64a1

lqiu96 reviewed Sep 30, 2024

View reviewed changes

ldetmer added 3 commits September 30, 2024 13:11

fixed gdch IT tests

a39bba0

updated so credential deduping happens during the object build process

f64279e

additional cleanup

703139b

ldetmer requested a review from lqiu96 September 30, 2024 20:01

ldetmer added 2 commits September 30, 2024 16:04

lint

245f8e2

lint

0dc642e

lqiu96 reviewed Sep 30, 2024

View reviewed changes

gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java Show resolved Hide resolved

blakeli0 reviewed Sep 30, 2024

View reviewed changes

ldetmer added 4 commits October 1, 2024 14:05

updated to only dedup API key credential headers

60fbed4

language fixes

68f38ae

lint

d3492b3

fixed changes to existing tests

1330841

ldetmer requested review from blakeli0 and lqiu96 October 1, 2024 18:42

lqiu96 approved these changes Oct 1, 2024

View reviewed changes

blakeli0 reviewed Oct 1, 2024

View reviewed changes

ldetmer removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 2, 2024

fixed test modifiers

768140d

ldetmer requested a review from blakeli0 October 2, 2024 13:11

ldetmer and others added 2 commits October 2, 2024 09:11

Merge branch 'main' into api-keys

bc798db

no longer need to pre-load gdch creds as we're not deduping headers f…

e20771d

…or them

blakeli0 approved these changes Oct 2, 2024

View reviewed changes

ldetmer merged commit df08956 into main Oct 2, 2024
49 of 50 checks passed

ldetmer deleted the api-keys branch October 2, 2024 16:09

release-please bot mentioned this pull request Oct 2, 2024

chore(main): release 2.47.0 #3261

Merged

ldetmer mentioned this pull request Oct 7, 2024

chore: update ITDynamicRoutingHeaders to use new standalone Interceptor classes #3287

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(gax): add API key authentication to ClientSettings #3137

feat(gax): add API key authentication to ClientSettings #3137

ldetmer commented Aug 28, 2024 •

edited

Loading

conventional-commit-lint-gcf bot commented Aug 28, 2024 •

edited

Loading

lqiu96 Sep 30, 2024

blakeli0 Sep 30, 2024

lqiu96 left a comment

blakeli0 Oct 1, 2024

blakeli0 Oct 1, 2024

ldetmer Oct 2, 2024

sonarcloud bot commented Oct 2, 2024

sonarcloud bot commented Oct 2, 2024

feat(gax): add API key authentication to ClientSettings #3137

feat(gax): add API key authentication to ClientSettings #3137

Conversation

ldetmer commented Aug 28, 2024 • edited Loading

conventional-commit-lint-gcf bot commented Aug 28, 2024 • edited Loading

lqiu96 Sep 30, 2024

Choose a reason for hiding this comment

blakeli0 Sep 30, 2024

Choose a reason for hiding this comment

lqiu96 left a comment

Choose a reason for hiding this comment

blakeli0 Oct 1, 2024

Choose a reason for hiding this comment

blakeli0 Oct 1, 2024

Choose a reason for hiding this comment

ldetmer Oct 2, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Oct 2, 2024

Quality Gate passed for 'gapic-generator-java-root'

sonarcloud bot commented Oct 2, 2024

Quality Gate passed for 'java_showcase_integration_tests'

ldetmer commented Aug 28, 2024 •

edited

Loading

conventional-commit-lint-gcf bot commented Aug 28, 2024 •

edited

Loading