protobuf 3.10.3 → 3.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b525441c3875b1c480aa66d017320f94e6a1709dc57a01a00046875dc818514b
-  data.tar.gz: b0120b20ec1992adb4aae4f257bc3f3e019c0cd928b1f11b716ff3443aff22d2
+  metadata.gz: 4ea13b6353fc56a116dc91e87662ffaaac8c4b8cb27dd85be480797e7ef922d2
+  data.tar.gz: 6f5804860b80527356f1a6cec79def05499abd4a5536038c453e7e65cd05c237
 SHA512:
-  metadata.gz: '08c01a3a8158ffec5621d563a298e6cce89044dcac4a1ffbc64f40fd792efc29fe960e76527e2b3fbdbfefa0bb464d51b576c9ec0dcc54aa71d444ef104c7e14'
-  data.tar.gz: c980ad847a3f546792925141738373ca511ed42ae161e37b4447f7b109e9fea1a6697241951a89faff0e1871bcc6f0b42fb47eac5d36f9af37bc3c0b8f2433d3
+  metadata.gz: a49491b32df80049107f59673008d6f8ac64977abcae332ad407c120f9f9628f4c3b47dbd5f809b8843ce477e02286da3fc1242131a8919ddac7170e2002bbf4
+  data.tar.gz: b5352584a6c79b77ce1360fb0ce6a03c00a165cdfb8f92b96aaf61d37a3acf7a89f7bd4bd2fc8a3f1c879434b941db3e0689040edf5988cee2c05cb5bfd0a3a5

data/.circleci/config.yml

@@ -0,0 +1,46 @@
+version: 2.1
+
+jobs:
+  # skipping build step because Gemfile.lock is not included in the source
+  # this makes the bundler caching step a noop
+  test:
+    parameters:
+      ruby-image:
+        type: string
+    docker:
+      - image: << parameters.ruby-image >>
+    steps:
+      - run:
+          name: Install protobuf compiler
+          command: |
+            archive=protoc-3.16.0-linux-x86_64
+            curl -O -L https://github.com/protocolbuffers/protobuf/releases/download/v3.16.0/$archive.zip
+            sudo unzip -d '/usr/local' $archive.zip 'bin/*' 'include/*'
+            sudo chown -R $(whoami) /usr/local/bin/protoc /usr/local/include/google
+            rm -rf $archive.zip
+      - run:
+          command: protoc --version
+      - run:
+          command: sudo apt-get update
+      - run:
+          message: Install ZeroMQ
+          command: sudo apt-get -y install libzmq3-dev
+      - checkout
+      - run:
+          command: gem install bundler
+      - run:
+          command: bundle install
+      - run:
+          command: bundle exec rake
+
+workflows:
+  build_and_test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-image:
+                - circleci/jruby:9.2.6.0-jdk
+                - circleci/jruby:9.1.17.0-jdk
+                - circleci/ruby:2.5
+                - circleci/ruby:2.7

data/CHANGES.md

@@ -4,6 +4,7 @@
 3.10.0
 ------
 - Add headers to request proto
+- Add support for compiling v3 protos with optional fields as v2 optional fields
 
 3.9.0
 -----

data/Rakefile

@@ -22,10 +22,12 @@ namespace :compile do
   task :spec do
     proto_path = ::File.expand_path('../spec/support/', __FILE__)
     proto_files = Dir[File.join(proto_path, '**', '*.proto')]
