-
Notifications
You must be signed in to change notification settings - Fork 213
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Prepare Jdeps extension for K2 implementation #1164
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
149 changes: 149 additions & 0 deletions
149
src/main/kotlin/io/bazel/kotlin/plugin/jdeps/BaseJdepsGenExtension.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| package io.bazel.kotlin.plugin.jdeps | ||
|
|
||
| import com.google.devtools.build.lib.view.proto.Deps | ||
| import io.bazel.kotlin.builder.utils.jars.JarOwner | ||
| import org.jetbrains.kotlin.config.CompilerConfiguration | ||
| import java.io.BufferedOutputStream | ||
| import java.io.File | ||
| import java.nio.file.Paths | ||
|
|
||
| abstract class BaseJdepsGenExtension( | ||
| protected val configuration: CompilerConfiguration, | ||
| ) { | ||
|
|
||
| protected fun onAnalysisCompleted( | ||
| explicitClassesCanonicalPaths: Set<String>, | ||
| implicitClassesCanonicalPaths: Set<String>, | ||
| ) { | ||
| val directDeps = configuration.getList(JdepsGenConfigurationKeys.DIRECT_DEPENDENCIES) | ||
| val targetLabel = configuration.getNotNull(JdepsGenConfigurationKeys.TARGET_LABEL) | ||
| val explicitDeps = createDepsMap(explicitClassesCanonicalPaths) | ||
|
|
||
| doWriteJdeps(directDeps, targetLabel, explicitDeps, implicitClassesCanonicalPaths) | ||
|
|
||
| doStrictDeps(configuration, targetLabel, directDeps, explicitDeps) | ||
| } | ||
|
|
||
| /** | ||
| * Returns a map of jars to classes loaded from those jars. | ||
| */ | ||
| private fun createDepsMap(classes: Set<String>): Map<String, List<String>> { | ||
| val jarsToClasses = mutableMapOf<String, MutableList<String>>() | ||
| classes.forEach { | ||
| val parts = it.split("!/") | ||
| val jarPath = parts[0] | ||
| if (jarPath.endsWith(".jar")) { | ||
| jarsToClasses.computeIfAbsent(jarPath) { ArrayList() }.add(parts[1]) | ||
| } | ||
| } | ||
| return jarsToClasses | ||
| } | ||
|
|
||
| private fun doWriteJdeps( | ||
| directDeps: MutableList<String>, | ||
| targetLabel: String, | ||
| explicitDeps: Map<String, List<String>>, | ||
| implicitClassesCanonicalPaths: Set<String>, | ||
| ) { | ||
| val implicitDeps = createDepsMap(implicitClassesCanonicalPaths) | ||
|
|
||
| // Build and write out deps.proto | ||
| val jdepsOutput = configuration.getNotNull(JdepsGenConfigurationKeys.OUTPUT_JDEPS) | ||
|
|
||
| val rootBuilder = Deps.Dependencies.newBuilder() | ||
| rootBuilder.success = true | ||
| rootBuilder.ruleLabel = targetLabel | ||
|
|
||
| val unusedDeps = directDeps.subtract(explicitDeps.keys) | ||
| unusedDeps.forEach { jarPath -> | ||
| val dependency = Deps.Dependency.newBuilder() | ||
| dependency.kind = Deps.Dependency.Kind.UNUSED | ||
| dependency.path = jarPath | ||
| rootBuilder.addDependency(dependency) | ||
| } | ||
|
|
||
| explicitDeps.forEach { (jarPath, _) -> | ||
| val dependency = Deps.Dependency.newBuilder() | ||
| dependency.kind = Deps.Dependency.Kind.EXPLICIT | ||
| dependency.path = jarPath | ||
| rootBuilder.addDependency(dependency) | ||
| } | ||
|
|
||
| implicitDeps.keys.subtract(explicitDeps.keys).forEach { | ||
| val dependency = Deps.Dependency.newBuilder() | ||
| dependency.kind = Deps.Dependency.Kind.IMPLICIT | ||
| dependency.path = it | ||
| rootBuilder.addDependency(dependency) | ||
| } | ||
|
|
||
| BufferedOutputStream(File(jdepsOutput).outputStream()).use { | ||
| it.write(rootBuilder.buildSorted().toByteArray()) | ||
| } | ||
| } | ||
|
|
||
| private fun doStrictDeps( | ||
| compilerConfiguration: CompilerConfiguration, | ||
| targetLabel: String, | ||
| directDeps: MutableList<String>, | ||
| explicitDeps: Map<String, List<String>>, | ||
| ) { | ||
| when (compilerConfiguration.getNotNull(JdepsGenConfigurationKeys.STRICT_KOTLIN_DEPS)) { | ||
| "warn" -> checkStrictDeps(explicitDeps, directDeps, targetLabel) | ||
| "error" -> { | ||
| if (checkStrictDeps(explicitDeps, directDeps, targetLabel)) { | ||
| error( | ||
| "Strict Deps Violations - please fix", | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Prints strict deps warnings and returns true if violations were found. | ||
| */ | ||
| private fun checkStrictDeps( | ||
| result: Map<String, List<String>>, | ||
| directDeps: List<String>, | ||
| targetLabel: String, | ||
| ): Boolean { | ||
| val missingStrictDeps = result.keys | ||
| .filter { !directDeps.contains(it) } | ||
| .map { JarOwner.readJarOwnerFromManifest(Paths.get(it)) } | ||
|
|
||
| if (missingStrictDeps.isNotEmpty()) { | ||
| val missingStrictLabels = missingStrictDeps.mapNotNull { it.label } | ||
|
|
||
| val open = "\u001b[35m\u001b[1m" | ||
| val close = "\u001b[0m" | ||
|
|
||
| var command = | ||
| """ | ||
| $open ** Please add the following dependencies:$close | ||
| ${ | ||
| missingStrictDeps.map { it.label ?: it.jar }.joinToString(" ") | ||
| } to $targetLabel | ||
| """ | ||
|
|
||
| if (missingStrictLabels.isNotEmpty()) { | ||
| command += """$open ** You can use the following buildozer command:$close | ||
| buildozer 'add deps ${ | ||
| missingStrictLabels.joinToString(" ") | ||
| }' $targetLabel | ||
| """ | ||
| } | ||
|
|
||
| println(command.trimIndent()) | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| private fun Deps.Dependencies.Builder.buildSorted(): Deps.Dependencies { | ||
| val sortedDeps = dependencyList.sortedBy { it.path } | ||
| sortedDeps.forEachIndexed { index, dep -> | ||
| setDependency(index, dep) | ||
| } | ||
| return build() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason this needs to be a base class and not just some independent class that both implementations can call into?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
either one works, but I figured I was going to use a common base for the 2 extensions anyways