feat: make 302 the default status_code for redirect responses (#2189

)

* Fix: better error message.

* feat: Ensures deterministic ordering of handlers (#2152)

Ensure deterministic handler order

* feat: Support custom status code for openapi exceptions (#1949)

* Support custom status code for openapi exceptions

* add docs for custom exceptions in OpenAPI schemas

---------

Co-authored-by: Na'aman Hirschfeld <[email protected]>

* docs(openapi): Fix stdlib link (#2177)

doc(openapi): fix stdlib link

Signed-off-by: Janek Nouvertné <[email protected]>

* Enhancement: make 302 the default status_code for Redirect
Fixes #2138

* fix: updates `ASGIRedirectResponse` to use a 302 by default.

* Update docs/usage/responses.rst

Co-authored-by: Na'aman Hirschfeld <[email protected]>

---------

Signed-off-by: Janek Nouvertné <[email protected]>
Co-authored-by: Stefane Fermigier <[email protected]>
Co-authored-by: George Sakkis <[email protected]>
Co-authored-by: Abdulhaq Emhemmed <[email protected]>
Co-authored-by: Na'aman Hirschfeld <[email protected]>
Co-authored-by: Janek Nouvertné <[email protected]>
Co-authored-by: Jacob Coffee <[email protected]>

docs/usage/responses.rst

@@ -575,12 +575,12 @@ In Litestar, a redirect response looks like this:
 
 .. code-block:: python
 
-   from litestar.status_codes import HTTP_307_TEMPORARY_REDIRECT
+   from litestar.status_codes import HTTP_302_FOUND
    from litestar import get
    from litestar.response import Redirect
 
 
-   @get(path="/some-path", status_code=HTTP_307_TEMPORARY_REDIRECT)
+   @get(path="/some-path", status_code=HTTP_302_FOUND)
    def redirect() -> Redirect:
        # do some stuff here
        # ...
@@ -589,7 +589,7 @@ In Litestar, a redirect response looks like this:
 
 To return a redirect response you should do the following:
 
-- set an appropriate status code for the route handler (301, 302, 303, 307, 308)
+- optionally: set an appropriate status code for the route handler (301, 302, 303, 307, 308). If not set the default of 302 will be used.
 - annotate the return value of the route handler as returning :class:`Redirect <.response.Redirect>`
 - return an instance of the :class:`Redirect <.response.Redirect>` class with the desired redirect path
 

litestar/response/redirect.py

@@ -6,7 +6,7 @@
 from litestar.enums import MediaType
 from litestar.exceptions import ImproperlyConfiguredException
 from litestar.response.base import ASGIResponse, Response
-from litestar.status_codes import HTTP_307_TEMPORARY_REDIRECT
+from litestar.status_codes import HTTP_302_FOUND
 from litestar.utils import url_quote
 from litestar.utils.helpers import filter_cookies, get_enum_string_value
 
@@ -40,7 +40,7 @@ def __init__(
     ) -> None:
         headers = {**(headers or {}), "location": url_quote(path)}
         media_type = media_type or MediaType.TEXT
-        status_code = status_code or HTTP_307_TEMPORARY_REDIRECT
+        status_code = status_code or HTTP_302_FOUND
 
         if status_code not in REDIRECT_STATUS_CODES:
             raise ImproperlyConfiguredException(
@@ -95,6 +95,8 @@ def __init__(
                 supported.
         """
         self.url = path
+        if status_code is None:
+            status_code = HTTP_302_FOUND
         super().__init__(
             background=background,
             content=b"",

tests/unit/test_openapi/test_responses.py

@@ -249,6 +249,23 @@ def handler() -> Stream:
 
 
 def test_create_success_response_redirect() -> None:
+    @get(path="/test", name="test")
+    def redirect_handler() -> Redirect:
+        return Redirect(path="/target")
+
+    handler = get_registered_route_handler(redirect_handler, "test")
+
+    response = create_success_response(handler, SchemaCreator(generate_examples=True))
+    assert response.description == "Redirect Response"
+    assert response.headers
+    location = response.headers["location"]
+    assert isinstance(location, OpenAPIHeader)
+    assert isinstance(location.schema, Schema)
+    assert location.schema.type == OpenAPIType.STRING
+    assert location.description
+
+
+def test_create_success_response_redirect_override() -> None:
     @get(path="/test", status_code=HTTP_307_TEMPORARY_REDIRECT, name="test")
     def redirect_handler() -> Redirect:
         return Redirect(path="/target")

tests/unit/test_response/test_redirect_response.py

@@ -110,8 +110,8 @@ def handler() -> Redirect:
 def test_redirect(handler_status_code: Optional[int]) -> None:
     @get("/", status_code=handler_status_code)
     def handler() -> Redirect:
-        return Redirect(path="/something-else", status_code=301)
+        return Redirect(path="/something-else", status_code=handler_status_code)  # type: ignore[arg-type]
 
     with create_test_client([handler]) as client:
         res = client.get("/", follow_redirects=False)
-        assert res.status_code == 301
+        assert res.status_code == 302 if handler_status_code is None else handler_status_code