2023年4月20日に発表された変更

2023年4月20日にProtocol Buffersに対して発表された変更。

Rubyジェネレータの変更

このGitHub PR（23.xリリースに登場予定）は、RubyコードジェネレータがDSLの代わりにシリアライズされたprotoを出力するように変更します。

これは、DSLを別のパッケージに分割することを想定して、コードジェネレータからDSLを削除します。

.protoファイルが次のような場合：

syntax = "proto3";

package pkg;

message TestMessage {
  optional int32 i32 = 1;
  optional TestMessage msg = 2;
}

変更前の生成コード

# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: protoc_explorer/main.proto

require 'google/protobuf'

Google::Protobuf::DescriptorPool.generated_pool.build do
  add_file("test.proto", :syntax => :proto3) do
    add_message "pkg.TestMessage" do
      proto3_optional :i32, :int32, 1
      proto3_optional :msg, :message, 2, "pkg.TestMessage"
    end
  end
end

module Pkg
  TestMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pkg.TestMessage").msgclass
end

変更後の生成コード

# frozen_string_literal: true
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: test.proto

require 'google/protobuf'

descriptor_data = "\n\ntest.proto\x12\x03pkg\"S\n\x0bTestMessage\x12\x10\n\x03i32\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12\"\n\x03msg\x18\x02 \x01(\x0b\x32\x10.pkg.TestMessageH\x01\x88\x01\x01\x42\x06\n\x04_i32B\x06\n\x04_msgb\x06proto3"
begin
  Google::Protobuf::DescriptorPool.generated_pool.add_serialized_file(descriptor_data)
rescue TypeError => e
  # <compatibility code, see below>
end

module Pkg
  TestMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pkg.TestMessage").msgclass
end

この変更により、以前に存在していたほぼすべての残りの適合性問題が修正されます。これは、DSL（損失が多い）からシリアライズされた記述子（すべての情報を保持する）に移行することの副作用です。

後方互換性

この変更は、2021年9月にリリースされたRuby Protobuf >= 3.18.0と100％互換性があるはずです。さらに、既存のすべてのユーザーとデプロイメントとも互換性があるはずです。

このレベルの後方互換性を実現するために挿入された特別な互換性コードがありますので、注意してください。互換性コードがないと、後方互換性を損なう可能性のあるエッジケースが存在します。以前のコードは寛容でしたが、新しいコードはより厳格になります。

完全なシリアライズされた記述子を使用する場合、それにはこのファイルによってインポートされたすべての.protoファイルのリストが含まれています（一方、DSLは依存関係を適切に追加しませんでした）。descriptor.protoのコードを参照してください。

add_serialized_fileは、記述子にリストされているすべての依存関係が以前にadd_serialized_fileで追加されたことを検証します。一般的に、これは問題ないはずです。なぜなら、生成されたコードにはすべての依存関係に対するRubyのrequireステートメントが含まれており、依存している型がDescriptorPoolで以前に定義されていない場合、記述子はとにかくロードに失敗するためです。

ただし、ファイルパスに関する曖昧さがある場合、問題が発生する可能性があります。たとえば、次のシナリオを考えてみましょう。

// foo/bar.proto

syntax = "proto2";

message Bar {}

// foo/baz.proto

syntax = "proto2";

import "bar.proto";

message Baz {
  optional Bar bar = 1;
}

次のようにprotocを呼び出すと、正しく動作します

$ protoc --ruby_out=. -Ifoo foo/bar.proto foo/baz.proto
$ RUBYLIB=. ruby baz_pb.rb

ただし、次のようにprotocを呼び出し、互換性コードがない場合、ロードに失敗します

$ protoc --ruby_out=. -I. -Ifoo foo/baz.proto
$ protoc --ruby_out=. -I. -Ifoo foo/bar.proto
$ RUBYLIB=foo ruby foo/baz_pb.rb
foo/baz_pb.rb:10:in `add_serialized_file': Unable to build file to DescriptorPool: Depends on file 'bar.proto', but it has not been loaded (Google::Protobuf::TypeError)
    from foo/baz_pb.rb:10:in `<main>'

問題は、bar.protoがbar.protoとfoo/bar.protoの2つの異なる正規名で参照されていることです。これはユーザーエラーです。各インポートは常に一貫したフルパスで参照される必要があります。このようなユーザーエラーはまれであることを願っていますが、試してみないとわかりません。

この変更のコードは、このエッジケースが発生したことを検出した場合、warnを使用して警告を出力します

$ RUBYLIB=foo ruby foo/baz_pb.rb
Warning: Protobuf detected an import path issue while loading generated file foo/baz_pb.rb
- foo/baz.proto imports bar.proto, but that import was loaded as foo/bar.proto
Each proto file must use a consistent fully-qualified name.
This will become an error in the next major version.

この場合、2つの可能な修正方法があります。1つは、インポートに一貫して名前bar.protoを使用することです（-I.を削除）。もう1つは、インポートに一貫して名前foo/bar.protoを使用することです（インポート行をimport "foo/bar.proto"に変更し、-Ifooを削除）。

次のメジャーバージョンでこの互換性コードを削除する予定です。