-    cmd = %(protoc --plugin=./bin/protoc-gen-ruby --ruby_out=#{proto_path} -I #{proto_path} #{proto_files.join(' ')})
 
-    puts cmd
-    system(cmd)
+    proto_files.each do |proto_file|
+      cmd = %(protoc --plugin=protoc-gen-ruby-protobuf=./bin/protoc-gen-ruby --ruby-protobuf_out=#{proto_path} -I #{proto_path} #{proto_file})
+      puts cmd
+      system(cmd) || fail("Failed to compile spec proto: #{proto_file}")
+    end
   end
 
   desc 'Compile rpc protos in protos/ directory'
@@ -35,10 +37,10 @@ namespace :compile do
     output_dir = ::File.expand_path('../tmp/rpc', __FILE__)
     ::FileUtils.mkdir_p(output_dir)
 
-    cmd = %(protoc --plugin=./bin/protoc-gen-ruby --ruby_out=#{output_dir} -I #{proto_path} #{proto_files.join(' ')})
+    cmd = %(protoc --plugin=protoc-gen-ruby-protobuf=./bin/protoc-gen-ruby --ruby-protobuf_out=#{output_dir} -I #{proto_path} #{proto_files.join(' ')})
 
     puts cmd
-    system(cmd)
+    system(cmd) || fail("Failed to compile rpc protos!")
 
     files = {
       'tmp/rpc/dynamic_discovery.pb.rb'               => 'lib/protobuf/rpc',

data/lib/protobuf/code_generator.rb

@@ -46,7 +46,16 @@ module Protobuf
         generate_file(file_descriptor)
       end
 
-      ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(:file => generated_files)
+      ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(
+        :file => generated_files,
+        :supported_features => supported_features,
+      )
+    end
+
+    def supported_features
+      # The only available feature is proto3 with optional fields.
+      # This is backwards compatible with proto2 optional fields.
+      ::Google::Protobuf::Compiler::CodeGeneratorResponse::Feature::FEATURE_PROTO3_OPTIONAL.to_i
     end
 
     Protobuf::Field::BaseField.module_eval do

data/lib/protobuf/descriptors/google/protobuf/compiler/plugin.pb.rb

@@ -19,8 +19,14 @@ module Google
       ##
       # Message Classes
       #
+      class Version < ::Protobuf::Message; end
       class CodeGeneratorRequest < ::Protobuf::Message; end
       class CodeGeneratorResponse < ::Protobuf::Message
+        class Feature < ::Protobuf::Enum
+          define :FEATURE_NONE, 0
+          define :FEATURE_PROTO3_OPTIONAL, 1
+        end
+
         class File < ::Protobuf::Message; end
 
       end
@@ -32,15 +38,24 @@ module Google
       #
       set_option :java_package, "com.google.protobuf.compiler"
       set_option :java_outer_classname, "PluginProtos"
+      set_option :go_package, "google.golang.org/protobuf/types/pluginpb"
 
 
       ##
       # Message Fields
       #
+      class Version
+        optional :int32, :major, 1
+        optional :int32, :minor, 2
+        optional :int32, :patch, 3
+        optional :string, :suffix, 4
+      end
+
       class CodeGeneratorRequest
         repeated :string, :file_to_generate, 1
         optional :string, :parameter, 2
         repeated ::Google::Protobuf::FileDescriptorProto, :proto_file, 15
+        optional ::Google::Protobuf::Compiler::Version, :compiler_version, 3
       end
 
       class CodeGeneratorResponse
@@ -48,9 +63,11 @@ module Google
           optional :string, :name, 1
           optional :string, :insertion_point, 2
           optional :string, :content, 15
+          optional ::Google::Protobuf::GeneratedCodeInfo, :generated_code_info, 16
         end
 
         optional :string, :error, 1
+        optional :uint64, :supported_features, 2
         repeated ::Google::Protobuf::Compiler::CodeGeneratorResponse::File, :file, 15
       end
 

data/lib/protobuf/descriptors/google/protobuf/descriptor.pb.rb

@@ -20,6 +20,7 @@ module Google
 
     end
 
+    class ExtensionRangeOptions < ::Protobuf::Message; end
     class FieldDescriptorProto < ::Protobuf::Message
       class Type < ::Protobuf::Enum
         define :TYPE_DOUBLE, 1
@@ -51,7 +52,11 @@ module Google
     end
 
     class OneofDescriptorProto < ::Protobuf::Message; end
-    class EnumDescriptorProto < ::Protobuf::Message; end
+    class EnumDescriptorProto < ::Protobuf::Message
+      class EnumReservedRange < ::Protobuf::Message; end
+
+    end
+
     class EnumValueDescriptorProto < ::Protobuf::Message; end
     class ServiceDescriptorProto < ::Protobuf::Message; end
     class MethodDescriptorProto < ::Protobuf::Message; end
@@ -80,10 +85,19 @@ module Google
 
     end
 
+    class OneofOptions < ::Protobuf::Message; end
     class EnumOptions < ::Protobuf::Message; end
     class EnumValueOptions < ::Protobuf::Message; end
     class ServiceOptions < ::Protobuf::Message; end
-    class MethodOptions < ::Protobuf::Message; end
+    class MethodOptions < ::Protobuf::Message
+      class IdempotencyLevel < ::Protobuf::Enum
+        define :IDEMPOTENCY_UNKNOWN, 0
+        define :NO_SIDE_EFFECTS, 1
+        define :IDEMPOTENT, 2
+      end
+
+    end
+
     class UninterpretedOption < ::Protobuf::Message
       class NamePart < ::Protobuf::Message; end
 
@@ -94,6 +108,11 @@ module Google
 
     end
 
+    class GeneratedCodeInfo < ::Protobuf::Message
+      class Annotation < ::Protobuf::Message; end
+
+    end
+
 
 
     ##
@@ -102,7 +121,8 @@ module Google
     set_option :java_package, "com.google.protobuf"
     set_option :java_outer_classname, "DescriptorProtos"
     set_option :optimize_for, ::Google::Protobuf::FileOptions::OptimizeMode::SPEED
-    set_option :go_package, "descriptor"
+    set_option :go_package, "google.golang.org/protobuf/types/descriptorpb"
+    set_option :cc_enable_arenas, true
     set_option :objc_class_prefix, "GPB"
     set_option :csharp_namespace, "Google.Protobuf.Reflection"
 
@@ -133,6 +153,7 @@ module Google
       class ExtensionRange
         optional :int32, :start, 1
         optional :int32, :end, 2
+        optional ::Google::Protobuf::ExtensionRangeOptions, :options, 3
       end
 
       class ReservedRange
@@ -152,6 +173,12 @@ module Google
       repeated :string, :reserved_name, 10
     end
 
+    class ExtensionRangeOptions
+      repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
+      # Extension Fields
+      extensions 1000...536870912
+    end
+
     class FieldDescriptorProto
       optional :string, :name, 1
       optional :int32, :number, 3
@@ -163,16 +190,25 @@ module Google
       optional :int32, :oneof_index, 9
       optional :string, :json_name, 10
       optional ::Google::Protobuf::FieldOptions, :options, 8
+      optional :bool, :proto3_optional, 17
     end
 
     class OneofDescriptorProto
       optional :string, :name, 1
+      optional ::Google::Protobuf::OneofOptions, :options, 2
     end
 
     class EnumDescriptorProto
+      class EnumReservedRange
+        optional :int32, :start, 1
+        optional :int32, :end, 2
+      end
+
       optional :string, :name, 1
       repeated ::Google::Protobuf::EnumValueDescriptorProto, :value, 2
       optional ::Google::Protobuf::EnumOptions, :options, 3
+      repeated ::Google::Protobuf::EnumDescriptorProto::EnumReservedRange, :reserved_range, 4
+      repeated :string, :reserved_name, 5
     end
 
     class EnumValueDescriptorProto
@@ -200,18 +236,23 @@ module Google
       optional :string, :java_package, 1
       optional :string, :java_outer_classname, 8
       optional :bool, :java_multiple_files, 10, :default => false
-      optional :bool, :java_generate_equals_and_hash, 20, :default => false
+      optional :bool, :java_generate_equals_and_hash, 20, :deprecated => true
       optional :bool, :java_string_check_utf8, 27, :default => false
       optional ::Google::Protobuf::FileOptions::OptimizeMode, :optimize_for, 9, :default => ::Google::Protobuf::FileOptions::OptimizeMode::SPEED
       optional :string, :go_package, 11
       optional :bool, :cc_generic_services, 16, :default => false
       optional :bool, :java_generic_services, 17, :default => false
       optional :bool, :py_generic_services, 18, :default => false
+      optional :bool, :php_generic_services, 42, :default => false
       optional :bool, :deprecated, 23, :default => false
-      optional :bool, :cc_enable_arenas, 31, :default => false
+      optional :bool, :cc_enable_arenas, 31, :default => true
       optional :string, :objc_class_prefix, 36
       optional :string, :csharp_namespace, 37
-      optional :bool, :javanano_use_deprecated_package, 38
+      optional :string, :swift_prefix, 39
+      optional :string, :php_class_prefix, 40
+      optional :string, :php_namespace, 41
+      optional :string, :php_metadata_namespace, 44
+      optional :string, :ruby_package, 45
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
@@ -239,6 +280,12 @@ module Google
       extensions 1000...536870912
     end
 
+    class OneofOptions
+      repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
+      # Extension Fields
+      extensions 1000...536870912
+    end
+
     class EnumOptions
       optional :bool, :allow_alias, 2
       optional :bool, :deprecated, 3, :default => false
@@ -263,6 +310,7 @@ module Google
 
     class MethodOptions
       optional :bool, :deprecated, 33, :default => false
+      optional ::Google::Protobuf::MethodOptions::IdempotencyLevel, :idempotency_level, 34, :default => ::Google::Protobuf::MethodOptions::IdempotencyLevel::IDEMPOTENCY_UNKNOWN
       repeated ::Google::Protobuf::UninterpretedOption, :uninterpreted_option, 999
       # Extension Fields
       extensions 1000...536870912
@@ -295,6 +343,17 @@ module Google
       repeated ::Google::Protobuf::SourceCodeInfo::Location, :location, 1
     end
 
+    class GeneratedCodeInfo
+      class Annotation
+        repeated :int32, :path, 1, :packed => true
+        optional :string, :source_file, 2
+        optional :int32, :begin, 3
+        optional :int32, :end, 4
+      end
+
+      repeated ::Google::Protobuf::GeneratedCodeInfo::Annotation, :annotation, 1
+    end
+
   end
 
 end

data/lib/protobuf/rpc/error.rb

@@ -13,12 +13,12 @@ module Protobuf
         super message
       end
 
-      def encode
-        to_response.encode
+      def encode(args = {})
+        to_response(args).encode
       end
 
-      def to_response
-        ::Protobuf::Socketrpc::Response.new(:error => message, :error_reason => error_type)
+      def to_response(args = {})
+        ::Protobuf::Socketrpc::Response.new({ :error => message, :error_reason => error_type }.merge(args))
       end
     end
   end

data/lib/protobuf/rpc/middleware/exception_handler.rb

@@ -22,7 +22,7 @@ module Protobuf
           # Rescue exceptions, re-wrap them as generic Protobuf errors,
           # and encode them
           env.response = wrap_exception(exception)
-          env.encoded_response = env.response.encode
+          env.encoded_response = wrap_and_encode_with_server(env.response, env)
           env
         end
 
@@ -34,6 +34,17 @@ module Protobuf
           exception = RpcFailed.new(exception.message) unless exception.is_a?(PbError)
           exception
         end
+
+        # If the response is a PbError, it won't have the server merged into the response proto.
+        # We should add it here since exception handler is always at the bottom of the middleware
+        # stack. Without this, the server hostname in the client rpc log will not be set.
+        def wrap_and_encode_with_server(response, env)
+          if response.is_a?(PbError)
+            response.encode(:server => env.server)
+          else
+            response.encode
+          end
+        end
       end
     end
   end

data/lib/protobuf/version.rb

@@ -1,3 +1,3 @@
 module Protobuf
-  VERSION = '3.10.3' # rubocop:disable Style/MutableConstant
+  VERSION = '3.10.6' # rubocop:disable Style/MutableConstant
 end

data/proto/dynamic_discovery.proto

@@ -22,6 +22,8 @@
 //
 // Protobufs needed for dynamic discovery zmq server and client.
 
+syntax = "proto2";
+
 package protobuf.rpc.dynamicDiscovery;
 
 enum BeaconType {

data/proto/google/protobuf/compiler/plugin.proto

@@ -1,6 +1,6 @@
 // Protocol Buffers - Google's data interchange format
 // Copyright 2008 Google Inc.  All rights reserved.
-// http://code.google.com/p/protobuf/
+// https://developers.google.com/protocol-buffers/
 //
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
@@ -44,12 +44,26 @@
 // plugin should be named "protoc-gen-$NAME", and will then be used when the
 // flag "--${NAME}_out" is passed to protoc.
 
+syntax = "proto2";
+
 package google.protobuf.compiler;
 option java_package = "com.google.protobuf.compiler";
 option java_outer_classname = "PluginProtos";
 
+option go_package = "google.golang.org/protobuf/types/pluginpb";
+
 import "google/protobuf/descriptor.proto";
 
+// The version number of protocol compiler.
+message Version {
+  optional int32 major = 1;
+  optional int32 minor = 2;
+  optional int32 patch = 3;
+  // A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
+  // be empty for mainline stable releases.
+  optional string suffix = 4;
+}
+
 // An encoded CodeGeneratorRequest is written to the plugin's stdin.
 message CodeGeneratorRequest {
   // The .proto files that were explicitly listed on the command-line.  The
@@ -71,7 +85,14 @@ message CodeGeneratorRequest {
   // the entire set into memory at once.  However, as of this writing, this
   // is not similarly optimized on protoc's end -- it will store all fields in
   // memory at once before sending them to the plugin.
+  //
+  // Type names of fields and extensions in the FileDescriptorProto are always
+  // fully qualified.
   repeated FileDescriptorProto proto_file = 15;
+
+  // The version number of protocol compiler.
+  optional Version compiler_version = 3;
+
 }
 
 // The plugin writes an encoded CodeGeneratorResponse to stdout.
@@ -86,6 +107,16 @@ message CodeGeneratorResponse {
   // exiting with a non-zero status code.
   optional string error = 1;
 
+  // A bitmask of supported features that the code generator supports.
+  // This is a bitwise "or" of values from the Feature enum.
+  optional uint64 supported_features = 2;
+
+  // Sync with code_generator.h.
+  enum Feature {
+    FEATURE_NONE = 0;
+    FEATURE_PROTO3_OPTIONAL = 1;
+  }
+
   // Represents a single generated file.
   message File {
     // The file name, relative to the output directory.  The name must not
@@ -142,6 +173,11 @@ message CodeGeneratorResponse {
 
     // The file contents.
     optional string content = 15;
+
+    // Information describing the file content being inserted. If an insertion
+    // point is used, this information will be appropriately offset and inserted
+    // into the code generation metadata for the generated files.
+    optional GeneratedCodeInfo generated_code_info = 16;
   }
   repeated File file = 15;
 }