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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
|
# frozen_string_literal: true
require 'stringio'
require 'logger'
RSpec.describe Faraday::Response::Logger do
let(:string_io) { StringIO.new }
let(:logger) { Logger.new(string_io) }
let(:logger_options) { {} }
let(:conn) do
rubbles = ['Barney', 'Betty', 'Bam Bam']
Faraday.new do |b|
b.response :logger, logger, logger_options do |logger|
logger.filter(/(soylent green is) (.+)/, '\1 tasty')
logger.filter(/(api_key:).*"(.+)."/, '\1[API_KEY]')
logger.filter(/(password)=(.+)/, '\1=[HIDDEN]')
end
b.adapter :test do |stubs|
stubs.get('/hello') { [200, { 'Content-Type' => 'text/html' }, 'hello'] }
stubs.post('/ohai') { [200, { 'Content-Type' => 'text/html' }, 'fred'] }
stubs.post('/ohyes') { [200, { 'Content-Type' => 'text/html' }, 'pebbles'] }
stubs.get('/rubbles') { [200, { 'Content-Type' => 'application/json' }, rubbles] }
stubs.get('/8bit') { [200, { 'Content-Type' => 'text/html' }, (+'café!').force_encoding(Encoding::ASCII_8BIT)] }
stubs.get('/filtered_body') { [200, { 'Content-Type' => 'text/html' }, 'soylent green is people'] }
stubs.get('/filtered_headers') { [200, { 'Content-Type' => 'text/html' }, 'headers response'] }
stubs.get('/filtered_params') { [200, { 'Content-Type' => 'text/html' }, 'params response'] }
stubs.get('/filtered_url') { [200, { 'Content-Type' => 'text/html' }, 'url response'] }
stubs.get('/connection_failed') { raise Faraday::ConnectionFailed, 'Failed to open TCP connection' }
end
end
end
before do
logger.level = Logger::DEBUG
end
it 'still returns output' do
resp = conn.get '/hello', nil, accept: 'text/html'
expect(resp.body).to eq('hello')
end
context 'without configuration' do
let(:conn) do
Faraday.new do |b|
b.response :logger
b.adapter :test do |stubs|
stubs.get('/hello') { [200, { 'Content-Type' => 'text/html' }, 'hello'] }
end
end
end
it 'defaults to stdout' do
expect(Logger).to receive(:new).with($stdout).and_return(Logger.new(nil))
conn.get('/hello')
end
end
context 'when logger with program name' do
let(:logger) { Logger.new(string_io, progname: 'my_best_program') }
it 'logs with program name' do
conn.get '/hello'
expect(string_io.string).to match('-- my_best_program: request:')
expect(string_io.string).to match('-- my_best_program: response:')
end
end
context 'when logger without program name' do
it 'logs without program name' do
conn.get '/hello'
expect(string_io.string).to match('-- : request:')
expect(string_io.string).to match('-- : response:')
end
end
context 'with default formatter' do
let(:formatter) { instance_double(Faraday::Logging::Formatter, request: true, response: true, filter: []) }
before { allow(Faraday::Logging::Formatter).to receive(:new).and_return(formatter) }
it 'delegates logging to the formatter' do
expect(formatter).to receive(:request).with(an_instance_of(Faraday::Env))
expect(formatter).to receive(:response).with(an_instance_of(Faraday::Env))
conn.get '/hello'
end
context 'when no route' do
it 'delegates logging to the formatter' do
expect(formatter).to receive(:request).with(an_instance_of(Faraday::Env))
expect(formatter).to receive(:exception).with(an_instance_of(Faraday::Adapter::Test::Stubs::NotFound))
expect { conn.get '/noroute' }.to raise_error(Faraday::Adapter::Test::Stubs::NotFound)
end
end
end
context 'with custom formatter' do
let(:formatter_class) do
Class.new(Faraday::Logging::Formatter) do
def request(_env)
info 'Custom log formatter request'
end
def response(_env)
info 'Custom log formatter response'
end
end
end
let(:logger_options) { { formatter: formatter_class } }
it 'logs with custom formatter' do
conn.get '/hello'
expect(string_io.string).to match('Custom log formatter request')
expect(string_io.string).to match('Custom log formatter response')
end
end
it 'logs method and url' do
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).to match('GET http:/hello')
end
it 'logs status' do
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).to match('Status 200')
end
it 'does not log error message by default' do
expect { conn.get '/noroute' }.to raise_error(Faraday::Adapter::Test::Stubs::NotFound)
expect(string_io.string).not_to match(%(no stubbed request for get http:/noroute))
end
it 'logs request headers by default' do
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).to match(%(Accept: "text/html))
end
it 'logs response headers by default' do
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).to match(%(Content-Type: "text/html))
end
it 'does not log request body by default' do
conn.post '/ohai', 'name=Unagi', accept: 'text/html'
expect(string_io.string).not_to match(%(name=Unagi))
end
it 'does not log response body by default' do
conn.post '/ohai', 'name=Toro', accept: 'text/html'
expect(string_io.string).not_to match(%(fred))
end
it 'logs filter headers' do
conn.headers = { 'api_key' => 'ABC123' }
conn.get '/filtered_headers', nil, accept: 'text/html'
expect(string_io.string).to match(%(api_key:))
expect(string_io.string).to match(%([API_KEY]))
expect(string_io.string).not_to match(%(ABC123))
end
it 'logs filter url' do
conn.get '/filtered_url?password=hunter2', nil, accept: 'text/html'
expect(string_io.string).to match(%([HIDDEN]))
expect(string_io.string).not_to match(%(hunter2))
end
context 'when not logging request headers' do
let(:logger_options) { { headers: { request: false } } }
it 'does not log request headers if option is false' do
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).not_to match(%(Accept: "text/html))
end
end
context 'when not logging response headers' do
let(:logger_options) { { headers: { response: false } } }
it 'does not log response headers if option is false' do
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).not_to match(%(Content-Type: "text/html))
end
end
context 'when logging request body' do
let(:logger_options) { { bodies: { request: true } } }
it 'logs only request body' do
conn.post '/ohyes', 'name=Tamago', accept: 'text/html'
expect(string_io.string).to match(%(name=Tamago))
expect(string_io.string).not_to match(%(pebbles))
end
end
context 'when logging response body' do
let(:logger_options) { { bodies: { response: true } } }
it 'logs only response body' do
conn.post '/ohyes', 'name=Hamachi', accept: 'text/html'
expect(string_io.string).to match(%(pebbles))
expect(string_io.string).not_to match(%(name=Hamachi))
end
end
context 'when logging request and response bodies' do
let(:logger_options) { { bodies: true } }
it 'logs request and response body' do
conn.post '/ohyes', 'name=Ebi', accept: 'text/html'
expect(string_io.string).to match(%(name=Ebi))
expect(string_io.string).to match(%(pebbles))
end
it 'logs response body object' do
conn.get '/rubbles', nil, accept: 'text/html'
expect(string_io.string).to match(%([\"Barney\", \"Betty\", \"Bam Bam\"]\n))
end
it 'logs filter body' do
conn.get '/filtered_body', nil, accept: 'text/html'
expect(string_io.string).to match(%(soylent green is))
expect(string_io.string).to match(%(tasty))
expect(string_io.string).not_to match(%(people))
end
end
context 'when bodies are logged by default' do
before do
described_class.default_options = { bodies: true }
end
it 'logs response body' do
conn.post '/ohai'
expect(string_io.string).to match(%(fred))
end
it 'converts to UTF-8' do
conn.get '/8bit'
expect(string_io.string).to match(%(caf��!))
end
after do
described_class.default_options = { bodies: false }
end
end
context 'when logging errors' do
let(:logger_options) { { errors: true } }
it 'logs error message' do
expect { conn.get '/noroute' }.to raise_error(Faraday::Adapter::Test::Stubs::NotFound)
expect(string_io.string).to match(%(no stubbed request for get http:/noroute))
end
end
context 'when logging headers and errors' do
let(:logger_options) { { headers: true, errors: true } }
it 'logs error message' do
expect { conn.get '/connection_failed' }.to raise_error(Faraday::ConnectionFailed)
expect(string_io.string).to match(%(Failed to open TCP connection))
end
end
context 'when using log_level' do
let(:logger_options) { { bodies: true, log_level: :debug } }
it 'logs request/request body on the specified level (debug)' do
logger.level = Logger::DEBUG
conn.post '/ohyes', 'name=Ebi', accept: 'text/html'
expect(string_io.string).to match(%(name=Ebi))
expect(string_io.string).to match(%(pebbles))
end
it 'logs headers on the debug level' do
logger.level = Logger::DEBUG
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).to match(%(Content-Type: "text/html))
end
it 'does not log request/response body on the info level' do
logger.level = Logger::INFO
conn.post '/ohyes', 'name=Ebi', accept: 'text/html'
expect(string_io.string).not_to match(%(name=Ebi))
expect(string_io.string).not_to match(%(pebbles))
end
it 'does not log headers on the info level' do
logger.level = Logger::INFO
conn.get '/hello', nil, accept: 'text/html'
expect(string_io.string).not_to match(%(Content-Type: "text/html))
end
end
end
|