-
Notifications
You must be signed in to change notification settings - Fork 23
/
client.rb
127 lines (106 loc) · 4.46 KB
/
client.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
require 'percy/capybara/client/builds'
require 'percy/capybara/client/snapshots'
require 'percy/capybara/client/user_agent'
require 'percy/capybara/loaders/filesystem_loader'
require 'percy/capybara/loaders/native_loader'
require 'percy/capybara/loaders/sprockets_loader'
require 'percy/capybara/loaders/ember_cli_rails_loader'
module Percy
module Capybara
class Client
include Percy::Capybara::Client::Builds
include Percy::Capybara::Client::Snapshots
include Percy::Capybara::Client::UserAgent
class Error < RuntimeError; end
class BuildNotInitializedError < Error; end
class WebMockBlockingConnectionsError < Error; end
attr_reader :client
attr_accessor :sprockets_environment
attr_accessor :sprockets_options
attr_accessor :loader
attr_accessor :loader_options
def initialize(options = {})
@failed = false
@enabled = options[:enabled]
@loader_options = options[:loader_options] || {}
@loader = options[:loader]
@client = options[:client] || \
Percy.client(client_info: _client_info, environment_info: _environment_info)
return unless defined?(Rails) && defined?(Sprockets::Rails)
@sprockets_environment = options[:sprockets_environment] || Rails.application.assets
@sprockets_options = options[:sprockets_options] || Rails.application.config.assets
end
# Check that environment variables required for Percy::Client are set
def required_environment_variables_set?
!!ENV['PERCY_TOKEN']
end
def enabled?
return @enabled unless @enabled.nil?
# Disable if PERCY_ENABLE is set to 0
return @enabled = false if ENV['PERCY_ENABLE'] == '0'
# Enable if required environment variables are set
return @enabled = true if required_environment_variables_set?
# Disable otherwise
@enabled = false
end
def disable!
@enabled = false
end
def rescue_connection_failures
raise ArgumentError, 'block is required' unless block_given?
begin
yield
rescue Percy::Client::ServerError, # Rescue server errors.
Percy::Client::PaymentRequiredError, # Rescue quota exceeded errors.
Percy::Client::ConnectionFailed, # Rescue some networking errors.
Percy::Client::TimeoutError => e
Percy.logger.error(e)
@enabled = false
@failed = true
nil
end
end
def failed?
!!@failed
end
def initialize_loader(options = {})
merged_options = loader_options.merge(options)
is_sprockets = sprockets_environment && sprockets_options
if is_sprockets
merged_options[:sprockets_environment] = sprockets_environment
merged_options[:sprockets_options] = sprockets_options
end
if loader
case loader
when :filesystem
Percy.logger.debug { 'Using filesystem_loader to discover assets.' }
Percy::Capybara::Loaders::FilesystemLoader.new(merged_options)
when :native
Percy.logger.debug { 'Using native_loader to discover assets (slow).' }
Percy::Capybara::Loaders::NativeLoader.new(merged_options)
when :ember_cli_rails
Percy.logger.debug { 'Using ember_cli_rails_loader to discover assets.' }
mounted_apps = merged_options.delete(:mounted_apps)
Percy::Capybara::Loaders::EmberCliRailsLoader.new(mounted_apps, merged_options)
else
Percy.logger.debug { 'Using a custom loader to discover assets.' }
loader.new(merged_options)
end
elsif is_sprockets
Percy.logger.debug { 'Using sprockets_loader to discover assets.' }
Percy::Capybara::Loaders::SprocketsLoader.new(merged_options)
else
unless @warned_about_native_loader
Percy.logger.warn \
'[DEPRECATED] The native_loader is deprecated and will be opt-in in a future ' \
'release. You should move to the faster, more reliable filesystem_loader. See the ' \
'docs for Non-Rails frameworks: https://percy.io/docs/clients/ruby/capybara '
@warned_about_native_loader = true
end
Percy.logger.debug { 'Using native_loader to discover assets (slower).' }
Percy::Capybara::Loaders::NativeLoader.new(merged_options)
end
end
end
end
end