feat: add timeout and keep alive (#1220)

* feat: add timeout and keep alive params

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: sansyrox

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "robyn"
-version = "0.71.4"
+version = "0.72.0"
 authors = ["Sanskar Jethi <[email protected]>"]
 edition = "2021"
 description = "Robyn is a Super Fast Async Python Web Framework with a Rust runtime."

Cargo.toml

@@ -288,6 +288,10 @@ export const navigation = [
         href: '/documentation/en/api_reference/scaling',
         title: 'Scaling the Application',
       },
+      {
+        href: '/documentation/en/api_reference/timeout_configuration',
+        title: 'Timeout Configuration',
+      },
       {
         href: '/documentation/en/api_reference/advanced_features',
         title: 'Advanced Features',
@@ -455,6 +459,7 @@ const translations = {
       Websockets: 'Websockets',
       Exceptions: 'Exceptions',
       'Scaling the Application': 'Scaling the Application',
+      'Timeout Configuration': 'Timeout Configuration',
       'Advanced Features': 'Advanced Features',
       'Advanced Routing': 'Advanced Routing',
       'Architecture Deep Dive': 'Architecture Deep Dive',
@@ -500,6 +505,7 @@ const translations = {
       'Server-Sent Events': '服务器发送事件',
       'Exceptions': '异常处理',
       'Scaling the Application': '多核扩展',
+      'Timeout Configuration': '超时配置',
       'Advanced Features': '高级特性',
       'Advanced Routing': '高级路由',
       'Architecture Deep Dive': '架构深度剖析',

docs_src/src/components/documentation/Navigation.jsx

@@ -0,0 +1,168 @@
+export const description =
+  'Configure timeout settings to handle high-concurrency scenarios and prevent resource exhaustion.'
+
+# Timeout Configuration
+
+Robyn supports comprehensive timeout configuration to handle high-concurrency scenarios and prevent resource exhaustion like the "Too many open files" error. {{ className: 'lead' }}
+
+## Configuration Options
+
+### Method Parameters
+
+Configure timeouts directly in the `app.start()` method:
+
+```python
+from robyn import Robyn
+
+app = Robyn(__file__)
+
+@app.get("/")
+async def hello(request):
+    return "Hello, world!"
+
+# Configure timeout settings
+app.start(
+    host="0.0.0.0", 
+    port=8080,
+    client_timeout=30,          # Client connection timeout (seconds)
+    keep_alive_timeout=20       # Keep-alive timeout (seconds)
+)
+```
+
+### Environment Variables
+
+Override configuration using environment variables:
+
+```bash
+# Set timeout configurations
+export ROBYN_CLIENT_TIMEOUT=45
+export ROBYN_KEEP_ALIVE_TIMEOUT=30
+
+# Start your application
+python app.py
+```
+
+## Configuration Parameters
+
+| Parameter | Default | Description | Environment Variable |
+|-----------|---------|-------------|---------------------|
+| `client_timeout` | 30 | Maximum time (seconds) for client request processing | `ROBYN_CLIENT_TIMEOUT` |
+| `keep_alive_timeout` | 20 | Time (seconds) to keep idle connections alive | `ROBYN_KEEP_ALIVE_TIMEOUT` |
+
+## Usage Examples
+
+### Basic Configuration
+
+```python
+# Minimal timeout configuration
+app.start(client_timeout=30)
+```
+
+### High-Traffic Production Setup
+
+```python
+# Optimized for high-traffic scenarios
+app.start(
+    host="0.0.0.0",
+    port=8080,
+    client_timeout=60,      # Allow longer processing time
+    keep_alive_timeout=15   # Shorter keep-alive for faster turnover
+)
+```
+
+### Development Setup
+
+```python
+# Development-friendly settings
+app.start(
+    client_timeout=300,     # Long timeout for debugging
+    keep_alive_timeout=60   # Longer keep-alive for testing
+)
+```
+
+### Load Testing Configuration
+
+```python
+# Optimized for load testing with tools like wrk
+app.start(
+    client_timeout=10,      # Quick timeouts
+    keep_alive_timeout=5    # Fast connection turnover
+)
+```
+
+## Environment Variable Priority
+
+Environment variables take precedence over method parameters:
+
+```python
+# This will use ROBYN_CLIENT_TIMEOUT=60 if set, otherwise 30
+app.start(client_timeout=30)
+```
+
+## Troubleshooting
+
+### "Too Many Open Files" Error
+
+If you encounter file descriptor exhaustion:
+
+1. **Increase system limits:**
+   ```bash
+   ulimit -n 65536
+   ```
+
+2. **Optimize timeout settings:**
+   ```python
+   app.start(
+       client_timeout=15,      # Shorter timeouts
+       keep_alive_timeout=5    # Faster connection cleanup
+   )
+   ```
+
+3. **Use environment variables for deployment:**
+   ```bash
+   export ROBYN_CLIENT_TIMEOUT=15
+   export ROBYN_KEEP_ALIVE_TIMEOUT=5
+   ```
+
+### Performance Tuning
+
+**For high-throughput APIs:**
+- Lower `keep_alive_timeout` (5-15s)
+- Moderate `client_timeout` (15-30s)
+
+**For long-running operations:**
+- Higher `client_timeout` (60-300s)
+- Standard `keep_alive_timeout` (20-30s)
+
+
+## Best Practices
+
+1. **Always set explicit timeouts** in production
+2. **Use environment variables** for deployment-specific configuration
+3. **Test timeout settings** with realistic load patterns
+4. **Start with conservative values** and tune based on metrics
+
+## Migration Guide
+
+### From Previous Versions
+
+If upgrading from earlier Robyn versions, the default behavior changes:
+
+**Before (infinite timeout):**
+```python
+# Previously: no timeout (could cause resource exhaustion)
+app.start(host="0.0.0.0", port=8080)
+```
+
+**After (sensible defaults):**
+```python
+# Now: automatic 30s client timeout, 20s keep-alive
+app.start(host="0.0.0.0", port=8080)
+# Equivalent to:
+app.start(
+    host="0.0.0.0", 
+    port=8080,
+    client_timeout=30,
+    keep_alive_timeout=20
+)
+```

docs_src/src/pages/documentation/en/api_reference/timeout_configuration.mdx

@@ -0,0 +1,178 @@
+export const description =
+  '配置超时设置以处理高并发场景并防止资源耗尽。'
+
+# 超时配置
+
+Robyn 支持全面的超时配置，以处理高并发场景并防止资源耗尽，如"打开文件过多"错误。 {{ className: 'lead' }}
+
+## 配置选项
+
+### 方法参数
+
+直接在 `app.start()` 方法中配置超时：
+
+```python
+from robyn import Robyn
+
+app = Robyn(__file__)
+
+@app.get("/")
+async def hello(request):
+    return "Hello, world!"
+
+# 配置超时设置
+app.start(
+    host="0.0.0.0", 
+    port=8080,
+    client_timeout=30,          # 客户端连接超时（秒）
+    keep_alive_timeout=20,      # 保持连接超时（秒）
+)
+```
+
+### 环境变量
+
+使用环境变量覆盖配置：
+
+```bash
+# 设置超时配置
+export ROBYN_CLIENT_TIMEOUT=45
+export ROBYN_KEEP_ALIVE_TIMEOUT=30
+
+# 启动应用程序
+python app.py
+```
+
+## 配置参数
+
+| 参数 | 默认值 | 描述 | 环境变量 |
+|------|-------|------|---------|
+| `client_timeout` | 30 | 客户端请求处理的最大时间（秒） | `ROBYN_CLIENT_TIMEOUT` |
+| `keep_alive_timeout` | 20 | 保持空闲连接的时间（秒） | `ROBYN_KEEP_ALIVE_TIMEOUT` |
+
+## 使用示例
+
+### 基本配置
+
+```python
+# 最小超时配置
+app.start(client_timeout=30)
+```
+
+### 高流量生产设置
+
+```python
+# 针对高流量场景优化
+app.start(
+    host="0.0.0.0",
+    port=8080,
+    client_timeout=60,      # 允许更长的处理时间
+    keep_alive_timeout=15,  # 更短的保持连接以加快周转
+)
+```
+
+### 开发设置
+
+```python
+# 开发友好设置
+app.start(
+    client_timeout=300,     # 调试的长超时
+    keep_alive_timeout=60,  # 测试的长保持连接
+)
+```
+
+### 负载测试配置
+
+```python
+# 针对 wrk 等工具的负载测试优化
+app.start(
+    client_timeout=10,      # 快速超时
+    keep_alive_timeout=5,   # 快速连接周转
+)
+```
+
+## 环境变量优先级
+
+环境变量优先于方法参数：
+
+```python
+# 如果设置了 ROBYN_CLIENT_TIMEOUT=60，将使用 60，否则使用 30
+app.start(client_timeout=30)
+```
+
+## 故障排除
+
+### "打开文件过多"错误
+
+如果遇到文件描述符耗尽：
+
+1. **增加系统限制：**
+   ```bash
+   ulimit -n 65536
+   ```
+
+2. **优化超时设置：**
+   ```python
+   app.start(
+       client_timeout=15,      # 更短的超时
+       keep_alive_timeout=5,   # 更快的连接清理
+   )
+   ```
+
+3. **在部署中使用环境变量：**
+   ```bash
+   export ROBYN_CLIENT_TIMEOUT=15
+   export ROBYN_KEEP_ALIVE_TIMEOUT=5
+      ```
+
+### 性能调优
+
+**对于高吞吐量 API：**
+- 较低的 `keep_alive_timeout` (5-15秒)
+- 中等的 `client_timeout` (15-30秒)
+
+**对于长时间运行的操作：**
+- 较高的 `client_timeout` (60-300秒)
+- 标准的 `keep_alive_timeout` (20-30秒)
+
+## 与其他框架的比较
+
+| 框架 | 默认客户端超时 | 默认保持连接 | 配置方式 |
+|-----|--------------|-------------|----------|
+| **Robyn** | 30秒 | 20秒 | 方法参数 + 环境变量 |
+| Uvicorn | 无 | 20秒 | 构造函数参数 |
+| Express.js | 120秒 | 5秒 | 方法链式调用 |
+| Django/Gunicorn | 30秒 | 不适用 | 配置文件 |
+| Flask/Gunicorn | 30秒 | 2秒 | 命令行选项 |
+
+## 最佳实践
+
+1. **在生产环境中始终设置明确的超时**
+2. **使用环境变量进行特定部署的配置**
+3. **在负载下监控文件描述符使用**
+4. **用现实负载模式测试超时设置**
+5. **从保守值开始，根据指标进行调优**
+
+## 迁移指南
+
+### 从早期版本
+
+如果从早期 Robyn 版本升级，默认行为会改变：
+
+**之前（无限超时）：**
+```python
+# 以前：无超时（可能导致资源耗尽）
+app.start(host="0.0.0.0", port=8080)
+```
+
+**之后（合理默认值）：**
+```python
+# 现在：自动 30秒 客户端超时，20秒 保持连接
+app.start(host="0.0.0.0", port=8080)
+# 等价于：
+app.start(
+    host="0.0.0.0", 
+    port=8080,
+    client_timeout=30,
+    keep_alive_timeout=20,
+)
+```