rails_grpc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: acc0ad828c933fd0f0ae43e535227444abc7dc4d9ce5217ac0c0137620e65488
-  data.tar.gz: dee6ef08887455e08f66d8e5d694edf39e90199f68e5bac38c4a28a5d4bf154d
+SHA1:
+  metadata.gz: d366cc22163cbb02c16dc299be7180222183b608
+  data.tar.gz: 8ec96617b1c0b8d9acf4120545a0863e6e3111fc
 SHA512:
-  metadata.gz: 3a6d38a83f247d78a53b00e0377465b349b50d8c1b6164acebdf3eac395bd154880afbb3d4ccb3b2c280dd86d81d16e37ce3012273bbdbee032146327d32ec04
-  data.tar.gz: bac414c21a83a38125052dabea4f0eb28041fe5ee03e9b7e03e62a4278d19b885d6d117faf742409ca2b1421c5bf54127e6745a2e04c3dba3b7029793c0ec06c
+  metadata.gz: 57c873d6cbbf088ba58263b0e29334598edbfe635a6872ff7ea921e8bb73476c3c69b2e70789a53958826f4a996e2a6a7bb69f2f5e756b36cfdd0fcf4cca5b3b
+  data.tar.gz: a44d0ce699339c40333385a9a46c12968c8543b5cbfa31eb821a67cf2ac3a6d75df73de08c52d46183a346803614209a930e901151dbc80333ae29e7cc66e908

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    rails_grpc (0.1.0)
+    rails_grpc (0.1.1)
       grpc
       protobuf
       rails
@@ -17,43 +17,43 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.0)
-      actionpack (= 5.2.0)
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.0)
-      activesupport (= 5.2.0)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
       globalid (>= 0.3.6)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
       arel (>= 9.0)
