Add Lower Level (Complete) HTTP Request/Response API
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先查看 WIT 接口以及 stubs/wit_world/imports/http_req.py、http_resp.py、http_downstream.py 和 http_body.py 中指定的 stub。然后检查现有的 SDK wrapper 和 Viceroy 的 @on_viceroy 测试支持。当这里描述的 Request、Response、Headers、Body 和 downstream 元数据 API 已实现,并且涵盖列出的 HTTP 操作和流式行为时,即视为完成。
由索引模型根据 Issue 内容生成。
描述
Overview
Add low-level HTTP Request and Response wrappers for advanced use cases requiring direct control over HTTP primitives, streaming, and Fastly-specific features.
Context - What exists:
- ✅ WSGI adapter - Run Flask/Bottle apps unmodified
- ✅ requests facade - Client API for making backend calls (
requests.get(), etc.) - ❌ Low-level Request/Response API - This issue
What this enables:
- Streaming/proxying without buffering entire request/response bodies
- Access to Fastly-specific metadata (TLS fingerprints, client IP, compliance region)
- Request transformation (modify incoming request, send to backend)
- Cache control and surrogate key management
- Foundation for other SDK features (cache, security, image optimizer APIs)
When to use what:
| Use Case | Use This | Not This |
|---|---|---|
| Run Flask app | WSGI adapter | This |
| Make API calls from app | requests.get() |
This |
| Proxy/stream requests | This (Request/Response) | requests facade |
| Need TLS/IP metadata | This (Request.downstream) | WSGI |
| Cache override/surrogate keys | This | requests facade |
WIT Interface
interface http-req {
use types.{error};
use http-types.{http-version};
use http-resp.{response};
use http-body.{body};
use backend.{backend};
resource request {
new: static func() -> result<request, error>;
set-cache-override: func(cache-override: cache-override) -> result<_, error>;
get-header-names: func(max-len: u64, cursor: u32) -> result<tuple<string, option<u32>>, error>;
get-header-value: func(name: string, max-len: u64) -> result<option<list<u8>>, error>;
get-header-values: func(name: string, max-len: u64, cursor: u32) -> result<tuple<list<u8>, option<u32>>, error>;
set-header-values: func(name: string, values: list<u8>) -> result<_, error>;
get-method: func(max-len: u64) -> result<string, error>;
set-method: func(method: string) -> result<_, error>;
get-uri: func(max-len: u64) -> result<string, error>;
set-uri: func(uri: string) -> result<_, error>;
get-version: func() -> result<http-version, error>;
set-version: func(version: http-version) -> result<_, error>;
send: func(backend: borrow<backend>, body: body) -> result<response, error>;
}
}
interface http-resp {
use types.{error};
use http-types.{http-version};
use http-body.{body};
resource response {
new: static func() -> result<response, error>;
get-status: func() -> result<u16, error>;
set-status: func(status: u16) -> result<_, error>;
get-version: func() -> result<http-version, error>;
set-version: func(version: http-version) -> result<_, error>;
get-header-names: func(max-len: u64, cursor: u32) -> result<tuple<string, option<u32>>, error>;
get-header-value: func(name: string, max-len: u64) -> result<option<list<u8>>, error>;
get-header-values: func(name: string, max-len: u64, cursor: u32) -> result<tuple<list<u8>, option<u32>>, error>;
set-header-values: func(name: string, values: list<u8>) -> result<_, error>;
send-downstream: func(body: body, streaming: bool) -> result<_, error>;
}
}
interface http-downstream {
use types.{ip-address, error};
use http-req.{request};
downstream-client-ip-addr: func(ds-request: borrow<request>) -> option<ip-address>;
downstream-server-ip-addr: func(ds-request: borrow<request>) -> option<ip-address>;
downstream-client-request-id: func(ds-request: borrow<request>, max-len: u64) -> result<string, error>;
downstream-tls-cipher-openssl-name: func(ds-request: borrow<request>, max-len: u64) -> result<option<list<u8>>, error>;
downstream-tls-protocol: func(ds-request: borrow<request>, max-len: u64) -> result<option<list<u8>>, error>;
downstream-tls-ja3-md5: func(ds-request: borrow<request>) -> result<option<list<u8>>, error>;
downstream-tls-ja4: func(ds-request: borrow<request>, max-len: u64) -> result<option<string>, error>;
}
WIT bindings: stubs/wit_world/imports/http_req.py, http_resp.py, http_downstream.py, http_body.py
API Design
Core types:
Request- Wrapshttp_req.Requestwith Pythonic API (properties for method, uri, version)Response- Wrapshttp_resp.ResponseHeaders- Dict-like interface for header manipulationBody-io.IOBase-compatible for streaming (useshutil.copyfileobj(), etc.)
Key features:
- Downstream metadata via
request.downstreamaccessor:client_ip()→IPv4Address | IPv6Addresstls_cipher(),tls_ja3_md5(),tls_ja4()→ TLS fingerprintscompliance_region()→ GDPR/data residency region
- Cache control:
request.set_cache_override(ttl=..., surrogate_key=...) - Backend requests:
request.send(backend, body)→Response - Streaming: Bodies are file-like objects, work with stdlib
Example - Proxying with transformation:
def handle(incoming_req, incoming_body):
# Access metadata
client_ip = incoming_req.downstream.client_ip()
# Transform request
incoming_req.headers['X-Forwarded-For'] = str(client_ip)
incoming_req.set_cache_override(ttl=3600, surrogate_key='user-data')
# Send to backend (streaming)
response = incoming_req.send('origin', incoming_body)
return response
Integration with Existing SDK
WSGI Adapter
Can wrap incoming WIT request in Request object and expose via environ['fastly.request']:
from flask import Flask, request
@app.route("/api/data")
def get_data():
fastly_req = request.environ['fastly.request']
client_ip = fastly_req.downstream.client_ip()
return {"client_ip": str(client_ip)}
Requests Facade
The requests.get() / requests.post() API is for making outgoing requests (client use case). It should NOT be extended for proxying - that's what this low-level API is for.
Clear separation:
- Client pattern (outgoing): Use
requests.get(url)- builds request from scratch - Server/Proxy pattern (incoming): Use
Request/ResponseAPI - transforms received request
The requests facade could use Request wrappers internally but public API stays the same.
Cross-SDK Comparison:
- Rust:
Request/Responsetypes wrapping HTTP standard types. Methods for headers, body streams, methods, URLs. Rich builder patterns. Strongly typed. - Go: Standard
*http.Request/*http.Responsefrom stdlib with Fastly extensions via embedded fields/methods. - JS: Standard
Request/Responsefrom Fetch API with Fastly extensions.
Recommended approach: Python should provide standard library-compatible types (similar to requests or urllib) while adding Fastly-specific extensions.
Viceroy Testing
Viceroy supports HTTP request/response handling with full metadata access in tests. The @on_viceroy decorator can provide synthetic requests with headers, bodies, and metadata.
Tests can verify:
- Request/response creation and manipulation
- Header handling (case-insensitive, multi-value)
- Body streaming and reading
- Downstream metadata access (may have defaults for TLS info in Viceroy)
HTTP operations are well-supported in Viceroy testing.
Reference
- 主要语言
- Python
- 星标
- 5
- 派生
- 1
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
fastly/compute-sdk-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
fastly/compute-sdk-python#116 ·
-
难度 4/5 3-5 天 新手友好度 35/100
fastly/compute-sdk-python#98 ·
-
难度 5/5 一周以上 新手友好度 35/100
fastly/compute-sdk-python#74 ·
-
难度 5/5 一周以上 新手友好度 35/100
fastly/compute-sdk-python#61 ·
-
fastly/compute-sdk-python#60 · 已指派 1 人 ·
查看 fastly/compute-sdk-python 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 86/100
browser-use/browser-use#5905 ·
-
type: enhancement
难度 2/5 1-3 小时 新手友好度 68/100
ynput/ayon-python-api#363 ·
-
bug needs triage
难度 2/5 1-3 小时 新手友好度 88/100
modelscope/FunASR#3728 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
open-compass/opencompass#2655 ·