Generated Protos are no longer considered as virtual_imports in Bazel 7

[XuanWang-Amos]

Description of the bug:

One of our test starts failing in Bazel 7, after some investigation, we found out it's because Bazel 7.0.0 removed the generated file check and stopped symlink our generated proto to _virtual_imports.

• Bazel 6.4.0 will symlink generated proto to _virtual_imports because it's a generated file (link to code):

    generate_protos_in_virtual_imports = False
    if ctx.fragments.proto.generated_protos_in_virtual_imports():
        generate_protos_in_virtual_imports = any([not src.is_source for src in srcs])

    if import_prefix != "" or strip_import_prefix != "" or generate_protos_in_virtual_imports:
        # Use virtual source roots
        return _symlink_to_virtual_imports(ctx, srcs, import_prefix, strip_import_prefix)

• Bazel 7.0.0 removed the generated file check thus it will not symlink generated proto to _virtual_imports (link to code):

    if import_prefix != "" or strip_import_prefix != "":
        # Use virtual source roots
        return _symlink_to_virtual_imports(ctx, srcs, import_prefix, strip_import_prefix)
    else:
        # No virtual source roots
        return "", srcs

Is this change of behavior expected? If it is, can someone share some context on why it was changed?

Link to our issue: grpc/grpc#35391

Which category does this issue belong to?

Rules API

What's the simplest, easiest way to reproduce this bug? Please provide a minimal example if possible.

Build this with Bazel 7: https://github.com/grpc/grpc/blob/714640d71f07d415a14aab2c68e8f37d74c644aa/test/distrib/bazel/python/BUILD#L123

Which operating system are you running Bazel on?

Not related

What is the output of bazel info release?

Not related

If bazel info release returns development version or (@non-git), tell us how you built Bazel.

Not related

What's the output of git remote get-url origin; git rev-parse HEAD ?

Not related

Is this a regression? If yes, please try to identify the Bazel commit where the bug was introduced.

No

Have you found anything relevant by searching the web?

No

Any other information, logs, or outputs that you want to share?

No response

[comius]

Is this change of behavior expected? If it is, can someone share some context on why it was changed?

Yes, this change of behaviour is intentional and expected (I just wish I caught it earlier in grpc). _virtual_imports are created only when it's strictly necessary. That's when proto_library uses import_prefix or strip_import_prefix.

The reason for the change was, that the behaviour was is some cases incorrect (external repos using sibling repository layout) and creating _virtual_imports created a performance penalty.

Ideally proto generation would happen using proto_common.compile, where you don't need to specify output directories anymore. A quicker workaround would be to copy _output_directory implementation from proto_common.bzl in Bazel.

[XuanWang-Amos]

Thanks for the reply, do you mind share more details on the workaround?

By copy _output_directory implementation you mean we can use _output_directory to replace the outputs here? What about the parameters, I guess we can use copied_proto as root, what should be our proto_info here?

[XuanWang-Amos]

@comius We're still trying to figure out the correct fix, any further details you can provide would be extremely helpful.

[github-actions]

Thank you for contributing to the Bazel repository! This issue has been marked as stale since it has not had any activity in the last 1+ years. It will be closed in the next 90 days unless any other activity occurs. If you think this issue is still relevant and should stay open, please post any comment here and the issue will no longer be marked as stale.