-
Notifications
You must be signed in to change notification settings - Fork 39
Use the shadow plugin to shade Jetty #225
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
staktrace
merged 3 commits into
cashapp:main
from
ThePumpingLemma:dgrochowski.shade-jetty
Apr 29, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| .gradle-7.6.1.pkg | ||
| .gradle-8.13.pkg |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| import com.vanniktech.maven.publish.JavadocJar.Dokka | ||
| import com.vanniktech.maven.publish.KotlinJvm | ||
| import com.vanniktech.maven.publish.MavenPublishBaseExtension | ||
|
|
||
| plugins { | ||
| kotlin("jvm") | ||
| `java-library` | ||
| id("com.gradleup.shadow") | ||
| id("com.vanniktech.maven.publish.base") | ||
| } | ||
|
|
||
| dependencies { | ||
| // Ignore transtive dependencies and instead manage explicitly. | ||
| implementation(libs.awsDynamodbLocal) { | ||
| isTransitive = false | ||
| } | ||
|
|
||
| // Implementation dependencies will be shaded in the JAR. | ||
| implementation(libs.bundles.jackson) | ||
| implementation(libs.bundles.jetty) | ||
| implementation(libs.kotlinStdLib) | ||
|
|
||
| // Shadow dependencies will not be shaded. | ||
| shadow(libs.antlr4Runtime) | ||
| shadow(libs.aws2Dynamodb) | ||
| shadow(libs.aws2DynamodbEnhanced) | ||
| shadow(libs.aws2Pinpoint) | ||
| shadow(libs.awsDynamodb) | ||
| shadow(libs.commonsCli) | ||
| shadow(libs.commonsLang3) | ||
| shadow(libs.guava) | ||
| shadow(libs.slf4jApi) | ||
| shadow(libs.bundles.sqlite4java) | ||
| } | ||
|
|
||
| tasks.named<Jar>("jar") { | ||
| archiveClassifier.set("unshaded") | ||
| } | ||
|
|
||
| tasks.shadowJar { | ||
| // Dependencies to be shaded must be explicitly included as dependencies. | ||
| dependencies { | ||
| include(dependency("com.amazonaws:DynamoDBLocal")) | ||
| include(dependency("com.fasterxml.jackson.core:.*")) | ||
| include(dependency("com.fasterxml.jackson.dataformat:.*")) | ||
| include(dependency("com.fasterxml.jackson.datatype:.*")) | ||
| include(dependency("com.fasterxml.jackson.module:.*")) | ||
| include(dependency("org.eclipse.jetty:.*")) | ||
| } | ||
|
|
||
| // Relocate packages to avoid conflicts. | ||
| listOf( | ||
| "com.amazon.dynamodb.grammar", | ||
| "com.amazon.ion", | ||
| "com.amazonaws.services.dynamodbv2.dataMembers", | ||
| "com.amazonaws.services.dynamodbv2.datamodel", | ||
| "com.amazonaws.services.dynamodbv2.dbenv", | ||
| "com.amazonaws.services.dynamodbv2.exceptions", | ||
| "com.amazonaws.services.dynamodbv2.local", | ||
| "com.fasterxml.jackson", | ||
| "ddb.partiql", | ||
| "kotlin", | ||
| "org.eclipse.jetty", | ||
| "org.partiql", | ||
| ).forEach { relocate(it, "app.cash.tempest.testing.dynamodb.local.shaded.${it}") } | ||
|
|
||
| mergeServiceFiles() | ||
|
|
||
| // Publish shadow JAR as the main JAR. | ||
| archiveClassifier = "" | ||
| } | ||
|
|
||
| configure<MavenPublishBaseExtension> { | ||
| configure( | ||
| KotlinJvm(javadocJar = Dokka("dokkaGfm")) | ||
| ) | ||
|
|
||
| pom { | ||
| withXml { | ||
| val root = asNode() | ||
|
|
||
| // First collect all dependencies nodes. | ||
| val dependenciesNodes = root.children() | ||
| .filterIsInstance<groovy.util.Node>() | ||
| .filter { it.name().toString().contains("dependencies") } | ||
| .toList() | ||
|
|
||
| // Then remove them safely. | ||
| dependenciesNodes.forEach { node -> | ||
| root.remove(node) | ||
| } | ||
|
|
||
| // Add a new dependencies node with shadow configuration. | ||
| val dependenciesNode = root.appendNode("dependencies") | ||
|
|
||
| // Add all shadow dependencies to the POM. | ||
| project.configurations.named("shadow").get().allDependencies.forEach { dep -> | ||
| val dependencyNode = dependenciesNode.appendNode("dependency") | ||
| dependencyNode.appendNode("groupId", dep.group) | ||
| dependencyNode.appendNode("artifactId", dep.name) | ||
| dependencyNode.appendNode("version", dep.version) | ||
| dependencyNode.appendNode("scope", "compile") | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The net effect here is to remove the dependencies that were shaded, right? Kinda surprised this needs to be done explicitly but I don't have much experience with the intersection of shadow and publication
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this surprised me as well. What's happening is that the publication is using the runtime classpath, which is not the same as the shadow classpath of the shadow jar. If you publish via the shadow plugin, it can handle this for you, but I didn't want to change the publication mechanism.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ThePumpingLemma can you elaborate on
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't want to switch which plugin was used to publish to maven, but if we're okay with doing this via the shadow plugin and it's easier then let's do it.