garage_client 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67db70f420fa5fc41a2a070c99dbbd37eb70f909
-  data.tar.gz: a1caece74b9d92acfc6df7a7e5429e330969401f
+  metadata.gz: 8c9d279f5317c4beb50f7542c228b79e21082741
+  data.tar.gz: e82fee549ef03800c4a17fc10c0c351a9d704fbe
 SHA512:
-  metadata.gz: 323b4e8bab3eca3cafcdffa6c83c5960b745b1ad7827298d79fd59ad7f44df3e29186a0a295766ae5d2864c29c7e593c671302fbc9b06c96a4a1e59ffd0882f7
-  data.tar.gz: e7bf77480f8e5f46f511f7d66ecba31fdc5da866570a16c3fd683eb6d72e7046be0d65bcbc2b521960169e621193e45046891d11556f343dc175b34d3492848a
+  metadata.gz: 57a217f525aed34172d4e08192040d772d5a79a8c7bb396b133c83f4e500ec27729ae9f7bad093565b0a7b66c2486c5a18b138023bd0d1baefa950a40a22ec70
+  data.tar.gz: 0b5d6f3ebdc2149acd28519ae99a67e7b42638b819abadf062729c6573532915ccb1ff8b9b2a8bca9324adf3950640555c721a650cfdd73512935442548d9087

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.4.1
+- Record http request/response even if API returns errors.
+
 ## 2.4.0
 - Support distributed tracing.
 

data/lib/garage_client/client.rb

@@ -58,17 +58,6 @@ module GarageClient
 
     def connection
       Faraday.new(headers: headers, url: endpoint) do |builder|
-        if options[:tracing]
-          case options[:tracing][:tracer]
-          when 'aws-xray'
-            service = options[:tracing][:service]
-            raise 'Configure target service name with `tracing.service`' unless service
-            builder.use Aws::Xray::Faraday, service
-          else
-            raise "`tracing` option specified but GarageClient does not support the tracer: #{options[:tracing][:tracer]}"
-          end
-        end
-
         # Response Middlewares
         builder.use Faraday::Response::Logger if verbose
         builder.use FaradayMiddleware::Mashify
@@ -81,6 +70,18 @@ module GarageClient
         builder.use GarageClient::Request::JsonEncoded
         builder.use GarageClient::Request::PropagateRequestId
 
+        # Tracing Middlewares
+        if options[:tracing]
+          case options[:tracing][:tracer]
+          when 'aws-xray'
+            service = options[:tracing][:service]
+            raise 'Configure target service name with `tracing.service`' unless service
+            builder.use Aws::Xray::Faraday, service
+          else
+            raise "`tracing` option specified but GarageClient does not support the tracer: #{options[:tracing][:tracer]}"
+          end
+        end
+
         # Low-level Middlewares
         apply_auth_middleware builder
         builder.adapter(*adapter)

data/lib/garage_client/version.rb

@@ -1,3 +1,3 @@
 module GarageClient
-  VERSION = '2.4.0'
+  VERSION = '2.4.1'
 end

data/spec/features/tracing_spec.rb

@@ -21,13 +21,13 @@ RSpec.describe 'Tracing support' do
     end
     let(:stubs) do
       Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('/campain') { |env| [200, {'Content-Type' => 'application/json'}, '{"campain": false}'] }
+        stub.get('/campaign') { |env| [200, {'Content-Type' => 'application/json'}, '{"campaign": false}'] }
       end
     end
 
     specify 'client enables tracing and sends trace data to a local agent' do
-      res = client.get('/campain')
-      expect(res.body.campain).to eq(false)
+      res = client.get('/campaign')
+      expect(res.body.campaign).to eq(false)
 
       io.rewind
       sent_jsons = io.read.split("\n")
@@ -35,5 +35,48 @@ RSpec.describe 'Tracing support' do
       body = JSON.parse(sent_jsons[1])
       expect(body['name']).to eq('target-app')
     end
+
+    context 'API returns client errors' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/campaign') { |env| [404, {'Content-Type' => 'application/json'}, '{"error": "not_found"}'] }
+        end
+      end
+
+      specify 'client traces HTTP request and response and records errors' do
+        expect { client.get('/campaign') }.to raise_error(GarageClient::NotFound)
+
+        io.rewind
+        sent_jsons = io.read.split("\n")
+        expect(sent_jsons.size).to eq(2)
+        body = JSON.parse(sent_jsons[1])
+        expect(body['name']).to eq('target-app')
+        expect(body['error']).to eq(true)
+        expect(body['http']['request']['method']).to eq('GET')
+        expect(body['http']['response']['status']).to eq(404)
+      end
+    end
+
+    context 'API returns server errors' do
+      let(:stubs) do
+        Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/campaign') { |env| [500, {'Content-Type' => 'application/json'}, '{"error": "internal_server_error"}'] }
+        end
+      end
+
+      specify 'client traces HTTP request and response and marks as fault' do
+        expect { client.get('/campaign') }.to raise_error(GarageClient::InternalServerError)
+
+        io.rewind
+        sent_jsons = io.read.split("\n")
+        expect(sent_jsons.size).to eq(2)
+        body = JSON.parse(sent_jsons[1])
+        expect(body['name']).to eq('target-app')
+        expect(body['error']).to eq(false)
+        expect(body['fault']).to eq(true)
+        expect(body['http']['request']['method']).to eq('GET')
+        expect(body['http']['response']['status']).to eq(500)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garage_client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-29 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport