more tests

Author: rishabhpoddar

CHANGELOG.md

@@ -8,7 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.22.0] - 2024-06-05
 - Adds caching per API based on user context.
+
+### Breaking change:
 - Changes general error in querier to normal python error.
 
 ## [0.21.0] - 2024-05-23

setup.py

@@ -83,7 +83,7 @@
 
 setup(
     name="supertokens_python",
-    version="0.21.0",
+    version="0.22.0",
     author="SuperTokens",
     license="Apache 2.0",
     author_email="[email protected]",

supertokens_python/constants.py

@@ -14,7 +14,7 @@
 from __future__ import annotations
 
 SUPPORTED_CDI_VERSIONS = ["3.0"]
-VERSION = "0.21.0"
+VERSION = "0.22.0"
 TELEMETRY = "/telemetry"
 USER_COUNT = "/users/count"
 USER_DELETE = "/user/remove"

supertokens_python/querier.py

@@ -400,11 +400,15 @@ def invalidate_core_call_cache(
         upd_global_cache_tag_if_necessary: bool = True,
     ):
         if user_context is None:
+            # this is done so that the code below runs as expected.
+            # It will reset the __global_cache_tag if needed, and the
+            # stuff we assign to the user_context will just be ignored (as expected)
             user_context = {}
 
         if upd_global_cache_tag_if_necessary and (
             user_context.get("_default", {}).get("keep_cache_alive", False) is not True
         ):
+            # there can be race conditions here, but i think we can ignore them.
             self.__global_cache_tag = get_timestamp_ms()
 
         user_context["_default"] = {

tests/test_querier.py

@@ -473,3 +473,213 @@ def intercept(
     user = await get_user_by_id("random", user_context)
     assert user is None
     assert called_core
+
+
+async def test_caching_does_not_get_clear_with_non_get_if_keep_alive():
+
+    called_core = False
+
+    def intercept(
+        url: str,
+        method: str,
+        headers: Dict[str, Any],
+        params: Optional[Dict[str, Any]],
+        body: Optional[Dict[str, Any]],
+        _: Optional[Dict[str, Any]],
+    ):
+        nonlocal called_core
+        called_core = True
+        return url, method, headers, params, body
+
+    init(
+        supertokens_config=SupertokensConfig(
+            connection_uri="http://localhost:3567", network_interceptor=intercept
+        ),
+        app_info=InputAppInfo(
+            app_name="ST",
+            api_domain="http://api.supertokens.io",
+            website_domain="http://supertokens.io",
+            api_base_path="/auth",
+        ),
+        framework="fastapi",
+        mode="asgi",
+        recipe_list=[
+            session.init(),
+            emailpassword.init(),
+            dashboard.init(),
+        ],
+    )  # type: ignore
+    start_st()
+    user_context: Dict[str, Any] = {"_default": {"keep_cache_alive": True}}
+    user_context_2: Dict[str, Any] = {}
+
+    user = await get_user_by_id("random", user_context)
+
+    assert user is None
+    assert called_core
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context_2)
+
+    assert user is None
+    assert called_core
+
+    await sign_up("public", "[email protected]", "abcd1234", user_context)
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context)
+    assert user is None
+    assert called_core
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context)
+    assert user is None
+    assert not called_core
+
+    user = await get_user_by_id("random", user_context_2)
+
+    assert user is None
+    assert not called_core
+
+
+async def test_caching_gets_clear_with_non_get_if_keep_alive_is_false():
+
+    called_core = False
+
+    def intercept(
+        url: str,
+        method: str,
+        headers: Dict[str, Any],
+        params: Optional[Dict[str, Any]],
+        body: Optional[Dict[str, Any]],
+        _: Optional[Dict[str, Any]],
+    ):
+        nonlocal called_core
+        called_core = True
+        return url, method, headers, params, body
+
+    init(
+        supertokens_config=SupertokensConfig(
+            connection_uri="http://localhost:3567", network_interceptor=intercept
+        ),
+        app_info=InputAppInfo(
+            app_name="ST",
+            api_domain="http://api.supertokens.io",
+            website_domain="http://supertokens.io",
+            api_base_path="/auth",
+        ),
+        framework="fastapi",
+        mode="asgi",
+        recipe_list=[
+            session.init(),
+            emailpassword.init(),
+            dashboard.init(),
+        ],
+    )  # type: ignore
+    start_st()
+    user_context: Dict[str, Any] = {"_default": {"keep_cache_alive": False}}
+    user_context_2: Dict[str, Any] = {}
+
+    user = await get_user_by_id("random", user_context)
+
+    assert user is None
+    assert called_core
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context_2)
+
+    assert user is None
+    assert called_core
+
+    await sign_up("public", "[email protected]", "abcd1234", user_context)
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context)
+    assert user is None
+    assert called_core
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context)
+    assert user is None
+    assert not called_core
+
+    user = await get_user_by_id("random", user_context_2)
+
+    assert user is None
+    assert called_core
+
+
+async def test_caching_gets_clear_with_non_get_if_keep_alive_is_not_set():
+
+    called_core = False
+
+    def intercept(
+        url: str,
+        method: str,
+        headers: Dict[str, Any],
+        params: Optional[Dict[str, Any]],
+        body: Optional[Dict[str, Any]],
+        _: Optional[Dict[str, Any]],
+    ):
+        nonlocal called_core
+        called_core = True
+        return url, method, headers, params, body
+
+    init(
+        supertokens_config=SupertokensConfig(
+            connection_uri="http://localhost:3567", network_interceptor=intercept
+        ),
+        app_info=InputAppInfo(
+            app_name="ST",
+            api_domain="http://api.supertokens.io",
+            website_domain="http://supertokens.io",
+            api_base_path="/auth",
+        ),
+        framework="fastapi",
+        mode="asgi",
+        recipe_list=[
+            session.init(),
+            emailpassword.init(),
+            dashboard.init(),
+        ],
+    )  # type: ignore
+    start_st()
+    user_context: Dict[str, Any] = {}
+    user_context_2: Dict[str, Any] = {}
+
+    user = await get_user_by_id("random", user_context)
+
+    assert user is None
+    assert called_core
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context_2)
+
+    assert user is None
+    assert called_core
+
+    await sign_up("public", "[email protected]", "abcd1234", user_context)
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context)
+    assert user is None
+    assert called_core
+
+    called_core = False
+
+    user = await get_user_by_id("random", user_context)
+    assert user is None
+    assert not called_core
+
+    user = await get_user_by_id("random", user_context_2)
+
+    assert user is None
+    assert called_core