Protobuf import path issue

[chiperific]

Warning: Protobuf detected an import path issue while loading generated file /usr/local/rvm/gems/ruby-3.1.4/gems/authzed-0.7.0/lib/authzed/api/v1/core_pb.rb
Each proto file must use a consistent fully-qualified name.
This will become an error in the next major version.
Warning: Protobuf detected an import path issue while loading generated file /usr/local/rvm/gems/ruby-3.1.4/gems/authzed-0.7.0/lib/authzed/api/v1/schema_service_pb.rb
Each proto file must use a consistent fully-qualified name.
This will become an error in the next major version.
Warning: Protobuf detected an import path issue while loading generated file /usr/local/rvm/gems/ruby-3.1.4/gems/authzed-0.7.0/lib/authzed/api/v1/watch_service_pb.rb
Each proto file must use a consistent fully-qualified name.
This will become an error in the next major version.
Warning: Protobuf detected an import path issue while loading generated file /usr/local/rvm/gems/ruby-3.1.4/gems/authzed-0.7.0/lib/authzed/api/v1/permission_service_pb.rb
Each proto file must use a consistent fully-qualified name.
This will become an error in the next major version.
Warning: Protobuf detected an import path issue while loading generated file /usr/local/rvm/gems/ruby-3.1.4/gems/authzed-0.7.0/lib/authzed/api/v1/experimental_service_pb.rb
Each proto file must use a consistent fully-qualified name.
This will become an error in the next major version.

Dependencies:

• rails 7.1.1
• google-protobuf (3.24.4-aarch64-linux)
• google-protobuf (3.24.4-arm64-darwin)
• google-protobuf (3.24.4-x86_64-linux)
• grpc (1.59.2)
• grpc-tools (1.59.2)

[chiperific]

Seems the change is here: https://protobuf.dev/news/2023-04-20/

[vroldanbet]

@chiperific can you provide more context on how you reproduced those warnings? This project uses buf and I don't seem to observe any warnings when using the buf toolchain.

[chiperific]

Here's a repo that shows how the warnings appeared in 0.7.0 but aren't in 0.5.0:

https://github.com/chiperific/authzed-protobuf-check

I played with reverting google-protobuf, grpc and grpc-tools to the gem versions in the 0.5.0 release, but the only way I found to remove the error messages was to change authzed.

Locally, when I install google-protobuf, I get google-protobuf (3.24.4-arm64-darwin), not sure if that would have an affect.

[vroldanbet]

Thanks for the repro! I created a new Rails application, imported the latest authzed-rb gem, set some breakpoints here and there, and identified the actual underlying error:

#<Google::Protobuf::TypeError: Unable to build file to DescriptorPool: Depends on file 'validate/validate.proto', but it has not been loaded>

This is going to require some research, as validate is now deprecated in favor of buf's fork.

EDIT: I couldn't find a quick way to address this. proto-validate does not offer ruby templates for protoc so until now the generated code has ignored the dependecy, thanks to an empty module to satisfy the import. The new Ruby code expects proto validate types to exist and complains they do not:

add_serialized_file verifies that all dependencies listed in the descriptor were previously added with add_serialized_file. Generally that should be fine, because the generated code will contain Ruby require statements for all dependencies, and the descriptor will fail to load anyway if the types depended on were not previously defined in the DescriptorPool.

The solution I proposed was to vendor the validate.proto file into the project and generate code out of it. See #79

[vroldanbet]

@chiperific this should be fixed in https://github.com/authzed/authzed-rb/releases/tag/v0.7.1

[chiperific]

Can confirm that 0.7.1 has no protobuf errors. Thanks so much!