build: correctly declare api dependencies #334
Merged
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.
Currently, both the
isthmus
andcore
projects are declaring all dependencies asimplementation
dependencies. Gradle has two types of dependenciesapi
andimplementation
dependencies. From the Gradle documentation:https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_separation
For the
core
project some of the protobuf Java classes are part of the Substrait Java API, e.g.com.google.protobuf.ByteString
is exposed as part of theio.substrait.expression.Expression
interface. Which means we should declarecom.google.protobuf:protobuf-java
as anapi
dependency instead of animplementation
dependency.Similarly, in the
isthmus
project classes coming from the dependency on thecore
project are part of the isthmus API and should be reported as anapi
dependency. Additionally, the Apache Calcite classes are part of the isthmus API and so theorg.apache.calcite:calcite-core
should also be declared as anapi
dependency.In order to correctly declare these
api
dependencies we need to switch from thejava
to thejava-library
Gradle plugin.If such dependencies are not declared as
api
dependencies Gradle projects depending on thecore
oristhmus
libraries are forced to repeat the dependency declaration on the respective dependencies.