zss 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6209d59b210fc8bd7e64ed36f5fca6642c40f61
-  data.tar.gz: cf82318a2842a97b3d8ac7199e665b29820a6eaa
+  metadata.gz: 9929b5eec2008f17870d5526121bb9b7d8dfacac
+  data.tar.gz: e47be6ad965a97fa60328e19391f6291eb8e864c
 SHA512:
-  metadata.gz: eee1a5348aae779968829771172d51b8c085e328816f8317b253984b5c565227522d4c05c39aa3d60e56c4533efdad04661a9b3ef81bdfb3130cc674dfc05193
-  data.tar.gz: 3939c3e70096ce5f5ecfe47a72b986c21a8202d970ceb189b97cfda6a68c35c01cb35044b259fae882b1c9520778320c8a63fab560bf931ba3c435b014ea7f64
+  metadata.gz: 77bceb3312a63f02956010f946a4925d49361e099f2d41654f55f143f42df1d7f37ae897ea2aa4f133eba6beb4165421d43d50542a1883f7da5d0ebf16344bb9
+  data.tar.gz: 898068c75ef33bfae1551acfb874b4aad33775f7860996d195adf8768d4ce48b022066f5cf0c1b60ff2b6ee49f6d09f1d91d3c3b9364626376188e49ff87df72

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    zss (0.2.5)
-      activesupport (~> 4.1)
+    zss (0.3.0)
+      activesupport (= 4.1)
       daemons (~> 1.1)
       em-zeromq (~> 0.5)
       ffi-rzmq (~> 2.0)
       hashie (~> 3.2)
-      logger_facade (~> 0.1)
+      logger_facade (~> 0.3.2)
       msgpack (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.6)
+    activesupport (4.1.0)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -23,10 +23,10 @@ GEM
       builder
       multi_json
     builder (3.2.2)
-    bump (0.5.0)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    codeclimate-test-reporter (0.3.0)
+    bump (0.5.1)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    codeclimate-test-reporter (0.4.5)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     daemons (1.1.9)
@@ -36,52 +36,56 @@ GEM
       eventmachine (>= 1.0.0)
       ffi (>= 1.0.0)
       ffi-rzmq (~> 2.0.1)
-    eventmachine (1.0.3)
-    ffi (1.9.3)
+    eventmachine (1.0.4)
+    ffi (1.9.6)
     ffi-rzmq (2.0.1)
       ffi-rzmq-core (>= 1.0.1)
     ffi-rzmq-core (1.0.3)
       ffi (~> 1.9)
-    hashie (3.3.1)
-    i18n (0.6.11)
-    json (1.8.1)
-    logger_facade (0.2.0)
+    hashie (3.3.2)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    logger_facade (0.3.2)
       airbrake (~> 4.0)
       hashie (~> 3.2)
       sucker_punch (~> 1.1)
+      yajl-ruby (~> 1.2)
     method_source (0.8.2)
-    minitest (5.4.2)
-    msgpack (0.5.8)
+    minitest (5.5.1)
+    msgpack (0.5.10)
     multi_json (1.10.1)
-    pry (0.10.0)
+    pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.3)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.3)
-    simplecov (0.9.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    simplecov (0.9.1)
       docile (~> 1.1.0)
-      multi_json
+      multi_json (~> 1.0)
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.6.0)
-    sucker_punch (1.2.1)
-      celluloid (~> 0.15.2)
+    sucker_punch (1.3.2)
+      celluloid (~> 0.16.0)
     thread_safe (0.3.4)
