fix: declare depenencies of API surfaces as api #1535

suztomo · 2021-10-16T03:25:28Z

Fixes: #1534.

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

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

If a class is exposed as API surface, then the dependency should be declared using 'api'.

google-auth-library-oauth2-http

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.

google-auth-library-credentials

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() {

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(

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.

Fix googleapis#1534

gax-grpc/build.gradle

suztomo · 2021-10-16T03:57:10Z

gax-httpjson/build.gradle

 archivesBaseName = "gax-httpjson"

 // TODO: Populate this from dependencies.properties version property (for proper Gradle-Bazel sync)
 project.version = "0.91.1-SNAPSHOT" // {x-version-update:gax-httpjson:current}

 dependencies {
-  implementation( project(':gax'),
-    libraries['maven.com_google_protobuf'],
+  api ( project(':gax'),


At least gax's StatusCode is exposed as API surface.

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

Line 351 in 0fe20f3

public Set<StatusCode.Code> getRetryableCodes() {

suztomo · 2021-10-16T03:58:36Z

gax-grpc/build.gradle

 archivesBaseName = "gax-grpc"

 // TODO: Populate this from dependencies.properties version property (for proper Gradle-Bazel sync)
 project.version = "2.6.1-SNAPSHOT" // {x-version-update:gax-grpc:current}

 dependencies {
-  implementation( project(':gax'),
-    libraries['maven.io_grpc_grpc_stub'],
+  api (project(':gax'),


At least gax's StatusCode is exposed as API surface.

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

Line 301 in 0fe20f3

public Set<StatusCode.Code> getRetryableCodes() {

suztomo · 2021-10-16T03:59:55Z

gax-grpc/build.gradle

-  implementation( project(':gax'),
-    libraries['maven.io_grpc_grpc_stub'],
+  api (project(':gax'),
+    libraries['maven.com_google_auth_google_auth_library_credentials'])


com.google.auth.Credentials is part of API surface

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

Line 158 in 0fe20f3

public GrpcCallContext withCredentials(Credentials newCredentials) {

suztomo · 2021-10-16T04:00:47Z

gax-httpjson/build.gradle

-  implementation( project(':gax'),
-    libraries['maven.com_google_protobuf'],
+  api ( project(':gax'),
+    libraries['maven.com_google_auth_google_auth_library_credentials'])


com.google.auth.Credentials is part of API surface.

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

Line 327 in 0fe20f3

public Credentials getCredentials() {

suztomo · 2021-10-16T04:01:52Z

gax/build.gradle

 archivesBaseName = "gax"

 // TODO: Populate this from dependencies.properties version property (for proper Gradle-Bazel sync)
 project.version = "2.6.1-SNAPSHOT" // {x-version-update:gax:current}

 dependencies {
+  api libraries['maven.com_google_auth_google_auth_library_credentials']


com.google.auth.Credentials is part of API surface #1534 (comment)

Adding more artifacts to be declared as 'api' because they appear in public API surface. See the comment of the following issue for the analysis: googleapis#1534

suztomo

@chanseokoh PTAL.

gax-grpc/build.gradle

build.gradle

* deps: declaring the latest auth library version * fix: declare API surface as api configuration Fix googleapis#1534 * fix: declare API surface's dependencies as 'api' Adding more artifacts to be declared as 'api' because they appear in public API surface. See the comment of the following issue for the analysis: googleapis#1534 * refactor: move java-library declaration to top-level build.gradle

* deps: declaring the latest auth library version * fix: declare API surface as api configuration Fix #1534 * fix: declare API surface's dependencies as 'api' Adding more artifacts to be declared as 'api' because they appear in public API surface. See the comment of the following issue for the analysis: #1534 * refactor: move java-library declaration to top-level build.gradle

🤖 I have created a release \*beep\* \*boop\* --- ### [2.6.1](https://www.github.com/googleapis/gax-java/compare/2.6.0...v2.6.1) (2021-10-18) ### Bug Fixes * declare depenencies of API surfaces as api ([#1535](https://www.github.com/googleapis/gax-java/issues/1535)) ([#1536](https://www.github.com/googleapis/gax-java/issues/1536)) ([8794b5c](https://www.github.com/googleapis/gax-java/commit/8794b5c322659af5a339c40552f16d71b7605cdf)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

suztomo added 2 commits October 15, 2021 23:10

deps: declaring the latest auth library version

63c2ed3

fix: declare API surface as api configuration

b3c3595

Fix googleapis#1534

suztomo requested review from a team as code owners October 16, 2021 03:25

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 16, 2021

suztomo commented Oct 16, 2021

View reviewed changes

fix: declare API surface's dependencies as 'api'

65027e3

Adding more artifacts to be declared as 'api' because they appear in public API surface. See the comment of the following issue for the analysis: googleapis#1534

suztomo changed the title ~~deps: upgrading auth library and declare it as api~~ deps: declare depenencies of API surfaces as api Oct 18, 2021

suztomo changed the title ~~deps: declare depenencies of API surfaces as api~~ fix: declare depenencies of API surfaces as api Oct 18, 2021

suztomo requested a review from chanseokoh October 18, 2021 04:03

refactor: move java-library declaration to top-level build.gradle

397a4fd

suztomo commented Oct 18, 2021

View reviewed changes

gax-grpc/build.gradle Outdated Show resolved Hide resolved

suztomo commented Oct 18, 2021

View reviewed changes

build.gradle Show resolved Hide resolved

chanseokoh approved these changes Oct 18, 2021

View reviewed changes

suztomo merged commit 725414f into googleapis:main Oct 18, 2021

suztomo mentioned this pull request Oct 18, 2021

fix: declare depenencies of API surfaces as api (#1535) #1536

Merged

nwbirnie mentioned this pull request Oct 19, 2021

gax-java should put its dependencies on the compile classpath, not just the runtime classpath #1540

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: declare depenencies of API surfaces as api #1535

fix: declare depenencies of API surfaces as api #1535

suztomo commented Oct 16, 2021 •

edited by chanseokoh

suztomo Oct 16, 2021

suztomo Oct 16, 2021

suztomo Oct 16, 2021

suztomo Oct 16, 2021

suztomo Oct 16, 2021

suztomo left a comment

fix: declare depenencies of API surfaces as api #1535

fix: declare depenencies of API surfaces as api #1535

Conversation

suztomo commented Oct 16, 2021 • edited by chanseokoh

google-auth-library-oauth2-http

google-auth-library-credentials

Other artifacts

org_threeten_threetenbp

com_google_api_api_common

io_opencensus_opencensus_api

grpc-api

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

guava

com_google_api_grpc_proto_google_common_protos

com_google_protobuf

com_google_protobuf_java_util

com_google_code_gson_gson

com_google_http_client_google_http_client

com_google_http_client_google_http_client_gson

suztomo Oct 16, 2021

Choose a reason for hiding this comment

suztomo Oct 16, 2021

Choose a reason for hiding this comment

suztomo Oct 16, 2021

Choose a reason for hiding this comment

suztomo Oct 16, 2021

Choose a reason for hiding this comment

suztomo Oct 16, 2021

Choose a reason for hiding this comment

suztomo left a comment

Choose a reason for hiding this comment

suztomo commented Oct 16, 2021 •

edited by chanseokoh