fix: includeShadowJar was breaking shadowJar tasks laziness

Author: bric3

dd-java-agent/build.gradle

@@ -46,73 +46,75 @@ dependencies {
  * This general config is shared by all of them
  */
 
-ext.generalShadowJarConfig = {
-  mergeServiceFiles()
-
-  duplicatesStrategy = DuplicatesStrategy.FAIL
-
-  // Include AgentPreCheck compiled with Java 6.
-  from sourceSets.main_java6.output
-
-  // Remove some cruft from the final jar.
-  // These patterns should NOT include **/META-INF/maven/**/pom.properties, which is
-  // used to report our own dependencies, but we should remove the top-level metadata
-  // of vendored packages because those could trigger unwanted framework checks.
-  exclude '/META-INF/maven/org.slf4j/**'
-  exclude '/META-INF/maven/org.snakeyaml/**'
-  exclude '**/META-INF/maven/**/pom.xml'
-  exclude '**/META-INF/proguard/'
-  exclude '**/META-INF/*.kotlin_module'
-  exclude '**/module-info.class'
-  exclude '**/liblz4-java.so'
-  exclude '**/liblz4-java.dylib'
-  exclude '**/inst/META-INF/versions/**'
-  exclude '**/META-INF/versions/*/org/yaml/**'
-
-  // Replaced by 'instrumenter.index', no need to include original service file
-  exclude '**/META-INF/services/datadog.trace.agent.tooling.InstrumenterModule'
-
-  // Prevents conflict with other SLF4J instances. Important for premain.
-  relocate 'org.slf4j', 'datadog.slf4j'
-  // Prevent conflicts with flat class-path when using GraalVM native-images
-  relocate 'org.jctools', 'datadog.jctools'
-  relocate 'net.jpountz', 'datadog.jpountz'
-  // rewrite dependencies calling Logger.getLogger
-  relocate 'java.util.logging.Logger', 'datadog.trace.bootstrap.PatchLogger'
-  // patch JFFI loading mechanism to maintain isolation
-  exclude '**/com/kenai/jffi/Init.class'
-  relocate('com.kenai.jffi.Init', 'com.kenai.jffi.PatchInit')
-
-  // Minimize and relocate the airlift compressor dependency for ZSTD
-  exclude '**/io/airlift/compress/bzip2/**'
-  exclude '**/io/airlift/compress/deflate/**'
-  exclude '**/io/airlift/compress/gzip/**'
-  exclude '**/io/airlift/compress/hadoop/**'
-  exclude '**/io/airlift/compress/lz4/**'
-  exclude '**/io/airlift/compress/lzo/**'
-  exclude '**/io/airlift/compress/snappy/**'
-  relocate 'io.airlift', 'datadog.io.airlift'
-
-  final String projectName = "${project.name}"
-
-  // Prevents conflict with other instances, but doesn't relocate instrumentation
-  if (!projectName.equals('instrumentation')) {
-    relocate 'org.snakeyaml.engine', 'datadog.snakeyaml.engine'
-    relocate 'okhttp3', 'datadog.okhttp3'
-    relocate 'okio', 'datadog.okio'
-  }
+def generalShadowJarConfig(ShadowJar shadowJarTask) {
+  shadowJarTask.with {
+    mergeServiceFiles()
+
+    duplicatesStrategy = DuplicatesStrategy.FAIL
+
+    // Include AgentPreCheck compiled with Java 6.
+    from sourceSets.main_java6.output
+
+    // Remove some cruft from the final jar.
+    // These patterns should NOT include **/META-INF/maven/**/pom.properties, which is
+    // used to report our own dependencies, but we should remove the top-level metadata
+    // of vendored packages because those could trigger unwanted framework checks.
+    exclude '/META-INF/maven/org.slf4j/**'
+    exclude '/META-INF/maven/org.snakeyaml/**'
+    exclude '**/META-INF/maven/**/pom.xml'
+    exclude '**/META-INF/proguard/'
+    exclude '**/META-INF/*.kotlin_module'
+    exclude '**/module-info.class'
+    exclude '**/liblz4-java.so'
+    exclude '**/liblz4-java.dylib'
+    exclude '**/inst/META-INF/versions/**'
+    exclude '**/META-INF/versions/*/org/yaml/**'
+
+    // Replaced by 'instrumenter.index', no need to include original service file
+    exclude '**/META-INF/services/datadog.trace.agent.tooling.InstrumenterModule'
+
+    // Prevents conflict with other SLF4J instances. Important for premain.
+    relocate 'org.slf4j', 'datadog.slf4j'
+    // Prevent conflicts with flat class-path when using GraalVM native-images
+    relocate 'org.jctools', 'datadog.jctools'
+    relocate 'net.jpountz', 'datadog.jpountz'
+    // rewrite dependencies calling Logger.getLogger
+    relocate 'java.util.logging.Logger', 'datadog.trace.bootstrap.PatchLogger'
+    // patch JFFI loading mechanism to maintain isolation
+    exclude '**/com/kenai/jffi/Init.class'
+    relocate('com.kenai.jffi.Init', 'com.kenai.jffi.PatchInit')
+
+    // Minimize and relocate the airlift compressor dependency for ZSTD
+    exclude '**/io/airlift/compress/bzip2/**'
+    exclude '**/io/airlift/compress/deflate/**'
+    exclude '**/io/airlift/compress/gzip/**'
+    exclude '**/io/airlift/compress/hadoop/**'
+    exclude '**/io/airlift/compress/lz4/**'
+    exclude '**/io/airlift/compress/lzo/**'
+    exclude '**/io/airlift/compress/snappy/**'
+    relocate 'io.airlift', 'datadog.io.airlift'
+
+    final String projectName = "${project.name}"
+
+    // Prevents conflict with other instances, but doesn't relocate instrumentation
+    if (!projectName.equals('instrumentation')) {
+      relocate 'org.snakeyaml.engine', 'datadog.snakeyaml.engine'
+      relocate 'okhttp3', 'datadog.okhttp3'
+      relocate 'okio', 'datadog.okio'
+    }
 
-  if (!project.hasProperty("disableShadowRelocate") || !disableShadowRelocate) {
-    // shadow OT impl to prevent casts to implementation
-    relocate 'datadog.trace.common', 'datadog.trace.agent.common'
-    relocate 'datadog.trace.core', 'datadog.trace.agent.core'
-    relocate 'datadog.opentracing', 'datadog.trace.agent.ot'
-    // shadow things in internal API that has slf4j in the API and is accessed from core
-    relocate 'datadog.trace.relocate', 'datadog.trace.agent.relocate'
+    if (!project.hasProperty("disableShadowRelocate") || !disableShadowRelocate) {
+      // shadow OT impl to prevent casts to implementation
+      relocate 'datadog.trace.common', 'datadog.trace.agent.common'
+      relocate 'datadog.trace.core', 'datadog.trace.agent.core'
+      relocate 'datadog.opentracing', 'datadog.trace.agent.ot'
+      // shadow things in internal API that has slf4j in the API and is accessed from core
+      relocate 'datadog.trace.relocate', 'datadog.trace.agent.relocate'
+    }
   }
 }
 
-def includeShadowJar(TaskProvider<ShadowJar> shadowJarTask, String jarname) {
+def includeShadowJar(TaskProvider<ShadowJar> includedShadowJarTask, String dirLocation) {
   def opentracingFound = new AtomicBoolean()
   project.processResources {
     doFirst {
@@ -129,12 +131,12 @@ def includeShadowJar(TaskProvider<ShadowJar> shadowJarTask, String jarname) {
       }
     }
 
-    from(zipTree(shadowJarTask.get().archiveFile)) {
-      into jarname
+    from(zipTree(includedShadowJarTask.map { it.archiveFile })) {
+      into dirLocation
       rename '(^.*)\\.class$', '$1.classdata'
       // Rename LICENSE file since it clashes with license dir on non-case sensitive FSs (i.e. Mac)
       rename '^LICENSE$', 'LICENSE.renamed'
-      if (jarname == 'inst') {
+      if (dirLocation == 'inst') {
         // byte-buddy now ships classes optimized for Java8+ under META-INF/versions/9
         // since we target Java8+ we can promote these classes over the pre-Java8 ones
         duplicatesStrategy = DuplicatesStrategy.EXCLUDE
@@ -148,27 +150,30 @@ def includeShadowJar(TaskProvider<ShadowJar> shadowJarTask, String jarname) {
   }
 
   project.tasks.named("processResources") {
-    dependsOn shadowJarTask
+    dependsOn includedShadowJarTask
+  }
+
+  includedShadowJarTask.configure {
+    generalShadowJarConfig(it as ShadowJar)
   }
-  shadowJarTask.configure generalShadowJarConfig
 }
 
 def includeSubprojShadowJar(String projName, String jarname) {
   evaluationDependsOn projName
   def proj = project(projName)
-  includeShadowJar proj.tasks.named("shadowJar"), jarname
+  includeShadowJar(proj.tasks.named("shadowJar", ShadowJar), jarname)
 }
 
-includeSubprojShadowJar ':dd-java-agent:instrumentation', 'inst'
-includeSubprojShadowJar ':dd-java-agent:agent-jmxfetch', 'metrics'
-includeSubprojShadowJar ':dd-java-agent:agent-profiling', 'profiling'
-includeSubprojShadowJar ':dd-java-agent:appsec', 'appsec'
-includeSubprojShadowJar ':dd-java-agent:agent-iast', 'iast'
-includeSubprojShadowJar ':dd-java-agent:agent-debugger', 'debugger'
-includeSubprojShadowJar ':dd-java-agent:agent-ci-visibility', 'ci-visibility'
-includeSubprojShadowJar ':dd-java-agent:agent-llmobs', 'llm-obs'
-includeSubprojShadowJar ':dd-java-agent:agent-logs-intake', 'logs-intake'
-includeSubprojShadowJar ':dd-java-agent:cws-tls', 'cws-tls'
+includeSubprojShadowJar(':dd-java-agent:instrumentation', 'inst')
+includeSubprojShadowJar(':dd-java-agent:agent-jmxfetch', 'metrics')
+includeSubprojShadowJar(':dd-java-agent:agent-profiling', 'profiling')
+includeSubprojShadowJar(':dd-java-agent:appsec', 'appsec')
+includeSubprojShadowJar(':dd-java-agent:agent-iast', 'iast')
+includeSubprojShadowJar(':dd-java-agent:agent-debugger', 'debugger')
+includeSubprojShadowJar(':dd-java-agent:agent-ci-visibility', 'ci-visibility')
+includeSubprojShadowJar(':dd-java-agent:agent-llmobs', 'llm-obs')
+includeSubprojShadowJar(':dd-java-agent:agent-logs-intake', 'logs-intake')
+includeSubprojShadowJar(':dd-java-agent:cws-tls', 'cws-tls')
 
 def sharedShadowJar = tasks.register('sharedShadowJar', ShadowJar) {
   configurations = [project.configurations.sharedShadowInclude]
@@ -200,7 +205,9 @@ def traceShadowJar = tasks.register('traceShadowJar', ShadowJar) {
 }
 includeShadowJar(traceShadowJar, 'trace')
 
-shadowJar generalShadowJarConfig >> {
+tasks.named("shadowJar", ShadowJar) {
+  generalShadowJarConfig(it)
+
   configurations = [project.configurations.shadowInclude]
 
   archiveClassifier = ''
@@ -212,7 +219,7 @@ shadowJar generalShadowJarConfig >> {
       "Premain-Class": "datadog.trace.bootstrap.AgentPreCheck",
       "Can-Redefine-Classes": true,
       "Can-Retransform-Classes": true,
-      )
+    )
   }
 }