Construct DependencyFileWriter only when required

Author: bigdaz

plugin/src/main/kotlin/org/gradle/github/dependencygraph/GitHubDependencyExtractorPlugin.kt

@@ -50,7 +50,7 @@ class GitHubDependencyExtractorPlugin : Plugin<Gradle> {
         gradle.rootProject { project ->
             dependencyExtractorProvider
                 .get()
-                .setRootProjectBuildDirectory(project.buildDir)
+                .rootProjectBuildDirectory = project.buildDir
         }
 
         // Register the service to listen for Build Events

plugin/src/main/kotlin/org/gradle/github/dependencygraph/internal/DependencyExtractor.kt

@@ -5,6 +5,7 @@ import org.gradle.api.artifacts.result.ResolvedComponentResult
 import org.gradle.api.artifacts.result.ResolvedDependencyResult
 import org.gradle.api.internal.artifacts.DefaultProjectComponentIdentifier
 import org.gradle.api.internal.artifacts.configurations.ResolveConfigurationDependenciesBuildOperationType
+import org.gradle.api.logging.Logging
 import org.gradle.github.GitHubDependencyGraphPlugin
 import org.gradle.github.dependencygraph.internal.model.ComponentCoordinates
 import org.gradle.github.dependencygraph.internal.model.ResolvedComponent
@@ -28,11 +29,7 @@ abstract class DependencyExtractor :
     protected abstract val gitRef: String
     protected abstract val gitWorkspaceDirectory: Path
 
-    /**
-     * Can't use this as a proper input:
-     * https://github.com/gradle/gradle/issues/19562
-     */
-    private var fileWriter: DependencyFileWriter = DependencyFileWriter.create()
+    var rootProjectBuildDirectory: File? = null
 
     private val gitHubRepositorySnapshotBuilder by lazy {
         GitHubRepositorySnapshotBuilder(
@@ -50,10 +47,6 @@ abstract class DependencyExtractor :
         println("Creating: DependencyExtractorService")
     }
 
-    internal fun setRootProjectBuildDirectory(rootProjectBuildDirectory: File) {
-        fileWriter = DependencyFileWriter.create(rootProjectBuildDirectory, dependencyGraphJobCorrelator)
-    }
-
     override fun started(buildOperation: BuildOperationDescriptor, startEvent: OperationStartEvent) {
         // This method will never be called when registered in a `BuildServiceRegistry` (ie. Gradle 6.1 & higher)
         // No-op
@@ -182,8 +175,19 @@ abstract class DependencyExtractor :
         }
     }
 
-    private fun writeAndGetSnapshotFile(): File =
+    private fun writeAndGetSnapshotFile() {
+        if (rootProjectBuildDirectory == null) {
+            LOGGER.warn("Unable to write dependency graph snapshot: target directory not known")
+            return
+        }
+        val outputFile = File(
+            rootProjectBuildDirectory,
+            "reports/github-dependency-graph-plugin/github-dependency-snapshot-${dependencyGraphJobCorrelator}.json"
+        )
+
+        val fileWriter = DependencyFileWriter(outputFile)
         fileWriter.writeDependencyManifest(gitHubRepositorySnapshotBuilder.build())
+    }
 
     override fun close() {
         if (thrownExceptions.isNotEmpty()) {
@@ -203,6 +207,9 @@ abstract class DependencyExtractor :
             )
         }
     }
+    companion object {
+        private val LOGGER = Logging.getLogger(DependencyExtractor::class.java)
+    }
 }
 
 private inline fun <reified D, reified R> handleBuildOperationTypeRaw(

plugin/src/main/kotlin/org/gradle/github/dependencygraph/internal/DependencyFileWriter.kt

@@ -4,19 +4,13 @@ import org.gradle.api.logging.Logging
 import org.gradle.github.dependencygraph.internal.json.GitHubRepositorySnapshot
 import java.io.File
 
-class DependencyFileWriter
-private constructor(
-    private val manifestFile: File,
-    private val loggerWarning: () -> Unit
-) {
-
+class DependencyFileWriter(val manifestFile: File) {
     private var writtenFile: Boolean = false
 
     fun writeDependencyManifest(graph: GitHubRepositorySnapshot): File {
         if (writtenFile) {
             return manifestFile
         }
-        loggerWarning()
         manifestFile.parentFile.mkdirs()
         manifestFile.writeText(JacksonJsonSerializer.serializeToJson(graph))
         writtenFile = true
@@ -26,28 +20,5 @@ private constructor(
 
     companion object {
         private val LOGGER = Logging.getLogger(DependencyFileWriter::class.java)
-
-        fun create(buildDirectory: File, jobCorrelator:String): DependencyFileWriter =
-            create(buildDirectory, jobCorrelator) {
-                // No-op
-            }
-
-        fun create(): DependencyFileWriter =
-            create(File("."), "UNKNOWN") {
-                LOGGER.warn(
-                    "[WARNING] Something went wrong configuring the GithubDependencyExtractorPlugin. " +
-                        "Using JVM working directory as root of build"
-                )
-            }
-
-        private fun create(buildDirectory: File, jobCorrelator: String, loggerWarning: () -> Unit): DependencyFileWriter {
-            return DependencyFileWriter(
-                File(
-                    buildDirectory,
-                    "reports/github-dependency-graph-plugin/github-dependency-snapshot-${jobCorrelator}.json"
-                ),
-                loggerWarning
-            )
-        }
     }
 }