grpc_reflection 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b17804fde58e327e1e11735e929252ea6b0d39b27f0c6422ee5641c37f251fb
-  data.tar.gz: 845fc82d9ed3149fb45c31ef8307a5da43240e14b7615e43d00748f5ba1ac008
+  metadata.gz: '083f05c2730db17b2d790b16084a54c3b3e165607265747e564adc26b72d71b3'
+  data.tar.gz: 4d9033ce323235fc76ffbd6bb0bc43ba218fb166479e0a4347b12eec2604ccba
 SHA512:
-  metadata.gz: e91d01d52dad1cfccbcdf331ea1996d90ee546e3f92ad1dd44863c89c4aca742565d6d67b5ff7a71d93d9d48cc5346cdf258c841b49e8f54feb8e13092b262bd
-  data.tar.gz: 96d03f3dec08b28b217111bb6f1017f7423d69eb9fc9785551ee16f953cfa8c589df797b3fbcf7f7aa276b63917c5ea5a537943b4de780d7ce6e8b0bfcd815f2
+  metadata.gz: 957c82b81d874bed400ccd707580b41c266d80f9a240fe7f81d21067e285ed5d508c24a362f274697168c0002aaa302669ea1c3341465018bb163980fd164f51
+  data.tar.gz: 5a6a5a469ea8829baf149b97888a8eb68e58bc1e229553a186cd6308256e54cf2db3511934114a02fbee92e91e5ef342c721c71360236046f8f65270debb9e2c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.5.0
+
+* Support multiple requests #24
+* Find the RpcServer actually hosting the reflection service- #23
+* Return error_response for not-found and invalid reflection requests #21
+* Fix file_containing_extension to look up by extendee type, not extension name #20
+* Fix symbol resolution for services/methods defined without a package #19
+* Fix symbol lookup cache for non-dataset symbols #18
+
 ## 0.4.0
 
 * Support `file_containing_extension` request #14

data/lib/grpc_reflection/file_descriptor_decorator.rb

@@ -6,7 +6,7 @@ require "google/protobuf/descriptor_pb"
 
 module GrpcReflection
   class FileDescriptorDecorator
-    attr_reader :dataset, :serialized_file, :filename, :dependency
+    attr_reader :dataset, :serialized_file, :filename, :dependency, :file_descriptor_proto
 
     def initialize(file_descriptor_proto)
       @file_descriptor_proto = file_descriptor_proto
@@ -24,17 +24,23 @@ module GrpcReflection
     def set_dataset
       @file_descriptor_proto.service.each do |s|
         converted_service = JSON.parse(s.to_json)
-        @dataset.add(@file_descriptor_proto.package + "." + converted_service["name"])
+        @dataset.add(qualified_name(converted_service["name"]))
         converted_service["method"].each do |m|
-          @dataset.add(@file_descriptor_proto.package + "." + converted_service["name"] + "." + m["name"])
+          @dataset.add(qualified_name(converted_service["name"] + "." + m["name"]))
           @dataset.add(m["inputType"][1..])
           @dataset.add(m["outputType"][1..])
         end
       end
 
       @file_descriptor_proto.extension.each do |s|
-        @dataset.add(@file_descriptor_proto.package + "." + s.name)
+        @dataset.add(qualified_name(s.name))
       end
     end
+
+    def qualified_name(name)
+      return name if @file_descriptor_proto.package.empty?
+
+      @file_descriptor_proto.package + "." + name
+    end
   end
 end

data/lib/grpc_reflection/file_descriptor_manager.rb

@@ -2,25 +2,37 @@
 
 module GrpcReflection
   module FileDescriptorManager
-    @@file_descriptor_decorators = []
+    @@file_descriptor_decorators = {}
 
     class << self
       def add(file_descriptor_proto)
-        decorator = GrpcReflection::FileDescriptorDecorator.new(file_descriptor_proto)
-        @@file_descriptor_decorators << decorator
-        decorator
+        filename = file_descriptor_proto.name
+        @@file_descriptor_decorators[filename] ||= GrpcReflection::FileDescriptorDecorator.new(file_descriptor_proto)
       end
 
       def find(name)
         file_descriptor = find_file_descriptor(name)
         return [] if file_descriptor.nil?
 