-    activestorage (5.2.0)
-      actionpack (= 5.2.0)
-      activerecord (= 5.2.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
       marcel (~> 0.3.1)
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -72,7 +72,7 @@ GEM
     grpc (1.14.1)
       google-protobuf (~> 3.1)
       googleapis-common-protos-types (~> 1.0.0)
-    i18n (1.0.1)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     loofah (2.2.2)
       crass (~> 1.0.2)
@@ -84,7 +84,7 @@ GEM
     method_source (0.9.0)
     middleware (0.1.0)
     mimemagic (0.3.2)
-    mini_mime (1.0.0)
+    mini_mime (1.0.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
     nio4r (2.3.1)
@@ -104,30 +104,30 @@ GEM
     rack (2.0.5)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.0)
-      actioncable (= 5.2.0)
-      actionmailer (= 5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
-      activemodel (= 5.2.0)
-      activerecord (= 5.2.0)
-      activestorage (= 5.2.0)
-      activesupport (= 5.2.0)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
       bundler (>= 1.3.0)
-      railties (= 5.2.0)
+      railties (= 5.2.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
+      thor (>= 0.19.0, < 2.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)

data/lib/rails_grpc.rb

@@ -1,10 +1,17 @@
 require "rails_grpc/version"
 
 module RailsGrpc
-end
-
-if defined?(Rails)
+  # required
   require "rails_grpc/dependencies"
-  require "rails_grpc/reloader"
   require "rails_grpc/railtie"
+  require "rails_grpc/logger"
+  require "rails_grpc/interceptor/logging_interceptor"
+
+  # extension
+  require "rails_grpc/extension/rpc_server"
+
+  # options
+  autoload :Reloader, "rails_grpc/reloader"
+  autoload :GeneralServer, "rails_grpc/general_server"
+  autoload :RackReloader, "rails_grpc/rack_reloader"
 end

data/lib/rails_grpc/dependencies.rb

@@ -1,5 +1,3 @@
-require "rails"
-
 module RailsGrpc
   module Dependencies
     mattr_accessor :proto_lib_dir
@@ -75,12 +73,12 @@ module RailsGrpc
       end
 
       def load_and_watch(file_path, const_name)
-        watch_file_and_dir(file_path) if self.cache_classes?
+        watch_file_and_dir(file_path) unless self.cache_classes?
 
         ActiveSupport::Dependencies.require_or_load(file_path, const_name.to_sym)
       end
 
-      def watch_file_and_dir(filepath)
+      def watch_file_and_dir(file_path)
         dir_path = File.dirname(file_path)
 
         ::Rails.application.config.watchable_dirs[dir_path] = [:rb]

data/lib/rails_grpc/extension/rpc_server.rb

@@ -0,0 +1,68 @@
+require "grpc"
+
+module GRPC
+  class RpcServer
+    attr_accessor :application_reload
+
+    # handles calls to the server
+    def loop_handle_server_calls
+      fail 'not started' if running_state == :not_started
+      while running_state == :running
+        begin
+          an_rpc = @server.request_call
+          break if (!an_rpc.nil?) && an_rpc.call.nil?
+          active_call = new_active_server_call(an_rpc)
+          unless active_call.nil?
+            @pool.schedule(active_call) do |ac|
+              c, mth = ac
+              begin
+                # extended for reloader
+                @application_reload.call unless @application_reload.nil?
+                # extended for reloader
+
+                rpc_descs[mth].run_server_method(
+                  c,
+                  rpc_handlers[mth],
+                  @interceptors.build_context
+                )
+              rescue StandardError
+                c.send_status(GRPC::Core::StatusCodes::INTERNAL,
+                              'Server handler failed')
+              end
+            end
+          end
+        rescue Core::CallError, RuntimeError => e
+          # these might happen for various reasons.  The correct behavior of
+          # the server is to log them and continue, if it's not shutting down.
+          if running_state == :running
+            GRPC.logger.warn("server call failed: #{e}")
+          end
+          next
+        end
+      end
+      # @running_state should be :stopping here
+      @run_mutex.synchronize do
+        transition_running_state(:stopped)
+        GRPC.logger.info("stopped: #{self}")
+        @server.close
+      end
+    end
+
+    def add_force_rpc_descs_for(service)
+      cls = service.is_a?(Class) ? service : service.class
+      specs, handlers = (@rpc_descs ||= {}), (@rpc_handlers ||= {})
+      cls.rpc_descs.each_pair do |name, spec|
+        route = "/#{cls.service_name}/#{name}".to_sym
+        # fail "already registered: rpc #{route} from #{spec}" if specs.key? route
+        specs[route] = spec
+        rpc_name = GenericService.underscore(name.to_s).to_sym
+        if service.is_a?(Class)
+          handlers[route] = cls.new.method(rpc_name)
+        else
+          handlers[route] = service.method(rpc_name)
+        end
+        GRPC.logger.info("handling #{route} with #{handlers[route]}")
+      end
+    end
+  end
+end

data/lib/rails_grpc/general_server.rb

@@ -0,0 +1,70 @@
+require "grpc"
+require "rails_grpc/interceptor/logging_interceptor"
+require "rails_grpc/dependencies"
+
+module RailsGrpc
+  class GeneralServer
+    attr_accessor :port, :logger, :grpc_server, :handlers, :interceptors
+
+    # When you would like to use autoreload in development mode,
+    # pool_size > 1 reloading is so slow, so you should set pool_size 1.
+    attr_accessor :pool_size
+
+    def initialize(port:, pool_size: nil, logger: Rails.logger)
+      self.port = port
+      self.pool_size = pool_size
+      self.logger = logger
+      self.handlers = []
+
+      self.interceptors = [
+        RailsGrpc::Interceptor::LoggingInterceptor.new(RailsGrpc::Logger.logger(logger))
+      ]
+
+      self.grpc_server = if pool_size.present?
+                           GRPC::RpcServer.new(pool_size: pool_size, interceptors: self.interceptors)
+                         else
+                           GRPC::RpcServer.new(interceptors: self.interceptors)
+                         end
+      self.grpc_server.add_http2_port(port, :this_port_is_insecure)
+      set_reloader
+    end
+
+    def set_reloader
+      unless RailsGrpc::Dependencies.cache_classes?
+        @grpc_server.application_reload = lambda do
+          changed = Rails.application.reloader.check.call
+          if changed
+            @logger.info("Reloading GRPC Server...")
+            Rails.application.reloader.reload!
+            @logger.info("Reset GRPC services...")
+
+            @handlers.each do |h|
+              reloaded_handler = h.to_s.constantize
+              @grpc_server.send(:add_force_rpc_descs_for, reloaded_handler)
+            end
+          end
+        end
+      end
+    end
+
+    def set_handlers(handlers)
+      hs = Array(handlers)
+      hs.each do |h|
+        @grpc_server.handle(h)
+      end
+      @handlers.concat(hs)
+    end
+
+    def run
+      @logger.info("GRPC server running on #{port}")
+      begin
+        @grpc_server.run_till_terminated
+      rescue SystemExit, Interrupt
+        # server does not stop gracefully because of it is a bug of grpc ruby.
+        # see: https://github.com/grpc/grpc/issues/14043
+        @logger.info("GRPC server goodbye!")
+        @grpc_server.stop
+      end
+    end
+  end
+end

data/lib/rails_grpc/interceptor/logging_interceptor.rb

@@ -0,0 +1,24 @@
+require "grpc"
+
+module RailsGrpc
+  module Interceptor
+    class LoggingInterceptor < ::GRPC::ServerInterceptor
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def request_response(request: nil, call: nil, method: nil)
+        grpc_method = "#{method.owner.name}##{method.name}"
+        logger = @logger
+        logger.debug("[GRPC] #{grpc_method}")
+        t = Time.now
+
+        yield
+
+        t = Time.now - t
+        display_duration = "%.1f ms" % (t * 1000.0)
+        logger.debug("[GRPC response] (#{display_duration}) #{grpc_method}")
+      end
+    end
+  end
+end

data/lib/rails_grpc/logger.rb

@@ -0,0 +1,22 @@
+require "rails"
+
+module RailsGrpc
+  class Logger
+    class << self
+      delegate :debug, :info, :warn, :error, :fatal, to: :logger
+
+      def logger(original_logger)
+        return @logger if @logger.present?
+
+        if Rails.env.development? || Rails.env.test?
+          std_logger = ActiveSupport::Logger.new(STDOUT)
+          multiple_loggers = ActiveSupport::Logger.broadcast(std_logger)
+          original_logger.extend(multiple_loggers)
+        end
+
+        @logger = original_logger
+        @logger
+      end
+    end
+  end
+end

data/lib/rails_grpc/rack_reloader.rb

@@ -0,0 +1,19 @@
+require "rails_grpc/dependencies"
+
+module RailsGrpc
+  class RackReloader
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      unless RailsGrpc::Dependencies.cache_classes?
+        changed = Rails.application.reloader.check.call
+        if changed
+          Rails.application.reloader.reload!
+        end
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/rails_grpc/railtie.rb

@@ -1,5 +1,5 @@
-require "rails"
 require "rails_grpc/dependencies"
+require "rails_grpc/reloader"
 require "google/protobuf"
 
 module RailsGrpc
@@ -13,11 +13,7 @@ module RailsGrpc
     end
 
     ActiveSupport::Reloader.to_complete do
-      unless RailsGrpc::Dependencies.cache_classes?
-        Google::Protobuf::DescriptorPool.generated_pool.clear
-        RailsGrpc::Dependencies.clear_dependencies!
-        RailsGrpc::Dependencies.load_dependencies!
-      end
+      RailsGrpc::Reloader.reload!
     end
   end
 end

data/lib/rails_grpc/reloader.rb

@@ -0,0 +1,15 @@
+require "rails_grpc/dependencies"
+
+module RailsGrpc
+  module Reloader
+    class << self
+      def reload!
+        unless RailsGrpc::Dependencies.cache_classes?
+          Google::Protobuf::DescriptorPool.generated_pool.clear
+          RailsGrpc::Dependencies.clear_dependencies!
+          RailsGrpc::Dependencies.load_dependencies!
+        end
+      end
+    end
+  end
+end

data/lib/rails_grpc/version.rb

@@ -1,3 +1,3 @@
 module RailsGrpc
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/tasks/protoc.rake

@@ -55,7 +55,24 @@ protoc -I #{proto_path} --ruby_out=#{ruby_out} --grpc_out=#{grpc_out} \
       name.end_with?("_pb.rb") && name.include?("_services_")
     end
     service_files.each do |path|
-      source = open(path).read.split("\n").reject { |line| line =~ /^require / }.join("\n")
+      source = open(path)
+        .read
+        .split("\n")
+        .reject { |line| line =~ /^require / && !line.include?("grpc") }.join("\n")
+      open(path, "w") do |f|
+        f.write source
+      end
+    end
+
+    without_service_files = grpc_out_ruby_files.select do |v|
+      name = File.basename(v)
+      name.end_with?("_pb.rb") && !name.include?("_services_")
+    end
+    without_service_files.each do |path|
+      source = open(path)
+        .read
+        .split("\n")
+        .reject { |line| line =~ /^require / && !line.include?("google/protobuf") }.join("\n")
       open(path, "w") do |f|
         f.write source
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_grpc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shinsuke Nishio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-12 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,6 +114,11 @@ files:
 - bin/setup
 - lib/rails_grpc.rb
 - lib/rails_grpc/dependencies.rb
+- lib/rails_grpc/extension/rpc_server.rb
+- lib/rails_grpc/general_server.rb
+- lib/rails_grpc/interceptor/logging_interceptor.rb
+- lib/rails_grpc/logger.rb
+- lib/rails_grpc/rack_reloader.rb
 - lib/rails_grpc/railtie.rb
 - lib/rails_grpc/reloader.rb
 - lib/rails_grpc/version.rb
@@ -139,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: gRPC for Ruby on Rails