Merge branch 'main' into dev

Author: Roopan-Microsoft

code/backend/batch/utilities/helpers/azure_search_helper.py

@@ -265,15 +265,27 @@ def get_conversation_logger(self):
             ),
         ]
 
-        return AzureSearch(
-            azure_search_endpoint=self.env_helper.AZURE_SEARCH_SERVICE,
-            azure_search_key=(
-                self.env_helper.AZURE_SEARCH_KEY
-                if self.env_helper.is_auth_type_keys()
-                else None
-            ),
-            index_name=self.env_helper.AZURE_SEARCH_CONVERSATIONS_LOG_INDEX,
-            embedding_function=self.llm_helper.get_embedding_model().embed_query,
-            fields=fields,
-            user_agent="langchain chatwithyourdata-sa",
-        )
+        if self.env_helper.AZURE_AUTH_TYPE == "rbac":
+            credential = DefaultAzureCredential()
+            return AzureSearch(
+                azure_search_endpoint=self.env_helper.AZURE_SEARCH_SERVICE,
+                azure_search_key=None,  # Remove API key
+                index_name=self.env_helper.AZURE_SEARCH_CONVERSATIONS_LOG_INDEX,
+                embedding_function=self.llm_helper.get_embedding_model().embed_query,
+                fields=fields,
+                user_agent="langchain chatwithyourdata-sa",
+                credential=credential  # Add token credential or send none so it is auto handled by AzureSearch library
+            )
+        else:
+            return AzureSearch(
+                azure_search_endpoint=self.env_helper.AZURE_SEARCH_SERVICE,
+                azure_search_key=(
+                    self.env_helper.AZURE_SEARCH_KEY
+                    if self.env_helper.is_auth_type_keys()
+                    else None
+                ),
+                index_name=self.env_helper.AZURE_SEARCH_CONVERSATIONS_LOG_INDEX,
+                embedding_function=self.llm_helper.get_embedding_model().embed_query,
+                fields=fields,
+                user_agent="langchain chatwithyourdata-sa",
+            )

docs/create_new_app_registration.md

@@ -16,7 +16,7 @@
 
 ![Add Details](images/AddDetails.png)
 
-5. After application is created sucessfully, then click on `Add a Redirect URL`.
+5. After application is created successfully, then click on `Add a Redirect URL`.
 
 ![Redirect URL](images/AddRedirectURL.png)
 

tests/e2e-test/README.md

@@ -8,6 +8,7 @@ Write end-to-end tests for your web apps with [Playwright](https://github.com/mi
 - Support for **headless and headed** execution.
 - **Built-in fixtures** that provide browser primitives to test functions.
 
+
 Pre-Requisites:
 - Install Visual Studio Code: Download and Install Visual Studio Code(VSCode).
 - Install NodeJS: Download and Install Node JS
@@ -21,21 +22,19 @@ This will create a virtual environment directory named microsoft inside your cur
 Installing Playwright Pytest from Virtual Environment
 - To install libraries run "pip install -r requirements.txt"
 
-
 Run test cases
 - To run test cases from your 'tests\e2e-test' folder : "pytest --headed --html=report/report.html"
 
-Steps need to be followed to enable Access Token and Client Credentials
+Steps need to be followed to enable Access Token and Client Credentials 
 - Go to App Service from the resource group and select the Access Tokens check box in 'Manage->Authentication' tab
 ![img.png](img.png)
 - Go to Manage->Certificates & secrets tab to generate Client Secret value
 ![img_1.png](img_1.png)
 - Go to Overview tab to get the client id and tenant id.
 
 Create .env file in project root level with web app url and client credentials
-- create a .env file in project root level and add your user_name, pass_word, client_id,client_secret,
+- create a .env file in project root level and add your user_name, pass_word, client_id,client_secret, 
         tenant_id, web_url and admin_url for the resource group. please refer 'sample_dotenv_file.txt' file.
 
 ## Documentation
-
 See on [playwright.dev](https://playwright.dev/python/docs/test-runners) for examples and more detailed information.

tests/e2e-test/pages/webUserPage.py

@@ -19,7 +19,6 @@ class WebUserPage(BasePage):
     CHAT_CLOSE_ICON = "button[title='Hide']"
     CHAT_HISTORY_OPTIONS = "//button[@id='moreButton']"
     CHAT_HISTORY_DELETE = "//button[@role='menuitem']"
-
     TOGGLE_CITATIONS_LIST = "[data-testid='toggle-citations-list']"
     CITATIONS_CONTAINER = "[data-testid='citations-container']"
     CITATION_BLOCK = "[data-testid='citation-block']"

tests/e2e-test/sample_dotenv_file.txt

@@ -1,2 +1,8 @@
 web_url = 'web app url'
 admin_url = 'admin url'
+user_name = 'user name'
+pass_word = 'pass word'
+client_id = 'client id'
+client_secret = 'client secret'
+tenant_id = 'tenant id'
+

tests/e2e-test/tests/test_poc_chat_with_your_data.py

@@ -0,0 +1,71 @@
+import logging
+
+from config.constants import *
+from pages.adminPage import AdminPage
+from pages.webUserPage import WebUserPage
+
+logger = logging.getLogger(__name__)
+
+
+def test_golden_path_web_page_demo_script(login_logout):
+    """Validate Golden path test case for Chat with your Data"""
+    page = login_logout
+    page.goto(ADMIN_URL)
+    logger.info("Step 1: Validate Admin page is loaded.")
+    admin_page = AdminPage(page)
+    assert (
+        admin_page_title == page.locator(admin_page.ADMIN_PAGE_TITLE).text_content()
+    ), "page title not found"
+    logger.info("Step 2: Validate Files are uploaded or not")
+    admin_page.click_delete_data_tab()
+    assert (
+        page.locator(admin_page.DELETE_CHECK_BOXES).count() >= 1
+    ), "Files are not uploaded."
+    logger.info("Step 3: Validate Web page is loaded.")
+    page.goto(WEB_URL)
+    home_page = WebUserPage(page)
+    logger.info("Step 5: Validate Chat history has been deleted.")
+    home_page.delete_chat_history()
+
+    failed_questions = []
+    logger.info("Step 6: Validate Golden Path prompts response")
+
+    def ask_question_and_check(question, attempt):
+        home_page.wait_for_load(4000)
+        home_page.enter_a_question(question)
+        home_page.click_send_button()
+        home_page.validate_response_status(question)
+
+        response_text = page.locator(home_page.ANSWER_TEXT)
+        response_count = response_text.count()
+
+        if response_count == 0:
+            return False  # no response found
+
+        response_text_content = response_text.nth(response_count - 1).text_content()
+
+        if response_text_content == invalid_response:
+            print(f"[Attempt {attempt}] Invalid response for prompt: {question}")
+            return False
+        return True
+
+    # First run through all questions
+    for question in questions:
+        if not ask_question_and_check(question, attempt=1):
+            failed_questions.append(question)
+
+    # Retry failed questions once more
+    if failed_questions:
+        logger.info("Step 7: Retry failed question one more time.")
+        for question in failed_questions:
+            if not ask_question_and_check(question, attempt=2):
+                home_page.soft_assert(
+                    False,
+                    f"Failed after retry- Invalid response for prompt: {question}",
+                )
+
+    logger.info("Step 8: Validate chat history.")
+    home_page.show_chat_history()
+    logger.info("Step 9: Validate chat history closed.")
+    home_page.close_chat_history()
+    home_page.assert_all()