Remove the experimental name space from cookie parameters

.bumpversion.toml

@@ -0,0 +1,17 @@
+[tool.bumpversion]
+current_version = "0.26.0"
+commit = true
+tag = true
+tag_name = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = 'CHANGES.rst'
+search = "\\(unreleased\\)$"
+replace = "({now:%Y-%m-%d})"
+regex = true
+
+[[tool.bumpversion.files]]
+filename = "docs/conf.py"
+
+[[tool.bumpversion.files]]
+filename = "scrapy_zyte_api/__version__.py"

CHANGES.rst

@@ -1,6 +1,26 @@
 Changes
 =======
 
+0.27.0 (unreleased)
+-------------------
+
+* Cookie support is no longer experimental:
+
+  * If the ``COOKIES_ENABLED`` setting is ``True`` (default), automatic request
+    parameter mapping now sets ``responseCookies`` to ``True`` and maps request
+    cookies to ``requestCookies``.
+
+  * The ``ZYTE_API_EXPERIMENTAL_COOKIES_ENABLED`` setting is now deprecated.
+    When enabled, however, the ``experimental`` name space is still used for
+    automatic request parameter mapping.
+
+  * If you use ``requestCookies``, ``responseCookies``, or ``cookieManagement``
+    within the ``experimental`` name space in request parameters, a deprecation
+    warning is now logged.
+
+  * The ``responseCookies`` response parameter is now handled the same as
+    ``experimental.responseCookies``; the latter still works but is deprecated.
+
 0.26.0 (2025-01-15)
 -------------------
 
@@ -111,7 +131,6 @@ Changes
 * Fixed some documentation examples where the parameters of the ``check``
   method of :setting:`ZYTE_API_SESSION_CHECKER` were in reverse order.
 
-
 0.20.0 (2024-06-26)
 -------------------
 
@@ -302,6 +321,7 @@ Changes
             work as expected with
             :class:`~scrapy.pqueues.DownloaderAwarePriorityQueue`.
 
+
 0.14.0 (2024-01-15)
 -------------------
 
@@ -313,6 +333,7 @@ Changes
 
 * Added support for ``zyte_common_items.JobPosting`` to the scrapy-poet provider.
 
+
 0.13.0 (2023-12-13)
 -------------------
 
@@ -355,6 +376,7 @@ Changes
 
 * Test and CI improvements.
 
+
 0.12.2 (2023-10-19)
 -------------------
 
@@ -363,6 +385,7 @@ Changes
 * When logging Zyte API requests, truncation now uses
   "..." instead of Unicode ellipsis.
 
+
 0.12.1 (2023-09-29)
 -------------------
 
@@ -390,7 +413,7 @@ Changes
   Experimental is treated as a namespace, and its parameters are the ones
   counted, i.e. there is no ``scrapy-zyte-api/request_args/experimental`` stat,
   but there are stats like
-  ``scrapy-zyte-api/request_args/experimental.responseCookies``.
+  ``scrapy-zyte-api/request_args/experimental.foo``.
 
 
 0.11.1 (2023-08-25)

docs/reference/fingerprint-params.rst

@@ -42,10 +42,9 @@ The following Zyte API parameters are *not* taken into account for request
 fingerprinting:
 
 -   Request header parameters (:http:`request:customHttpRequestHeaders`,
-    :http:`request:requestHeaders`)
+    :http:`request:requestHeaders`, :http:`request:requestCookies`)
 
--   Request cookie parameters (:http:`request:cookieManagement`,
-    :http:`request:requestCookies`)
+-   :http:`request:cookieManagement`
 
 -   Session handling parameters (:http:`request:sessionContext`,
     :http:`request:sessionContextParameters`)

docs/reference/request.rst

@@ -29,15 +29,14 @@ Automatic mapping
     :http:`request:requestHeaders` for browser requests. See
     :ref:`header-mapping` and :ref:`request-unsupported` for details.
 
--   If :setting:`ZYTE_API_EXPERIMENTAL_COOKIES_ENABLED` is ``True``,
-    :setting:`COOKIES_ENABLED <scrapy:COOKIES_ENABLED>` is ``True`` (default),
-    and :attr:`Request.meta <scrapy.http.Request.meta>` does not set
+-   If the :setting:`COOKIES_ENABLED <scrapy:COOKIES_ENABLED>` is ``True``
+    (default), and :attr:`Request.meta <scrapy.http.Request.meta>` does not set
     :reqmeta:`dont_merge_cookies <scrapy:dont_merge_cookies>` to ``True``:
 
