restify 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05b4120c9755cdd5a88f172e3d5964eff3804add46785bd3cbec8b842f2af459
-  data.tar.gz: 5cb09e31e263560b373b156cfaa601925b9bde328ff892d4533c2738b10dff67
+  metadata.gz: 8910f0a86f7bab64dbcfe43794c8fddbe8d37fb289845105718f61de3228f245
+  data.tar.gz: 843c1fd568747ed129589f08a8d7e3e040315f49f49620e46cd40265e1df2411
 SHA512:
-  metadata.gz: a5854443d09b5d6ce73f3a68da7c76e2ed7453288b4e9ef940cfb2e437b8666f0c4f03b6602405193728751b5ee2cf46a12937196d412e3d911d7b497e947daf
-  data.tar.gz: 535598e592a526d20cb8c5d93fe4926deea1d1f92f60bf5fd003115a56841462ad6ce475d96927a09b940524c622e80730ff06c858940c2d08e4ed8396fa8359
+  metadata.gz: 1697fecae910ceaf8c93f40416dcef77a1eba6a5bb0aa9fb67fffa520a7191fb273ac5a5bb9202ee00a7eec6ad559ccebd56f07b1a7c572077f4d44c9f7d3500
+  data.tar.gz: 4ad078a7595c6fdf7fc867eb367f658c7e1cec5297845467547668177834ad5722447520de2d3bcf1c0c1ff0d7924c903b7fe55cbe443bfa33605b5de2a8da0a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.5.0
+
+* Tune typhoeus adapter to be more race-condition resilent
+* Add MessagePack processor enabled by default
+
 ## 1.4.4
 
 * Fix race condition in typhoeus adapter

data/lib/restify/adapter/typhoeus.rb

@@ -2,6 +2,8 @@
 
 require 'typhoeus'
 
+::Ethon.logger = ::Logging.logger[Ethon]
+
 module Restify
   module Adapter
     class Typhoeus < Base
@@ -26,30 +28,26 @@ module Restify
       end
 
       def call_native(request, writer)
