Recommended protobuf integration triggers bazel warning: external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match #4495

davido · 2018-01-21T08:00:47Z

//CC @ejona86 @cgrushko as author of Protobuf integration recommendation and maintainer of https://github.com/cgrushko/proto_library.

In bazelbuild/rules_closure#231, bazelbuild/rules_closure#232 rules_closure recently moved from depending on protobuf release binaries to depending on the protobuf directly.

Gerrit Code Review updated recently to rules_closure@Head and now Gerrit build started to issue this warning:

WARNING: /private/var/tmp/_bazel_xxx/4e4bb427cd475349ab3944ff29048468/external/com_google_protobuf_java/WORKSPACE:1: Workspace name in /private/var/tmp/_bazel_xxx/4e4bb427cd475349ab3944ff29048468/external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf)
does not match the name given in the repository's definition (@com_google_protobuf_java);
this will cause a build error in future versions

To reproduce, clone gerrit code review and issue bazel build gerrit.

I reported this issue in rules_closure repository, but I was recommended to ask for feedback here.

The alternative way to repro is to clone rules_closure and run the tests there:

davido@wizball:~/projects/rules_closure (master=)$ bazel test javatests/...
WARNING: /home/davido/.cache/bazel/_bazel_davido/2a0702ea37a9bc7e0f689212ecb3673c/external/com_google_protobuf_java/WORKSPACE:1: Workspace name in /home/davido/.cache/bazel/_bazel_davido/2a0702ea37a9bc7e0f689212ecb3673c/external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match the name given in the repository's definition (@com_google_protobuf_java); this will cause a build error in future versions

The Protobuf integration recommendation is telling us to fetch the same repository multiple times under different names:

# proto_library rules implicitly depend on @com_google_protobuf//:protoc,
# which is the proto-compiler.
# This statement defines the @com_google_protobuf repo.
http_archive(
    name = "com_google_protobuf",
    urls = ["https://github.com/google/protobuf/archive/b4b0e304be5a68de3d0ee1af9b286f958750f5e4.zip"],
)

# cc_proto_library rules implicitly depend on @com_google_protobuf_cc//:cc_toolchain,
# which is the C++ proto runtime (base classes and common utilities).
http_archive(
    name = "com_google_protobuf_cc",
    urls = ["https://github.com/google/protobuf/archive/b4b0e304be5a68de3d0ee1af9b286f958750f5e4.zip"],
)

# java_proto_library rules implicitly depend on @com_google_protobuf_java//:java_toolchain,
# which is the Java proto runtime (base classes and common utilities).
http_archive(
    name = "com_google_protobuf_java",
    urls = ["https://github.com/google/protobuf/archive/b4b0e304be5a68de3d0ee1af9b286f958750f5e4.zip"],
)

What is the recommended way to avoid the warning? Or should Bazel accept such mismatch:
external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match without warning, not to mention "cause a build error in future versions"?

The text was updated successfully, but these errors were encountered:

cgrushko · 2018-01-22T13:42:02Z

Seems like a bug in the gh.com/google/protobuf repo? If so, please reassign / move there.

…

On Mon, Jan 22, 2018, 15:15 Irina Iancu ***@***.***> wrote: Assigned #4495 <#4495> to @cgrushko <https://github.com/cgrushko>. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#4495 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AB5_YZodG60omroAx3TqJ92L1dEYPY38ks5tNInVgaJpZM4Rlu7f> .

davido · 2018-01-22T13:58:59Z

Seems like a bug in the gh.com/google/protobuf repo?

That's indeed the question here, whether or not is this a bug or a feature? In case it's a feature, then Bazel should accept the mismatch and remove the warning. Can you (or someone else) shed some light on what is the right next step here?

It can be also seen, that Bazel's own build tool chain uses a similar language-specific-protobuf-rules-duplication idiom under different names:

com_google_protobuf
com_google_protobuf_cc
com_google_protobuf_java

bazel/WORKSPACE

Lines 75 to 91 in bea6712

    
           new_local_repository( 
        
               name = "com_google_protobuf", 
        
               build_file = "./third_party/protobuf/3.4.0/BUILD", 
        
               path = "./third_party/protobuf/3.4.0/", 
        
           ) 
        
           new_local_repository( 
        
               name = "com_google_protobuf_cc", 
        
               build_file = "./third_party/protobuf/3.4.0/BUILD", 
        
               path = "./third_party/protobuf/3.4.0/", 
        
           ) 
        
           new_local_repository( 
        
               name = "com_google_protobuf_java", 
        
               build_file = "./third_party/protobuf/3.4.0/com_google_protobuf_java.BUILD", 
        
               path = "./third_party/protobuf/3.4.0/", 
        
           )

drigz · 2018-01-22T15:15:06Z

The warning will be resolved in grpc-java v1.10.0, which will include grpc/grpc-java#3881. The warning is caused by grpc-java, not the recommendations (although these are indeed out-of-date - maybe worth another issue?)

ejona86 · 2018-01-22T15:25:14Z

The warning will be common for any project using the previous set up with @com_google_protobuf_java and similar. They should migrate to using @com_google_protobuf. This will be handled by each project individually. File a bug against the repo if it hasn't yet updated. In this case, bazelbuild/rules_closure.

@drigz, the warning will not be resolved by the grpc update, since @davido is having trouble with rules_closure because it still uses the old style.

ejona86 · 2018-01-22T15:26:19Z

cgrushko/proto_library#5 can be referenced to show projects how to update.

