Dagger codegen uses ImmutableMap.builderWithExpectedSize which is marked as @Beta

[perezd]

Using latest released version of dagger, I've noticed that Map multibindings is making use of ImmutableMap.builderWithExpectedSize. When compiling code w/ Bazel + errorprone enabled its throwing a warning about this and halting my builds.

This goes against Google philosophy: https://github.com/google/guava/wiki/PhilosophyExplained#beta-apis

What is the best way to suppress this for my users (I am building a library on top of Dagger/Bazel). Perhaps the generated code could @SuppressWarnings("BetaApi") since we consider this safe?

[michaelxinsun]

Hello @perezd :

Thank you for reaching out! I was the engineer that added this change of generating ImmutableMap.builderWithExpectedSize, which is, as of the current Guava latest version (28.0-jre as of this writing), still a @Beta API:
https://guava.dev/releases/28.0-jre/api/docs/com/google/common/collect/ImmutableMap.html#builderWithExpectedSize-int-

I was coding at Google and I was doing 20% work for the Dagger team for a while. I intend to keep myself involved in Dagger and Guava and keep helping, on and off, as soon as I have bandwidth.

I'm aware of the Google Guava philosophy. I guess you mean the current situation is at odds with this, right?
"If your code is a library itself (i.e. it is used on the CLASSPATH of users outside your own control), you should not use beta APIs, unless you repackage them (e.g. using ProGuard)"

Anyways, could you paste us the bazel + errorprone compilation that halts your build, please? What's the error message you're seeing? I'd like to learn more. Thank you @perezd !

[perezd]

Thanks for the reply!

You are correct, it seems that dagger generated code shouldn't be relying on @beta annotated fields according to the spirit of that annotation, and Bazel + Guava beta checker basically enforces that rule such that it becomes a fatal error unless you disable errorprone which is non-ideal.

This is the error message Bazel provides:

ERROR .../BUILD:6:1: Building component.jar (1 source jar) and running annotation processors (ComponentProcessor) failed (Exit 1)
bazel-out/k8-fastbuild/bin/.../generated/DaggerComponent.java:330: error: [BetaApi] @Beta APIs should not be used in library code as they are subject to change
        return ImmutableMap.<Class<? extends Foo>, Bar<? extends Baz>>builderWithExpectedSize(30).put(...).build();}
                           ^
    (see https://github.com/google/guava/wiki/PhilosophyExplained#beta-apis)
Target failed to build
Use --verbose_failures to see the command lines of failed build steps.
INFO: Elapsed time: 160.108s, Critical Path: 71.45s
INFO: 118 processes: 58 linux-sandbox, 60 worker.
FAILED: Build did NOT complete successfully
FAILED: Build did NOT complete successfully

This kicks in just after the codegen plugin produces a source code file and just before bazel goes to compile that into a classfile jar I suspect.

[perezd]

Any thoughts on how to resolve this for Bazel/Errorprone users?

[michaelxinsun]

Hey @perezd ! My current idea is to remove @Beta for those builderWithExpectedSize methods, so when you depend on a newer version of Dagger that depends on a newer version of Guava, you'll no longer have this problem:
google/guava#3591

Meanwhile, for now, you might want to consider adding the following flag inside your .bazelrc, so that you don't have to disable ErrorProne entirely:

# TODO(perezd):  Remove this line when Dagger no longer depends on Guava `builderWithExpectedSize`
--javacopt="-Xep: BetaApi:WARN"

Tell me whether that works for your case. Let me know if you have any questions. Thank you for using Dagger!

[perezd]

That would be great to remove @beta assuming guava team thinks it should no longer be in beta. Definitely ideal!

…

On Mon, Sep 2, 2019, 7:51 PM Michael Xin Sun ***@***.***> wrote: Hey @perezd <https://github.com/perezd> ! My current idea is to remove @beta for those builderWithExpectedSize methods, so when you depend on a newer version of Dagger that depends on a newer version of Guava, you'll no longer have this problem: google/guava#3591 <google/guava#3591> Meanwhile, for now, you might want to consider adding the following flag inside your .bazelrc <https://docs.bazel.build/versions/master/best-practices.html#bazelrc>, so that you don't have to disable ErrorProne entirely: # TODO(perezd): Remove this line when Dagger no longer depends on Guava `builderWithExpectedSize` --javacopt="-Xep: BetaApi:WARN" Tell me whether that works for your case. Let me know if you have any questions. Thank you for using Dagger! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1569?email_source=notifications&email_token=AAAFA5XATDJQUY4TOBYVOQTQHXGM5A5CNFSM4IF4GWB2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5W3OJI#issuecomment-527284005>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAFA5V4IETBCGYWLFV63S3QHXGM5ANCNFSM4IF4GWBQ> .