Skip to content

feat: add stale while revalidate directive according MDN standard. #455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
allen0099 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add stale while revalidate directive according MDN standard. #455

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions fastapi_cache/decorator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,22 @@ def _uncacheable(request: Optional[Request]) -> bool:
return request.headers.get("Cache-Control") == "no-store"


def _generate_directive(
ttl: int,
*,
stale_while_revalidate: Optional[int] = None,
) -> str:
directive = f"max-age={ttl}"

if stale_while_revalidate:
directive = ", ".join([directive, f"stale-while-revalidate={stale_while_revalidate}"])

return directive


def cache(
expire: Optional[int] = None,
stale_while_revalidate: Optional[int] = None,
coder: Optional[Type[Coder]] = None,
key_builder: Optional[KeyBuilder] = None,
namespace: str = "",
Expand All @@ -96,6 +110,7 @@ def cache(
:param injected_dependency_namespace:
:param namespace:
:param expire:
:param stale_while_revalidate:
:param coder:
:param key_builder:

Expand Down Expand Up @@ -127,6 +142,7 @@ def wrapper(
async def inner(*args: P.args, **kwargs: P.kwargs) -> Union[R, Response]:
nonlocal coder
nonlocal expire
nonlocal stale_while_revalidate
nonlocal key_builder

async def ensure_async_func(*args: P.args, **kwargs: P.kwargs) -> R:
Expand Down Expand Up @@ -198,7 +214,7 @@ async def ensure_async_func(*args: P.args, **kwargs: P.kwargs) -> R:
if response:
response.headers.update(
{
"Cache-Control": f"max-age={expire}",
"Cache-Control": _generate_directive(expire, stale_while_revalidate=stale_while_revalidate),
"ETag": f"W/{hash(to_cache)}",
cache_status_header: "MISS",
}
Expand All @@ -209,7 +225,7 @@ async def ensure_async_func(*args: P.args, **kwargs: P.kwargs) -> R:
etag = f"W/{hash(cached)}"
response.headers.update(
{
"Cache-Control": f"max-age={ttl}",
"Cache-Control": _generate_directive(ttl, stale_while_revalidate=stale_while_revalidate),
"ETag": etag,
cache_status_header: "HIT",
}
Expand Down