Bazel Support: Compilation error due to only records being generated but failing to compile possibly due to missing Builder

[vorburger]

In https://github.com/enola-dev/enola/pull/1450/files, I'm exploring using this wonderful project with https://bazel.build instead of Maven or Gradle.

It's not quite working just yet, and I'm not sure if I'm just stupid - or perhaps there is a gap here? (I may well be the 1st one trying this...)

I'll provide logs, initial findings, and a reproducer in the next comment.

[vorburger]

I'll provide logs, initial findings, and a reproducer in the next comment.

This should (hopefully...) be reproducible by pulling the aforementioned PR, installing https://github.com/bazelbuild/bazelisk, and:

$ bazelisk build //java/dev/enola/common/struct

(...)

ERROR: /home/vorburger/git/github.com/enola-dev/enola/java/dev/enola/common/struct/BUILD:20:13: Building java/dev/enola/common/struct/libstruct.jar (6 source files) and running annotation processors (RecordBuilderProcessor) failed: (Exit 1): java failed: error executing Javac command (from target //java/dev/enola/common/struct:struct) external/rules_java++toolchains+remotejdk21_linux/bin/java '--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED' '--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED' ... (remaining 19 arguments skipped)
java/dev/enola/common/struct/Example.java:28: error: Could not create source file: Attempt to recreate a file for type dev.enola.common.struct.ExampleRecord
public interface Example {
       ^
bazel-out/k8-fastbuild/bin/java/dev/enola/common/struct/_javac/struct/libstruct_sources/dev/enola/common/struct/ExampleRecord.java:13: error: package ExampleRecordBuilder does not exist
        Map<String, Example> map) implements Example, ExampleRecordBuilder.With {
                                                                          ^
bazel-out/k8-fastbuild/bin/java/dev/enola/common/struct/_javac/struct/libstruct_sources/dev/enola/common/struct/ExtendedExampleRecord.java:16: error: package ExtendedExampleRecordBuilder does not exist
        Map<String, Example> map) implements ExtendedExample, ExtendedExampleRecordBuilder.With {
                                                                                          ^
Target //java/dev/enola/common/struct:struct failed to build
Use --verbose_failures to see the command lines of failed build steps.
INFO: Elapsed time: 1.643s, Critical Path: 1.27s
INFO: 2 processes: 2 internal.
ERROR: Build did NOT complete successfully


$ ls bazel-out/k8-fastbuild/bin/java/dev/enola/common/struct/_javac/struct/libstruct_sources/dev/enola/common/struct/
ExampleRecord.java  ExtendedExampleRecord.java

Looks like the ExampleBuilder (and ExtendedExampleBuilder) are missing here, no?

The ExampleRecord looks like this:

// Auto generated by io.soabase.recordbuilder.core.RecordBuilder: https://github.com/Randgalt/record-builder
package dev.enola.common.struct;

import io.soabase.recordbuilder.core.RecordBuilder;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.Set;

@RecordBuilder
public record ExampleRecord(String text, Integer number, Instant instant, Example example,
        List<Example> examplesInOrder, Set<Example> examplesBag,
        Map<String, Example> map) implements Example, ExampleRecordBuilder.With {
}

The ExtendedExampleRecord looks like this:

// Auto generated by io.soabase.recordbuilder.core.RecordBuilder: https://github.com/Randgalt/record-builder
package dev.enola.common.struct;

import io.soabase.recordbuilder.core.RecordBuilder;
import java.math.BigDecimal;
import java.net.URI;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.Set;

@RecordBuilder
public record ExtendedExampleRecord(CustomDatatype customDatatype, BigDecimal bigDecimal, URI url,
        String text, Integer number, Instant instant, Example example,
        List<Example> examplesInOrder, Set<Example> examplesBag,
        Map<String, Example> map) implements ExtendedExample, ExtendedExampleRecordBuilder.With {
}

Could this be some sort of "ordering" issue - should it perhaps generate the *Builder before it generates the record? (Or can it not do that, because both need/depend on each other?) It's theoretically possible that Bazel somehow handles APT processors a little bit differently than Maven and Gradle. (FYI I do have 2 separate unrelated other annotation processors working with Bazel though [Google Auto Service & PicoCLI], so I'm confident that it's possible.)

PS: I'm not sure / don't see why javac says "error: package ExampleRecordBuilder does not exist" - why package, not class?!

Or am I just missing an annotation?! According to https://github.com/Randgalt/record-builder#recordinterface-example, just @RecordInterface should suffice.

[Randgalt]

@RecordInterface has been a problem for a while. There seem to be bugs in the various Java compilers/build tools. I may have a workaround. I'll try to get to it soon and maybe you can test it for us.

[vorburger]

@Randgalt awesome, appreciate your help!! I'll definitely help you to test anything that you would like me to try.

FYI I wanted to convince myself that this was indeed only a Bazel specific issue, and in a new commit to https://github.com/enola-dev/enola/pull/1450/files just now added a pom.xml, and interestingly am now seeing a similar issue:

$ java/mvnw -f java/dev/enola/common/struct/pom.xml clean compile
(...)
[INFO] --- compiler:3.13.0:compile (default-compile) @ struct ---
[INFO] Recompiling the module because of changed source code.
[INFO] Compiling 9 source files with javac [debug target 21] to target/classes
[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR : 
[INFO] -------------------------------------------------------------
[ERROR] /home/vorburger/git/github.com/enola-dev/enola/java/dev/enola/common/struct/Example.java:[28,8] Could not create source file: Attempt to recreate a file for type dev.enola.common.struct.ExampleRecord
[ERROR] /home/vorburger/git/github.com/enola-dev/enola/java/dev/enola/common/struct/ExtendedExample.java:[26,8] Could not create source file: Attempt to recreate a file for type dev.enola.common.struct.ExtendedExampleRecord
[ERROR] /home/vorburger/git/github.com/enola-dev/enola/java/dev/enola/common/struct/gen/ExampleRecord.java:[11,8] Could not create source file: Attempt to recreate a file for type dev.enola.common.struct.ExampleRecordBuilder
[ERROR] /home/vorburger/git/github.com/enola-dev/enola/java/dev/enola/common/struct/gen/ExtendedExampleRecord.java:[13,8] Could not create source file: Attempt to recreate a file for type dev.enola.common.struct.ExtendedExampleRecordBuilder
[INFO] 4 errors 

PS: I don't suppose using https://github.com/google/auto/tree/main/common (specifically that common module for "Helper utilities for writing annotation processors", NOT the AutoFactory, AutoService, AutoValue modules, could be useful?

PPS: Curiously, somehow I did manage to make it generate with Maven once, but then it didn't work anymore, I'm not sure what I've changed, and could get it to work again, maybe that's just something "non-deterministic".

[vorburger]

@Randgalt this might actually be unrelated to @RecordInterface... FYI in enola-dev/enola#1596 I've attempted to use just @RecordBuilder (with generates_api = True AND explicit "com.squareup:javapoet:1.13.0), but even that does not seem to work - neither under Bazel (instead of Maven or Gradle) on the CLI, nor in IntelliJ with Bazel integration. I suspect that this might a Bazel specific issue. I've attempted to debug it a bit, but with no luck.