percy-capybara 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c4cc56770f66ae733c1b919f38301d17b7910c2
-  data.tar.gz: 0698249b05a20484631589ba84c68440e30b8844
+  metadata.gz: 1c71d17b90a56a54122b7ab3ca6b6ba5d191afc1
+  data.tar.gz: 59ae7c7476a3bf8ad24df13fcd5c645762d7a7fa
 SHA512:
-  metadata.gz: 8c577cb415023e6ab72549983e00f9db56a228a796648775820debb839bee6cf232ff4fffd4ed36225d6ab18491da6d781aee638b10ea70e6022d0e33050bf93
-  data.tar.gz: cfb935770d5bb6d5e7223045584a0a337debe8d6f14705b8bd25459eb713691b3bacb08c792c14d8474d9b05dc8e593c68feb6a77eaecdfcfa1335a0d3ee95fc
+  metadata.gz: 9d7c169bcadc15579454c9f433a7de8e044213e5679fead6d6fef24798ee52b71f5bf8686add411fbb443bf0ca55c513c3c3b5e68562bc945ff0662e31c5871b
+  data.tar.gz: 1dab69ac68f0c303d658932ced422b3655a59c6c084c53cebbbe14c667c38aad777c1334b84330e4de3cc5892aa5e1965a044e48e03e16fa1cd4afdb4864b08d

data/lib/percy/capybara/client.rb

@@ -38,6 +38,24 @@ module Percy
         @enabled ||= !Percy::Client::Environment.current_ci.nil?
       end
 
+      def rescue_connection_failures(&block)
+        raise ArgumentError.new('block is requried') if !block_given?
+        begin
+          block.call
+        rescue Percy::Client::HttpError,
+            Percy::Client::ConnectionFailed,
+            Percy::Client::TimeoutError => e
+          Percy.logger.error(e)
+          @enabled = false
+          @failed = true
+          nil
+        end
+      end
+
+      def failed?
+        return !!@failed
+      end
+
       def initialize_loader(options = {})
         if sprockets_environment && sprockets_options
           Percy.logger.debug { 'Using sprockets_loader to discover assets.' }

data/lib/percy/capybara/client/builds.rb

@@ -15,8 +15,14 @@ module Percy
           build_resources.each { |br| Percy.logger.debug { "Build resource: #{br.resource_url}" } }
           Percy.logger.debug { "All build resources loaded (#{Time.now - start}s)" }
 
-          @current_build = client.create_build(client.config.repo, options)
-          _upload_missing_build_resources(build_resources) if !build_resources.empty?
+          rescue_connection_failures do
+            @current_build = client.create_build(client.config.repo, options)
+            _upload_missing_build_resources(build_resources) if !build_resources.empty?
+          end
+          if failed?
+            Percy.logger.error { "Percy build failed! Check log above for errors." }
+            return
+          end
           @current_build
         end
 
@@ -35,7 +41,14 @@ module Percy
             raise Percy::Capybara::Client::BuildNotInitializedError.new(
               'Failed to finalize build because no build has been initialized.')
           end
-          client.finalize_build(current_build['data']['id'])
+          result = rescue_connection_failures do
+            client.finalize_build(current_build['data']['id'])
+          end
+          if failed?
+            Percy.logger.error { "Percy build failed! Check log above for errors." }
+            return
+          end
+          result
         end
 
         # @private

data/lib/percy/capybara/client/snapshots.rb

@@ -58,16 +58,21 @@ module Percy
 
           # Create the snapshot and upload any missing snapshot resources.
           start = Time.now
-          snapshot = client.create_snapshot(current_build_id, resources, name: name)
-          snapshot['data']['relationships']['missing-resources']['data'].each do |missing_resource|
-            sha = missing_resource['id']
-            client.upload_resource(current_build_id, resource_map[sha].content)
-          end
-          Percy.logger.debug { "All snapshot resources uploaded (#{Time.now - start}s)" }
-
-          # Finalize the snapshot.
-          client.finalize_snapshot(snapshot['data']['id'])
+          rescue_connection_failures do
+            snapshot = client.create_snapshot(current_build_id, resources, name: name)
+            snapshot['data']['relationships']['missing-resources']['data'].each do |missing_resource|
+              sha = missing_resource['id']
+              client.upload_resource(current_build_id, resource_map[sha].content)
+            end
+            Percy.logger.debug { "All snapshot resources uploaded (#{Time.now - start}s)" }
 
+            # Finalize the snapshot.
+            client.finalize_snapshot(snapshot['data']['id'])
+          end
+          if failed?
+            Percy.logger.error { "Percy build failed! Check log above for errors." }
+            return
+          end
           true
         end
       end

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
   end
 end

