nats-streaming 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b4619f24307110860a56b03d04b15be8c8f35b3
-  data.tar.gz: 79e03889f056cfbd5fb64491c236ffe66b99f4e9
+  metadata.gz: b75b9c85c86a9586a19f5b9a7b742f69f4b230df
+  data.tar.gz: fac785865b216da75a7e1255e6b20dd33bb1a7da
 SHA512:
-  metadata.gz: 64d4045d951790d2207aa80cc5732b0f08078f7fe244f5ea033663c74a70f901d78e5015758300fa198a7fb35457fb70ad0f5a311ca0be83a6ccaae37ef745f4
-  data.tar.gz: 7cbbcef0b8ab55e53b8ca2124427ff41f77356eb326d775106249ea58c880cea88dd065657df323289abea2e7dbae517cb6383be4a26133a35857355b6cfbafc
+  metadata.gz: 7b1738c21713867a7f3d14405620539fb6e8cdc6306665bd2cdce3a6e6c9e19e46a0c4037c1408e1d09fc63d95914cdea78ec0b727ab18be405ffe7d783424a1
+  data.tar.gz: 33a9106e621be55c92dbaa585f31865755d6414e012fb6341e402d896d2ae66b4e3336418701ab2ef515048463393450868fb72a58986d98f766469782ff8bd5

data/lib/stan/client.rb

@@ -2,6 +2,7 @@ require 'stan/pb/protocol.pb'
 require 'nats/io/client'
 require 'securerandom'
 require 'monitor'
+require 'stan/version'
 
 module STAN
 
@@ -24,12 +25,24 @@ module STAN
   # Errors
   class Error < StandardError; end
 
-  # When we detect we cannot connect to the server
+  # When we get an error from the server during connect request
   class ConnectError < Error; end
 
+  # When we cannot connect due to an invalid connection
+  class BadConnectionError < Error; end
+
   # When we detect we have a request timeout
   class TimeoutError < Error; end
 
+  # When we detect we cannot connect to NATS Streaming
+  class ConnectReqTimeoutError < TimeoutError; end
+
+  # When we timeout making a subscription
+  class SubReqTimeoutError < TimeoutError; end
+
+  # When we timeout closing session with NATS Streaming
+  class CloseReqTimeoutError < TimeoutError; end
+
   class Client
     include MonitorMixin
 
@@ -117,15 +130,15 @@ module STAN
       end
 
       # If no connection to NATS present at this point then bail already
-      raise ConnectError.new("stan: invalid connection to nats") unless @nats
+      raise BadConnectionError.new("stan: invalid connection to nats") unless @nats
 
       # Heartbeat subscription
       @hb_inbox = (STAN.create_inbox).freeze
 
       # Setup acks and heartbeats processing callbacks
-      @hb_inbox_sid    = nats.subscribe(@hb_inbox)    { |raw| process_heartbeats(raw) }
-      @ack_subject_sid = nats.subscribe(@ack_subject) { |raw| process_ack(raw) }
-      nats.flush
+      @hb_inbox_sid    = nats.subscribe(@hb_inbox)    { |raw, reply, subject| process_heartbeats(raw, reply, subject) }
+      @ack_subject_sid = nats.subscribe(@ack_subject) { |raw, reply, subject| process_ack(raw, reply, subject) }
+      nats.flush(options[:connect_timeout])
 
       # Initial connect request to discover subjects to be used
       # for communicating with STAN.
@@ -135,8 +148,24 @@ module STAN
       })
 
       # TODO: Check for error and bail if required
-      raw = nats.request(@discover_subject, req.to_proto, timeout: options[:connect_timeout])
+      begin
+        raw = nats.request(@discover_subject, req.to_proto, timeout: options[:connect_timeout])
+      rescue NATS::IO::Timeout
+        raise ConnectReqTimeoutError.new("stan: failed connecting to '#{@cluster_id}'")
+      end
+
       resp = STAN::Protocol::ConnectResponse.decode(raw.data)
+      unless resp.error.empty?
+        # We didn't really connect but we call closing in order to
+        # cleanup any other present state.
+        # FIXME: Errors happening here should be reported async
+        close rescue nil
+
+        raise ConnectError.new(resp.error)
+      end
+
+      # Capture communication channels to STAN only when there
+      # have not been any errors when connecting.
       @pub_prefix = resp.pubPrefix.freeze
       @sub_req_subject = resp.subRequests.freeze
       @unsub_req_subject = resp.unsubRequests.freeze
@@ -155,6 +184,8 @@ module STAN
 
     # Publish will publish to the cluster and wait for an ack
     def publish(subject, payload, opts={}, &blk)
+      raise BadConnectionError.new unless @pub_prefix
+
       stan_subject = "#{@pub_prefix}.#{subject}"
       future = nil
       guid = STAN.create_guid
@@ -224,6 +255,8 @@ module STAN
 
     # Create subscription which dispatches messages to callback asynchronously
     def subscribe(subject, opts={}, &cb)
+      raise BadConnectionError.new unless @sub_req_subject
+
       sub_options = {}
       sub_options.merge!(opts)
       sub_options[:ack_wait] ||= DEFAULT_ACK_WAIT