+        collect_with_dependencies(file_descriptor)
+      end
+
+      def find_extension(containing_type, extension_number, service_names = [])
+        file_descriptor = find_extension_file_descriptor(containing_type, extension_number, service_names)
+        return [] if file_descriptor.nil?
+
+        collect_with_dependencies(file_descriptor)
+      end
+
+      private
+
+      def collect_with_dependencies(file_descriptor)
         result = {}
         result[file_descriptor.filename] = file_descriptor.serialized_file
         dependencies = file_descriptor.dependency.dup
         until dependencies.empty?
           dependency = dependencies.shift
-          decorated_file_descriptor = @@file_descriptor_decorators.detect { |f| f.filename == dependency }
+          decorated_file_descriptor = @@file_descriptor_decorators[dependency]
           if decorated_file_descriptor.nil? && proto = Google::Protobuf::DescriptorPool.generated_pool.lookup(dependency)&.to_proto
             decorated_file_descriptor = add(proto)
           end
@@ -34,26 +46,82 @@ module GrpcReflection
         result.values
       end
 
-      private
+      def find_extension_file_descriptor(containing_type, extension_number, service_names)
+        candidate_file_descriptor_protos(service_names).each_value do |file_descriptor_proto|
+          next unless extension_field_matches?(file_descriptor_proto, containing_type, extension_number)
+
+          return add(file_descriptor_proto)
+        end
+
+        nil
+      end
+
+      def candidate_file_descriptor_protos(service_names)
+        candidates = {}
+
+        @@file_descriptor_decorators.each_value do |decorated_file_descriptor|
+          candidates[decorated_file_descriptor.filename] = decorated_file_descriptor.file_descriptor_proto
+        end
+
+        pending = service_names.filter_map do |service_name|
+          descriptor = Google::Protobuf::DescriptorPool.generated_pool.lookup(service_name)
+          descriptor&.file_descriptor&.to_proto if descriptor.respond_to?(:file_descriptor)
+        end
+
+        until pending.empty?
+          file_descriptor_proto = pending.shift
+          next if file_descriptor_proto.nil? || candidates.key?(file_descriptor_proto.name)
+
+          candidates[file_descriptor_proto.name] = file_descriptor_proto
+          file_descriptor_proto.dependency.each do |dependency|
+            next if candidates.key?(dependency)
+
+            dependency_proto = Google::Protobuf::DescriptorPool.generated_pool.lookup(dependency)&.to_proto
+            pending << dependency_proto unless dependency_proto.nil?
+          end
+        end
+
+        candidates
+      end
+
+      def extension_field_matches?(file_descriptor_proto, containing_type, extension_number)
+        each_extension_field(file_descriptor_proto).any? do |field|
+          field.extendee == ".#{containing_type}" && field.number == extension_number
+        end
+      end
+
+      def each_extension_field(file_descriptor_proto, &block)
+        return enum_for(:each_extension_field, file_descriptor_proto) unless block_given?
+
+        file_descriptor_proto.extension.each(&block)
+        file_descriptor_proto.message_type.each { |message_type| each_message_extension_field(message_type, &block) }
+      end
+
+      def each_message_extension_field(message_type, &block)
+        message_type.extension.each(&block)
+        message_type.nested_type.each { |nested_type| each_message_extension_field(nested_type, &block) }
+      end
 
       def find_file_descriptor(name)
-        file_descriptor = @@file_descriptor_decorators.detect { |f| f.dataset.include?(name) }
+        file_descriptor = @@file_descriptor_decorators.values.detect { |f| f.dataset.include?(name) }
         return file_descriptor if file_descriptor
 
         search_name = name
         file_descriptor_proto = nil
-        while pos = search_name.rindex(".")
+        loop do
           descriptor = Google::Protobuf::DescriptorPool.generated_pool.lookup(search_name)
-          search_name = search_name.slice(0..(pos - 1))
-          next if descriptor.nil? || !descriptor.respond_to?(:file_descriptor)
-          file_descriptor_proto = descriptor.file_descriptor&.to_proto
-          break unless file_descriptor_proto.nil?
+          pos = search_name.rindex(".")
+          search_name = pos ? search_name.slice(0..(pos - 1)) : nil
+          unless descriptor.nil? || !descriptor.respond_to?(:file_descriptor)
+            file_descriptor_proto = descriptor.file_descriptor&.to_proto
+            break unless file_descriptor_proto.nil?
+          end
+          break if search_name.nil?
         end
 
         return nil if file_descriptor_proto.nil?
 
         add(file_descriptor_proto)
-        @@file_descriptor_decorators.detect { |f| f.dataset.include?(name) }
       end
     end
   end

data/lib/grpc_reflection/server_shared.rb

@@ -1,39 +1,57 @@
 module GrpcReflection
   module ServerShared
     def server_reflection_info_response(req, proto_module)