-    timers (1.1.0)
+    timers (4.0.1)
+      hitimes
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    yajl-ruby (1.2.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -272,15 +272,15 @@ We use [bump gem](https://github.com/gregorym/bump) to control gem versioning.
 
 Bump Patch version
 
-    $ bump patch
+    $ bump patch --tag
 
 Bump Minor version
 
-    $ bump minor
+    $ bump minor --tag
 
 Bump Major version
 
-    $ bump major
+    $ bump major --tag
 
 ## Running Specs
 

data/lib/zss/client.rb

@@ -13,6 +13,11 @@ module ZSS
       @sid      = sid.to_s.upcase
       @identity = config[:identity] || "client"
       @timeout  = config[:timeout] || 1000
+      @config = Hashie::Mash.new(
+        socket_address: frontend,
+        identity: identity,
+        timeout: timeout
+      )
     end
 
     def call verb, payload, headers: {}, timeout: nil
@@ -24,11 +29,14 @@ module ZSS
         headers: headers,
         payload: payload)
 
-      log.info("Request #{request.rid} sent to #{request.address} with #{timeout}s timeout")
+      timeout ||= config.timeout
+      metadata = metadata(timeout, request)
+      log.info("Request #{request.rid} sent to #{request.address} with #{timeout/1000.0}s timeout", metadata)
 
       response = socket.call(request, timeout)
+      metadata = metadata(timeout, response)
 
-      log.info("Received response to #{request.rid} with status #{response.status}")
+      log.info("Received response to #{request.rid} with status #{response.status}", metadata)
 
       fail ZSS::Error.new(response.status, payload: response.payload) if response.is_error?
 
@@ -37,6 +45,8 @@ module ZSS
 
     private
 
+    attr_reader :config
+
     def method_missing method, *args
       # since we cannot use / on method names we replace _ with /
       verb = method.to_s.gsub('_', '/')
@@ -46,14 +56,18 @@ module ZSS
     end
 
     def socket
-      config = Hashie::Mash.new(
-        socket_address: frontend,
-        identity: identity,
-        timeout: timeout
-      )
-
       Socket.new config
     end
 
+    def metadata(timeout, message)
+      metadata = {
+        identity: identity,
+        timeout: timeout,
+        pid: Process.pid,
+        request: message.to_log
+      }
+      metadata
+    end
+
   end
 end

data/lib/zss/message.rb

@@ -7,16 +7,20 @@ require_relative 'message/message_address'
 module ZSS
   class Message
 
+    CLIENT_ID_REGEX = /^(.+?)#/
+
     PROTOCOL_VERSION = "ZSS:0.0"
 
-    attr_accessor :identity,
+    attr_accessor :client,
+                  :identity,
                   :protocol,
                   :type,
                   :rid,
                   :address,
                   :headers,
                   :status,
-                  :payload
+                  :payload,
+                  :payload_size
 
     def initialize(args = {})
 
@@ -28,7 +32,17 @@ module ZSS
       @headers      = args[:headers] || {}
       @status       = args[:status]
       @payload      = args[:payload]
+      @client       = nil
+      @payload_size  = args[:payload_size]
+
+      match = identity.try(:match, CLIENT_ID_REGEX)
+      @client = match.captures.first if match
+    end
 
+    def payload=(payload)
+      @payload = payload
+      @payload_msgpack_data = nil
+      @payload_size = payload_msgpack.length
     end
 
     def req?
@@ -39,6 +53,11 @@ module ZSS
 
       frames.unshift(nil) if frames.length == 7
 
+      payload_data = frames[7]
+      payload_size = payload_data.length
+      payload = MessagePack.unpack(payload_data)
+      payload = Hashie::Mash.new(payload) if payload.kind_of? Hash
+
       msg = Message.new(
         identity: frames.shift,
         protocol: frames.shift,
@@ -49,13 +68,10 @@ module ZSS
         ),
         headers:  Hashie::Mash.new(MessagePack.unpack(frames.shift)),
         status:   frames.shift.to_i,
-        payload:  MessagePack.unpack(frames.shift),
+        payload:  payload,
+        payload_size: payload_size
       )
 
-      if msg.payload.kind_of? Hash
-        msg.payload = Hashie::Mash.new(msg.payload)
-      end
-
       msg
     end
 
@@ -91,13 +107,38 @@ module ZSS
         address.instance_values.to_msgpack,
         headers.to_h.to_msgpack,
         status.to_s,
-        payload.to_msgpack
+        payload_msgpack
       ]
     end
 
+    def to_log
+      {
+        client: client,
+        identity: identity,
+        protocol: protocol,
+        type: type,
+        rid: rid,
+        address: address,
+        headers: headers,
+        status: status,
+        payload: big? ? "<<Message to big to log>>" : payload,
+        "payload-size" => payload_size
+      }
+    end
+
     def is_error?
       status != 200
     end
 
+    def big?
+      payload_size = payload_msgpack.length unless payload_size
+      payload_size > 1024
+    end
+
+    def payload_msgpack
+      # this will avoid executing multiple serializations
+      @payload_msgpack_data ||= payload.to_msgpack
+    end
+
   end
 end

data/lib/zss/service.rb

