GAX now declares google-auth-library-oauth2-http as runtime scope. Is this correct?

[suztomo]

googleapis/java-shared-dependencies@3e5ffe0#r730141975 a check failed because GAX recently changed the scope of the google-auth-library-oauth2-http as runtime.

This means the code that touches the class of google-auth-library-oauth2-http now have to declare google-auth-library-oauth2-http as dependency. (This is a good thing; If you use a class, then you should declare the dependency.)

Is there any other implications of changing the scope?

[chanseokoh]

I believe this is the commit that made the change. The compile configuration name (you may think of it as "scope" in Maven's terms) in Gradle is deprecated and shouldn't be used.

Now, whether google-auth-library-oauth2-http and (all other dependencies of gax-java affected by the change) should be exposed to the compile classpath of the user using gax-java, the answer depends on whether it's necessary to do so or not. As a Java library, if the public API surface of gax-java does make use of the classes from google-auth-library-oauth2-http (e.g., used as a return value of a public interface), then it must be exposed. Otherwise, if all the classes from google-auth-library-oauth2-http are never visible through the public surface but consumed only internally by gax-java, it shouldn't be exposed. I'm pretty new to gax-java, so I don't have an immediate answer.

[suztomo]

Thank you for the pointer. I found the corresponding explanation of Gradle's "implementation" mapped to Maven's "runtime" scope:

Gradle will also use the versions resolved on the runtimeClasspath for dependencies declared in implementation, which are mapped to the runtime scope of Maven

https://docs.gradle.org/current/userguide/publishing_maven.html

[suztomo]

@chanseokoh For the classes in com.google.auth.oauth2 (com.google.auth.oauth2.QuotaProjectIdProvider, com.google.auth.oauth2.ComputeEngineCredentials, com.google.auth.oauth2.GoogleCredentials, com.google.auth.oauth2.ServiceAccountCredentials, com.google.auth.oauth2.ServiceAccountJwtAccessCredentials, com.google.auth.oauth2.QuotaProjectIdProvider), I didn't find any of them used as API surface. Therefore "implementation" makes sense.

However, I found com.google.auth.Credentials class in google-auth-library-credentials is exposed in gax. This artifact is not declared in gax's build.gradle.

Other artifacts?

org_threeten_threetenbp

The artifact defines org.threeten.bp.Duration.

gax exposes it in its public API

gax-java/gax/src/main/java/com/google/api/gax/batching/BatchingSettings.java

Line 103 in 2ce5a2f

public abstract Duration getDelayThreshold();

gax-grpc uses it in its public API

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

Line 202 in 0fe20f3

public Duration getTimeout() {

gax-httpjson uses it in its public API

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/HttpJsonCallContext.java

Line 247 in 0fe20f3

public Duration getTimeout() {

maven.com_google_api_api_common

gax uses com.google.api.core.ApiFuture in its public API

gax-java/gax/src/main/java/com/google/api/gax/batching/ThresholdBatcher.java

Line 217 in ff4b61e

public ApiFuture<Void> pushCurrentBatch() {

.

gax-grpc uses it

gax-java/gax-grpc/src/main/java/com/google/longrunning/OperationsClient.java

Line 598 in 68761a7

public static ApiFuture<ListOperationsPagedResponse> createAsync(

gax-httpjson uses it

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/HttpJsonChannel.java

Line 38 in 8d45d18

<ResponseT, RequestT> ApiFuture<ResponseT> issueFutureUnaryCall(

maven.io_opencensus_opencensus_api

It doesn't appear in the API surfaces of gax, gax-grpc, and gax-httpjson.

grpc-api

gax-grpc uses it in public API

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

Line 44 in 4b3f21b

void onHeaders(Metadata metadata);

grpc-auth, grpc-protobuf, grpc-netty-shaded, grpc-alts, grpc-stub

They are not in public API.

guava

gax-grpc uses com.google.common.collect.ImmutableList in public API

gax-java/gax-grpc/src/main/java/com/google/longrunning/stub/OperationsStubSettings.java

Line 353 in 68761a7

public ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders() {

gax-httpjson uses it in public API

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/longrunning/stub/OperationsStubSettings.java

Line 398 in 2d76bff

public ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders() {

com_google_api_grpc_proto_google_common_protos

gax-grpc uses com.google.longrunning.Operation in public API

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

Line 184 in 763aafb

GrpcCallSettings<RequestT, Operation> grpcCallSettings,

gax-httpjson uses com.google.longrunning.ListOperationsRequest in public API

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/longrunning/stub/OperationsStub.java

Line 54 in 2d76bff

public UnaryCallable<ListOperationsRequest, ListOperationsPagedResponse>

com_google_protobuf

gax-httpjson uses com.google.protobuf.TypeRegistry in public API

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/ApiMessageHttpResponseParser.java

Line 109 in 95ca348

public ResponseT parse(InputStream httpResponseBody, TypeRegistry registry) {

com_google_protobuf_java_util

It's not used as public API.

com_google_code_gson_gson

gax-httpjson uses com.google.gson.JsonElement in public API

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/FieldMaskedSerializer.java

Line 51 in 8f9d6ce

public JsonElement serialize(

com_google_http_client_google_http_client

gax-httpjson uses com.google.api.client.http.HttpTransport in public API

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/ManagedHttpJsonChannel.java

Line 170 in 8f48b70

public Builder setHttpTransport(HttpTransport httpTransport) {

com_google_http_client_google_http_client_gson

This is not used in public API.