data/spec/lib/percy/capybara/client/builds_spec.rb

@@ -2,7 +2,9 @@ RSpec.describe Percy::Capybara::Client::Builds do
   let(:enabled) { true }
   let(:capybara_client) { Percy::Capybara::Client.new(enabled: enabled) }
 
-  describe '#initialize_build' do
+  describe '#initialize_build', type: :feature, js: true do
+    before(:each) { setup_sprockets(capybara_client) }
+
     context 'percy is not enabled' do
       let(:enabled) { false }
       it 'returns nil if not enabled' do
@@ -20,6 +22,77 @@ RSpec.describe Percy::Capybara::Client::Builds do
         .to_return(status: 201, body: mock_response.to_json)
       expect(capybara_client.initialize_build).to eq(mock_response)
     end
+    it 'uploads missing build resources' do
+      visit '/'
+      loader = capybara_client.initialize_loader(page: page)
+      mock_response = {
+        'data' => {
+          'id' => '123',
+          'type' => 'builds',
+          'relationships' => {
+            'self' => "/api/v1/snapshots/123",
+            'missing-resources' => {
+              'data' => [
+                {
+                  'type' => 'resources',
+                  'id' => loader.build_resources.first.sha,
+                },
+              ],
+            },
+          },
+        },
+      }
+      # Stub create build.
+      build_stub = stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
+        .to_return(status: 201, body: mock_response.to_json)
+
+      # Stub resource upload.
+      resources_stub = stub_request(:post, "https://percy.io/api/v1/builds/123/resources/")
+        .to_return(status: 201, body: {success: true}.to_json)
+      capybara_client.initialize_build
+
+      expect(resources_stub).to have_been_requested
+      expect(build_stub).to have_been_requested
+    end
+    it 'safely handles connection errors when creating build' do
+      expect(capybara_client.client).to receive(:create_build)
+        .and_raise(Percy::Client::ConnectionFailed)
+      expect(capybara_client.initialize_build).to eq(nil)
+      expect(capybara_client.failed?).to eq(true)
+    end
+    it 'safely handles connection errors when uploading missing build_resources' do
+      visit '/'
+      loader = capybara_client.initialize_loader(page: page)
+      mock_response = {
+        'data' => {
+          'id' => '123',
+          'type' => 'builds',
+          'relationships' => {
+            'self' => "/api/v1/snapshots/123",
+            'missing-resources' => {
+              'data' => [
+                {
+                  'type' => 'resources',
+                  'id' => loader.build_resources.first.sha,
+                },
+              ],
+            },
+          },
+        },
+      }
+      # Stub create build.
+      build_stub = stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
+        .to_return(status: 201, body: mock_response.to_json)
+
+      # Stub resource upload.
+      expect(capybara_client.client).to receive(:upload_resource)
+        .and_raise(Percy::Client::ConnectionFailed)
+
+      result = capybara_client.initialize_build
+      expect(capybara_client.initialize_build).to eq(nil)
+      expect(capybara_client.failed?).to eq(true)
+      expect(build_stub).to have_been_requested
+    end
   end
   describe '#current_build' do
     it 'returns nil if no build has been initialized' do
@@ -42,10 +115,10 @@ RSpec.describe Percy::Capybara::Client::Builds do
   describe '#build_initialized?' do
     it 'is false before a build is initialized and true afterward' do
       expect(capybara_client.client).to receive(:create_build).and_return(double('build'))
-      expect(capybara_client.build_initialized?).to be_falsey
+      expect(capybara_client.build_initialized?).to eq(false)
 
       capybara_client.initialize_build
-      expect(capybara_client.build_initialized?).to be_truthy
+      expect(capybara_client.build_initialized?).to eq(true)
     end
   end
   describe '#finalize_current_build' do
@@ -62,6 +135,16 @@ RSpec.describe Percy::Capybara::Client::Builds do
         capybara_client.finalize_current_build
       end.to raise_error(Percy::Capybara::Client::BuildNotInitializedError)
     end
+    it 'safely handles connection errors' do
+      build_data = {'data' => {'id' => 123}}
+      expect(capybara_client.client).to receive(:create_build).and_return(build_data)
+      capybara_client.initialize_build
+
+      expect(capybara_client.client).to receive(:finalize_build)
+        .and_raise(Percy::Client::ConnectionFailed)
+      expect(capybara_client.finalize_current_build).to eq(nil)
+      expect(capybara_client.failed?).to eq(true)
+    end
   end
   describe '#_upload_missing_build_resources', type: :feature, js: true do
     before(:each) { setup_sprockets(capybara_client) }
