Verifying the version of binary tool too early

[andrewparmet]

Trying to put #1208 into action and running into a dependency issue - it looks like Spotless is validating the provided version at configuration time, which is earlier than the value of toolVersion on BufExtension is resolvable to anything but its default.

An abridged version of my configuration:

configure<BufExtension> {
    toolVersion = "1.25.0"
}

configure<SpotlessExtension> {
    protobuf {
        buf("1.25.0").pathToExe(configurations.getByName(BUF_BINARY_CONFIGURATION_NAME).singleFile.absolutePath)
    }
}

This fails because the default value for toolVersion is 1.17.0 and resolving the Buf binary configuration is too eager.

Do you know if it's possible to:

• postpone this verification until we can read the BufExtension correctly?
• remove the verification?

Or if there's another approach that would be better?

Thanks!

[andrewparmet]

It actually goes deeper - Buf configures the binary to be executable as well. Calling it at configuration time doesn't work great with resolving a binary from a configuration.

[nedtwigg]

We need to resolve the State at configuration time, that is what makes up-to-date checks work

spotless/lib/src/main/java/com/diffplug/spotless/protobuf/BufStep.java

Lines 64 to 72 in b6e30f8

	private State createState() throws IOException, InterruptedException {
	String instructions = "https://docs.buf.build/installation";
	String exeAbsPath = ForeignExe.nameAndVersion("buf", version)
	.pathToExe(pathToExe)
	.versionRegex(Pattern.compile("(\\S*)"))
	.fixCantFind("Try following the instructions at " + instructions + ", or else tell Spotless where it is with {@code buf().pathToExe('path/to/executable')}")
	.confirmVersionAndGetAbsolutePath();
	return new State(this, exeAbsPath);
	}

But we don't need to create the FormatterFunc until execution time

spotless/lib/src/main/java/com/diffplug/spotless/protobuf/BufStep.java

Lines 94 to 97 in b6e30f8

	FormatterFunc.Closeable toFunc() {
	ProcessRunner runner = new ProcessRunner();
	return FormatterFunc.Closeable.of(runner, this::format);
	}

So we could remove exeAbsPath from the state, and instead move the ForeignExe calculation into the toFunc() calculation, which doesn't happen until a file is actually being formatted.

[andrewparmet]

Turns out this was a bug in the buf-gradle-plugin: bufbuild/buf-gradle-plugin#148