Implement filter_cookies() with domain-matching and path-matching

CHANGES/7583.feature

@@ -0,0 +1 @@
+Implement filter_cookies() with domain-matching and path-matching on the keys, instead of testing every single cookie.

CONTRIBUTORS.txt

@@ -355,6 +355,7 @@ William Grzybowski
 William S.
 Wilson Ong
 wouter bolsterlee
+Xiang Li
 Yang Zhou
 Yannick Koechlin
 Yannick Péroux

aiohttp/cookiejar.py

@@ -1,6 +1,7 @@
 import calendar
 import contextlib
 import datetime
+import itertools
 import os  # noqa
 import pathlib
 import pickle
@@ -78,7 +79,7 @@ def __init__(
         *,
         unsafe: bool = False,
         quote_cookie: bool = True,
-        treat_as_secure_origin: Union[StrOrURL, List[StrOrURL], None] = None
+        treat_as_secure_origin: Union[StrOrURL, List[StrOrURL], None] = None,
     ) -> None:
         self._cookies: DefaultDict[Tuple[str, str], SimpleCookie] = defaultdict(
             SimpleCookie
@@ -261,8 +262,32 @@ def filter_cookies(self, request_url: URL = URL()) -> "BaseCookie[str]":
                 request_origin = request_url.origin()
             is_not_secure = request_origin not in self._treat_as_secure_origin
 
+        # d: domain, d could be subdomain
+        # p: path
+        d = hostname
+
+        pairs = []
+        while d:
+            p = request_url.path
+            while p:
+                pairs.append((d, p))
+                p = p.rsplit("/", maxsplit=1)[0]
+
+            try:
+                d = d.split(".", maxsplit=1)[1]
+            except IndexError:
+                # handle last element for split
+                d = ""
+
+        # shared cookie, it should have max of 1 entry
+        pairs.append(("", "/"))
+
+        cookies = itertools.chain.from_iterable(
+            self._cookies[p].values() for p in reversed(pairs)
+        )
+
         # Point 2: https://www.rfc-editor.org/rfc/rfc6265.html#section-5.4
-        for cookie in sorted(self, key=lambda c: len(c["path"])):
+        for cookie in cookies:
             name = cookie.key
             domain = cookie["domain"]
 

tests/test_cookiejar.py

@@ -253,6 +253,78 @@ async def test_filter_cookies_str_deprecated(loop: Any) -> None:
         jar.filter_cookies("http://éé.com")
 
 
+@pytest.mark.parametrize(
+    ("url", "expected_cookies"),
+    [
+        (
+            "http://pathtest.com/one/two/",
+            [
+                "path2-cookie",
+                "shared-cookie",
+                "path3-cookie",
+                "path4-cookie",
+            ],
+        ),
+        (
+            "http://test1.example.com/",
+            [
+                "shared-cookie",
+                "domain-cookie",
+                "subdomain1-cookie",
+                "dotted-domain-cookie",
+            ],
+        ),
+        (
+            "http://pathtest.com/",
+            [
+                "shared-cookie",
+                "no-path-cookie",
+                "path1-cookie",
+            ],
+        ),
+    ],
+    ids=(
+        "/one/two/ path",
+        "test1.example.com subdomain",
+        "pathtest.com",
+    ),
+)
+async def test_filter_cookies_with_domain_path_lookup_multilevelpath(
+    loop: Any,
+    url: Any,
+    expected_cookies: Any,
+) -> None:
+    jar = CookieJar()
+    cookies = SimpleCookie(
+        "shared-cookie=first; "
+        "domain-cookie=second; Domain=example.com; "
+        "subdomain1-cookie=third; Domain=test1.example.com; "
+        "subdomain2-cookie=fourth; Domain=test2.example.com; "
+        "dotted-domain-cookie=fifth; Domain=.example.com; "
+        "different-domain-cookie=sixth; Domain=different.org; "
+        "secure-cookie=seventh; Domain=secure.com; Secure; "
+        "no-path-cookie=eighth; Domain=pathtest.com; "
+        "path1-cookie=ninth; Domain=pathtest.com; Path=/; "
+        "path2-cookie=tenth; Domain=pathtest.com; Path=/one; "
+        "path3-cookie=eleventh; Domain=pathtest.com; Path=/one/two; "
+        "path4-cookie=twelfth; Domain=pathtest.com; Path=/one/two/; "
+        "expires-cookie=thirteenth; Domain=expirestest.com; Path=/;"
+        " Expires=Tue, 1 Jan 1980 12:00:00 GMT; "
+        "max-age-cookie=fourteenth; Domain=maxagetest.com; Path=/;"
+        " Max-Age=60; "
+        "invalid-max-age-cookie=fifteenth; Domain=invalid-values.com; "
+        " Max-Age=string; "
+        "invalid-expires-cookie=sixteenth; Domain=invalid-values.com; "
+        " Expires=string;"
+    )
+    jar.update_cookies(cookies)
+    cookies = jar.filter_cookies(URL(url))
+
+    assert len(cookies) == len(expected_cookies)
+    for c in cookies:
+        assert c in expected_cookies
+
+
 async def test_domain_filter_ip_cookie_send(loop: Any) -> None:
     jar = CookieJar()
     cookies = SimpleCookie(