grpc-server-reflection 0.1.0

data/lib/grpc_server_reflection/service.rb

@@ -0,0 +1,154 @@
+module GrpcServerReflection
+  class << self
+    # Manually set which services to reflect.
+    # If not set, auto-detects from the server's registered handlers.
+    #
+    #   GrpcServerReflection.services = [MyService, OtherService]
+    #   s.handle(GrpcServerReflection::Service)
+    #
+    attr_accessor :services
+  end
+
+  class Service < Grpc::Reflection::V1::ServerReflection::Service
+    def server_reflection_info(requests, call)
+      registry = self.class.registry_for(allowed_service_names(call))
+
+      Enumerator.new do |yielder|
+        requests.each do |request|
+          response = handle_request(request, registry)
+          yielder << response
+        end
+      end
+    end
+
+    # Class-level registry cache. Reset with `GrpcServerReflection::Service.reset_registry!`
+    class << self
+      def registry_for(allowed)
+        @mutex ||= Mutex.new
+        @mutex.synchronize do
+          cache_key = allowed ? allowed.sort : nil
+          if @registry_cache_key != cache_key
+            @registry = nil
+            @registry_cache_key = cache_key
+          end
+          @registry ||= DescriptorRegistry.new(allowed_service_names: allowed)
+        end
+      end
+
+      def reset_registry!
+        @mutex ||= Mutex.new
+        @mutex.synchronize do
+          @registry = nil
+          @registry_cache_key = nil
+        end
+      end
+    end
+
+    private
+
+    def allowed_service_names(call)
+      # Manual override takes priority
+      if GrpcServerReflection.services
+        return GrpcServerReflection.services.map(&:service_name).compact
+      end
+
+      # Auto-detect from server's registered RPCs
+      server = find_server(call)
+      return nil unless server
+
+      rpc_descs = server.instance_variable_get(:@rpc_descs)
+      return nil unless rpc_descs
+
+      rpc_descs.keys.map do |key|
+        parts = key.to_s.split('/')
+        parts[1] if parts.length >= 3
+      end.compact.uniq
+    end
+
+    def find_server(call)
+      return nil unless call
+
+      # Try to find the server via ObjectSpace
+      # In a running gRPC server, there's typically one RpcServer instance
+      ObjectSpace.each_object(GRPC::RpcServer).first
+    rescue
+      nil
+    end
+
+    def handle_request(request, registry)
+      response = Grpc::Reflection::V1::ServerReflectionResponse.new(
+        valid_host: request.host,
+        original_request: request
+      )
+
+      case request.message_request
+      when :list_services
+        handle_list_services(response, registry)
+      when :file_by_filename
+        handle_file_by_filename(response, request.file_by_filename, registry)
+      when :file_containing_symbol
+        handle_file_containing_symbol(response, request.file_containing_symbol, registry)
+      when :file_containing_extension
+        handle_file_containing_extension(response, request.file_containing_extension, registry)
+      when :all_extension_numbers_of_type
+        handle_all_extension_numbers(response, request.all_extension_numbers_of_type, registry)
+      else
+        handle_error(response, GRPC::Core::StatusCodes::UNIMPLEMENTED, 'Request not implemented')
+      end
+
+      response
+    end
+
+    def handle_list_services(response, registry)
+      services = registry.list_services.map do |name|
+        Grpc::Reflection::V1::ServiceResponse.new(name: name)
+      end
+      response.list_services_response = Grpc::Reflection::V1::ListServiceResponse.new(
+        service: services
+      )
+    end
+
+    def handle_file_by_filename(response, filename, registry)
+      descriptors = registry.file_descriptors_with_dependencies(filename)
+      if descriptors.empty?
+        handle_error(response, GRPC::Core::StatusCodes::NOT_FOUND, "File not found: #{filename}")
+      else
+        response.file_descriptor_response = Grpc::Reflection::V1::FileDescriptorResponse.new(
+          file_descriptor_proto: descriptors
+        )
+      end
+    end
+
+    def handle_file_containing_symbol(response, symbol, registry)
+      filename = registry.find_filename_by_symbol(symbol)
+      if filename.nil?
+        handle_error(response, GRPC::Core::StatusCodes::NOT_FOUND, "Symbol not found: #{symbol}")
+      else
+        descriptors = registry.file_descriptors_with_dependencies(filename)
+        response.file_descriptor_response = Grpc::Reflection::V1::FileDescriptorResponse.new(
+          file_descriptor_proto: descriptors
+        )
+      end
+    end
+
+    def handle_file_containing_extension(response, ext_request, registry)
+      handle_error(response, GRPC::Core::StatusCodes::NOT_FOUND,
+        "Extension not found for type: #{ext_request.containing_type}, number: #{ext_request.extension_number}")
+    end
+
+    def handle_all_extension_numbers(response, type_name, registry)
+      numbers = registry.find_extension_numbers(type_name)
+      response.all_extension_numbers_response = Grpc::Reflection::V1::ExtensionNumberResponse.new(
+        base_type_name: type_name,
+        extension_number: numbers
+      )
+    end
+
+    def handle_error(response, code, message)
+      response.error_response = Grpc::Reflection::V1::ErrorResponse.new(
+        error_code: code,
+        error_message: message
+      )
+    end
+  end
+end

data/lib/grpc_server_reflection/version.rb

@@ -0,0 +1,3 @@
+module GrpcServerReflection
+  VERSION = '0.1.0'
+end

data/lib/grpc_server_reflection.rb

@@ -0,0 +1,6 @@
+require 'grpc'
+require 'google/protobuf'
+require 'grpc/reflection/v1/reflection_services_pb'
+require_relative 'grpc_server_reflection/version'
+require_relative 'grpc_server_reflection/descriptor_registry'
+require_relative 'grpc_server_reflection/service'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: grpc-server-reflection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zbokostya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Implements the gRPC Server Reflection Protocol v1, enabling tools like
+  grpcurl and Postman to introspect gRPC services.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- grpc/reflection/v1/reflection.proto
+- grpc/reflection/v1/reflection_pb.rb
+- grpc/reflection/v1/reflection_services_pb.rb
+- grpc/reflection/v1alpha/reflection.proto
+- grpc/reflection/v1alpha/reflection_pb.rb
+- grpc/reflection/v1alpha/reflection_services_pb.rb
+- lib/grpc_server_reflection.rb
+- lib/grpc_server_reflection/descriptor_registry.rb
+- lib/grpc_server_reflection/descriptor_registry/dependency_resolver.rb
+- lib/grpc_server_reflection/descriptor_registry/file_descriptor_indexer.rb
+- lib/grpc_server_reflection/descriptor_registry/object_space_indexer.rb
+- lib/grpc_server_reflection/descriptor_registry/proto_builder.rb
+- lib/grpc_server_reflection/descriptor_registry/type_mapping.rb
+- lib/grpc_server_reflection/service.rb
+- lib/grpc_server_reflection/version.rb
+homepage: https://github.com/zbokostya/ruby-grpc-server-reflection
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- "."
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: gRPC Server Reflection Protocol v1 for Ruby
+test_files: []