use yield for strays; fix tests

Author: pieroit

compose.yml

@@ -18,6 +18,7 @@ services:
       - TZ=${CCAT_TIMEZONE:-UTC}
     volumes:
       - ./core:/app
+      - ./tmp:/tmp
     command:
       - python
       - "-m"

core/cat/auth/connection.py

@@ -54,7 +54,13 @@ async def __call__(
                 protocol, credential, self.resource, self.permission, user_id=user_id
             )
             if user:
-                return await self.get_user_stray(user, connection)
+                stray = await self.get_user_stray(user, connection)
+                yield stray
+
+                log.critical("STRAY FINITO")
+                stray.update_working_memory_cache()
+                del stray
+                return
 
         # if no stray was obtained, raise exception
         self.not_allowed(connection)
@@ -135,7 +141,7 @@ def extract_credentials(self, connection: WebSocket) -> Tuple[str, str] | None:
 
 
     async def get_user_stray(self, user: AuthUserInfo, connection: WebSocket) -> StrayCat:
-         return StrayCat(
+        return StrayCat(
             ws=connection,
             user_id=user.name, # TODOV2: user_id should be the user.id
             user_data=user,

core/cat/looking_glass/stray_cat.py

@@ -42,6 +42,7 @@ def __init__(
         self.__user_data = user_data
 
         # get working memory from cache or create a new one
+        log.warning(f"GET working memory for {user_id}")
         self.working_memory = self.cache.get_value(f"{user_id}_working_memory") or WorkingMemory()
 
         # attribute to store ws connection
@@ -52,11 +53,15 @@ def __init__(
     def __repr__(self):
         return f"StrayCat(user_id={self.user_id})"
 
-    def __del__(self):
+    #def __del__(self):
+    #    log.critical(f"StrayCat __del__ called for {self.user_id}")
+        #self.__main_loop = None
+        #self.__ws = None
         # when the garbage collector deletes the stray, we update working memory in cache
-        updated_cache_item = CacheItem(f"{self.user_id}_working_memory", self.working_memory, -1)
-        self.cache.insert(updated_cache_item)
-        log.critical(f"StrayCat {self.user_id} deleted")
+    #    self.update_working_memory_cache()
+        #self.__user_id = None
+        #self.__user_data = None
+    #    del self
 
 
     def __send_ws_json(self, data: Any):
@@ -95,6 +100,12 @@ def __build_why(self) -> MessageWhy:
         )
 
         return why
+    
+    def update_working_memory_cache(self):
+        """Update the working memory in the cache."""
+        log.warning(f"SAVE working memory for {self.user_id}")
+        updated_cache_item = CacheItem(f"{self.user_id}_working_memory", self.working_memory, -1)
+        self.cache.insert(updated_cache_item)
 
     def send_ws_message(self, content: str, msg_type: MSG_TYPES = "notification"):
         """Send a message via websocket.
@@ -478,6 +489,7 @@ def __call__(self, message_dict):
     def run(self, user_message_json, return_message=False):
         try:
             cat_message = self.__call__(user_message_json)
+            self.update_working_memory_cache()
             if return_message:
                 # return the message for HTTP usage
                 return cat_message

core/cat/memory/working_memory.py

@@ -63,7 +63,7 @@ def update_conversation_history(self, message: str, who: str, why = {}):
         -----
         This method is deprecated and will be removed in future versions. Use `update_history` instead.
         """
-         
+
         deprecation_warning(
             "update_conversation_history is deprecated and will be removed in a future release. Use update_history instead."
         )

core/cat/routes/base.py

@@ -29,4 +29,5 @@ async def message_with_cat(
     """Get a response from the Cat"""
     user_message_json = {"user_id": stray.user_id, **payload}
     answer = await run_in_threadpool(stray.run, user_message_json, True)
+    del stray
     return answer

core/cat/routes/static/static.py

@@ -14,7 +14,7 @@ async def __call__(self, scope, receive, send) -> None:
         stray_http_auth = HTTPAuth(
             resource=AuthResource.STATIC, permission=AuthPermission.READ
         )
-        allowed = await stray_http_auth(request)
+        allowed = stray_http_auth(request)
         if allowed:
             await super().__call__(scope, receive, send)
         else:

core/cat/startup.py

@@ -78,14 +78,6 @@ def custom_generate_unique_id(route: APIRoute):
         allow_headers=["*"],
     )
 
-# Auto update sessions cache witha  middleware
-#@cheshire_cat_api.middleware("http")
-#async def update_stray_cache(request: Request, call_next):
-#    log.critical("MIDDLEWARE")
-#    print(request)
-#    response = await call_next(request)
-#    return response
-
 # Add routers to the middleware stack.
 cheshire_cat_api.include_router(base.router, tags=["Home"])
 cheshire_cat_api.include_router(auth.router, tags=["User Auth"], prefix="/auth")

core/tests/conftest.py

@@ -66,6 +66,7 @@ def clean_up_mocks():
         "tests/mocks/mock_plugin/settings.json",
         "tests/mocks/mock_plugin_folder/mock_plugin",
         "tests/mocks/empty_folder",
+        "/tmp_test",
     ]
     for tbr in to_be_removed:
         if os.path.exists(tbr):
@@ -86,6 +87,7 @@ def client(monkeypatch) -> Generator[TestClient, Any, None]:
     clean_up_mocks()
     # env variables
     os.environ["CCAT_DEBUG"] = "false" # do not autoreload
+    os.environ["CCAT_CACHE_DIR"] = "/tmp_test"  # use a different file system cache dir
     # monkeypatch classes
     mock_classes(monkeypatch)
     # delete all singletons!!!

core/tests/routes/test_session.py

@@ -5,6 +5,10 @@
 from tests.utils import send_websocket_message
 
 
+def test_no_sessions_at_startup(client):
+    assert False # TODO
+
+
 def test_session_creation_from_websocket(client):
     # send websocket message
     mex = {"text": "Where do I go?"}
@@ -14,7 +18,7 @@ def test_session_creation_from_websocket(client):
     assert "You did not configure" in res["content"]
 
     # verify session
-    strays = client.app.state.ccat.cache
+    strays = client.app.state.ccat.cache.get_value()
     assert "Alice" in strays
     assert isinstance(strays["Alice"], StrayCat)
     assert strays["Alice"].user_id == "Alice"

core/tests/test_env_variables.py

@@ -22,7 +22,10 @@ def test_get_env(client):
 
         if k == "CCAT_DEBUG":
             assert get_env(k) == "false" # we test installation with autoreload off
-        else:            
+        elif k == "CCAT_CACHE_DIR":
+            assert get_env(k) == "/tmp_test" # we test installation with a different cache dir
+        else:
+            # default values          
             assert get_env(k) == v
 
             # TODO: take away in v2