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
|
from __future__ import annotations
from io import BytesIO
from typing import TYPE_CHECKING, Any, Literal
from litestar.datastructures import Headers, MutableScopeHeaders
from litestar.enums import CompressionEncoding, ScopeType
from litestar.middleware.base import AbstractMiddleware
from litestar.middleware.compression.gzip_facade import GzipCompression
from litestar.utils.empty import value_or_default
from litestar.utils.scope.state import ScopeState
if TYPE_CHECKING:
from litestar.config.compression import CompressionConfig
from litestar.middleware.compression.facade import CompressionFacade
from litestar.types import (
ASGIApp,
HTTPResponseStartEvent,
Message,
Receive,
Scope,
Send,
)
try:
from brotli import Compressor
except ImportError:
Compressor = Any
class CompressionMiddleware(AbstractMiddleware):
"""Compression Middleware Wrapper.
This is a wrapper allowing for generic compression configuration / handler middleware
"""
def __init__(self, app: ASGIApp, config: CompressionConfig) -> None:
"""Initialize ``CompressionMiddleware``
Args:
app: The ``next`` ASGI app to call.
config: An instance of CompressionConfig.
"""
super().__init__(
app=app, exclude=config.exclude, exclude_opt_key=config.exclude_opt_key, scopes={ScopeType.HTTP}
)
self.config = config
async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
"""ASGI callable.
Args:
scope: The ASGI connection scope.
receive: The ASGI receive function.
send: The ASGI send function.
Returns:
None
"""
accept_encoding = Headers.from_scope(scope).get("accept-encoding", "")
config = self.config
if config.compression_facade.encoding in accept_encoding:
await self.app(
scope,
receive,
self.create_compression_send_wrapper(
send=send, compression_encoding=config.compression_facade.encoding, scope=scope
),
)
return
if config.gzip_fallback and CompressionEncoding.GZIP in accept_encoding:
await self.app(
scope,
receive,
self.create_compression_send_wrapper(
send=send, compression_encoding=CompressionEncoding.GZIP, scope=scope
),
)
return
await self.app(scope, receive, send)
def create_compression_send_wrapper(
self,
send: Send,
compression_encoding: Literal[CompressionEncoding.BROTLI, CompressionEncoding.GZIP] | str,
scope: Scope,
) -> Send:
"""Wrap ``send`` to handle brotli compression.
Args:
send: The ASGI send function.
compression_encoding: The compression encoding used.
scope: The ASGI connection scope
Returns:
An ASGI send function.
"""
bytes_buffer = BytesIO()
facade: CompressionFacade
# We can't use `self.config.compression_facade` directly if the compression is `gzip` since
# it may be being used as a fallback.
if compression_encoding == CompressionEncoding.GZIP:
facade = GzipCompression(buffer=bytes_buffer, compression_encoding=compression_encoding, config=self.config)
else:
facade = self.config.compression_facade(
buffer=bytes_buffer, compression_encoding=compression_encoding, config=self.config
)
initial_message: HTTPResponseStartEvent | None = None
started = False
connection_state = ScopeState.from_scope(scope)
async def send_wrapper(message: Message) -> None:
"""Handle and compresses the HTTP Message with brotli.
Args:
message (Message): An ASGI Message.
"""
nonlocal started
nonlocal initial_message
if message["type"] == "http.response.start":
initial_message = message
return
if initial_message is not None and value_or_default(connection_state.is_cached, False):
await send(initial_message)
await send(message)
return
if initial_message and message["type"] == "http.response.body":
body = message["body"]
more_body = message.get("more_body")
if not started:
started = True
if more_body:
headers = MutableScopeHeaders(initial_message)
headers["Content-Encoding"] = compression_encoding
headers.extend_header_value("vary", "Accept-Encoding")
del headers["Content-Length"]
connection_state.response_compressed = True
facade.write(body)
message["body"] = bytes_buffer.getvalue()
bytes_buffer.seek(0)
bytes_buffer.truncate()
await send(initial_message)
await send(message)
elif len(body) >= self.config.minimum_size:
facade.write(body)
facade.close()
body = bytes_buffer.getvalue()
headers = MutableScopeHeaders(initial_message)
headers["Content-Encoding"] = compression_encoding
headers["Content-Length"] = str(len(body))
headers.extend_header_value("vary", "Accept-Encoding")
message["body"] = body
connection_state.response_compressed = True
await send(initial_message)
await send(message)
else:
await send(initial_message)
await send(message)
else:
facade.write(body)
if not more_body:
facade.close()
message["body"] = bytes_buffer.getvalue()
bytes_buffer.seek(0)
bytes_buffer.truncate()
if not more_body:
bytes_buffer.close()
await send(message)
return send_wrapper
|