@@ -28,19 +28,7 @@ module ZSS
       fail RuntimeError, 'failed to create create_context' unless context
 
       log.info("Starting SID: '#{sid}' ID: '#{identity}' Env: '#{ZSS::Environment.env}' Broker: '#{backend}'")
-
-      EM.run do
-        # handle interrupts
-        Signal.trap("INT") { stop }
-        Signal.trap("TERM") { stop }
-
-        connect_socket context
-
-        start_heartbeat_worker
-
-        # send up message
-        send Message::SMI.up(sid)
-      end
+      event_machine_start(context)
     end
 
     def add_route(context, route, handler = nil)
@@ -52,7 +40,7 @@ module ZSS
 
       EM.add_timer do
 
-        log.info("Stoping SID: '#{sid}' ID: '#{socket.identity}'")
+        log.info("Stoping SID: '#{sid}' ID: '#{identity}'", metadata)
 
         send Message::SMI.down(sid)
         socket.disconnect backend
@@ -64,6 +52,24 @@ module ZSS
 
     attr_accessor :socket, :router, :timer
 
+    def event_machine_start(context)
+      EM.run do
+        handle_interrupts
+
+        connect_socket context
+
+        start_heartbeat_worker
+
+        # send up message
+        send Message::SMI.up(sid)
+      end
+    end
+
+    def handle_interrupts
+      Signal.trap("INT") { stop }
+      Signal.trap("TERM") { stop }
+    end
+
     def connect_socket(context)
 
       @socket = context.socket ZMQ::DEALER
@@ -97,29 +103,31 @@ module ZSS
       if message.req?
         handle_request(message)
       else
-        log.trace("SMI response received: \n #{message}") if log.is_debug
+        context = request_metadata(message)
+        log.trace("SMI response received: \n #{message}", context) if log.is_debug
       end
     rescue ZSS::Error => error
-      log.error("ZSS::Error raised while processing request: #{error}")
+      log.error("ZSS::Error raised while processing request: #{error}", metadata({ error: error }))
       reply_error error, message
     rescue => e
-      log.error("Unexpected error occurred while processing request: #{e}")
+      log.error("Unexpected error occurred while processing request: #{e}", metadata({ exception: e }))
       reply_error Error[500], message
     end
 
     def handle_request(message)
-      log.info("Handle request for #{message.address}")
-      log.debug("Request message:\n #{message}") if log.is_debug
+      start_time = Time.now.utc
 
-      if message.address.sid != sid
-        error = Error[404]
-        error.developer_message = "Invalid SID: #{message.address.sid}!"
-        fail error
-      end
+      log.info("Handle request for #{message.address}", request_metadata(message))
+      log.trace("Request message:\n #{message}") if log.is_debug
+
+      check_sid!(message.address.sid)
 
       # the router returns an handler that receives payload and headers
       handler = router.get(message.address.verb)
+
       message.payload = handler.call(message.payload, message.headers)
+      message.headers["zss-response-time"] = get_time(start_time)
+
       reply message
     end
 
@@ -131,6 +139,9 @@ module ZSS
         developerMessage: error.developer_message
       }
       message.type = Message::Type::REP
+
+      log.info("Reply with status: #{message.status}", request_metadata(message))
+
       send message
     end
 
@@ -138,8 +149,8 @@ module ZSS
       message.status = 200
       message.type = Message::Type::REP
 
-      log.info("Reply with status: #{message.status}")
-      log.debug("Reply with message:\n #{message}") if log.is_debug
+      log.info("Reply with status: #{message.status}", request_metadata(message))
+      log.trace("Reply with message:\n #{message}") if log.is_debug
 
       send message
     end
@@ -151,8 +162,36 @@ module ZSS
       #remove identity frame on request
       frames.shift if msg.req?
       success = socket.send_msg(*frames)
-      log.error("An Error ocurred while sending message") unless success
+
+      log.error("An Error ocurred while sending message", request_metadata(message)) unless success
     end
 
+    def check_sid!(message_sid)
+      return unless message_sid != sid
+
+      error = Error[404]
+      error.developer_message = "Invalid SID: #{message_sid}!"
+      fail error
+    end
+
+    def metadata(metadata = {})
+      metadata ||= {}
+      metadata[:sid] = sid
+      metadata[:identity] = identity
+      metadata[:pid] = Process.pid
+      metadata
+    end
+
+    def request_metadata(message, metadata = {})
+      metadata = metadata(metadata)
+
+      metadata[:request] = message.to_log
+      metadata
+    end
+
+    def get_time(start_time)
+      # return time in ms
+      ((Time.now.utc - start_time) * 1_000).to_i
+    end
   end
 end