@@ -239,9 +272,10 @@ module STAN
         # Listen for actual messages
         sid = nats.subscribe(sub.inbox) { |raw, reply, subject| process_msg(raw, reply, subject) }
         sub.sid = sid
-        nats.flush
+        nats.flush(options[:connect_timeout])
 
         # Create the subscription request announcing the inbox on which
+
         # we have made the NATS subscription for processing messages.
         # First, we normalize customized subscription options before
         # encoding to protobuf.
@@ -265,7 +299,7 @@ module STAN
         end
 
         unless response.error.empty?
-          # FIXME: Error handling on unsubscribe
+          # FIXME: Error handling on unsubscribe should be async
           nats.unsubscribe(sub.sid)
           raise Error.new(response.error)
         end
@@ -275,23 +309,31 @@ module STAN
 
         return sub
       end
+    rescue NATS::IO::Timeout
+      raise SubReqTimeoutError.new("stan: subscribe request timeout on '#{subject}'")
     end
 
     # Close wraps us the session with the NATS Streaming server
     def close
-      req = STAN::Protocol::CloseRequest.new(clientID: @client_id)
-      raw = nats.request(@close_req_subject, req.to_proto)
-
-      resp = STAN::Protocol::CloseResponse.decode(raw.data)
-      unless resp.error.empty?
-        raise Error.new(resp.error)
+      # Send close when going away only if we have been able to successfully connect
+      if @close_req_subject
+        req = STAN::Protocol::CloseRequest.new(clientID: @client_id)
+        raw = nats.request(@close_req_subject, req.to_proto, timeout: options[:connect_timeout])
+
+        resp = STAN::Protocol::CloseResponse.decode(raw.data)
+        unless resp.error.empty?
+          raise Error.new(resp.error)
+        end
       end
 
+      # If we do not even have a connection then return already...
+      return unless @nats
+
       # TODO: If connection to nats was borrowed then we should
       # unsubscribe from all topics from STAN.  If not borrowed
       # and we own the connection, then we just close.
       begin
-        # Remove all present subscriptions
+        # Remove all related subscriptions for STAN
         @sub_map.each_pair do |_, sub|
           nats.unsubscribe(sub.sid)
         end
@@ -299,8 +341,9 @@ module STAN
         # Finally, remove the core subscriptions for STAN
         nats.unsubscribe(@hb_inbox_sid)
         nats.unsubscribe(@ack_subject_sid)
-      rescue => e
-        # TODO: Async error handling
+        nats.flush(options[:connect_timeout])
+      rescue NATS::IO::Timeout
+        raise CloseReqTimeoutError.new("stan: close request timeout")
       ensure
         if @borrowed_nats_connection
           @nats = nil
@@ -322,10 +365,14 @@ module STAN
       end
     end
 
+    def to_s
+      %Q(#<STAN::Client @cluster_id="#{@cluster_id}" @client_id="#{@client_id}">)
+    end
+
     private
 
     # Process received publishes acks
-    def process_ack(data)
+    def process_ack(data, reply, subject)
       # FIXME: This should handle errors asynchronously in case there are any
 
       # Process ack
@@ -392,6 +439,7 @@ module STAN
       sub_opts[:qGroup] = opts[:queue] if opts[:queue]
       sub_opts[:durableName] = opts[:durable_name] if opts[:durable_name]
 
+      # Must announce the clientID as part of the protocol in each subscription
       sub_opts[:clientID] = @client_id
       sub_opts[:maxInFlight] = opts[:max_inflight]
       sub_opts[:ackWaitInSecs] = opts[:ack_wait] || opts[:ack_timeout]
@@ -440,6 +488,10 @@ module STAN
       @durable_name = opts[:durable_name]
     end
 
+    def to_s
+      %Q(#<STAN::Subscription @subject="#{@subject}" @queue="#{@queue}" @durable_name="#{@durable_name}" @inbox="#{@inbox}" @ack_inbox="#{@ack_inbox}" @sid=#{@sid}>)
+    end
+
     # Unsubscribe removes interest in the subscription.
     # For durables, it means that the durable interest is also removed from
     # the server. Restarting a durable with the same name will not resume
@@ -508,15 +560,25 @@ module STAN
   end
 
   # Data holder for sent messages
-  # It should have an Ack method as well to reply back?
-  Msg = Struct.new(:proto, :sub) do
+  # FIXME: It should have an Ack method as well to reply back?
+  ::STAN::Msg = Struct.new(:proto, :sub) do
     def data
       self.proto.data
     end
     def sequence
       self.proto.sequence
     end
+    def timestamp
+      self.proto.timestamp
+    end
+    def time
+      self.proto.timestamp / 1_000_000_000.0
+    end
     alias seq sequence
+
+    def to_s
+      "#<STAN::Msg sequence=#{self.sequence} time=#{self.time.to_f} data=#{self.data}>"
+    end
   end
 
   class << self

data/lib/stan/version.rb

@@ -1,3 +1,3 @@
 module STAN
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: nats-streaming
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Waldemar Quevedo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nats-pure
   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: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Ruby client for the NATS Streaming messaging system.
 email:
 - wally@apcera.com
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby client for the NATS Streaming messaging system.