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
|
# -*- encoding: utf-8 -*-
# partially based on tests in django and django-brotli
from io import BytesIO
import gzip
import random
from unittest import TestCase
import brotli
import zstandard as zstd
from django.http import (
FileResponse, HttpResponse,
StreamingHttpResponse,
)
from django.middleware.gzip import GZipMiddleware
from django.test import RequestFactory, SimpleTestCase
try:
# Python 2
range = xrange
int2byte = chr
except NameError:
# Python 3
import struct
int2byte = struct.Struct(">B").pack
from compression_middleware.middleware import CompressionMiddleware, compressor
from .utils import UTF8_LOREM_IPSUM_IN_CZECH
class FakeRequestAcceptsZstd(object):
META = {
"HTTP_ACCEPT_ENCODING": "gzip, deflate, sdch, br, zstd"
}
class FakeRequestAcceptsBrotli(object):
META = {
"HTTP_ACCEPT_ENCODING": "gzip, deflate, sdch, br"
}
class InvalidAcceptEcondingRequest(object):
META = {
"HTTP_ACCEPT_ENCODING": "text/plain,*/*; charset=utf-8"
}
class FakeLegacyRequest(object):
META = {
}
def gzip_decompress(gzipped_string):
with gzip.GzipFile(mode="rb", fileobj=BytesIO(gzipped_string)) as f:
return f.read()
class FakeResponse(object):
streaming = False
def __init__(self, content, headers=None, streaming=None):
self.content = content.encode(encoding="utf-8")
self.headers = headers or {}
if streaming:
self.streaming = streaming
def has_header(self, header):
return header in self.headers
def get(self, key):
return self.headers.get(key, None)
def __getitem__(self, header):
return self.headers[header]
def __setitem__(self, header, value):
self.headers[header] = value
class MiddlewareTestCase(TestCase):
def test_middleware_compress_response(self):
fake_request = FakeRequestAcceptsBrotli()
response_content = UTF8_LOREM_IPSUM_IN_CZECH
fake_response = FakeResponse(content=response_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
response = compression_middleware.process_response(
fake_request, fake_response
)
decompressed_response = brotli.decompress(response.content) # type: bytes
self.assertEqual(
response_content, decompressed_response.decode(encoding="utf-8")
)
self.assertEqual(response.get("Vary"), "Accept-Encoding")
def test_middleware_compress_response_zstd(self):
fake_request = FakeRequestAcceptsZstd()
response_content = UTF8_LOREM_IPSUM_IN_CZECH
fake_response = FakeResponse(content=response_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
response = compression_middleware.process_response(
fake_request, fake_response
)
cctx = zstd.ZstdDecompressor()
decompressed_response = cctx.decompress(response.content) # type: bytes
self.assertEqual(
response_content, decompressed_response.decode(encoding="utf-8")
)
self.assertEqual(response.get("Vary"), "Accept-Encoding")
def test_etag_is_updated_if_present(self):
fake_request = FakeRequestAcceptsBrotli()
response_content = UTF8_LOREM_IPSUM_IN_CZECH * 5
fake_etag_content = '"foo"'
fake_response = FakeResponse(
content=response_content, headers={"ETag": fake_etag_content}
)
self.assertEqual(fake_response["ETag"], fake_etag_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
response = compression_middleware.process_response(
fake_request, fake_response
)
decompressed_response = brotli.decompress(response.content) # type: bytes
self.assertEqual(response_content, decompressed_response.decode(encoding="utf-8"))
# note: this is where we differ from django-brotli
# django-brotli's expectation:
### self.assertEqual(response["ETag"], '"foo;br\\"')
# Django's expectation:
self.assertEqual(response["ETag"], 'W/"foo"')
def test_middleware_wont_compress_response_if_response_is_small(self):
fake_request = FakeRequestAcceptsBrotli()
response_content = "Hello World"
self.assertLess(len(response_content), 200) # a < b
fake_response = FakeResponse(content=response_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
response = compression_middleware.process_response(
fake_request, fake_response
)
self.assertEqual(
response_content, response.content.decode(encoding="utf-8")
)
self.assertFalse(response.has_header("Vary"))
self.assertEqual(response.get("Content-Encoding"), None)
def test_middleware_wont_compress_if_client_not_accept(self):
fake_request = FakeLegacyRequest()
response_content = UTF8_LOREM_IPSUM_IN_CZECH
fake_response = FakeResponse(content=response_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
response = compression_middleware.process_response(
fake_request, fake_response
)
django_gzip_middleware = GZipMiddleware(lambda: fake_response)
gzip_response = django_gzip_middleware.process_response(
fake_request, fake_response
)
self.assertEqual(
response_content, response.content.decode(encoding="utf-8")
)
self.assertEqual(response.get("Vary"), "Accept-Encoding")
self.assertEqual(response.get("Content-Encoding"), None)
def test_middleware_wont_compress_if_invalid_header(self):
"""
Test that the middleware doesn't crash if the client sends an invalid
Accept-Encoding header.
"""
fake_request = InvalidAcceptEcondingRequest()
response_content = UTF8_LOREM_IPSUM_IN_CZECH
fake_response = FakeResponse(content=response_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
response = compression_middleware.process_response(
fake_request, fake_response
)
django_gzip_middleware = GZipMiddleware(lambda: fake_response)
gzip_response = django_gzip_middleware.process_response(
fake_request, fake_response
)
self.assertEqual(
response_content, response.content.decode(encoding="utf-8")
)
self.assertEqual(
gzip_response.content.decode(encoding="utf-8"),
response.content.decode(encoding="utf-8")
)
self.assertEqual(response.get("Vary"), "Accept-Encoding")
self.assertEqual(response.get("Content-Encoding"), None)
def test_middleware_wont_compress_if_response_is_already_compressed(self):
fake_request = FakeRequestAcceptsBrotli()
response_content = UTF8_LOREM_IPSUM_IN_CZECH
fake_response = FakeResponse(content=response_content)
compression_middleware = CompressionMiddleware(lambda: fake_response)
django_gzip_middleware = GZipMiddleware(lambda: fake_response)
gzip_response = django_gzip_middleware.process_response(
fake_request, fake_response
)
response = compression_middleware.process_response(
fake_request, gzip_response
)
self.assertEqual(
response_content,
gzip_decompress(response.content).decode(encoding="utf-8")
)
self.assertEqual(response.get("Vary"), "Accept-Encoding")
def test_content_encoding_parsing(self):
self.assertEqual(compressor("")[0], None)
self.assertEqual(compressor("gzip")[0], "gzip")
self.assertEqual(compressor("br")[0], "br")
self.assertEqual(compressor("gzip, br")[0], "br")
self.assertEqual(compressor("br;q=1.0, gzip;q=0.8")[0], "br")
self.assertEqual(compressor("br;q=0, gzip;q=0.8")[0], "gzip")
self.assertEqual(compressor("bla;bla;gzip")[0], None)
self.assertEqual(compressor("text/plain,*/*; charset=utf-8")[0], None) # PR #12
self.assertEqual(compressor("gzip;q==1")[0], "gzip") # questionable
self.assertEqual(compressor("br;gzip")[0], "br") # questionable
# self.assertEqual(compressor("br;q=0, gzip;q=0.8, *;q=0.1")[0], "gzip")
self.assertEqual(compressor("*")[0], "zstd")
class StreamingTest(SimpleTestCase):
"""
Tests streaming.
"""
short_string = b"This string is too short to be worth compressing."
compressible_string = b"a" * 500
incompressible_string = b"".join(
int2byte(random.randint(0, 255)) for _ in range(500)
)
sequence = [b"a" * 500, b"b" * 200, b"a" * 300]
sequence_unicode = [u"a" * 500, u"é" * 200, u"a" * 300]
request_factory = RequestFactory()
def setUp(self):
self.req = self.request_factory.get("/")
self.req.META["HTTP_ACCEPT_ENCODING"] = "gzip, deflate, br"
self.req.META[
"HTTP_USER_AGENT"
] = "Mozilla/5.0 (Windows NT 5.1; rv:9.0.1) Gecko/20100101 Firefox/9.0.1"
self.resp = HttpResponse()
self.resp.status_code = 200
self.resp.content = self.compressible_string
self.resp["Content-Type"] = "text/html; charset=UTF-8"
self.stream_resp = StreamingHttpResponse(self.sequence)
self.stream_resp["Content-Type"] = "text/html; charset=UTF-8"
self.stream_resp_unicode = StreamingHttpResponse(self.sequence_unicode)
self.stream_resp_unicode["Content-Type"] = "text/html; charset=UTF-8"
def test_compress_streaming_response(self):
"""
Compression is performed on responses with streaming content.
"""
r = CompressionMiddleware(lambda: self.stream_resp).process_response(self.req, self.stream_resp)
self.assertEqual(brotli.decompress(b"".join(r)), b"".join(self.sequence))
self.assertEqual(r.get("Content-Encoding"), "br")
self.assertFalse(r.has_header("Content-Length"))
self.assertEqual(r.get("Vary"), "Accept-Encoding")
def test_compress_streaming_response_unicode(self):
"""
Compression is performed on responses with streaming Unicode content.
"""
r = CompressionMiddleware(lambda: self.stream_resp_unicode).process_response(
self.req, self.stream_resp_unicode
)
self.assertEqual(
brotli.decompress(b"".join(r)),
b"".join(x.encode("utf-8") for x in self.sequence_unicode)
)
self.assertEqual(r.get("Content-Encoding"), "br")
self.assertFalse(r.has_header("Content-Length"))
self.assertEqual(r.get("Vary"), "Accept-Encoding")
|
