gruf 2.12.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fbcc0f1b3083a00fa413c9d16bdb126e04a37f5a1cdee3ae05573698e4deb67
-  data.tar.gz: 5327ddd7497e82d991eba1a7ce37e35c62e9810ae5803227563fa4e6ebee31b4
+  metadata.gz: aebffd1712a25d5025e60e61797fd6089417db3d79c5be2de9374b3eeda71571
+  data.tar.gz: 82324e0b421ac2d82d2133dcf482746e6c6faaa31f7cbf50de3adaf31ae857ac
 SHA512:
-  metadata.gz: 6ab52c50feb431404c3cbde8b67de6f456b8310ce21a857d9ffcc4b820055773c908d3329a0b965c5b3459583658103f5be7bf3debc5acea541d84b516937c2c
-  data.tar.gz: 898363f243233aace1aeffd4163b996bd280462a2c444db4c75ad472010ac7bc99f50d5945a2126380a6676a80daeb72b401b94c97010d6920dc796c4b661b2b
+  metadata.gz: eae3c9439c9b8e9c6b7d26a30c7485aac0c3919bb174a9b2a8b23b7f863f5f2ddacbb52c87489724ac9e4345214ec585f257f852e94d8af27486ec12bb971aaf
+  data.tar.gz: 0fb952bb1e354fc5f756e1263b5a1929e68647df757d5da97d0689aa4f09185abd2cd4f91d023faf56fa75fc9b828098c670cf17a5bd171b2511ae0ae5d4096b

data/CHANGELOG.md

