fix: add cache for OrtDependency model objects to OrtModelBuilder

Only create one 'OrtDependency' for each 'ResolvedComponentResult'. The 'ResolvedComponentResult' is immutable and therefore all 'OrtDependency' object derived from the same 'ResolvedComponentResult' have the same content. Hence, we can reuse these objects to save memory and computation time. Without this, large builds seem to run forever: oss-review-toolkit#9763 This PR is a refined version of the fix posted in the error description of oss-review-toolkit#9763 Signed-off-by: Jendrik Johannes <[email protected]>
jjohannes · Jan 23, 2025 · 60bbc2e · 60bbc2e
1 parent 1d9c9c8
commit 60bbc2e
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/plugins/package-managers/gradle-plugin/src/main/kotlin/OrtModelBuilder.kt b/plugins/package-managers/gradle-plugin/src/main/kotlin/OrtModelBuilder.kt
@@ -33,6 +33,7 @@ import org.gradle.api.artifacts.component.ProjectComponentIdentifier
 import org.gradle.api.artifacts.component.ProjectComponentSelector
 import org.gradle.api.artifacts.result.DependencyResult
 import org.gradle.api.artifacts.result.ResolvedArtifactResult
+import org.gradle.api.artifacts.result.ResolvedComponentResult
 import org.gradle.api.artifacts.result.ResolvedDependencyResult
 import org.gradle.api.artifacts.result.UnresolvedDependencyResult
 import org.gradle.api.internal.GradleInternal
@@ -56,6 +57,9 @@ internal class OrtModelBuilder : ToolingModelBuilder {
     private val warnings = mutableListOf<String>()
     private val globalDependencySubtrees = mutableMapOf<String, List<OrtDependency>>()
 
+    // Only create one 'OrtDependency' for each 'ResolvedComponentResult'
+    private val ortDependencyCache = mutableMapOf<ResolvedComponentResult, OrtDependency>()
+
     override fun canBuild(modelName: String): Boolean = modelName == OrtDependencyTreeModel::class.java.name
 
     override fun buildAll(modelName: String, project: Project): OrtDependencyTreeModel {
@@ -165,6 +169,10 @@ internal class OrtModelBuilder : ToolingModelBuilder {
                     // Cut the graph on cyclic dependencies.
                     if (id in visited) return@mapNotNull null
 
+                    if (ortDependencyCache.containsKey(selectedComponent)) {
+                        return@mapNotNull ortDependencyCache[selectedComponent]
+                    }
+
                     when (id) {
                         is ModuleComponentIdentifier -> {
                             val pomFile = if (selectedComponent is ResolvedComponentResultInternal) {
@@ -211,7 +219,7 @@ internal class OrtModelBuilder : ToolingModelBuilder {
                                 selectedComponent.dependencies.toOrtDependencies(poms, visited + id)
                             }
 
-                            OrtDependencyImpl(
+                            val dependency = OrtDependencyImpl(
                                 groupId = id.group,
                                 artifactId = id.module,
                                 version = id.version,
@@ -232,13 +240,15 @@ internal class OrtModelBuilder : ToolingModelBuilder {
                                 },
                                 localPath = null
                             )
+                            ortDependencyCache[selectedComponent] = dependency
+                            dependency
                         }
 
                         is ProjectComponentIdentifier -> {
                             val moduleId = selectedComponent.moduleVersion ?: return@mapNotNull null
                             val dependencies = selectedComponent.dependencies.toOrtDependencies(poms, visited + id)
 
-                            OrtDependencyImpl(
+                            val dependency = OrtDependencyImpl(
                                 groupId = moduleId.group,
                                 artifactId = moduleId.name,
                                 version = moduleId.version.takeUnless { it == "unspecified" }.orEmpty(),
@@ -251,6 +261,8 @@ internal class OrtModelBuilder : ToolingModelBuilder {
                                 mavenModel = null,
                                 localPath = id.projectPath
                             )
+                            ortDependencyCache[selectedComponent] = dependency
+                            dependency
                         }
 
                         else -> {