2023年4月20日発表の変更

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

Rubyジェネレーターへの変更

23.xリリースに含まれる予定のこのGitHub PRにより、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が2つの異なる正規名（bar.protoとfoo/bar.proto）で参照されていることです。これはユーザーエラーです。各インポートは、常に一貫したフルパスで参照されるべきです。このようなユーザーエラーは稀であることを願いますが、試してみないことにはわかりません。

この変更に含まれるコードは、このエッジケースが発生したことを検出した場合、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を削除する）。

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