バージョン23.xのニュース発表

プロトコルバッファバージョン23.xで発表された変更点。

以下の発表はバージョン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 LTSのサポートを継続し、Bazel 5.3が最小必須バージョンとなります。これはFoundational C++ Support Policyに記載されているビルドサポートポリシーに従い、Foundational C++ Supportのバージョンに反映されています。

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

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