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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
| | # frozen_string_literal: true
require_relative 'helper'
require 'time' # for Time#httpdate
require 'zlib'
separate_testing do
require_relative '../lib/rack/deflater'
require_relative '../lib/rack/lint'
require_relative '../lib/rack/mock_request'
end
describe Rack::Deflater do
def build_response(status, body, accept_encoding, options = {})
body = [body] if body.respond_to? :to_str
app = lambda do |env|
res = [status, options['response_headers'] || {}, body]
res[1]['content-type'] = 'text/plain' unless res[0] == 304
res
end
request = Rack::MockRequest.env_for('', (options['request_headers'] || {}).merge('HTTP_ACCEPT_ENCODING' => accept_encoding))
deflater = Rack::Lint.new Rack::Deflater.new(app, options['deflater_options'] || {})
deflater.call(request)
end
##
# Constructs response object and verifies if it yields right results
#
# [expected_status] expected response status, e.g. 200, 304
# [expected_body] expected response body
# [accept_encoding] what Accept-Encoding header to send and expect, e.g.
# 'deflate' - accepts and expects deflate encoding in response
# { 'gzip' => nil } - accepts gzip but expects no encoding in response
# [options] hash of request options, i.e.
# 'app_status' - what status dummy app should return (may be changed by deflater at some point)
# 'app_body' - what body dummy app should return (may be changed by deflater at some point)
# 'request_headers' - extra request headers to be sent
# 'response_headers' - extra response headers to be returned
# 'deflater_options' - options passed to deflater middleware
# [block] useful for doing some extra verification
def verify(expected_status, expected_body, accept_encoding, options = {}, &block)
accept_encoding, expected_encoding = if accept_encoding.kind_of?(Hash)
[accept_encoding.keys.first, accept_encoding.values.first]
else
[accept_encoding, accept_encoding.dup]
end
start = Time.now.to_i
# build response
status, headers, body = build_response(
options['app_status'] || expected_status,
options['app_body'] || expected_body,
accept_encoding,
options
)
# verify status
status.must_equal expected_status
# verify body
unless options['skip_body_verify']
body_text = ''.dup
body.each { |part| body_text << part }
deflated_body = case expected_encoding
when 'deflate'
inflater = Zlib::Inflate.new(-Zlib::MAX_WBITS)
inflater.inflate(body_text) << inflater.finish
when 'gzip'
io = StringIO.new(body_text)
gz = Zlib::GzipReader.new(io)
mtime = gz.mtime.to_i
if last_mod = headers['last-modified']
Time.httpdate(last_mod).to_i.must_equal mtime
else
mtime.must_be(:<=, Time.now.to_i)
mtime.must_be(:>=, start.to_i - 1)
end
tmp = gz.read
gz.close
tmp
else
body_text
end
deflated_body.must_equal expected_body
end
# yield full response verification
yield(status, headers, body) if block_given?
body.close if body.respond_to?(:close)
end
# automatic gzip detection (streamable)
def auto_inflater
Zlib::Inflate.new(32 + Zlib::MAX_WBITS)
end
def deflate_or_gzip
{ 'deflate, gzip' => 'gzip' }
end
it 'be able to deflate bodies that respond to each' do
app_body = Object.new
class << app_body; def each; yield('foo'); yield('bar'); end; end
verify(200, 'foobar', deflate_or_gzip, { 'app_body' => app_body }) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
end
end
it 'should not update vary response header if it includes * or accept-encoding' do
verify(200, 'foobar', deflate_or_gzip, 'response_headers' => { 'vary' => 'Accept-Encoding' } ) do |status, headers, body|
headers['vary'].must_equal 'Accept-Encoding'
end
verify(200, 'foobar', deflate_or_gzip, 'response_headers' => { 'vary' => '*' } ) do |status, headers, body|
headers['vary'].must_equal '*'
end
verify(200, 'foobar', deflate_or_gzip, 'response_headers' => { 'vary' => 'Do-Not-Accept-Encoding' } ) do |status, headers, body|
headers['vary'].must_equal 'Do-Not-Accept-Encoding,Accept-Encoding'
end
end
it 'be able to deflate bodies that respond to each and contain empty chunks' do
app_body = Object.new
class << app_body; def each; yield('foo'); yield(''); yield('bar'); end; end
verify(200, 'foobar', deflate_or_gzip, { 'app_body' => app_body }) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
end
end
it 'flush deflated chunks to the client as they become ready' do
app_body = Object.new
class << app_body; def each; yield('foo'); yield('bar'); end; end
verify(200, app_body, deflate_or_gzip, { 'skip_body_verify' => true }) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
buf = []
inflater = auto_inflater
body.each { |part| buf << inflater.inflate(part) }
buf << inflater.finish
buf.delete_if { |part| part.empty? }.join.must_equal 'foobar'
end
end
it 'does not raise when a client aborts reading' do
app_body = Object.new
class << app_body; def each; yield('foo'); yield('bar'); end; end
opts = { 'skip_body_verify' => true }
verify(200, app_body, 'gzip', opts) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
buf = []
inflater = auto_inflater
FakeDisconnect = Class.new(RuntimeError)
assert_raises(FakeDisconnect, "not Zlib::DataError not raised") do
body.each do |part|
tmp = inflater.inflate(part)
buf << tmp if tmp.bytesize > 0
raise FakeDisconnect
end
end
inflater.finish
buf.must_equal(%w(foo))
end
end
# TODO: This is really just a special case of the above...
it 'be able to deflate String bodies' do
verify(200, 'Hello world!', deflate_or_gzip) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
end
end
it 'be able to gzip bodies that respond to each' do
app_body = Object.new
class << app_body; def each; yield('foo'); yield('bar'); end; end
verify(200, 'foobar', 'gzip', { 'app_body' => app_body }) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
end
end
it 'be able to gzip files' do
verify(200, File.binread(__FILE__), 'gzip', { 'app_body' => File.open(__FILE__)}) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
end
end
it 'flush gzipped chunks to the client as they become ready' do
app_body = Object.new
class << app_body; def each; yield('foo'); yield('bar'); end; end
verify(200, app_body, 'gzip', { 'skip_body_verify' => true }) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
buf = []
inflater = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)
body.each { |part| buf << inflater.inflate(part) }
buf << inflater.finish
buf.delete_if { |part| part.empty? }.join.must_equal 'foobar'
end
end
it 'be able to fallback to no deflation' do
verify(200, 'Hello world!', 'superzip') do |status, headers, body|
headers.must_equal({
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
end
end
it 'be able to skip when there is no response entity body' do
verify(304, '', { 'gzip' => nil }, { 'app_body' => [] }) do |status, headers, body|
headers.must_equal({})
end
end
it 'handle the lack of an acceptable encoding' do
app_body = 'Hello world!'
not_found_body1 = 'An acceptable encoding for the requested resource / could not be found.'
not_found_body2 = 'An acceptable encoding for the requested resource /foo/bar could not be found.'
options1 = {
'app_status' => 200,
'app_body' => app_body,
'request_headers' => {
'PATH_INFO' => '/'
}
}
options2 = {
'app_status' => 200,
'app_body' => app_body,
'request_headers' => {
'PATH_INFO' => '/foo/bar'
}
}
app_body3 = [app_body]
closed = false
app_body3.define_singleton_method(:close){closed = true}
options3 = {
'app_status' => 200,
'app_body' => app_body3,
'request_headers' => {
'PATH_INFO' => '/'
}
}
verify(406, not_found_body1, 'identity;q=0', options1) do |status, headers, body|
headers.must_equal({
'content-type' => 'text/plain',
'content-length' => not_found_body1.length.to_s
})
end
verify(406, not_found_body2, 'identity;q=0', options2) do |status, headers, body|
headers.must_equal({
'content-type' => 'text/plain',
'content-length' => not_found_body2.length.to_s
})
end
verify(406, not_found_body1, 'identity;q=0', options3) do |status, headers, body|
headers.must_equal({
'content-type' => 'text/plain',
'content-length' => not_found_body1.length.to_s
})
end
closed.must_equal true
end
it 'handle gzip response with last-modified header' do
last_modified = Time.now.httpdate
options = {
'response_headers' => {
'content-type' => 'text/plain',
'last-modified' => last_modified
}
}
verify(200, 'Hello World!', 'gzip', options) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'last-modified' => last_modified,
'content-type' => 'text/plain'
})
end
end
it 'do nothing when no-transform cache-control directive present' do
options = {
'response_headers' => {
'content-type' => 'text/plain',
'cache-control' => 'no-transform'
}
}
verify(200, 'Hello World!', { 'gzip' => nil }, options) do |status, headers, body|
headers.wont_include 'content-encoding'
end
end
it 'do nothing when content-encoding already present' do
options = {
'response_headers' => {
'content-type' => 'text/plain',
'content-encoding' => 'gzip'
}
}
verify(200, 'Hello World!', { 'gzip' => nil }, options)
end
it 'deflate when content-encoding is identity' do
options = {
'response_headers' => {
'content-type' => 'text/plain',
'content-encoding' => 'identity'
}
}
verify(200, 'Hello World!', deflate_or_gzip, options)
end
it "deflate if content-type matches :include" do
options = {
'response_headers' => {
'content-type' => 'text/plain'
},
'deflater_options' => {
include: %w(text/plain)
}
}
verify(200, 'Hello World!', 'gzip', options)
end
it "deflate if content-type is included it :include" do
options = {
'response_headers' => {
'content-type' => 'text/plain; charset=us-ascii'
},
'deflater_options' => {
include: %w(text/plain)
}
}
verify(200, 'Hello World!', 'gzip', options)
end
it "not deflate if content-type is not set but given in :include" do
options = {
'deflater_options' => {
include: %w(text/plain)
}
}
verify(304, 'Hello World!', { 'gzip' => nil }, options)
end
it "not deflate if content-type do not match :include" do
options = {
'response_headers' => {
'content-type' => 'text/plain'
},
'deflater_options' => {
include: %w(text/json)
}
}
verify(200, 'Hello World!', { 'gzip' => nil }, options)
end
it "not deflate if content-length is 0" do
options = {
'response_headers' => {
'content-length' => '0'
},
}
verify(200, '', { 'gzip' => nil }, options)
end
it "deflate response if :if lambda evaluates to true" do
options = {
'deflater_options' => {
if: lambda { |env, status, headers, body| true }
}
}
verify(200, 'Hello World!', deflate_or_gzip, options)
end
it "not deflate if :if lambda evaluates to false" do
options = {
'deflater_options' => {
if: lambda { |env, status, headers, body| false }
}
}
verify(200, 'Hello World!', { 'gzip' => nil }, options)
end
it "check for content-length via :if" do
response = 'Hello World!'
response_len = response.length
options = {
'response_headers' => {
'content-length' => response_len.to_s
},
'deflater_options' => {
if: lambda { |env, status, headers, body|
headers['content-length'].to_i >= response_len
}
}
}
verify(200, response, 'gzip', options)
end
it 'will honor sync: false to avoid unnecessary flushing' do
app_body = Object.new
class << app_body
def each
(0..20).each { |i| yield "hello\n" }
end
end
options = {
'deflater_options' => { sync: false },
'app_body' => app_body,
'skip_body_verify' => true,
}
verify(200, app_body, deflate_or_gzip, options) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
buf = ''.dup
raw_bytes = 0
inflater = auto_inflater
body.each do |part|
raw_bytes += part.bytesize
buf << inflater.inflate(part)
end
buf << inflater.finish
expect = "hello\n" * 21
buf.must_equal expect
raw_bytes.must_be(:<, expect.bytesize)
end
end
it 'will honor sync: false to avoid unnecessary flushing when deflating files' do
content = File.binread(__FILE__)
options = {
'deflater_options' => { sync: false },
'app_body' => File.open(__FILE__),
'skip_body_verify' => true,
}
verify(200, content, deflate_or_gzip, options) do |status, headers, body|
headers.must_equal({
'content-encoding' => 'gzip',
'vary' => 'Accept-Encoding',
'content-type' => 'text/plain'
})
buf = ''.dup
raw_bytes = 0
inflater = auto_inflater
body.each do |part|
raw_bytes += part.bytesize
buf << inflater.inflate(part)
end
buf << inflater.finish
buf.must_equal content
raw_bytes.must_be(:<, content.bytesize)
end
end
it 'does not close the response body prematurely' do
app_body = Class.new do
attr_reader :closed;
def each; yield('foo'); yield('bar'); end;
def close; @closed = true; end;
end.new
verify(200, 'foobar', deflate_or_gzip, { 'app_body' => app_body }) do |status, headers, body|
assert_nil app_body.closed
end
end
end
|