-      # TODO: support streaming call
-      request = req.first
+      req.lazy.map { |request| build_response(request, proto_module) }
+    end
+
+    private
 
-      res = proto_module::ServerReflectionResponse.new
-      if request.list_services.size != 0
+    def build_response(request, proto_module)
+      res = proto_module::ServerReflectionResponse.new(original_request: request, valid_host: request.host)
+      case request.message_request
+      when :list_services
         res.list_services_response = proto_module::ListServiceResponse.new(service: list_services_response(proto_module))
-      elsif !request.file_containing_symbol.empty?
+      when :file_containing_symbol
         result = GrpcReflection::FileDescriptorManager.find(request.file_containing_symbol)
-        res.file_descriptor_response = proto_module::FileDescriptorResponse.new(file_descriptor_proto: result)
-      elsif !request.file_by_filename.empty?
-        proto = Google::Protobuf::DescriptorPool.generated_pool.lookup(request.file_by_filename)&.to_proto
-        res.file_descriptor_response = proto_module::FileDescriptorResponse.new(file_descriptor_proto: [Google::Protobuf::FileDescriptorProto.encode(proto)])
-      elsif !request.file_containing_extension.nil? && !request.file_containing_extension.containing_type.empty?
-        descriptor = Google::Protobuf::DescriptorPool.generated_pool.lookup(request.file_containing_extension.containing_type)
-        if descriptor.is_a?(Google::Protobuf::FieldDescriptor) && descriptor.number == request.file_containing_extension.extension_number
-          result = GrpcReflection::FileDescriptorManager.find(request.file_containing_extension.containing_type)
+        if result.empty?
+          res.error_response = error_response(proto_module, GRPC::Core::StatusCodes::NOT_FOUND, "symbol not found: #{request.file_containing_symbol}")
+        else
           res.file_descriptor_response = proto_module::FileDescriptorResponse.new(file_descriptor_proto: result)
+        end
+      when :file_by_filename
+        descriptor = Google::Protobuf::DescriptorPool.generated_pool.lookup(request.file_by_filename)
+        if !descriptor.is_a?(Google::Protobuf::FileDescriptor)
+          res.error_response = error_response(proto_module, GRPC::Core::StatusCodes::NOT_FOUND, "file not found: #{request.file_by_filename}")
         else
-          res.file_descriptor_response = proto_module::FileDescriptorResponse.new(file_descriptor_proto: [])
+          res.file_descriptor_response = proto_module::FileDescriptorResponse.new(file_descriptor_proto: [Google::Protobuf::FileDescriptorProto.encode(descriptor.to_proto)])
         end
-      elsif !request.all_extension_numbers_of_type.empty?
-        res.error_response = proto_module::ErrorResponse.new(
-          error_code: GRPC::Core::StatusCodes::UNIMPLEMENTED,
-          error_message: "all_extension_numbers_of_type is not implemented"
+      when :file_containing_extension
+        result = GrpcReflection::FileDescriptorManager.find_extension(
+          request.file_containing_extension.containing_type,
+          request.file_containing_extension.extension_number,
+          service_names
         )
+        if result.empty?
+          res.error_response = error_response(proto_module, GRPC::Core::StatusCodes::NOT_FOUND, "extension not found: #{request.file_containing_extension.containing_type} #{request.file_containing_extension.extension_number}")
+        else
+          res.file_descriptor_response = proto_module::FileDescriptorResponse.new(file_descriptor_proto: result)
+        end
+      when :all_extension_numbers_of_type
+        res.error_response = error_response(proto_module, GRPC::Core::StatusCodes::UNIMPLEMENTED, "all_extension_numbers_of_type is not implemented")
+      else
+        res.error_response = error_response(proto_module, GRPC::Core::StatusCodes::INVALID_ARGUMENT, "invalid MessageRequest")
       end
-      [res].enum_for(:each)
+      res
     end
 
-    private
+    def error_response(proto_module, error_code, error_message)
+      proto_module::ErrorResponse.new(error_code: error_code, error_message: error_message)
+    end
 
     def main_server
-      @main_server ||= ObjectSpace.each_object(GRPC::RpcServer).to_a[0]
+      @main_server ||= ObjectSpace.each_object(GRPC::RpcServer).find do |server|
+        server.send(:rpc_handlers).values.any? { |handler| handler.receiver.equal?(self) }
+      end
     end
 
     def service_names

data/lib/grpc_reflection/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrpcReflection
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grpc_reflection
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yuji Yaginuma