File: http2_app.py

package info (click to toggle)
gunicorn 25.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,048 kB
  • sloc: python: 43,889; sh: 285; javascript: 54; makefile: 38
file content (270 lines) | stat: -rw-r--r-- 8,660 bytes parent folder | download
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
#
# This file is part of gunicorn released under the MIT license.
# See the NOTICE for more information.

"""
HTTP/2 ASGI application demonstrating priority and trailers.

This example shows how to:
- Access stream priority information from HTTP/2 requests
- Send response trailers (useful for gRPC, checksums, etc.)

Run with:
    cd examples/http2_features
    docker compose up --build

Test with:
    python test_http2.py

Or manually:
    curl -k --http2 https://localhost:8443/
    curl -k --http2 https://localhost:8443/priority
    curl -k --http2 https://localhost:8443/trailers
"""

import json
import hashlib


async def app(scope, receive, send):
    """ASGI application demonstrating HTTP/2 priority and trailers."""

    if scope["type"] == "lifespan":
        await handle_lifespan(scope, receive, send)
    elif scope["type"] == "http":
        await handle_http(scope, receive, send)
    else:
        raise ValueError(f"Unknown scope type: {scope['type']}")


async def handle_lifespan(scope, receive, send):
    """Handle lifespan events (startup/shutdown)."""
    while True:
        message = await receive()
        if message["type"] == "lifespan.startup":
            print("HTTP/2 features app starting...")
            await send({"type": "lifespan.startup.complete"})
        elif message["type"] == "lifespan.shutdown":
            print("HTTP/2 features app shutting down...")
            await send({"type": "lifespan.shutdown.complete"})
            return


async def handle_http(scope, receive, send):
    """Route HTTP requests to handlers."""
    path = scope["path"]
    method = scope["method"]

    if path == "/" and method == "GET":
        await handle_index(scope, receive, send)
    elif path == "/priority" and method == "GET":
        await handle_priority(scope, receive, send)
    elif path == "/trailers" and method in ("GET", "POST"):
        await handle_trailers(scope, receive, send)
    elif path == "/combined" and method in ("GET", "POST"):
        await handle_combined(scope, receive, send)
    elif path == "/health" and method == "GET":
        await send_response(send, 200, b"OK")
    else:
        await send_response(send, 404, b"Not Found\n")


async def handle_index(scope, receive, send):
    """Show available endpoints and HTTP/2 features."""
    extensions = scope.get("extensions", {})
    http_version = scope.get("http_version", "1.1")

    info = {
        "message": "HTTP/2 Features Demo",
        "http_version": http_version,
        "endpoints": {
            "/": "This info page",
            "/priority": "Shows stream priority information",
            "/trailers": "Demonstrates response trailers with checksum",
            "/combined": "Shows both priority and trailers",
            "/health": "Health check endpoint",
        },
        "extensions": list(extensions.keys()),
    }

    body = json.dumps(info, indent=2).encode() + b"\n"
    await send_response(send, 200, body, content_type=b"application/json")


async def handle_priority(scope, receive, send):
    """Return stream priority information.

    HTTP/2 allows clients to indicate relative importance of requests.
    Gunicorn exposes this through the http.response.priority extension.
    """
    extensions = scope.get("extensions", {})
    priority_info = extensions.get("http.response.priority")

    if priority_info:
        response = {
            "http_version": scope.get("http_version", "1.1"),
            "priority": {
                "weight": priority_info["weight"],
                "depends_on": priority_info["depends_on"],
                "description": (
                    f"Weight {priority_info['weight']}/256 - "
                    f"{'high' if priority_info['weight'] > 128 else 'normal' if priority_info['weight'] > 64 else 'low'} priority"
                ),
            },
            "note": "Priority is advisory - use for scheduling hints",
        }
    else:
        response = {
            "http_version": scope.get("http_version", "1.1"),
            "priority": None,
            "note": "Priority information only available for HTTP/2 requests",
        }

    body = json.dumps(response, indent=2).encode() + b"\n"
    await send_response(send, 200, body, content_type=b"application/json")


async def handle_trailers(scope, receive, send):
    """Demonstrate response trailers.

    Trailers are headers sent after the response body.
    Common uses: gRPC status codes, checksums, timing info.
    """
    extensions = scope.get("extensions", {})
    supports_trailers = "http.response.trailers" in extensions

    # Read request body if POST
    body_data = b""
    if scope["method"] == "POST":
        body_data = await read_body(receive)

    # Generate response
    response_body = body_data if body_data else b"Hello from HTTP/2 with trailers!\n"

    # Calculate checksum for trailer
    checksum = hashlib.md5(response_body).hexdigest()

    if supports_trailers:
        # Send response announcing trailers
        await send({
            "type": "http.response.start",
            "status": 200,
            "headers": [
                (b"content-type", b"application/octet-stream"),
                (b"trailer", b"content-md5, x-processing-time"),
            ],
        })

        # Send body
        await send({
            "type": "http.response.body",
            "body": response_body,
            "more_body": False,
        })

        # Send trailers
        await send({
            "type": "http.response.trailers",
            "headers": [
                (b"content-md5", checksum.encode()),
                (b"x-processing-time", b"42ms"),
            ],
        })
    else:
        # HTTP/1.1 fallback - include checksum in regular headers
        response = {
            "message": "Trailers not supported (HTTP/1.1)",
            "data": response_body.decode("utf-8", errors="replace"),
            "checksum_in_header": checksum,
        }
        body = json.dumps(response, indent=2).encode() + b"\n"
        await send_response(
            send, 200, body,
            content_type=b"application/json",
            extra_headers=[(b"x-checksum", checksum.encode())]
        )


async def handle_combined(scope, receive, send):
    """Show both priority and trailers in one response.

    This demonstrates a realistic scenario like gRPC where
    priority affects scheduling and trailers carry status.
    """
    extensions = scope.get("extensions", {})
    priority_info = extensions.get("http.response.priority")
    supports_trailers = "http.response.trailers" in extensions

    # Build response showing all HTTP/2 features
    response = {
        "http_version": scope.get("http_version", "1.1"),
        "priority": None,
        "trailers_supported": supports_trailers,
    }

    if priority_info:
        response["priority"] = {
            "weight": priority_info["weight"],
            "depends_on": priority_info["depends_on"],
        }

    response_body = json.dumps(response, indent=2).encode() + b"\n"
    checksum = hashlib.md5(response_body).hexdigest()

    if supports_trailers:
        # Full HTTP/2 response with trailers
        await send({
            "type": "http.response.start",
            "status": 200,
            "headers": [
                (b"content-type", b"application/json"),
                (b"trailer", b"content-md5, x-status"),
            ],
        })

        await send({
            "type": "http.response.body",
            "body": response_body,
            "more_body": False,
        })

        await send({
            "type": "http.response.trailers",
            "headers": [
                (b"content-md5", checksum.encode()),
                (b"x-status", b"success"),
            ],
        })
    else:
        await send_response(send, 200, response_body, content_type=b"application/json")


async def send_response(send, status, body, content_type=b"text/plain", extra_headers=None):
    """Send a simple HTTP response."""
    headers = [
        (b"content-type", content_type),
        (b"content-length", str(len(body)).encode()),
    ]
    if extra_headers:
        headers.extend(extra_headers)

    await send({
        "type": "http.response.start",
        "status": status,
        "headers": headers,
    })
    await send({
        "type": "http.response.body",
        "body": body,
    })


async def read_body(receive):
    """Read the full request body."""
    body = b""
    while True:
        message = await receive()
        body += message.get("body", b"")
        if not message.get("more_body", False):
            break
    return body