grpc_typechecker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 643cfc11b7ddbc6ff80cdb3e52add070e6d5832e7bfecafd5abafde411c3248d
+  data.tar.gz: 6505ceb3c61e0a319c83646b8dfea0b4d3d97223eb5000ab18f4558e9b737e17
+SHA512:
+  metadata.gz: aa01d8087578c31ffe19e97342b567162f277efc164da0a28847f0555811402f0edd9f63b1b9fae57c31687c47851c7b590862373bde8cccbdcb7e5e42357ba7
+  data.tar.gz: aeda9191c06cdb71d85d0cae8f2603adaacebd1968a802f33c40539318d2b58ffed787bb85097ac240f39cb519111be74d072293678b20085bf07eae5d8fbc3f

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_typechecker.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Masayuki Mizuno
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# GrpcTypechecker [![Build Status](https://travis-ci.com/wantedly/grpc_typechecker.svg?branch=master)](https://travis-ci.com/wantedly/grpc_typechecker)
+
+A dynamic type checker for gRPC methods. This gem consists of two features:
+
+- a client interceptor for the run-time type check of gRPC requests, and
+- a monkey patch for type checking gRPC responses during execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grpc_typechecker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grpc_typechecker
+
+## Usage
+
+If you would like to type check the gRPC requsts, please set the instance of `GrpcTypechecker::ClientInterceptor` as an interceptor of your gRPC application. For instance:
+
+```ruby
+server = Grpc::Testing::TestService::Stub.new(
+  "localhost:12345",
+  :this_port_is_insecure,
+  interceptors: [
+    GrpcTypechecker::ClientInterceptor(service_class: Grpc::Testing::TestService)
+  ]
+)
+```
+
+On the other hand, the dynamic type checker for gRPC responses will be automatically introduced only by requiring `grpc_typechecker`
+
+```ruby
+require 'grpc_typechecker'
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grpc_typechecker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grpc_typechecker.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/grpc_typechecker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grpc_typechecker"
+  spec.version       = GrpcTypechecker::VERSION
+  spec.authors       = ["Masayuki Mizuno"]
+  spec.email         = ["mizuno@wantedly.com"]
+
+  spec.summary       = "A dynamic type checker for gRPC methods"
+  spec.description   = "A dynamic type checker for gRPC methods"
+  spec.homepage      = "https://github.com/wantedly/grpc_typechecker"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wantedly/grpc_typechecker"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'grpc'
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'rspec'
+end

data/lib/grpc_typechecker.rb

@@ -0,0 +1,3 @@
+require "grpc_typechecker/version"
+require "grpc_typechecker/grpc_ext"
+require "grpc_typechecker/client_interceptor"

data/lib/grpc_typechecker/client_interceptor.rb

@@ -0,0 +1,40 @@
+module GrpcTypechecker
+  class ClientInterceptor < GRPC::ClientInterceptor
+    def initialize(service_class: nil)
+      @service = service_class::Service
+    end
+
+    def request_response(request: nil, call: nil, method: nil, metadata: nil)
+      # Raise InvalidArgument if the argument of gRPC method is ill-typed
+      unless request.is_a?(request_class(method))
+        raise GRPC::InvalidArgument, "#{method}: expected an instance of #{request_class(method)}, got an instance of #{request.class}"
+      end
+      yield
+    end
+
+    def client_streamer(requests: nil, call: nil, method: nil, metadata: nil)
+      # no-op
+      yield
+    end
+
+    def server_streamer(request: nil, call: nil, method: nil, metadata: nil)
+      # no-op
+      yield
+    end
+
+    def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil)
+      # no-op
+      yield
+    end
+
+  private
+
+    # @param [String] method A string which represents a full path of a gRPC
+    #     method. e.g. "/wantedly.users.UserService/GetUser"
+    # @return [Class]
+    def request_class(method)
+      rpc_method = method.split('/')[2].to_sym
+      @service.rpc_descs[rpc_method][:input]
+    end
+  end
+end

data/lib/grpc_typechecker/grpc_ext.rb

@@ -0,0 +1,59 @@
+require "grpc"
+require "active_support/core_ext/string/inflections"
+
+module GRPC::GenericService
+  # The usual way to supplement class methods is use of `Module#included'.
+  # `GRPC::GenericService' already contains `included', thus we wrap `self.included' by `Module#prepend'.
+
+  module IncludedForClassMethods
+    def included(base)
+      super
+      base.extend(GRPC::GenericService::ClassMethods)
+    end
+  end
+
+  class << self
+    prepend IncludedForClassMethods
+  end
+
+  module ClassMethods
+    def inherited(subclass)
+      super if defined? super
+
+      mod = Module.new do
+        singleton_class.class_eval do
+          # Some server interceptors try to obtain the service name by `method.owner.service_name`
+          # despite `method` is overwritten by the method in this module.
+          # We thus redirect class method calls of `service_name` for compatibility.
+          define_method :service_name do
+            subclass.service_name
+          end
+        end
+      end
+
+      subclass.class_eval do
+        prepend mod
+        @_prepended_module_for_type_check_ = mod
+      end
+    end
+
+    def method_added(method)
+      super if defined? super
+
+      rpc_method = rpc_descs[method.to_s.camelize.to_sym]
+      return unless rpc_method && @_prepended_module_for_type_check_
+
+      # Overwrite the gRPC method
+      @_prepended_module_for_type_check_.class_eval do
+        define_method method do |*args, **kwargs|
+          response = super(*args, **kwargs)
+          # Raise Internal if the response of gRPC method is ill-typed
+          unless response.is_a?(rpc_method[:output])
+            raise GRPC::Internal, "the response of #{method} is expected to be an instance of #{rpc_method[:output]}, but the response is an instance of #{response.class}"
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/grpc_typechecker/version.rb

@@ -0,0 +1,3 @@
+module GrpcTypechecker
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: grpc_typechecker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masayuki Mizuno
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A dynamic type checker for gRPC methods
+email:
+- mizuno@wantedly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grpc_typechecker.gemspec
+- lib/grpc_typechecker.rb
+- lib/grpc_typechecker/client_interceptor.rb
+- lib/grpc_typechecker/grpc_ext.rb
+- lib/grpc_typechecker/version.rb
+homepage: https://github.com/wantedly/grpc_typechecker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wantedly/grpc_typechecker
+  source_code_uri: https://github.com/wantedly/grpc_typechecker
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.5
+signing_key:
+specification_version: 4
+summary: A dynamic type checker for gRPC methods
+test_files: []