protobuf-nats 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c764e903778eb435b52043d155b769771bdda9ef
-  data.tar.gz: 26791ed1c774ce5be5adf22cfe14fd52fd01dce6
+  metadata.gz: 28a6d2646c7aa30566ecf3042f164df413453b6f
+  data.tar.gz: e0f1fc04823c3da16ec32eb8c17f49ae5d8a73c5
 SHA512:
-  metadata.gz: 760f358b74a5533d7b3fc9ed9f71fc235cee53a7b058c48e5ff880d33a944cfa5e96fba9169c3aae53b71ce25506bed88f96ca1e11b78ac3c68da39ba87a58a4
-  data.tar.gz: 472b03996ed36835f54db33c5ee7d71119682a5d0fb436370c99a47ab60869ce14f225df4bfccb3c3144b863f174929a59f5e2ebbd60302e0084941eabf64f66
+  metadata.gz: 9fefcb0855bd3467316bcfff911585f09b57a93d93bd6eeca5fff07f15a64da5bf80939553a5650b33f2f2edf5654406c6790b251aa789ccef1a23f3b8d63571
+  data.tar.gz: c4bb2859a7082516118805e5232b89218c668a813b03b7d936b972fc91cd948eb67dee10d77759904f934a91325030b5f7979eb9e1453df83d2b4913d3a01cc4

data/README.md

@@ -21,6 +21,22 @@ Or install it yourself as:
 
 ## Configuring
 
+### Environment Variables
+
+You can also use the following environment variables to tune parameters:
+
+`PB_NATS_SERVER_MAX_QUEUE_SIZE` - The size of the queue in front of your thread pool (default: thread count passed to CLI)
+
+`PB_NATS_CLIENT_ACK_TIMEOUT` - Seconds to wait for an ACK from the rpc server (default: 5 seconds)
+
+`PB_NATS_CLIENT_RESPONSE_TIMEOUT` - Seconds to wait for a non-ACK response from the rpc server (default: 60 seconds)
+
+`PB_NATS_CLIENT_RECONNECT_DELAY` - If we detect a reconnect delay, we will wait this many seconds (default: the ACK timeout)
+
+`PROTOBUF_NATS_CONFIG_PATH` - Custom path to the config yaml (default: "config/protobuf_nats.yml")
+
+### YAML Config
+
 The client and server are configured via environment variables defined in the `pure-ruby-nats` gem. However, there are a
 few params which cannot be set: `servers`, `uses_tls` and `connect_timeout`, so those my be defined in a yml file.
 
@@ -36,9 +52,11 @@ An example config looks like this:
       - "nats://127.0.0.1:4222"
       - "nats://127.0.0.1:4223"
       - "nats://127.0.0.1:4224"
+    max_reconnect_attempts: 500
     uses_tls: true
     tls_client_cert: "/path/to/client-cert.pem"
     tls_client_key: "/path/to/client-key.pem"