-    -   :http:`request:experimental.responseCookies` becomes ``True``.
+    -   :http:`request:responseCookies` becomes ``True``.
 
     -   Cookies from the :reqmeta:`cookiejar <scrapy:cookiejar>` become
-        :http:`request:experimental.requestCookies`.
+        :http:`request:requestCookies`.
 
         All cookies from the cookie jar are set, regardless of their cookie
         domain. This is because Zyte API requests may involve requests to
@@ -117,20 +116,18 @@ following parameters:
                 "value": "application/json"
             }
         ],
-        "experimental": {
-            "requestCookies": [
-                {
-                    "name": "a",
-                    "value": "b",
-                    "domain": ""
-                }
-            ],
-            "responseCookies": true
-        },
         "httpResponseBody": true,
         "httpResponseHeaders": true,
         "httpRequestBody": "eyJmb28iOiAiYmFyIn0=",
         "httpRequestMethod": "POST",
+        "requestCookies": [
+            {
+                "name": "a",
+                "value": "b",
+                "domain": ""
+            }
+        ],
+        "responseCookies": true,
         "url": "https://httpbin.org/anything"
     }
 

docs/reference/response.rst

@@ -19,12 +19,11 @@ Zyte API response parameters are mapped into :ref:`response class
     <scrapy_zyte_api.responses.ZyteAPIResponse.status>`.
 
 -   :http:`response:httpResponseHeaders` and
-    :http:`response:experimental.responseCookies` become
-    :class:`response.headers
+    :http:`response:responseCookies` become :class:`response.headers
     <scrapy_zyte_api.responses.ZyteAPIResponse.headers>`.
 
--   :http:`response:experimental.responseCookies` is also mapped into the
-    request :reqmeta:`cookiejar <scrapy:cookiejar>`.
+-   :http:`response:responseCookies` is also mapped into the request
+    :reqmeta:`cookiejar <scrapy:cookiejar>`.
 
 -   :http:`response:browserHtml` and :http:`response:httpResponseBody` are
     mapped into both

docs/reference/settings.rst

@@ -136,16 +136,6 @@ Default: ``True``
 Can be set to ``False`` to disable scrapy-zyte-api.
 
 
-.. setting:: ZYTE_API_EXPERIMENTAL_COOKIES_ENABLED
-
-ZYTE_API_EXPERIMENTAL_COOKIES_ENABLED
-=====================================
-
-Default: ``False``
-
-See :ref:`request-automatic`.
-
-
 .. setting:: ZYTE_API_FALLBACK_REQUEST_FINGERPRINTER_CLASS
 
 ZYTE_API_FALLBACK_REQUEST_FINGERPRINTER_CLASS
@@ -217,11 +207,11 @@ If the cookies to be set during :ref:`request mapping <request>` exceed this
 limit, a warning is logged, and only as many cookies as the limit allows are
 set for the target request.
 
-To silence this warning, set :http:`request:experimental.requestCookies`
-manually, e.g. to an empty :class:`dict`.
+To silence this warning, set :http:`request:requestCookies` manually, e.g. to
+an empty :class:`dict`.
 
-Alternatively, if :http:`request:experimental.requestCookies` starts supporting
-more than 100 cookies, update this setting accordingly.
+Alternatively, if :http:`request:requestCookies` starts supporting more than
+100 cookies, update this setting accordingly.
 
 
 .. setting:: ZYTE_API_MAX_REQUESTS

docs/usage/automap.rst

@@ -70,9 +70,7 @@ following parameters:
 
     {
         "browserHtml": true,
-        "experimental": {
-            "responseCookies": true
-        },
+        "responseCookies": true,
         "requestHeaders": {"referer": "https://example.com/"},
         "url": "https://quotes.toscrape.com"
     }

scrapy_zyte_api/_cookies.py

@@ -30,7 +30,8 @@ def _process_cookies(
 ):
     if not cookie_jars:
         return
-    response_cookies = api_response.get("experimental", {}).get("responseCookies")
+    old_response_cookies = api_response.get("experimental", {}).get("responseCookies")
+    response_cookies = api_response.get("responseCookies", old_response_cookies)
     if not response_cookies:
         return
     cookie_jar = _get_cookie_jar(request, cookie_jars)