バージョン 23.x の新機能のお知らせ

Protocol Buffers バージョン 23.x の変更点が発表されました。

以下の発表は、2023年5月8日にリリースされたバージョン 23.x に特化したものです。時系列順の情報については、「ニュース」をご覧ください。

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

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

これは、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` を削除する）。

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

Bazel <5.3 のサポート終了

v23 では Bazel 4 のサポートを終了します。Protobuf は、最小要件バージョンとして Bazel 5.3 を含む Bazel 5 LTS のサポートを継続します。これは、Foundational C++ Support Policy で説明されているビルドサポートポリシーに従い、Foundational C++ Support のバージョンに反映されています。

構文リフレクションの非推奨化

v23 では、リフレクションを使用して構文バージョンをチェックする機能が非推奨になります。非推奨化はビルド時に警告として含まれます。この機能は将来のリリースで削除されます。