drigz · 2018-01-22T15:27:33Z

Ah, thanks for the correction, @ejona86.

cgrushko · 2018-01-22T16:48:00Z

@ejona86 thanks for taking a look.
@davido, does that answer your question?

davido · 2018-01-22T17:09:16Z

Thanks, it almost clarifies it. Looking into grpc/grpc-java#3881 and comparing it with the current situation in rules_closure@Head, we have actually a complication there with com_google_protobuf_js rules duplication:

https://github.com/bazelbuild/rules_closure/blob/08039ba8ca59f64248bb3b6ae016460fe9c9914f/closure/repositories.bzl#L643-L653:

def com_google_protobuf_js():
  native.new_http_archive(
      name = "com_google_protobuf_js",
      urls = [
          "https://mirror.bazel.build/github.com/google/protobuf/archive/v3.5.0.tar.gz",
          "https://github.com/google/protobuf/archive/v3.5.0.tar.gz",
      ],
      sha256 = "0cc6607e2daa675101e9b7398a436f09167dffb8ca0489b0307ff7260498c13c",
      strip_prefix = "protobuf-3.5.0/js",
      build_file = str(Label("//closure/protobuf:protobuf_js.BUILD")),
  )

As it uses its own build_file and different strip_prefix ("protobuf-3.5.0/js").

I'm not sure how to replace this according to the new style?

davido · 2018-01-23T08:19:21Z

On second thought, I will let the fix for consumption of com_google_protobuf_js to rules_closure maintainers. I fixed the warning in gerrit build with this PR: [1] and here I forked rules_clsoure in gerrit: [2] to use this custom release: [3] until my PR is merged. Thanks again for the help.

[1] bazelbuild/rules_closure#249
[2] https://gerrit-review.googlesource.com/#/c/gerrit/+/153870
[3] https://github.com/davido/rules_closure/releases/tag/0.8.0

davido · 2018-01-23T10:21:48Z

FWIW: both CIs are now red with my CLs:

rules_closure: https://travis-ci.org/bazelbuild/rules_closure/jobs/332180567

gerrit: https://gerrit-ci.gerritforge.com/job/Gerrit-verifier-bazel/40429/consoleText

with the same message:

ERROR: /home/travis/build/bazelbuild/rules_closure/java/io/bazel/rules/closure/BUILD:60:1: every rule of type proto_library implicitly depends upon the target '@com_google_protobuf_java//:java_toolchain', but this target could not be found because of: no such package '@com_google_protobuf_java//': The repository could not be resolved.
ERROR: Analysis of target '//javatests/com/google/javascript/jscomp:JsCompilerTest' failed; build aborted.
INFO: Elapsed time: 8.570s
ERROR: Couldn't start the build. Unable to run tests.

That's because on both environments Bazel is tool old:

rules_closure: 0.5.3: https://github.com/bazelbuild/rules_closure/blob/master/.travis.yml#L14
gerrit 0.7.0

I guess Bazel must be at least 0.8.0 to support that, yet, rules_closure project removed recently Bazel version check, ...

Rules closure protobuf rules consumption is outdated and triggers workspace name mismatch warning. See discussion in: [1],[2]. Fork rules_closure with the fix until the PR [3] is merged upstream. [1] bazelbuild/rules_closure#248 [2] bazelbuild/bazel#4495 [3] bazelbuild/rules_closure#249 Bug: Issue 8182 Change-Id: Ifb59f90ac5a7604922b841377e75598369e9f70c

iirina assigned cgrushko Jan 22, 2018

iirina added the category: misc > misc label Jan 22, 2018

davido closed this as completed Jan 23, 2018

shahms mentioned this issue Aug 14, 2019

Starlark-based repository rules no longer warn about mismatched workspace names #9174

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Recommended protobuf integration triggers bazel warning: external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match #4495

Recommended protobuf integration triggers bazel warning: external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match #4495

davido commented Jan 21, 2018 •

edited

Loading

cgrushko commented Jan 22, 2018 via email

davido commented Jan 22, 2018 •

edited

Loading

drigz commented Jan 22, 2018 •

edited

Loading

ejona86 commented Jan 22, 2018

ejona86 commented Jan 22, 2018

drigz commented Jan 22, 2018

cgrushko commented Jan 22, 2018

davido commented Jan 22, 2018

davido commented Jan 23, 2018 •

edited

Loading

davido commented Jan 23, 2018 •

edited

Loading

Recommended protobuf integration triggers bazel warning: external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match #4495

Recommended protobuf integration triggers bazel warning: external/com_google_protobuf_java/WORKSPACE (@com_google_protobuf) does not match #4495

Comments

davido commented Jan 21, 2018 • edited Loading

cgrushko commented Jan 22, 2018 via email

davido commented Jan 22, 2018 • edited Loading

drigz commented Jan 22, 2018 • edited Loading

ejona86 commented Jan 22, 2018

ejona86 commented Jan 22, 2018

drigz commented Jan 22, 2018

cgrushko commented Jan 22, 2018

davido commented Jan 22, 2018

davido commented Jan 23, 2018 • edited Loading

davido commented Jan 23, 2018 • edited Loading

davido commented Jan 21, 2018 •

edited

Loading

davido commented Jan 22, 2018 •

edited

Loading

drigz commented Jan 22, 2018 •

edited

Loading

davido commented Jan 23, 2018 •

edited

Loading

davido commented Jan 23, 2018 •

edited

Loading