[BEAM-5875] Fix scope of dependency ensuring that it is packaged within the jar. #6894
Conversation
|
LGTM. Thanks for the fix. |
| @@ -23,7 +23,7 @@ description = "Apache Beam :: SDKs :: Java :: Test Utils" | |||
|
|
|||
| dependencies { | |||
| shadow project(path: ":beam-sdks-java-core", configuration: "shadow") | |||
| shadow library.java.guava | |||
| compile library.java.guava | |||
There was a problem hiding this comment.
Could you explain what is the difference between "compile" and "shadow"? I thought I understand this but as I read through "Gradle Primier" doc and "BeamModulePlugin.java" file, I start to have doubts. Some questions:
- both shadow and compile configurations "shadow" guava, because it is listed in the
DEFAULT_SHADOW_CLOSUREthat is used there, right? So whichever configuration I use it will still get shadowed the same way. What if Guava wasn't listed in theDEFAULT_SHADOW_CLOSURE? Would It get shadowed if I use "compile"? - you said that using "compile" packages the depencency "within the jar". So what happens with the guava dependency when I use "shadow"?
There was a problem hiding this comment.
There are two independent parts to what we call "shading": relocating (moving classes into different namespace) and bundling (putting classes into jars). You can do one and not the other. The difference between compile and shadow is bundling. If you have a compile dependency, then it will be bundled into the shadowJar. If you have a shadow dependency, then it will not be bundled into the shadowJar.
The DEFAULT_SHADOW_CLOSURE configures relocations and TBH not sure what include(dependency(...)) does. It is not the same as putting it in the scope to be bundled.
There was a problem hiding this comment.
Another part which is important for shading between compile and shadow is whether the dependency is listed in the pom.xml that is uploaded to Maven central for the artifact.
compile: Not part of pom.xml
shadow: Part of pom.xml
There was a problem hiding this comment.
Thanks for the clarification.
Follow this checklist to help us incorporate your contribution quickly and easily:
[BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replaceBEAM-XXXwith the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.It will help us expedite review of your Pull Request if you tag someone (e.g.
@username) to look at it.Post-Commit Tests Status (on master branch)