Test client creates Request directly without WSGI environ

Rewrite RequestFactory and ClientHandler to build and accept
Request objects directly instead of going through WSGI environ
dicts. Move LimitedStream to plain.http for shared use by both
the server and test client.

Author: davegaeddert

plain-htmx/tests/test_views.py

@@ -9,21 +9,21 @@ def get(self):
 
 
 def test_is_htmx_request():
-    request = RequestFactory().get("/", HTTP_HX_REQUEST="true")
+    request = RequestFactory().get("/", headers={"HX-Request": "true"})
     view = V()
     view.setup(request)
     assert view.is_htmx_request()
 
 
 def test_plain_hx_fragment():
-    request = RequestFactory().get("/", HTTP_PLAIN_HX_FRAGMENT="main")
+    request = RequestFactory().get("/", headers={"Plain-HX-Fragment": "main"})
     view = V()
     view.setup(request)
     assert view.get_htmx_fragment_name() == "main"
 
 
 def test_plain_hx_action():
-    request = RequestFactory().get("/", HTTP_PLAIN_HX_ACTION="create")
+    request = RequestFactory().get("/", headers={"Plain-HX-Action": "create"})
     view = V()
     view.setup(request)
     assert view.get_htmx_action_name() == "create"

plain/plain/cli/request.py

@@ -92,7 +92,7 @@ def request(
             raise SystemExit(1)
 
         # Create test client
-        client = Client(SERVER_NAME="localhost")
+        client = Client(headers={"Host": "localhost"})
 
         # If user_id provided, force login
         if user_id:
@@ -170,7 +170,7 @@ def request(
         click.echo(f"  Status: {response.status_code}")
 
         # Request ID
-        click.echo(f"  Request ID: {response.wsgi_request.unique_id}")
+        click.echo(f"  Request ID: {response.request.unique_id}")
 
         # User
         if getattr(response, "user", None):

plain/plain/http/__init__.py

@@ -12,6 +12,7 @@
 )
 from .middleware import HttpMiddleware
 from .request import (
+    LimitedStream,
     QueryDict,
     RawPostDataException,
     Request,
@@ -42,6 +43,7 @@
     "QueryDict",
     "RawPostDataException",
     "UnreadablePostError",
+    "LimitedStream",
     # Response
     "Response",
     "ResponseBase",

plain/plain/http/request.py

@@ -6,7 +6,7 @@
 import uuid
 from collections.abc import Iterator
 from functools import cached_property
-from io import BytesIO
+from io import BytesIO, IOBase
 from itertools import chain
 from typing import TYPE_CHECKING, Any, TypeVar, overload
 from urllib.parse import parse_qsl, quote, urlencode, urljoin, urlsplit
@@ -36,6 +36,47 @@
 _T = TypeVar("_T")
 
 
+class LimitedStream(IOBase):
+    """
+    Wrap another stream to disallow reading it past a number of bytes.
+
+    Based on the implementation from werkzeug.wsgi.LimitedStream
+    See https://github.com/pallets/werkzeug/blob/dbf78f67/src/werkzeug/wsgi.py#L828
+    """
+
+    def __init__(self, stream: Any, limit: int) -> None:
+        self._read = stream.read
+        self._readline = stream.readline
+        self._pos = 0
+        self.limit = limit
+
+    def read(self, size: int = -1, /) -> bytes:
+        _pos = self._pos
+        limit = self.limit
+        if _pos >= limit:
+            return b""
+        if size == -1 or size is None:
+            size = limit - _pos
+        else:
+            size = min(size, limit - _pos)
+        data = self._read(size)
+        self._pos += len(data)
+        return data
+
+    def readline(self, size: int | None = -1, /) -> bytes:
+        _pos = self._pos
+        limit = self.limit
+        if _pos >= limit:
+            return b""
+        if size is None or size == -1:
+            size = limit - _pos
+        else:
+            size = min(size, limit - _pos)
+        line = self._readline(size)
+        self._pos += len(line)
+        return line
+
+
 class UnreadablePostError(OSError):
     pass
 

plain/plain/internal/handlers/wsgi.py

@@ -2,12 +2,11 @@
 
 import codecs
 from functools import cached_property
-from io import IOBase
 from typing import TYPE_CHECKING
 from urllib.parse import quote
 
 from plain import signals
-from plain.http import FileResponse, QueryDict, Request, parse_cookie
+from plain.http import FileResponse, LimitedStream, QueryDict, Request, parse_cookie
 from plain.internal.handlers import base
 from plain.utils.http import parse_header_parameters
 from plain.utils.regex_helper import _lazy_re_compile
@@ -41,47 +40,6 @@ def _extract_headers_from_environ(environ: dict[str, Any]) -> dict[str, str]:
     return headers
 
 
-class LimitedStream(IOBase):
-    """
-    Wrap another stream to disallow reading it past a number of bytes.
-
-    Based on the implementation from werkzeug.wsgi.LimitedStream
-    See https://github.com/pallets/werkzeug/blob/dbf78f67/src/werkzeug/wsgi.py#L828
-    """
-
-    def __init__(self, stream: Any, limit: int) -> None:
-        self._read = stream.read
-        self._readline = stream.readline
-        self._pos = 0
-        self.limit = limit
-
-    def read(self, size: int = -1, /) -> bytes:
-        _pos = self._pos
-        limit = self.limit
-        if _pos >= limit:
-            return b""
-        if size == -1 or size is None:
-            size = limit - _pos
-        else:
-            size = min(size, limit - _pos)
-        data = self._read(size)
-        self._pos += len(data)
-        return data
-
-    def readline(self, size: int | None = -1, /) -> bytes:
-        _pos = self._pos
-        limit = self.limit
-        if _pos >= limit:
-            return b""
-        if size is None or size == -1:
-            size = limit - _pos
-        else:
-            size = min(size, limit - _pos)
-        line = self._readline(size)
-        self._pos += len(line)
-        return line
-
-
 class WSGIRequest(Request):
     non_picklable_attrs = Request.non_picklable_attrs | frozenset(["environ"])
 

plain/plain/server/http/wsgi.py

@@ -18,9 +18,8 @@
 from urllib.parse import quote, unquote_to_bytes
 
 import plain.runtime
-from plain.http import FileResponse
+from plain.http import FileResponse, LimitedStream
 from plain.http import Request as HttpRequest
-from plain.internal.handlers.wsgi import LimitedStream
 from plain.utils.http import parse_header_parameters
 
 from .. import util

plain/plain/test/README.md

@@ -119,7 +119,7 @@ The [`ClientResponse`](./client.py#ClientResponse) wrapper provides access to:
 - `content` - Response body as bytes
 - `headers` - Response headers
 - `cookies` - Cookies set by the response
-- `wsgi_request` - The original request object
+- `request` - The original request object
 - `resolver_match` - URL resolver match information
 - `redirect_chain` - List of redirects when using `follow=True`