Skip to content

Commit

Permalink
docs(3.1.2): bikeshed newsfragments & release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
vytas7 committed Nov 18, 2023
1 parent 802832d commit 2734692
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ listed below by date of first contribution:
* Laurent Chriqui (laurent-chriqui)
* Andrii Oriekhov (andriyor)
* Tom Boshoven (TBoshoven)
* Libor Jelínek (liborjelinek)

(et al.)

Expand Down
8 changes: 7 additions & 1 deletion docs/_newsfragments/2157.bugfix.rst
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
:class:`~falcon.testing.TestCase` mimics behavior of real WSGI servers following WSGI spec where is said that ``PATH_INFO`` CGI variable for WSGI app is already percent-decoded. However, this breaks routing if slash (encoded as ``%2F``) is part of path element, not a path separator, as explained in the FAQ :ref:`routing_encoded_slashes`. The workaround based on some WSGI servers' non-standard CGI variables described in :ref:`raw_url_path_recipe` recipe breaks tests because :py:func:`falcon.testing.helpers.create_environ` hard-code CGI variable ``RAW_URI`` to ``/`` instead to real path *before* percent-decoding.
Falcon's :class:`~falcon.testing.TestClient` mimics the behavior of real WSGI
servers (and the WSGI spec) by presenting the ``PATH_INFO`` CGI variable
already in the percent-decoded form. However, the client also used to
indiscriminately set the non-standard ``RAW_URI`` CGI variable to ``/``, which
made writing tests for apps :ref:`decoding raw URL path <raw_url_path_recipe>`
cumbersome. This has been fixed, and the raw path of a simulated request is now
preserved in ``RAW_URI``.
2 changes: 1 addition & 1 deletion docs/changes/3.1.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Summary
-------

This is a minor point release fixing a couple of high impact bugs,
as well as publishing binary wheels for the recently released CPython 3.11.
as well as publishing binary wheels for the recently released CPython 3.12.


Changes to Supported Platforms
Expand Down

0 comments on commit 2734692

Please sign in to comment.