Skip to content

Deduplicate Java runtime mismatch hints per formatter invocation #283

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.

Sign up for GitHub

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

Merged
mkurz merged 1 commit into from
Apr 16, 2026
+39 −9
Merged

Deduplicate Java runtime mismatch hints per formatter invocation #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions plugin/src/main/scala/com/github/sbt/JavaFormatterPlugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ object JavaFormatterPlugin extends AutoPlugin {
@transient
private val javafmtFormatterClasspath =
taskKey[Seq[File]]("Resolved classpath for the forked google-java-format CLI.")
@transient
private val javafmtInvocationId =
taskKey[String]("Internal invocation id for deduplicating formatter runtime mismatch hints.")

object autoImport {
@transient
Expand Down Expand Up @@ -131,6 +134,7 @@ object JavaFormatterPlugin extends AutoPlugin {
javafmt := {
val streamz = streams.value
val projectId = thisProjectRef.value.project
val invocationId = javafmtInvocationId.value
val sD = (javafmt / sourceDirectories).value.toList
val iF = (javafmt / includeFilter).value
val eF = (javafmt / excludeFilter).value
Expand All @@ -143,6 +147,7 @@ object JavaFormatterPlugin extends AutoPlugin {
val reflowLongStrings = javafmtReflowLongStrings.value
JavaFormatter(
projectId,
invocationId,
sD,
iF,
eF,
Expand All @@ -158,6 +163,7 @@ object JavaFormatterPlugin extends AutoPlugin {
javafmtCheck := {
val streamz = streams.value
val projectId = thisProjectRef.value.project
val invocationId = javafmtInvocationId.value
val baseDir = (ThisBuild / baseDirectory).value
val sD = (javafmt / sourceDirectories).value.toList
val iF = (javafmt / includeFilter).value
Expand All @@ -171,6 +177,7 @@ object JavaFormatterPlugin extends AutoPlugin {
val reflowLongStrings = javafmtReflowLongStrings.value
JavaFormatter.check(
projectId,
invocationId,
baseDir,
sD,
iF,
Expand All @@ -187,6 +194,7 @@ object JavaFormatterPlugin extends AutoPlugin {
javafmtFixImports := {
val streamz = streams.value
val projectId = thisProjectRef.value.project
val invocationId = javafmtInvocationId.value
val sD = (javafmt / sourceDirectories).value.toList
val iF = (javafmt / includeFilter).value
val eF = (javafmt / excludeFilter).value
Expand All @@ -199,6 +207,7 @@ object JavaFormatterPlugin extends AutoPlugin {
val reflowLongStrings = javafmtReflowLongStrings.value
JavaFormatter.fixImports(
projectId,
invocationId,
sD,
iF,
eF,
Expand All @@ -214,6 +223,7 @@ object JavaFormatterPlugin extends AutoPlugin {
javafmtFixImportsCheck := {
val streamz = streams.value
val projectId = thisProjectRef.value.project
val invocationId = javafmtInvocationId.value
val baseDir = (ThisBuild / baseDirectory).value
val sD = (javafmt / sourceDirectories).value.toList
val iF = (javafmt / includeFilter).value
Expand All @@ -227,6 +237,7 @@ object JavaFormatterPlugin extends AutoPlugin {
val reflowLongStrings = javafmtReflowLongStrings.value
JavaFormatter.fixImportsCheck(
projectId,
invocationId,
baseDir,
sD,
iF,
Expand All @@ -251,6 +262,7 @@ object JavaFormatterPlugin extends AutoPlugin {

def notToBeScopedSettings: Seq[Setting[?]] =
List(
javafmtInvocationId := java.util.UUID.randomUUID().toString,
ivyConfigurations += JavafmtRuntime,
libraryDependencies +=
("com.google.googlejavaformat" % "google-java-format" % formatterVersionForCompatibleJavaVersion(
Expand Down
36 changes: 27 additions & 9 deletions plugin/src/main/scala/com/github/sbt/javaformatter/JavaFormatter.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package com.github.sbt.javaformatter

import java.io.File
import java.util.concurrent.atomic.AtomicBoolean

import _root_.sbt.Keys._
import _root_.sbt._
Expand All @@ -33,14 +32,15 @@ object JavaFormatter {
private val JavaHomeEnvVar = "SBT_JAVAFMT_JAVA_HOME"
private val JavaHomeProperty = "sbt-javafmt.java.home"
private val incompatibleJavaRuntimeHelpLoggedByProject =
new scala.collection.concurrent.TrieMap[String, AtomicBoolean]
new scala.collection.concurrent.TrieMap[String, String]

private val JavaExports = Seq("api", "code", "file", "parser", "tree", "util").map { exportedPackage =>
s"--add-exports=jdk.compiler/com.sun.tools.javac.$exportedPackage=ALL-UNNAMED"
}

def apply(
projectId: String,
invocationId: String,
sourceDirectories: Seq[File],
includeFilter: FileFilter,
excludeFilter: FileFilter,
Expand All @@ -58,6 +58,7 @@ object JavaFormatter {
files,
streams.log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -69,6 +70,7 @@ object JavaFormatter {

def fixImports(
projectId: String,
invocationId: String,
sourceDirectories: Seq[File],
includeFilter: FileFilter,
excludeFilter: FileFilter,
Expand All @@ -86,6 +88,7 @@ object JavaFormatter {
files,
streams.log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -97,6 +100,7 @@ object JavaFormatter {

def check(
projectId: String,
invocationId: String,
baseDir: File,
sourceDirectories: Seq[File],
includeFilter: FileFilter,
Expand All @@ -117,6 +121,7 @@ object JavaFormatter {
files,
streams.log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -129,6 +134,7 @@ object JavaFormatter {

def fixImportsCheck(
projectId: String,
invocationId: String,
baseDir: File,
sourceDirectories: Seq[File],
includeFilter: FileFilter,
Expand All @@ -149,6 +155,7 @@ object JavaFormatter {
files,
streams.log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand Down Expand Up @@ -188,6 +195,7 @@ object JavaFormatter {
sources: Seq[File],
log: Logger,
projectId: String,
invocationId: String,
options: JavaFormatterOptions,
formatterClasspath: Seq[File],
javaMaxHeap: Option[String],
Expand All @@ -206,6 +214,7 @@ object JavaFormatter {
filesToCheck.toList,
log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -226,6 +235,7 @@ object JavaFormatter {
sources: Seq[File],
log: Logger,
projectId: String,
invocationId: String,
options: JavaFormatterOptions,
formatterClasspath: Seq[File],
javaMaxHeap: Option[String],
Expand All @@ -242,6 +252,7 @@ object JavaFormatter {
sources,
log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -258,6 +269,7 @@ object JavaFormatter {
sources: Seq[File],
log: Logger,
projectId: String,
invocationId: String,
options: JavaFormatterOptions,
formatterClasspath: Seq[File],
javaMaxHeap: Option[String],
Expand All @@ -275,6 +287,7 @@ object JavaFormatter {
filesToFormat,
log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -291,6 +304,7 @@ object JavaFormatter {
sources: Set[File],
log: Logger,
projectId: String,
invocationId: String,
options: JavaFormatterOptions,
formatterClasspath: Seq[File],
javaMaxHeap: Option[String],
Expand All @@ -304,6 +318,7 @@ object JavaFormatter {
sources.toList,
log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand All @@ -317,6 +332,7 @@ object JavaFormatter {
changed.toList,
log,
projectId,
invocationId,
options,
formatterClasspath,
javaMaxHeap,
Expand Down Expand Up @@ -375,13 +391,13 @@ object JavaFormatter {

private case class CliResult(exitCode: Int, stdout: Vector[String], stderr: Vector[String])

private def logCliFailure(result: CliResult, log: Logger, projectId: String): Unit = {
private def logCliFailure(result: CliResult, log: Logger, projectId: String, invocationId: String): Unit = {
result.stderr.foreach(line => log.error(line))
result.stdout.foreach(line => log.error(line))
incompatibleJavaRuntimeHelp(result).foreach { message =>
val loggedForProject =
incompatibleJavaRuntimeHelpLoggedByProject.getOrElseUpdate(projectId, new AtomicBoolean(false))
if (loggedForProject.compareAndSet(false, true)) {
val previouslyLoggedInvocation = incompatibleJavaRuntimeHelpLoggedByProject.putIfAbsent(projectId, invocationId)
if (previouslyLoggedInvocation.forall(_ != invocationId)) {
incompatibleJavaRuntimeHelpLoggedByProject.put(projectId, invocationId)
log.info(message)
}
}
Expand Down Expand Up @@ -470,6 +486,7 @@ object JavaFormatter {
sources: Seq[File],
log: Logger,
projectId: String,
invocationId: String,
options: JavaFormatterOptions,
formatterClasspath: Seq[File],
javaMaxHeap: Option[String],
Expand All @@ -490,13 +507,13 @@ object JavaFormatter {
result.exitCode match {
case 0 | 1 =>
if (result.exitCode == 1 && changed.isEmpty) {
logCliFailure(result, log, projectId)
logCliFailure(result, log, projectId, invocationId)
throw new MessageOnlyException("google-java-format check failed")
}
changed
case _ =>
if (warnOnFailure) {
logCliFailure(result, log, projectId)
logCliFailure(result, log, projectId, invocationId)
}
throw new MessageOnlyException("google-java-format check failed")
}
Expand All @@ -506,6 +523,7 @@ object JavaFormatter {
sources: Seq[File],
log: Logger,
projectId: String,
invocationId: String,
options: JavaFormatterOptions,
formatterClasspath: Seq[File],
javaMaxHeap: Option[String],
Expand All @@ -521,7 +539,7 @@ object JavaFormatter {
"--replace") ++ sources.map(_.getAbsolutePath)
val result = runCli(args, formatterClasspath, log, javaMaxHeap)
if (result.exitCode != 0) {
logCliFailure(result, log, projectId)
logCliFailure(result, log, projectId, invocationId)
throw new MessageOnlyException("google-java-format failed")
}
}
Expand Down