@@ -2,6 +2,21 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.14.0
+
+- Set default client host to 0.0.0.0:9001 (same as default server host)
+- Add support for Ruby 3.1
+
+### 2.13.1
+
+- Fix issue with race condition in server starts where servers may fail to bind connections and never reach  
+  serving state (fixes #147)
+ 
+### 2.13.0
+
+- Remove server mutex handling in deference to core grpc signal handling
+- Relax grpc pin as upstream regression is fixed
+
 ### 2.12.0
 
 - Fixed interceptor order to be FIFO as documented, instead of FILO (fixes #139)

data/README.md

@@ -1,6 +1,6 @@
 # gruf - gRPC Ruby Framework
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=main)](https://inch-ci.org/github/bigcommerce/gruf?branch=main)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf.svg)](https://badge.fury.io/rb/gruf) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf.svg?branch=main)](https://inch-ci.org/github/bigcommerce/gruf?branch=main) [![Maintainability](https://api.codeclimate.com/v1/badges/4a8e9269f99100aeb7cb/maintainability)](https://codeclimate.com/github/bigcommerce/gruf/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/4a8e9269f99100aeb7cb/test_coverage)](https://codeclimate.com/github/bigcommerce/gruf/test_coverage)
 
 gruf is a Ruby framework that wraps the [gRPC Ruby library](https://github.com/grpc/grpc/tree/master/src/ruby) to
 provide a more streamlined integration into Ruby and Ruby on Rails applications.
@@ -17,7 +17,7 @@ up fast and efficiently at scale. Some of its features include:
   still preserving gRPC BadStatus codes
 * Server and client execution timings in responses
 
-gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.2-3.0.
+gruf currently has active support for gRPC 1.10.x+. gruf is compatible and tested with Ruby 2.6-3.1.
 gruf is also not [Rails](https://github.com/rails/rails)-specific, and can be used in any Ruby framework
 (such as [Grape](https://github.com/ruby-grape/grape) or [dry-rb](https://dry-rb.org/), for instance).
 

data/gruf.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables << 'gruf'
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6', '< 3.1'
+  spec.required_ruby_version = '>= 2.6', '< 3.2'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 
@@ -59,8 +59,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '> 4'
   spec.add_runtime_dependency 'concurrent-ruby', '> 1'
   spec.add_runtime_dependency 'e2mmap', '>= 0.1'
-  spec.add_runtime_dependency 'grpc', '~> 1.10', '<= 1.41.0'
-  spec.add_runtime_dependency 'grpc-tools', '~> 1.10', '<= 1.41.0'
+  spec.add_runtime_dependency 'grpc', '~> 1.10'
+  spec.add_runtime_dependency 'grpc-tools', '~> 1.10'
   spec.add_runtime_dependency 'json', '>= 2.3'
   spec.add_runtime_dependency 'slop', '>= 4.6'
   spec.add_runtime_dependency 'thwait', '>= 0.1'

data/lib/gruf/configuration.rb

@@ -84,7 +84,7 @@ module Gruf
       interceptors: nil,
       hooks: nil,
       default_channel_credentials: nil,
-      default_client_host: '',
+      default_client_host: '0.0.0.0:9001',
       use_ssl: false,
       ssl_crt_file: '',
       ssl_key_file: '',

data/lib/gruf/server.rb

@@ -23,6 +23,8 @@ module Gruf
   class Server
     class ServerAlreadyStartedError < StandardError; end
 
+    KILL_SIGNALS = %w[INT TERM QUIT].freeze
+
     include Gruf::Loggable
 
     # @!attribute [r] port
@@ -43,10 +45,6 @@ module Gruf
       @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry)
       @services = []
       @started = false
-      @stop_server = false
-      @stop_server_cv = ConditionVariable.new
-      @stop_server_mu = Monitor.new
-      @server_mu = Monitor.new
       @hostname = opts.fetch(:hostname, Gruf.server_binding_url)
       @event_listener_proc = opts.fetch(:event_listener_proc, Gruf.event_listener_proc)
       setup
@@ -56,30 +54,28 @@ module Gruf
     # @return [GRPC::RpcServer] The GRPC server running
     #
     def server
-      @server_mu.synchronize do
-        @server ||= begin
-          # For backward compatibility, we allow these options to be passed directly
-          # in the Gruf::Server options, or via Gruf.rpc_server_options.
-          server_options = {
-            pool_size: options.fetch(:pool_size, Gruf.rpc_server_options[:pool_size]),
-            max_waiting_requests: options.fetch(:max_waiting_requests, Gruf.rpc_server_options[:max_waiting_requests]),
-            poll_period: options.fetch(:poll_period, Gruf.rpc_server_options[:poll_period]),
-            pool_keep_alive: options.fetch(:pool_keep_alive, Gruf.rpc_server_options[:pool_keep_alive]),
-            connect_md_proc: options.fetch(:connect_md_proc, Gruf.rpc_server_options[:connect_md_proc]),
-            server_args: options.fetch(:server_args, Gruf.rpc_server_options[:server_args])
-          }
-
-          server = if @event_listener_proc
-                     server_options[:event_listener_proc] = @event_listener_proc
-                     Gruf::InstrumentableGrpcServer.new(**server_options)
-                   else
-                     GRPC::RpcServer.new(**server_options)
-                   end
-
-          @port = server.add_http2_port(@hostname, ssl_credentials)
-          @services.each { |s| server.handle(s) }
-          server
-        end
+      @server ||= begin
+        # For backward compatibility, we allow these options to be passed directly
+        # in the Gruf::Server options, or via Gruf.rpc_server_options.
+        server_options = {
+          pool_size: options.fetch(:pool_size, Gruf.rpc_server_options[:pool_size]),
+          max_waiting_requests: options.fetch(:max_waiting_requests, Gruf.rpc_server_options[:max_waiting_requests]),
+          poll_period: options.fetch(:poll_period, Gruf.rpc_server_options[:poll_period]),
+          pool_keep_alive: options.fetch(:pool_keep_alive, Gruf.rpc_server_options[:pool_keep_alive]),
+          connect_md_proc: options.fetch(:connect_md_proc, Gruf.rpc_server_options[:connect_md_proc]),
+          server_args: options.fetch(:server_args, Gruf.rpc_server_options[:server_args])
+        }
+
+        server = if @event_listener_proc
+                   server_options[:event_listener_proc] = @event_listener_proc
+                   Gruf::InstrumentableGrpcServer.new(**server_options)
+                 else
+                   GRPC::RpcServer.new(**server_options)
+                 end
+
+        @port = server.add_http2_port(@hostname, ssl_credentials)
+        @services.each { |s| server.handle(s) }
+        server
       end
     end
 
@@ -92,23 +88,10 @@ module Gruf
 
       server_thread = Thread.new do
         logger.info { "Starting gruf server at #{@hostname}..." }
-        server.run
-      end
-
-      stop_server_thread = Thread.new do
-        loop do
-          break if @stop_server
-
-          @stop_server_mu.synchronize { @stop_server_cv.wait(@stop_server_mu, 10) }
-        end
-        logger.info { 'Shutting down...' }
-        server.stop
+        server.run_till_terminated_or_interrupted(KILL_SIGNALS)
       end
-
-      server.wait_till_running
       @started = true
       update_proc_title(:serving)
-      stop_server_thread.join
       server_thread.join
       @started = false
 
@@ -204,28 +187,10 @@ module Gruf
     #
     # :nocov:
     def setup
-      setup_signal_handlers
       load_controllers
     end
     # :nocov:
 
-    ##
-    # Register signal handlers
-    #
-    # :nocov:
-    def setup_signal_handlers
-      Signal.trap('INT') do
-        @stop_server = true
-        @stop_server_cv.broadcast
-      end
-
-      Signal.trap('TERM') do
-        @stop_server = true
-        @stop_server_cv.broadcast
-      end
-    end
-    # :nocov:
-
     ##
     # Auto-load all gRPC handlers
     #

data/lib/gruf/version.rb

@@ -16,5 +16,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '2.12.0'
+  VERSION = '2.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -241,9 +241,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.41.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -251,9 +248,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.41.0
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
@@ -261,9 +255,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.41.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -271,9 +262,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.41.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -387,14 +375,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: gRPC Ruby Framework