-        @mutex.synchronize do
-          logger.debug { "[#{request.object_id}] Queue request #{request}" }
-          @hydra.queue convert(request, writer)
-          @hydra.dequeue_many
-
-          if sync?
-            @hydra.run
-          else
-            thread.run
-            @signal.signal
+        req = convert(request, writer)
+
+        if sync?
+          req.run
+        else
+          @mutex.synchronize do
+            logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] [#{request.object_id}] request:add method=#{request.method.upcase} url=#{request.uri}" }
+            @hydra.queue(req)
+            @hydra.dequeue_many
+
+            thread.run unless thread.status
           end
-        end
-      end
 
-      def queued?
-        @mutex.synchronize { ns_queued? }
+          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] [#{request.object_id}] request:signal" }
+          @signal.signal
+        end
       end
 
       private
 
-      def ns_queued?
-        @hydra.queued_requests.any? || @hydra.multi.easy_handles.count > 0
-      end
-
       def convert(request, writer)
         ::Typhoeus::Request.new(
           request.uri,
@@ -61,7 +59,7 @@ module Restify
           connecttimeout: request.timeout
         ).tap do |req|
           req.on_complete do |response|
-            logger.debug { "[#{request.object_id}] Completed: #{response.code}" }
+            logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] [#{request.object_id}] request:complete status=#{response.code}" }
 
             if response.timed_out?
               writer.reject Restify::Timeout.new request
@@ -94,6 +92,7 @@ module Restify
       def thread
         if @thread.nil? || !@thread.status
           # Recreate thread if nil or dead
+          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:spawn" }
           @thread = Thread.new { _loop }
         end
 
@@ -101,20 +100,25 @@ module Restify
       end
 
       def _loop
+        Thread.current.name = 'Restify/Typhoeus Background'
         loop { _run }
       end
 
+      def _ongoing?
+        @hydra.queued_requests.any? || @hydra.multi.easy_handles.any?
+      end
+
       def _run
-        if queued?
-          logger.debug { 'Run hydra' }
-          @hydra.run
-          logger.debug { 'Hydra finished' }
-        else
-          @mutex.synchronize do
-            return if ns_queued?
-            logger.debug { 'Pause hydra thread' }
-            @signal.wait(@mutex)
-          end
+        logger.debug { "[#{self.object_id}/#{Process.pid}] hydra:run" }
+        @hydra.run while _ongoing?
+        logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:completed" }
+
+        @mutex.synchronize do
+          return if _ongoing?
+
+          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:pause" }
+          @signal.wait(@mutex, 60)
+          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:resumed" }
         end
       rescue StandardError => e
         logger.error(e)

data/lib/restify/processors/base/parsing.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Restify
+  module Processors
+    class Base
+      #
+      # Parses generic data structures into resources
+      #
+      module Parsing
+        def self.included(base)
+          base.extend ClassMethods
+          base.indifferent_access = true
+        end
+
+        def load
+          parse deserialized_body, root: true
+        end
+
+        def parse(object, root: false)
+          case object
+            when Hash
+              data      = object.each_with_object({}, &method(:parse_data))
+              relations = object.each_with_object({}, &method(:parse_rels))
+
+              if self.class.indifferent_access?
+                data = with_indifferent_access(data)
+              end
+
+              Resource.new context,
+                data: data,
+                response: root ? response : nil,
+                relations: relations
+
+            when Array
+              object.map(&method(:parse))
+            else
+              object
+          end
+        end
+
+        private
+
+        def parse_data(pair, data)
+          data[pair[0].to_s] = parse pair[1]
+        end
+
+        def parse_rels(pair, relations)
+          name = case pair[0].to_s.downcase
+                   when /\A(\w+)_url\z/
+                     Regexp.last_match[1]
+                   when 'url'
+                     'self'
+                   else
+                     return
+                 end
+
+          if relations.key?(name) || pair[1].nil? || pair[1].to_s =~ /\A\w*\z/
+            return
+          end
+
+          relations[name] = pair[1].to_s
+        end
+
+        def with_indifferent_access(data)
+          Hashie::Mash.new data
+        end
+
+        module ClassMethods
+          def indifferent_access?
+            @indifferent_access
+          end
+
+          attr_writer :indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/restify/processors/json.rb

@@ -3,7 +3,6 @@
 require 'json'
 
 module Restify
-  #
   module Processors
     #
     # Decode plain JSON responses.
@@ -11,82 +10,17 @@ module Restify
     # JSON fields matching *_url will be parsed as relations.
     #
     class Json < Base
-      def load
-        parse ::JSON.parse(body), root: true
-      end
-
-      private
-
-      # rubocop:disable Metrics/MethodLength
-      def parse(object, root: false)
-        case object
-          when Hash
-            data      = object.each_with_object({}, &method(:parse_data))
-            relations = object.each_with_object({}, &method(:parse_rels))
-
-            if self.class.indifferent_access?
-              data = with_indifferent_access(data)
-            end
-
-            if root
-              Resource.new context,
-                data: data,
-                response: response,
-                relations: relations
-            else
-              Resource.new context,
-                data: data,
-                relations: relations
-            end
-          when Array
-            object.map(&method(:parse))
-          else
-            object
-        end
-      end
-
-      def parse_data(pair, data)
-        data[pair[0].to_s] = parse pair[1]
-      end
-
-      def parse_rels(pair, relations)
-        name = case pair[0].to_s.downcase
-                 when /\A(\w+)_url\z/
-                   Regexp.last_match[1]
-                 when 'url'
-                   'self'
-                 else
-                   return
-               end
+      include Parsing
 
-        if relations.key?(name) || pair[1].nil? || pair[1].to_s =~ /\A\w*\z/
-          return
-        end
-
-        relations[name] = pair[1].to_s
-      end
-
-      def json
-        @json ||= JSON.parse(response.body)
-      end
-
-      def with_indifferent_access(data)
-        Hashie::Mash.new data
+      def deserialized_body
+        ::JSON.parse(body)
       end
 
       class << self
         def accept?(response)
           response.content_type =~ %r{\Aapplication/json($|;)}
         end
-
-        def indifferent_access?
-          @indifferent_access
-        end
-
-        attr_writer :indifferent_access
       end
-
-      self.indifferent_access = true
     end
   end
 end

data/lib/restify/processors/msgpack.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'msgpack'
+
+module Restify
+  module Processors
+    #
+    # Decode messagepack encoded responses.
+    #
+    # Fields matching *_url will be parsed as relations.
+    #
+    class Msgpack < Base
+      include Parsing
+
+      def deserialized_body
+        ::MessagePack.unpack(body)
+      end
+
+      class << self
+        def accept?(response)
+          response.content_type =~ %r{\Aapplication/(x-)?msgpack($|;)}
+        end
+      end
+    end
+  end
+end

data/lib/restify/version.rb

@@ -3,8 +3,8 @@
 module Restify
   module VERSION
     MAJOR = 1
-    MINOR = 4
-    PATCH = 4
+    MINOR = 5
+    PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
 

data/lib/restify.rb

@@ -9,7 +9,6 @@ require 'concurrent'
 require 'addressable/uri'
 require 'addressable/template'
 
-#
 module Restify
   require 'restify/error'
   require 'restify/logging'
@@ -34,10 +33,13 @@ module Restify
 
   module Processors
     require 'restify/processors/base'
+    require 'restify/processors/base/parsing'
+
     require 'restify/processors/json'
+    require 'restify/processors/msgpack'
   end
 
-  PROCESSORS = [Processors::Json].freeze
+  PROCESSORS = [Processors::Json, Processors::Msgpack].freeze
 
   extend Global
 end

data/spec/restify/processors/msgpack_spec.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify::Processors::Msgpack do
+  let(:context)  { Restify::Context.new('http://test.host/') }
+  let(:response) { double 'response' }
+
+  before do
+    allow(response).to receive(:links).and_return []
+    allow(response).to receive(:follow_location).and_return nil
+  end
+
+  describe 'class' do
+    describe '#accept?' do
+      subject { described_class.accept? response }
+
+      it 'accepts msgpack mime type (I)' do
+        expect(response).to receive(:content_type).and_return('application/msgpack')
+        expect(subject).to be_truthy
+      end
+
+      it 'accepts msgpack mime type (II)' do
+        expect(response).to receive(:content_type).and_return('application/msgpack; abc')
+        expect(subject).to be_truthy
+      end
+
+      it 'accepts x-msgpack mime type (I)' do
+        expect(response).to receive(:content_type).and_return('application/x-msgpack')
+        expect(subject).to be_truthy
+      end
+
+      it 'accepts x-msgpack mime type (II)' do
+        expect(response).to receive(:content_type).and_return('application/x-msgpack; abc')
+        expect(subject).to be_truthy
+      end
+    end
+  end
+
+  describe '#resource' do
+    subject { described_class.new(context, response).resource }
+    before { allow(response).to receive(:body).and_return(body) }
+
+    describe 'parsing' do
+      context 'single object' do
+        let(:body) do
+          ::MessagePack.dump('msg' => 'value')
+        end
+
+        it { is_expected.to be_a Restify::Resource }
+        it { expect(subject.response).to be response }
+        it { is_expected.to eq 'msg' => 'value' }
+      end
+
+      context 'object with relation fields' do
+        let(:body) do
+          ::MessagePack.dump(
+            'msg' => 'value',
+            'search_url' => 'https://google.com{?q}'
+          )
+        end
+
+        it do
+          is_expected.to eq \
+            'msg' => 'value', 'search_url' => 'https://google.com{?q}'
+        end
+
+        it { is_expected.to have_relation :search }
+        it { expect(subject.relation(:search)).to eq 'https://google.com{?q}' }
+      end
+
+      context 'object with implicit self relation' do
+        let(:body) do
+          ::MessagePack.dump(
+            'url' => '/self'
+          )
+        end
+
+        it { expect(subject.relation(:self)).to eq '/self' }
+      end
+
+      context 'single array' do
+        let(:body) do
+          ::MessagePack.dump([1, 2, nil, 'STR'])
+        end
+
+        it { is_expected.to be_a Restify::Resource }
+        it { expect(subject.response).to be response }
+        it { is_expected.to eq [1, 2, nil, 'STR'] }
+      end
+
+      context 'array with objects' do
+        let(:body) do
+          ::MessagePack.dump([{'a' => 0}, {'b' => 1}])
+        end
+
+        it { is_expected.to eq [{'a' => 0}, {'b' => 1}] }
+      end
+
+      context 'array with resources' do
+        let(:body) do
+          ::MessagePack.dump([
+                               {'name' => 'John', 'self_url' => '/users/john'},
+                               {'name' => 'Jane', 'self_url' => '/users/jane'}
+                             ])
+        end
+
+        it 'parses objects as resources' do
+          expect(subject).to all(be_a(Restify::Resource))
+        end
+
+        it 'parses relations of resources' do
+          expect(subject.map {|r| r.relation :self }).to eq \
+            ['/users/john', '/users/jane']
+        end
+      end
+
+      context 'nested objects' do
+        let(:body) do
+          ::MessagePack.dump(
+            'john' => {'name' => 'John'},
+            'jane' => {'name' => 'Jane'}
+          )
+        end
+
+        it { is_expected.to be_a Restify::Resource }
+        it { expect(subject.response).to be response }
+
+        it 'parses objects as resources' do
+          expect(subject['john']).to be_a Restify::Resource
+          expect(subject['jane']).to be_a Restify::Resource
+
+          expect(subject['john']['name']).to eq 'John'
+          expect(subject['jane']['name']).to eq 'Jane'
+        end
+      end
+
+      context 'single value' do
+        let(:body) do
+          ::MessagePack.dump('BLUB')
+        end
+
+        it { is_expected.to be_a Restify::Resource }
+        it { expect(subject.response).to be response }
+        it { is_expected.to eq 'BLUB' }
+      end
+
+      context 'with indifferent access' do
+        let(:body) do
+          ::MessagePack.dump('name' => 'John', 'age' => 24)
+        end
+
+        it '#key?' do
+          expect(subject).to have_key 'name'
+          expect(subject).to have_key 'age'
+
+          expect(subject).to have_key :name
+          expect(subject).to have_key :age
+        end
+
+        it '#[]' do
+          expect(subject['name']).to eq 'John'
+          expect(subject['age']).to eq 24
+
+          expect(subject[:name]).to eq 'John'
+          expect(subject[:age]).to eq 24
+        end
+      end
+
+      context 'with method getter access' do
+        let(:body) do
+          ::MessagePack.dump('name' => 'John', 'age' => 24)
+        end
+
+        it '#<method getter>' do
+          expect(subject).to respond_to :name
+          expect(subject).to respond_to :age
+
+          expect(subject.name).to eq 'John'
+          expect(subject.age).to eq 24
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restify
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +159,9 @@ files:
 - lib/restify/link.rb
 - lib/restify/logging.rb
 - lib/restify/processors/base.rb
+- lib/restify/processors/base/parsing.rb
 - lib/restify/processors/json.rb
+- lib/restify/processors/msgpack.rb
 - lib/restify/promise.rb
 - lib/restify/registry.rb
 - lib/restify/relation.rb
@@ -159,6 +175,7 @@ files:
 - spec/restify/link_spec.rb
 - spec/restify/processors/base_spec.rb
 - spec/restify/processors/json_spec.rb
+- spec/restify/processors/msgpack_spec.rb
 - spec/restify/promise_spec.rb
 - spec/restify/registry_spec.rb
 - spec/restify/relation_spec.rb
@@ -196,6 +213,7 @@ test_files:
 - spec/restify/link_spec.rb
 - spec/restify/processors/base_spec.rb
 - spec/restify/processors/json_spec.rb
+- spec/restify/processors/msgpack_spec.rb
 - spec/restify/promise_spec.rb
 - spec/restify/registry_spec.rb
 - spec/restify/relation_spec.rb