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`を削除する）です。

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