data/lib/zss/socket.rb

@@ -27,16 +27,16 @@ module ZSS
         socket ctx do |sock|
           begin
             ::Timeout.timeout t do
-
-              log.debug("Request #{request.rid} sent to #{request.address} with #{t}s timeout")
+              log.trace("Request #{request.rid} sent to #{request.address} with #{t}s timeout")
+              
               send_message sock, request
 
-              log.debug("Waiting for #{request.rid}")
+              log.trace("Waiting for #{request.rid}")
               response = receive_message(sock)
 
             end
           rescue ::Timeout::Error
-            log.debug("Request #{request.rid} exit with timeout after #{t}s")
+            log.info("Request #{request.rid} exit with timeout after #{t}s")
             raise ZSS::Socket::TimeoutError, "call timeout after #{t}s"
           end
         end
@@ -62,7 +62,7 @@ module ZSS
       socket.setsockopt(ZMQ::LINGER, 0)
       socket.connect(socket_address)
 
-      log.debug("#{socket.identity} connected to #{socket_address}")
+      log.trace("#{socket.identity} connected to #{socket_address}")
 
       yield socket
     ensure
@@ -71,7 +71,7 @@ module ZSS
 
     def send_message socket, message
 
-      log.debug("Sending:\n #{message}") if log.is_debug
+      log.trace("Sending:\n #{message}") if log.is_debug
 
       frames = message.to_frames
 
@@ -86,7 +86,7 @@ module ZSS
       check! socket.recv_strings(frames = [])
       message = Message.parse frames
 
-      log.debug("Receiving: \n #{message}") if log.is_debug
+      log.trace("Receiving: \n #{message}") if log.is_debug
 
       message
     end

data/lib/zss/version.rb

@@ -1,3 +1,3 @@
 module ZSS
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

data/spec/integration/service_spec.rb

@@ -33,7 +33,7 @@ describe ZSS::Service do
       run_broker_for_service(broker_backend, message) do |msg|
         expect(msg.payload).to eq("PONG")
         expect(msg.status).to eq(200)
-        expect(msg.headers).to eq({ "took" => "0s" })
+        expect(msg.headers.took).to eq("0s")
         subject.stop
         EM.stop
       end

data/spec/spec_helper.rb

@@ -18,11 +18,3 @@ require 'zss'
 require 'timeout'
 
 Dir['spec/support/**/*.rb'].each &method(:require)
-
-RSpec.configure do |c|
-  c.around(:each) do |example|
-    Timeout::timeout(2) {
-      example.run
-    }
-  end
-end

data/spec/unit/service_spec.rb

@@ -162,7 +162,7 @@ describe ZSS::Service do
 
             expect(message.type).to eq(ZSS::Message::Type::REP)
             expect(message.status).to eq(200)
-            expect(message.headers).to eq({ "took" => "0s" })
+            expect(message.headers.took).to eq("0s")
 
             done
 
@@ -172,6 +172,28 @@ describe ZSS::Service do
 
       end
 
+      it('returns response time header') do
+        service = DummyService.new
+        subject.add_route(service, :ping)
+
+        EM.run do
+          allow(socket).to receive(:on) do |event, &block|
+            EM.add_timer { block.call *message_parts }
+          end
+
+          subject.run
+
+          expect(socket).to receive(:send_msg) do |*frames|
+            message = ZSS::Message.parse(frames)
+            expect(message.headers["zss-response-time"]).to be
+            done
+
+            true
+          end
+        end
+
+      end
+
       context('on error') do
 
         it('returns 404 on invalid sid') do

data/zss.gemspec

@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'msgpack', '~> 0.5'
   spec.add_dependency 'ffi-rzmq', '~> 2.0'
-  spec.add_dependency 'activesupport', '~> 4.1'
+  spec.add_dependency 'activesupport', '= 4.1'
   spec.add_dependency 'hashie', '~> 3.2'
   spec.add_dependency 'daemons', '~> 1.1'
   spec.add_dependency 'em-zeromq', '~> 0.5'
-  spec.add_dependency 'logger_facade', '~> 0.1'
+  spec.add_dependency 'logger_facade', '~> 0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zss
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Pedro Januário
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,14 +140,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.2
 description: ZeroMQ SOA Suite
 email:
 - prnjanuario@gmail.com