@@ -80,38 +163,6 @@ RSpec.describe Percy::Capybara::Client::Builds do
       loader = capybara_client.initialize_loader
       expect(capybara_client.send(:_upload_missing_build_resources, loader.build_resources)).to eq(0)
     end
-    it 'uploads missing resources and returns the number uploaded' do
-      visit '/'
-      loader = capybara_client.initialize_loader(page: page)
-
-      mock_response = {
-        'data' => {
-          'id' => '123',
-          'type' => 'builds',
-          'relationships' => {
-            'self' => "/api/v1/snapshots/123",
-            'missing-resources' => {
-              'data' => [
-                {
-                  'type' => 'resources',
-                  'id' => loader.build_resources.first.sha,
-                },
-              ],
-            },
-          },
-        },
-      }
-      # Stub create build.
-      stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
-        .to_return(status: 201, body: mock_response.to_json)
-
-      # Stub resource upload.
-      stub_request(:post, "https://percy.io/api/v1/builds/123/resources/")
-        .to_return(status: 201, body: {success: true}.to_json)
-      capybara_client.initialize_build
-      result = capybara_client.send(:_upload_missing_build_resources, loader.build_resources)
-      expect(result).to eq(1)
-    end
   end
 
 end

data/spec/lib/percy/capybara/client/snapshots_spec.rb

@@ -73,6 +73,17 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
         remove_request_stub(build_resource_stub)
         expect(capybara_client.snapshot(page)).to eq(true)
       end
+      it 'safely handles connection errors' do
+        visit '/'
+        build_data = {'data' => {'id' => 123}}
+        expect(capybara_client.client).to receive(:create_build).and_return(build_data)
+        capybara_client.initialize_build
+
+        expect(capybara_client.client).to receive(:create_snapshot)
+          .and_raise(Percy::Client::ConnectionFailed)
+        expect(capybara_client.snapshot(page)).to eq(nil)
+        expect(capybara_client.failed?).to eq(true)
+      end
     end
   end
 end

data/spec/lib/percy/capybara/client_spec.rb

@@ -17,15 +17,58 @@ RSpec.describe Percy::Capybara::Client do
     context 'in supported CI environment' do
       it 'is true' do
         ENV['TRAVIS_BUILD_ID'] = '123'
-        expect(Percy::Capybara::Client.new.enabled?).to be_truthy
+        expect(Percy::Capybara::Client.new.enabled?).to eq(true)
       end
     end
     it 'is false by default for local dev environments or unknown CI environments' do
-      expect(Percy::Capybara::Client.new.enabled?).to be_falsey
+      expect(Percy::Capybara::Client.new.enabled?).to eq(false)
     end
     it 'is true if PERCY_ENABLE=1 is set' do
       ENV['PERCY_ENABLE'] = '1'
-      expect(Percy::Capybara::Client.new.enabled?).to be_truthy
+      expect(Percy::Capybara::Client.new.enabled?).to eq(true)
+    end
+  end
+  describe '#failed?' do
+    it 'is false by default' do
+      expect(Percy::Capybara::Client.new.failed?).to eq(false)
+    end
+  end
+  describe '#rescue_connection_failures' do
+    let(:capybara_client) { Percy::Capybara::Client.new(enabled: true) }
+    it 'returns block result on success' do
+      result = capybara_client.rescue_connection_failures do
+        true
+      end
+      expect(result).to eq(true)
+      expect(capybara_client.enabled?).to eq(true)
+      expect(capybara_client.failed?).to eq(false)
+    end
+    it 'makes block safe from HttpError' do
+      result = capybara_client.rescue_connection_failures do
+        raise Percy::Client::HttpError.new(500, 'POST', '', '')
+      end
+      expect(result).to eq(nil)
+      expect(capybara_client.enabled?).to eq(false)
+      expect(capybara_client.failed?).to eq(true)
+    end
+    it 'makes block safe from ConnectionFailed' do
+      result = capybara_client.rescue_connection_failures do
+        raise Percy::Client::ConnectionFailed
+      end
+      expect(result).to eq(nil)
+      expect(capybara_client.enabled?).to eq(false)
+      expect(capybara_client.failed?).to eq(true)
+    end
+    it 'makes block safe from TimeoutError' do
+      result = capybara_client.rescue_connection_failures do
+        raise Percy::Client::TimeoutError
+      end
+      expect(result).to eq(nil)
+      expect(capybara_client.enabled?).to eq(false)
+      expect(capybara_client.failed?).to eq(true)
+    end
+    it 'requires a block' do
+      expect { capybara_client.rescue_connection_failures }.to raise_error(ArgumentError)
     end
   end
   describe '#initialize_loader' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client