+    tls_ca_cert: "/path/to/ca.pem"
     connect_timeout: 2
 ```
 

data/lib/protobuf/nats/client.rb

@@ -40,15 +40,48 @@ module Protobuf
         end
       end
 
+      def ack_timeout
+        @ack_timeout ||= if ::ENV.key?("PB_NATS_CLIENT_ACK_TIMEOUT")
+          ::ENV["PB_NATS_CLIENT_ACK_TIMEOUT"].to_i
+        else
+          5
+        end
+      end
+
+      def reconnect_delay
+        @reconnect_delay ||= if ::ENV.key?("PB_NATS_CLIENT_RECONNECT_DELAY")
+          ::ENV["PB_NATS_CLIENT_RECONNECT_DELAY"].to_i
+        else
+          ack_timeout
+        end
+      end
+
+      def response_timeout
+        @response_timeout ||= if ::ENV.key?("PB_NATS_CLIENT_RESPONSE_TIMEOUT")
+          ::ENV["PB_NATS_CLIENT_RESPONSE_TIMEOUT"].to_i
+        else
+          60
+        end
+      end
+
       def send_request
         failure_handler do
           begin
             retries ||= 3
 
             setup_connection
-            request_options = {:timeout => 60, :ack_timeout => 5}
+            request_options = {:timeout => response_timeout, :ack_timeout => ack_timeout}
             @response_data = nats_request_with_two_responses(cached_subscription_key, @request_data, request_options)
             parse_response
+          rescue ::Protobuf::Nats::Errors::IOException => error
+            ::Protobuf::Nats.log_error(error)
+
+            delay = reconnect_delay
+            logger.warn "An IOException was raised. We are going to sleep for #{delay} seconds."
+            sleep delay
+
+            retry if (retries -= 1) > 0
+            raise
           rescue ::NATS::IO::Timeout
             # Nats response timeout.
             retry if (retries -= 1) > 0
@@ -112,8 +145,6 @@ module Protobuf
           response
         ensure
           # Ensure we don't leave a subscriptiosn sitting around.
-          # This also cleans up memory. It's a no-op if the subscription
-          # is already cleaned up.
           nats.unsubscribe(sub)
         end
 

data/lib/protobuf/nats/config.rb

@@ -4,12 +4,13 @@ require "yaml"
 module Protobuf
   module Nats
     class Config
-      attr_accessor :uses_tls, :servers, :connect_timeout, :tls_client_cert, :tls_client_key, :tls_ca_cert
+      attr_accessor :uses_tls, :servers, :connect_timeout, :tls_client_cert, :tls_client_key, :tls_ca_cert, :max_reconnect_attempts
 
       CONFIG_MUTEX = ::Mutex.new
 
       DEFAULTS = {
         :connect_timeout => nil,
+        :max_reconnect_attempts => 60_000,
         :servers => nil,
         :tls_client_cert => nil,
         :tls_client_key => nil,
@@ -54,6 +55,7 @@ module Protobuf
         @connection_options ||= begin
           options = {
             servers: servers,
+            max_reconnect_attempts: max_reconnect_attempts,
             uses_tls: uses_tls,
             tls_client_cert: tls_client_cert,
             tls_client_key: tls_client_key,

data/lib/protobuf/nats/errors.rb

@@ -0,0 +1,14 @@
+module Protobuf
+  module Nats
+    module Errors
+      class MriIOException < ::StandardError
+      end
+
+      IOException = if defined? JRUBY_VERSION
+                      java.io.IOException
+                    else
+                      MriIOException
+                    end
+    end
+  end
+end

data/lib/protobuf/nats/jnats.rb

@@ -39,8 +39,12 @@ module Protobuf
         servers = [servers].flatten.map { |uri_string| java.net.URI.new(uri_string) }
         connection_factory = ::Java::IoNatsClient::ConnectionFactory.new
         connection_factory.setServers(servers)
-        # Basically never stop trying to connect
-        connection_factory.setMaxReconnect(60_000)
+        connection_factory.setMaxReconnect(options[:max_reconnect_attempts])
+
+        # Shrink the pending buffer to always raise an error and let the caller retry.
+        if options[:disable_reconnect_buffer]
+          connection_factory.setReconnectBufSize(1)
+        end
 
         # Setup callbacks
         connection_factory.setDisconnectedCallback { |event| @on_disconnect_cb.call }

data/lib/protobuf/nats/server.rb

@@ -16,14 +16,22 @@ module Protobuf
         @running = true
         @stopped = false
 
-        @nats = options[:client] || ::Protobuf::Nats::NatsClient.new
+        @nats = @options[:client] || ::Protobuf::Nats::NatsClient.new
         @nats.connect(::Protobuf::Nats.config.connection_options)
 
-        @thread_pool = ::Protobuf::Nats::ThreadPool.new(options[:threads], :max_queue => options[:threads])
+        @thread_pool = ::Protobuf::Nats::ThreadPool.new(@options[:threads], :max_queue => max_queue_size)
 
         @subscriptions = []
       end
 
+      def max_queue_size
+        if ::ENV.key?("PB_NATS_SERVER_MAX_QUEUE_SIZE")
+          ::ENV["PB_NATS_SERVER_MAX_QUEUE_SIZE"].to_i
+        else
+          @options[:threads]
+        end
+      end
+
       def service_klasses
         ::Protobuf::Rpc::Service.implemented_services.map(&:safe_constantize)
       end
@@ -68,11 +76,11 @@ module Protobuf
 
       def run
         nats.on_reconnect do
-          logger.warn "Reconnected to NATS server!"
+          logger.warn "Server NATS connection was reconnected"
         end
 
         nats.on_disconnect do
-          logger.warn "Disconnected from NATS server!"
+          logger.warn "Server NATS connection was disconnected"
         end
 
         nats.on_error do |error|
@@ -80,7 +88,7 @@ module Protobuf
         end
 
         nats.on_close do
-          logger.warn "NATS connection was closed!"
+          logger.warn "Server NATS connection was closed"
         end
 
         subscribe_to_services

data/lib/protobuf/nats/version.rb

@@ -1,5 +1,5 @@
 module Protobuf
   module Nats
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/lib/protobuf/nats.rb

@@ -6,6 +6,7 @@ require "protobuf/rpc/service_directory"
 
 require "nats/io/client"
 
+require "protobuf/nats/errors"
 require "protobuf/nats/client"
 require "protobuf/nats/server"
 require "protobuf/nats/runner"
@@ -53,12 +54,32 @@ module Protobuf
           break true if @client_nats_connection
           break true if @start_client_nats_connection
 
-          @client_nats_connection = NatsClient.new
-          @client_nats_connection.connect(config.connection_options)
+          # Disable publisher pending buffer on reconnect
+          options = config.connection_options.merge(:disable_reconnect_buffer => true)
+
+          begin
+            @client_nats_connection = NatsClient.new
+            @client_nats_connection.connect(options)
+          rescue ::Protobuf::Nats::Errors::IOException
+            @client_nats_connection = nil
+            raise
+          end
 
           # Ensure we have a valid connection to the NATS server.
           @client_nats_connection.flush(5)
 
+          @client_nats_connection.on_disconnect do
+            logger.warn("Client NATS connection was disconnected")
+          end
+
+          @client_nats_connection.on_reconnect do
+            logger.warn("Client NATS connection was reconnected")
+          end
+
+          @client_nats_connection.on_close do
+            logger.warn("Client NATS connection was closed")
+          end
+
           @client_nats_connection.on_error do |error|
             log_error(error)
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protobuf-nats
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Brandon Dewitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
@@ -137,6 +137,7 @@ files:
 - lib/protobuf/nats.rb
 - lib/protobuf/nats/client.rb
 - lib/protobuf/nats/config.rb
+- lib/protobuf/nats/errors.rb
 - lib/protobuf/nats/jnats.rb
 - lib/protobuf/nats/runner.rb
 - lib/protobuf/nats/server.rb