refactor(model): Introduce a function to add dependencies to the graph

sschuberth · sschuberth · commit dcc97a0ecb3c · 2024-11-14T08:36:29.000+01:00
This reduces a bit of code duplication and avoids mistakes where the
qualified scope is generated on each dependency iteration.

Signed-off-by: Sebastian Schuberth &lt;sebastian@doubleopen.org&gt;
diff --git a/model/src/main/kotlin/utils/DependencyGraphBuilder.kt b/model/src/main/kotlin/utils/DependencyGraphBuilder.kt
@@ -148,6 +148,15 @@ class DependencyGraphBuilder<D>(
     fun addDependency(scopeName: String, dependency: D): DependencyGraphBuilder<D> =
         apply { addDependencyToGraph(scopeName, dependency, transitive = false, emptySet()) }
 
+    /**
+     * Add all [dependencies] to the qualified scope name generated from the [projectId] and unqualified [scopeName].
+     */
+    fun addDependencies(projectId: Identifier, scopeName: String, dependencies: Collection<D>) =
+        apply {
+            val qualifiedScopeName = DependencyGraph.qualifyScope(projectId, scopeName)
+            dependencies.forEach { addDependency(qualifiedScopeName, it) }
+        }
+
     /**
      * Add the given [packages] to this builder. They are stored internally and also returned when querying the set of
      * known packages. This function can be used by package managers that have to deal with packages not part of
diff --git a/plugins/package-managers/gradle-inspector/src/main/kotlin/GradleInspector.kt b/plugins/package-managers/gradle-inspector/src/main/kotlin/GradleInspector.kt
@@ -37,7 +37,6 @@ import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
 import org.ossreviewtoolkit.downloader.VersionControlSystem
-import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
 import org.ossreviewtoolkit.model.Project
@@ -254,12 +253,7 @@ class GradleInspector(
         dependencyTreeModel.configurations.filterNot {
             excludes.isScopeExcluded(it.name)
         }.forEach { configuration ->
-            configuration.dependencies.forEach { dependency ->
-                graphBuilder.addDependency(
-                    DependencyGraph.qualifyScope(projectId, configuration.name),
-                    dependency
-                )
-            }
+            graphBuilder.addDependencies(projectId, configuration.name, configuration.dependencies)
         }
 
         val project = Project(
diff --git a/plugins/package-managers/gradle/src/main/kotlin/Gradle.kt b/plugins/package-managers/gradle/src/main/kotlin/Gradle.kt
@@ -42,7 +42,6 @@ import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
 import org.ossreviewtoolkit.downloader.VersionControlSystem
-import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
 import org.ossreviewtoolkit.model.Project
@@ -300,16 +299,11 @@ class Gradle(
                     version = dependencyTreeModel.version
                 )
 
-                dependencyTreeModel.configurations
-                    .filterNot { excludes.isScopeExcluded(it.name) }
-                    .forEach { configuration ->
-                        configuration.dependencies.forEach { dependency ->
-                            graphBuilder.addDependency(
-                                DependencyGraph.qualifyScope(projectId, configuration.name),
-                                dependency
-                            )
-                        }
-                    }
+                dependencyTreeModel.configurations.filterNot {
+                    excludes.isScopeExcluded(it.name)
+                }.forEach { configuration ->
+                    graphBuilder.addDependencies(projectId, configuration.name, configuration.dependencies)
+                }
 
                 val project = Project(
                     id = projectId,
diff --git a/plugins/package-managers/node/src/main/kotlin/npm/Npm.kt b/plugins/package-managers/node/src/main/kotlin/npm/Npm.kt
@@ -29,7 +29,6 @@ import org.apache.logging.log4j.kotlin.logger
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
-import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.Issue
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
@@ -115,11 +114,8 @@ class Npm(
             .filterNot { excludes.isScopeExcluded(it.descriptor) }
             .mapTo(mutableSetOf()) { scope ->
                 val scopeName = scope.descriptor
-                val qualifiedScopeName = DependencyGraph.qualifyScope(project, scopeName)
 
-                projectModuleInfo.getScopeDependencies(scope).forEach { dependency ->
-                    graphBuilder.addDependency(qualifiedScopeName, dependency)
-                }
+                graphBuilder.addDependencies(project.id, scopeName, projectModuleInfo.getScopeDependencies(scope))
 
                 scopeName
             }
diff --git a/plugins/package-managers/node/src/main/kotlin/pnpm/Pnpm.kt b/plugins/package-managers/node/src/main/kotlin/pnpm/Pnpm.kt
@@ -26,7 +26,6 @@ import org.apache.logging.log4j.kotlin.logger
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
-import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.ProjectAnalyzerResult
 import org.ossreviewtoolkit.model.config.AnalyzerConfiguration
 import org.ossreviewtoolkit.model.config.RepositoryConfiguration
@@ -85,12 +84,9 @@ class Pnpm(
 
             val scopeNames = Scope.entries.mapTo(mutableSetOf()) { scope ->
                 val scopeName = scope.descriptor
-                val qualifiedScopeName = DependencyGraph.qualifyScope(project, scopeName)
                 val moduleInfo = moduleInfosForScope.getValue(scope).single { it.path == projectDir.absolutePath }
 
-                moduleInfo.getScopeDependencies(scope).forEach { dependency ->
-                    graphBuilder.addDependency(qualifiedScopeName, dependency)
-                }
+                graphBuilder.addDependencies(project.id, scopeName, moduleInfo.getScopeDependencies(scope))
 
                 scopeName
             }
diff --git a/plugins/package-managers/node/src/main/kotlin/yarn/Yarn.kt b/plugins/package-managers/node/src/main/kotlin/yarn/Yarn.kt
@@ -39,7 +39,6 @@ import org.apache.logging.log4j.kotlin.loggerOf
 import org.ossreviewtoolkit.analyzer.AbstractPackageManagerFactory
 import org.ossreviewtoolkit.analyzer.PackageManager
 import org.ossreviewtoolkit.analyzer.PackageManagerResult
-import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
 import org.ossreviewtoolkit.model.Project
@@ -292,10 +291,9 @@ open class Yarn(
     ): String? {
         if (excludes.isScopeExcluded(targetScope)) return null
 
-        val qualifiedScopeName = DependencyGraph.qualifyScope(project, targetScope)
         val moduleInfo = checkNotNull(getModuleInfo(workingDir, scopes, projectDirs, listOfNotNull(workspaceDir)))
 
-        moduleInfo.dependencies.forEach { graphBuilder.addDependency(qualifiedScopeName, it) }
+        graphBuilder.addDependencies(project.id, targetScope, moduleInfo.dependencies)
 
         return targetScope.takeUnless { moduleInfo.dependencies.isEmpty() }
     }
diff --git a/plugins/package-managers/node/src/main/kotlin/yarn2/Yarn2.kt b/plugins/package-managers/node/src/main/kotlin/yarn2/Yarn2.kt
@@ -37,7 +37,6 @@ import org.ossreviewtoolkit.analyzer.PackageManagerResult
 import org.ossreviewtoolkit.analyzer.parseAuthorString
 import org.ossreviewtoolkit.downloader.VcsHost
 import org.ossreviewtoolkit.downloader.VersionControlSystem
-import org.ossreviewtoolkit.model.DependencyGraph
 import org.ossreviewtoolkit.model.Hash
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
@@ -322,7 +321,6 @@ class Yarn2(
         allDependencies.filterNot { excludes.isScopeExcluded(it.key.type) }
             .forEach { (dependencyType, allScopedDependencies) ->
                 allProjects.values.forEach { project ->
-                    val qualifiedScopeName = DependencyGraph.qualifyScope(project.id, dependencyType.type)
                     val dependencies = allScopedDependencies[project.id]
                     val dependenciesInfo = dependencies?.mapNotNull { dependency ->
                         if ("Yarn2" in dependency.type) {
@@ -364,9 +362,7 @@ class Yarn2(
                         }
                     }?.toSet().orEmpty()
 
-                    dependenciesInfo.forEach {
-                        graphBuilder.addDependency(qualifiedScopeName, it)
-                    }
+                    graphBuilder.addDependencies(project.id, dependencyType.type, dependenciesInfo)
                 }
             }
 
