Resolve Configuration directly in DependencyFilter (#1045)

GradleUp · Nov 26, 2024 · d373be1 · d373be1
1 parent d5e3cec
commit d373be1
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 11 deletions.
diff --git a/api/shadow.api b/api/shadow.api
@@ -100,7 +100,7 @@ public abstract interface class com/github/jengelman/gradle/plugins/shadow/inter
 	public abstract fun project (Ljava/lang/String;)Lorg/gradle/api/specs/Spec;
 	public abstract fun project (Ljava/util/Map;)Lorg/gradle/api/specs/Spec;
 	public abstract fun resolve (Ljava/util/Collection;)Lorg/gradle/api/file/FileCollection;
-	public abstract fun resolve (Lorg/gradle/api/file/FileCollection;)Lorg/gradle/api/file/FileCollection;
+	public abstract fun resolve (Lorg/gradle/api/artifacts/Configuration;)Lorg/gradle/api/file/FileCollection;
 }
 
 public abstract interface class com/github/jengelman/gradle/plugins/shadow/internal/ZipCompressor : org/gradle/api/internal/file/archive/compression/ArchiveOutputStreamFactory {

diff --git a/src/docs/changes/README.md b/src/docs/changes/README.md
@@ -10,6 +10,7 @@
 **Changed**
 
 - **BREAKING CHANGE:** Rewrite this plugin in Kotlin. ([#1012](https://github.com/GradleUp/shadow/pull/1012))
+- **BREAKING CHANGE:** Resolve `Configuration` directly in `DependencyFilter`. ([#1045](https://github.com/GradleUp/shadow/pull/1045))
 
 **Removed**
 

diff --git a/...in/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/AbstractDependencyFilter.kt b/...in/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/AbstractDependencyFilter.kt
@@ -22,16 +22,15 @@ internal sealed class AbstractDependencyFilter(
     excludedDependencies: MutableSet<ResolvedDependency>,
   )
 
-  override fun resolve(configuration: FileCollection): FileCollection {
+  override fun resolve(configuration: Configuration): FileCollection {
     val includedDeps = mutableSetOf<ResolvedDependency>()
     val excludedDeps = mutableSetOf<ResolvedDependency>()
-    configuration as Configuration
     resolve(configuration.resolvedConfiguration.firstLevelModuleDependencies, includedDeps, excludedDeps)
     return project.files(configuration.files) -
       project.files(excludedDeps.flatMap { it.moduleArtifacts.map(ResolvedArtifact::getFile) })
   }
 
-  override fun resolve(configurations: Collection<FileCollection>): FileCollection {
+  override fun resolve(configurations: Collection<Configuration>): FileCollection {
     return configurations.map { resolve(it) }
       .reduceOrNull { acc, fileCollection -> acc + fileCollection }
       ?: project.files()

diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/DependencyFilter.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/DependencyFilter.kt
@@ -1,21 +1,22 @@
 package com.github.jengelman.gradle.plugins.shadow.internal
 
 import groovy.lang.Closure
+import org.gradle.api.artifacts.Configuration
 import org.gradle.api.artifacts.Dependency
 import org.gradle.api.artifacts.ResolvedDependency
 import org.gradle.api.file.FileCollection
 import org.gradle.api.specs.Spec
 
 public interface DependencyFilter {
   /**
-   * Resolve a FileCollection against the include/exclude rules in the filter.
+   * Resolve a [Configuration] against the include/exclude rules in the filter.
    */
-  public fun resolve(configuration: FileCollection): FileCollection
+  public fun resolve(configuration: Configuration): FileCollection
 
   /**
-   * Resolve all FileCollections against the include/exclude rules in the filter and combine the results.
+   * Resolve all [Configuration]s against the include/exclude rules in the filter and combine the results.
    */
-  public fun resolve(configurations: Collection<FileCollection>): FileCollection
+  public fun resolve(configurations: Collection<Configuration>): FileCollection
 
   /**
    * Exclude dependencies that match the provided spec.

diff --git a/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.kt b/src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.kt
@@ -20,6 +20,7 @@ import java.util.concurrent.Callable
 import java.util.jar.JarFile
 import org.apache.tools.zip.ZipOutputStream
 import org.gradle.api.Action
+import org.gradle.api.artifacts.Configuration
 import org.gradle.api.file.DuplicatesStrategy
 import org.gradle.api.file.FileCollection
 import org.gradle.api.internal.DocumentationRegistry
@@ -47,7 +48,7 @@ public abstract class ShadowJar :
   ShadowSpec {
   private val _transformers = mutableListOf<Transformer>()
   private val _relocators = mutableListOf<Relocator>()
-  private val _configurations = mutableListOf<FileCollection>()
+  private val _configurations = mutableListOf<Configuration>()
   private val _stats = ShadowStats()
   private val _includedDependencies = project.files(Callable { _dependencyFilter.resolve(_configurations) })
 
@@ -158,7 +159,7 @@ public abstract class ShadowJar :
 
   @get:Classpath
   @get:Optional
-  public var configurations: List<FileCollection>
+  public var configurations: List<Configuration>
     get() = _configurations
     set(value) {
       _configurations.clear()
@@ -327,7 +328,8 @@ public abstract class ShadowJar :
 
   private fun configureRelocation() {
     val packages = mutableSetOf<String>()
-    configurations.forEach { configuration ->
+    // Must cast configurations to List<FileCollection> to fix type mismatch in runtime.
+    (configurations as List<FileCollection>).forEach { configuration ->
       configuration.files.forEach { jarFile ->
         JarFile(jarFile).use { jf ->
           jf.entries().asSequence().forEach { entry ->