Change cast to type annotation, add initial test

Author: pamelafox

app/backend/chat_history/cosmosdb.py

@@ -24,7 +24,7 @@ async def post_chat_history(auth_claims: Dict[str, Any]):
     if not current_app.config[CONFIG_CHAT_HISTORY_COSMOS_ENABLED]:
         return jsonify({"error": "Chat history not enabled"}), 405
 
-    container = cast(ContainerProxy, current_app.config[CONFIG_COSMOS_HISTORY_CONTAINER])
+    container: ContainerProxy = current_app.config[CONFIG_COSMOS_HISTORY_CONTAINER]
     if not container:
         return jsonify({"error": "Chat history not enabled"}), 405
 
@@ -193,6 +193,6 @@ async def setup_clients():
 
 @chat_history_cosmosdb_bp.after_app_serving
 async def close_clients():
-    cosmos_client = cast(CosmosClient, current_app.config.get(CONFIG_COSMOS_HISTORY_CLIENT))
+    cosmos_client: CosmosClient = current_app.config.get(CONFIG_COSMOS_HISTORY_CLIENT)
     if cosmos_client:
         await cosmos_client.close()

docs/deploy_features.md

@@ -7,7 +7,7 @@ You should typically enable these features before running `azd up`. Once you've
 * [Using GPT-4](#using-gpt-4)
 * [Using text-embedding-3 models](#using-text-embedding-3-models)
 * [Enabling GPT-4 Turbo with Vision](#enabling-gpt-4-turbo-with-vision)
-* [Enabling chat history](#enabling-chat-history)
+* [Enabling client-side chat history](#enabling-client-side-chat-history)
 * [Enabling persistent chat history with Azure Cosmos DB](#enabling-persistent-chat-history-with-azure-cosmos-db)
 * [Enabling language picker](#enabling-language-picker)
 * [Enabling speech input/output](#enabling-speech-inputoutput)
@@ -151,7 +151,7 @@ If you have already deployed:
 
 This section covers the integration of GPT-4 Vision with Azure AI Search. Learn how to enhance your search capabilities with the power of image and text indexing, enabling advanced search functionalities over diverse document types. For a detailed guide on setup and usage, visit our [Enabling GPT-4 Turbo with Vision](gpt4v.md) page.
 
-## Enabling chat history
+## Enabling client-side chat history
 
 This feature allows users to view the chat history of their conversation, stored in the browser using [IndexedDB](https://developer.mozilla.org/docs/Web/API/IndexedDB_API). That means the chat history will be available only on the device where the chat was initiated. To enable browser-stored chat history, run:
 

tests/conftest.py

@@ -419,6 +419,11 @@ async def auth_public_documents_client(
     monkeypatch.setenv("USE_LOCAL_PDF_PARSER", "true")
     monkeypatch.setenv("USE_LOCAL_HTML_PARSER", "true")
     monkeypatch.setenv("AZURE_DOCUMENTINTELLIGENCE_SERVICE", "test-documentintelligence-service")
+    monkeypatch.setenv("USE_CHAT_HISTORY_COSMOS", "true")
+    monkeypatch.setenv("AZURE_COSMOSDB_ACCOUNT", "test-cosmosdb-account")
+    monkeypatch.setenv("AZURE_CHAT_HISTORY_DATABASE", "test-cosmosdb-database")
+    monkeypatch.setenv("AZURE_CHAT_HISTORY_CONTAINER", "test-cosmosdb-container")
+
     for key, value in request.param.items():
         monkeypatch.setenv(key, value)
 

tests/test_cosmosdb.py

@@ -0,0 +1,24 @@
+import pytest
+from azure.cosmos.aio import ContainerProxy
+
+
+@pytest.mark.asyncio
+async def test_chathistory(auth_public_documents_client, monkeypatch):
+
+    async def mock_upsert_item(container_proxy, item, **kwargs):
+        assert item["id"] == "123"
+        assert item["answers"] == [["This is a test message"]]
+        assert item["entra_oid"] == "OID_X"
+        assert item["title"] == "This is a test message"
+
+    monkeypatch.setattr(ContainerProxy, "upsert_item", mock_upsert_item)
+
+    response = await auth_public_documents_client.post(
+        "/chat_history",
+        headers={"Authorization": "Bearer MockToken"},
+        json={
+            "id": "123",
+            "answers": [["This is a test message"]],
+        },
+    )
+    assert response.status_code == 201