update wsgi to support big body

.github/ISSUE_TEMPLATE/1-question.md

@@ -0,0 +1,17 @@
+---
+name: Question
+about: Ask a question
+---
+
+### Checklist
+
+<!-- To help keep this issue tracker clean and focused, please make sure you tried *all* the following resources before submitting your question. -->
+
+- [ ] I searched the [Uvicorn documentation](https://www.uvicorn.org/) but couldn't find what I'm looking for.
+- [ ] I looked through similar issues on GitHub, but didn't find anything.
+- [ ] I looked up "How to do ... in Uvicorn" on a search engine and didn't find any information.
+- [ ] I asked the [community chat](https://gitter.im/encode/community) for help.
+
+### Question
+
+<!-- Please ask your question here. -->

.github/ISSUE_TEMPLATE/2-bug-report.md

@@ -0,0 +1,53 @@
+---
+name: Bug report
+about: Report a bug to help improve this project
+---
+
+### Checklist
+
+<!-- Please make sure you check all these items before submitting your bug report. -->
+
+- [ ] The bug is reproducible against the latest release and/or `master`.
+- [ ] There are no similar issues or pull requests to fix it yet.
+
+### Describe the bug
+
+<!-- A clear and concise description of what the bug is. -->
+
+### To reproduce
+
+<!-- Provide a *minimal* example with steps to reproduce the bug locally.
+
+NOTE: try to keep any external dependencies *at an absolute minimum* .
+In other words, remove anything that doesn't make the bug go away.
+
+-->
+
+### Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+### Actual behavior
+
+<!-- A clear and concise description of what actually happens. -->
+
+### Debugging material
+
+<!-- Any tracebacks, screenshots, etc. that can help understanding the problem.
+
+NOTE:
+- Please list tracebacks in full (don't truncate them).
+- If relevant, consider turning on DEBUG or TRACE logs for additional details (see the Logging section on https://www.uvicorn.org/settings/ specifically the `log-level` flag).
+- Consider using `<details>` to make tracebacks/logs collapsible if they're very large (see https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d).
+-->
+
+### Environment
+
+- OS / Python / Uvicorn version: just run `uvicorn --version`
+- The exact command you're running uvicorn with, all flags you passed included. If you run it with gunicorn please do the same. If there is a reverse-proxy involved and you cannot reproduce without it please give the minimal config of it to reproduce.
+
+### Additional context
+
+<!-- Any additional information that can help understanding the problem.
+
+Eg. linked issues, or a description of what you were trying to achieve. -->

.github/ISSUE_TEMPLATE/3-feature-request.md

@@ -0,0 +1,33 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+---
+
+### Checklist
+
+<!-- Please make sure you check all these items before submitting your feature request. -->
+
+- [ ] There are no similar issues or pull requests for this yet.
+- [ ] I discussed this idea on the [community chat](https://gitter.im/encode/community) and feedback is positive.
+
+### Is your feature related to a problem? Please describe.
+
+<!-- A clear and concise description of what you are trying to achieve.
+
+Eg "I want to be able to [...] but I can't because [...]". -->
+
+## Describe the solution you would like.
+
+<!-- A clear and concise description of what you would want to happen.
+
+For API changes, try to provide a code snippet of what you would like the API to look like.
+-->
+
+## Describe alternatives you considered
+
+<!-- Please describe any alternative solutions or features you've considered to solve
+your problem and why they wouldn't solve it. -->
+
+## Additional context
+
+<!-- Provide any additional context, screenshots, tracebacks, etc. about the feature here. -->

.github/workflows/test-suite.yml

@@ -2,24 +2,27 @@
 name: Test Suite
 
 on:
+  push:
+    branches: ["master"]
   pull_request:
     branches: ["master"]
 
 jobs:
   tests:
-    name: "Python ${{ matrix.python-version }}"
-    runs-on: "ubuntu-latest"
-
+    name: "Python ${{ matrix.python-version }} ${{ matrix.os }}"
+    runs-on: "${{ matrix.os }}"
     strategy:
       matrix:
         python-version: ["3.6", "3.7", "3.8"]
-
+        os: [windows-latest, ubuntu-latest]
     steps:
       - uses: "actions/checkout@v2"
       - uses: "actions/setup-python@v1"
         with:
           python-version: "${{ matrix.python-version }}"
       - name: "Install dependencies"
         run: "scripts/install"
+        shell: bash
       - name: "Run tests"
         run: "scripts/test"
+        shell: bash

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## 0.11.8 - 2020-07-30
+
+* Fix a regression that caused Uvicorn to crash when using `--interface=wsgi`. (Pull #730)
+* Fix a regression that caused Uvicorn to crash when using unix domain sockets. (Pull #729)
+
+## 0.11.7 - 2020-28-07
+
+* SECURITY FIX: Prevent sending invalid HTTP header names and values. (Pull #725)
+* SECURITY FIX: Ensure path value is escaped before logging to the console. (Pull #724)
+* Fix `--proxy-headers` client IP and host when using a Unix socket. (Pull #636)
+
+## 0.11.6
+
+* Fix overriding the root logger.
+
 ## 0.11.5
 
 * Revert "Watch all files, not just .py" due to unexpected side effects.

docs/deployment.md

@@ -39,7 +39,7 @@ Options:
   --workers INTEGER               Number of worker processes. Defaults to the
                                   $WEB_CONCURRENCY environment variable if
                                   available. Not valid with --reload.
-  --loop [auto|asyncio|uvloop|iocp]
+  --loop [auto|asyncio|uvloop]
                                   Event loop implementation.  [default: auto]
   --http [auto|h11|httptools]     HTTP protocol implementation.  [default:
                                   auto]
@@ -87,6 +87,9 @@ Options:
                                   [default: TLSv1]
   --header TEXT                   Specify custom default HTTP response headers
                                   as a Name:Value pair
+  --app-dir TEXT                  Look for APP in the specified directory, by
+                                  adding this to the PYTHONPATH. Defaults to
+                                  the current working directory.
   --help                          Show this message and exit.
 ```
 
@@ -255,7 +258,7 @@ To run uvicorn with https, a certificate and a private key are required.
 The recommended way to get them is using [Let's Encrypt][letsencrypt].
 
 For local development with https, it's possible to use [mkcert][mkcert]
-to generate a valid certificat and private key.
+to generate a valid certificate and private key.
 
 ```bash
 $ uvicorn example:app --port 5000 --ssl-keyfile=./key.pem --ssl-certfile=./cert.pem

docs/index.md

@@ -90,7 +90,7 @@ Options:
   --workers INTEGER               Number of worker processes. Defaults to the
                                   $WEB_CONCURRENCY environment variable if
                                   available. Not valid with --reload.
-  --loop [auto|asyncio|uvloop|iocp]
+  --loop [auto|asyncio|uvloop]
                                   Event loop implementation.  [default: auto]
   --http [auto|h11|httptools]     HTTP protocol implementation.  [default:
                                   auto]

docs/settings.md

@@ -40,7 +40,7 @@ $ pip install uvicorn[watchgodreload]
 
 ## Implementation
 
-* `--loop <str>` - Set the event loop implementation. The uvloop implementation provides greater performance, but is not compatible with Windows or PyPy. But you can use IOCP in windows. **Options:** *'auto', 'asyncio', 'uvloop', 'iocp'.* **Default:** *'auto'*.
+* `--loop <str>` - Set the event loop implementation. The uvloop implementation provides greater performance, but is not compatible with Windows or PyPy. **Options:** *'auto', 'asyncio', 'uvloop'.* **Default:** *'auto'*.
 * `--http <str>` - Set the HTTP protocol implementation. The httptools implementation provides greater performance, but it not compatible with PyPy, and requires compilation on Windows. **Options:** *'auto', 'h11', 'httptools'.* **Default:** *'auto'*.
 * `--ws <str>` - Set the WebSockets protocol implementation. Either of the `websockets` and `wsproto` packages are supported. Use `'none'` to deny all websocket requests. **Options:** *'auto', 'none', 'websockets', 'wsproto'.* **Default:** *'auto'*.
 * `--lifespan <str>` - Set the Lifespan protocol implementation. **Options:** *'auto', 'on', 'off'.* **Default:** *'auto'*.
@@ -71,7 +71,7 @@ connecting IPs in the `forwarded-allow-ips` configuration.
 
 * `--limit-concurrency <int>` - Maximum number of concurrent connections or tasks to allow, before issuing HTTP 503 responses. Useful for ensuring known memory usage patterns even under over-resourced loads.
 * `--limit-max-requests <int>` - Maximum number of requests to service before terminating the process. Useful when running together with a process manager, for preventing memory leaks from impacting long-running processes.
-* `--backlog <int>` - Maximum number of connections to hold in backlog. Relevant for heavy incoming traffic.
+* `--backlog <int>` - Maximum number of connections to hold in backlog. Relevant for heavy incoming traffic. **Default:** *2048*
 
 ## Timeouts
 

requirements_windows.txt

@@ -0,0 +1,19 @@
+click
+h11
+
+# Optional
+websockets==8.*
+wsproto==0.13.*
+
+# Testing
+autoflake
+black
+codecov
+flake8
+isort
+pytest
+pytest-cov
+requests
+
+# Efficient debug reload
+watchgod>=0.6,<0.7

scripts/install

@@ -1,9 +1,15 @@
-#!/bin/sh -e
+#!/usr/bin/env bash
+
+set -e
 
 # Use the Python executable provided from the `-p` option, or a default.
 [ "$1" = "-p" ] && PYTHON=$2 || PYTHON="python3"
 
-REQUIREMENTS="requirements.txt"
+if [ "$OSTYPE" = "linux-gnu" ]; then
+    REQUIREMENTS="requirements.txt"
+elif [ "$OSTYPE" = "msys" ]; then
+    REQUIREMENTS="requirements_windows.txt"
+fi
 VENV="venv"
 
 set -x

tests/middleware/test_wsgi.py

@@ -1,9 +1,44 @@
 import sys
+import asyncio
+from tempfile import TemporaryFile
 
 import pytest
 
 from tests.client import TestClient
-from uvicorn.middleware.wsgi import WSGIMiddleware
+from uvicorn.middleware.wsgi import WSGIMiddleware, Body
+
+
+def test_body():
+    recv_event = asyncio.Event()
+    body = Body(recv_event)
+    body.write(
+        b"""This is a body test.
+Why do this?
+To prevent memory leaks.
+And cancel pre-reading.
+Newline.0
+Newline.1
+Newline.2
+Newline.3
+"""
+    )
+    body.feed_eof()
+    assert body.readline() == b"This is a body test.\n"
+    assert body.readline(6) == b"Why do"
+    assert body.readline(20) == b" this?\n"
+
+    assert body.readlines(2) == [
+        b"To prevent memory leaks.\n",
+        b"And cancel pre-reading.\n",
+    ]
+    for index, line in enumerate(body):
+        assert line == b"Newline." + str(index).encode("utf8") + b"\n"
+        if index == 1:
+            break
+    assert body.readlines() == [
+        b"Newline.2\n",
+        b"Newline.3\n",
+    ]
 
 
 def hello_world(environ, start_response):
@@ -62,6 +97,17 @@ def test_wsgi_post():
     assert response.text == '{"example": 123}'
 
 
+def test_wsgi_post_big_file():
+    app = WSGIMiddleware(echo_body)
+    client = TestClient(app)
+    file = TemporaryFile()
+    for num in range(1000000):
+        file.write(str(num).encode("utf8"))
+    response = client.post("/", files={"file": file})
+    assert response.status_code == 200
+    assert response.content
+
+
 def test_wsgi_exception():
     # Note that we're testing the WSGI app directly here.
     # The HTTP protocol implementations would catch this error and return 500.

tests/protocols/test_http.py

@@ -674,3 +674,29 @@ def test_supported_upgrade_request(protocol_cls):
     protocol.data_received(UPGRADE_REQUEST)
 
     assert b"HTTP/1.1 426 " in protocol.transport.buffer
+
+
+async def asgi3app(scope, receive, send):
+    pass
+
+
+def asgi2app(scope):
+    async def asgi(receive, send):
+        pass
+
+    return asgi
+
+
+asgi_scope_data = [
+    (asgi3app, {"version": "3.0", "spec_version": "2.1"}),
+    (asgi2app, {"version": "2.0", "spec_version": "2.1"}),
+]
+
+
+@pytest.mark.parametrize("asgi2or3_app, expected_scopes", asgi_scope_data)
+@pytest.mark.parametrize("protocol_cls", HTTP_PROTOCOLS)
+def test_scopes(asgi2or3_app, expected_scopes, protocol_cls):
+    protocol = get_connected_protocol(asgi2or3_app, protocol_cls,)
+    protocol.data_received(SIMPLE_GET_REQUEST)
+    protocol.loop.run_one()
+    assert expected_scopes == protocol.scope.get("asgi")