Support list as a value for no-cache and private directives (#615)

Author: karpetrosyan

blacksheep/server/headers/cache.py

@@ -5,7 +5,7 @@
 
 import inspect
 from functools import wraps
-from typing import Optional
+from typing import List, Optional, Union
 
 from blacksheep import Request, Response
 from blacksheep.server.normalization import ensure_response
@@ -15,11 +15,11 @@ def write_cache_control_response_header(
     *,
     max_age: Optional[int] = None,
     shared_max_age: Optional[int] = None,
-    no_cache: Optional[bool] = None,
+    no_cache: Union[bool, List[str], None] = None,
     no_store: Optional[bool] = None,
     must_revalidate: Optional[bool] = None,
     proxy_revalidate: Optional[bool] = None,
-    private: Optional[bool] = None,
+    private: Union[bool, List[str], None] = None,
     public: Optional[bool] = None,
     must_understand: Optional[bool] = None,
     no_transform: Optional[bool] = None,
@@ -36,16 +36,18 @@ def write_cache_control_response_header(
         max age in seconds
     shared_max_age: int | None
         optional shared max age in seconds
-    no_cache: bool | None
-        enables no-cache
+    no_cache: bool | list[str] | None
+        enables no-cache; if a list of field names is provided, they will be added
+        as field-names (e.g., no-cache="Set-Cookie, Authorization")
     no_store: bool | None
         enables no-store
     must_revalidate: bool | None
         enables must-revalidate
     proxy_revalidate: bool | None
         enables proxy-revalidate
-    private: bool | None
-        enables private
+    private: bool | list[str] | None
+        enables private; if a list of field names is provided, they will be added
+        as field-names (e.g., private="Set-Cookie, Authorization")
     public: bool | None
         enables public
     must_understand: bool | None
@@ -73,7 +75,11 @@ def extend(part: bytes):
         value.extend(part)
 
     if private:
-        extend(b"private")
+        if isinstance(private, list):
+            field_names = ", ".join(private)
+            extend(f'private="{field_names}"'.encode("ascii"))
+        else:
+            extend(b"private")
 
     if public:
         extend(b"public")
@@ -85,7 +91,11 @@ def extend(part: bytes):
         extend(f"s-maxage={shared_max_age}".encode("ascii"))
 
     if no_cache:
-        extend(b"no-cache")
+        if isinstance(no_cache, list):
+            field_names = ", ".join(no_cache)
+            extend(f'no-cache="{field_names}"'.encode("ascii"))
+        else:
+            extend(b"no-cache")
 
     if must_revalidate:
         extend(b"must-revalidate")
@@ -124,16 +134,18 @@ class CacheControlHeaderValue:
         max age in seconds
     shared_max_age: int | None
         optional shared max age in seconds
-    no_cache: bool | None
-        enables no-cache
+    no_cache: bool | list[str] | None
+        enables no-cache; if a list of field names is provided, they will be added
+        as field-names (e.g., no-cache="Set-Cookie, Authorization")
     no_store: bool | None
         enables no-store
     must_revalidate: bool | None
         enables must-revalidate
     proxy_revalidate: bool | None
         enables proxy-revalidate
-    private: bool | None
-        enables private
+    private: bool | list[str] | None
+        enables private; if a list of field names is provided, they will be added
+        as field-names (e.g., private="Set-Cookie, Authorization")
     public: bool | None
         enables public
     must_understand: bool | None
@@ -156,11 +168,11 @@ def __init__(
         *,
         max_age: Optional[int] = None,
         shared_max_age: Optional[int] = None,
-        no_cache: Optional[bool] = None,
+        no_cache: Union[bool, List[str], None] = None,
         no_store: Optional[bool] = None,
         must_revalidate: Optional[bool] = None,
         proxy_revalidate: Optional[bool] = None,
-        private: Optional[bool] = None,
+        private: Union[bool, List[str], None] = None,
         public: Optional[bool] = None,
         must_understand: Optional[bool] = None,
         no_transform: Optional[bool] = None,
@@ -188,11 +200,11 @@ def __init__(
 def cache_control(
     max_age: Optional[int] = None,
     shared_max_age: Optional[int] = None,
-    no_cache: Optional[bool] = None,
+    no_cache: Union[bool, List[str], None] = None,
     no_store: Optional[bool] = None,
     must_revalidate: Optional[bool] = None,
     proxy_revalidate: Optional[bool] = None,
-    private: Optional[bool] = None,
+    private: Union[bool, List[str], None] = None,
     public: Optional[bool] = None,
     must_understand: Optional[bool] = None,
     no_transform: Optional[bool] = None,
@@ -210,16 +222,18 @@ def cache_control(
         max age in seconds
     shared_max_age: int | None
         optional shared max age in seconds
-    no_cache: bool | None
-        enables no-cache
+    no_cache: bool | list[str] | None
+        enables no-cache; if a list of field names is provided, they will be added
+        as field-names (e.g., no-cache="Set-Cookie, Authorization")
     no_store: bool | None
         enables no-store
     must_revalidate: bool | None
         enables must-revalidate
     proxy_revalidate: bool | None
         enables proxy-revalidate
-    private: bool | None
-        enables private
+    private: bool | list[str] | None
+        enables private; if a list of field names is provided, they will be added
+        as field-names (e.g., private="Set-Cookie, Authorization")
     public: bool | None
         enables public
     must_understand: bool | None
@@ -287,16 +301,18 @@ class CacheControlMiddleware:
         max age in seconds
     shared_max_age: int | None
         optional shared max age in seconds
-    no_cache: bool | None
-        enables no-cache
+    no_cache: bool | list[str] | None
+        enables no-cache; if a list of field names is provided, they will be added
+        as field-names (e.g., no-cache="Set-Cookie, Authorization")
     no_store: bool | None
         enables no-store
     must_revalidate: bool | None
         enables must-revalidate
     proxy_revalidate: bool | None
         enables proxy-revalidate
-    private: bool | None
-        enables private
+    private: bool | list[str] | None
+        enables private; if a list of field names is provided, they will be added
+        as field-names (e.g., private="Set-Cookie, Authorization")
     public: bool | None
         enables public
     must_understand: bool | None
@@ -316,11 +332,11 @@ def __init__(
         *,
         max_age: Optional[int] = None,
         shared_max_age: Optional[int] = None,
-        no_cache: Optional[bool] = None,
+        no_cache: Union[bool, List[str], None] = None,
         no_store: Optional[bool] = None,
         must_revalidate: Optional[bool] = None,
         proxy_revalidate: Optional[bool] = None,
-        private: Optional[bool] = None,
+        private: Union[bool, List[str], None] = None,
         public: Optional[bool] = None,
         must_understand: Optional[bool] = None,
         no_transform: Optional[bool] = None,

tests/test_caching.py

@@ -35,6 +35,27 @@
         {"max_age": 604800, "stale_if_error": 86400},
         b"max-age=604800, stale-if-error=86400",
     ),
+    # Test list support for private directive
+    ({"private": ["Set-Cookie"]}, b'private="Set-Cookie"'),
+    (
+        {"private": ["Set-Cookie", "Authorization"]},
+        b'private="Set-Cookie, Authorization"',
+    ),
+    # Test list support for no-cache directive
+    ({"no_cache": ["Set-Cookie"]}, b'no-cache="Set-Cookie"'),
+    (
+        {"no_cache": ["Set-Cookie", "Authorization"]},
+        b'no-cache="Set-Cookie, Authorization"',
+    ),
+    # Test combined list support
+    (
+        {"private": ["Set-Cookie"], "max_age": 3600},
+        b'private="Set-Cookie", max-age=3600',
+    ),
+    (
+        {"no_cache": ["Authorization"], "no_store": True},
+        b'no-cache="Authorization", no-store',
+    ),
 ]