refactor: Centralize Teams UI text in constants file

cursoragent · cursoragent · commit 7010be1ef971 · 2025-09-19T15:21:06.000Z
- Create constants/teams_text.py with all Teams UI text strings
- Add TeamsTextConstants class with environment-driven text formatting
- Refactor TeamsComponents to use constants instead of hardcoded strings
- Refactor TeamsResponseAdapter to use constants for all text
- Refactor TeamsHandler action responses to use constants
- Add helper methods for dynamic text formatting with f-strings
- Maintain structural engineering focus with environment-driven defaults
- All tests passing with centralized text management
- Improves maintainability and consistency across Teams UI
diff --git a/agents/adapters/teams_response_adapter.py b/agents/adapters/teams_response_adapter.py
@@ -4,14 +4,14 @@
 """
 
 import logging
-import os
 from typing import Dict, Any, List, Optional
 
 from botbuilder.core import TurnContext, MessageFactory
 from botbuilder.schema import Activity, ActivityTypes, Attachment, CardAction, ActionTypes, TextFormatTypes
 
 from services.rag_service import RAGResponse
 from components.teams_components import TeamsComponents, TeamsCardConfig
+from constants.teams_text import TeamsTextConstants
 
 
 logger = logging.getLogger(__name__)
@@ -75,25 +75,17 @@ def format_welcome_response(self, turn_context: TurnContext) -> Activity:
         Format a welcome response for Teams.
         """
         try:
-            # Get bot name and description from environment
-            bot_name = os.getenv("AGENT_NAME", "Structural Engineering Assistant")
-            bot_description = os.getenv("AGENT_DESCRIPTION", "AI-powered structural engineering document search and analysis assistant")
-            
             card_json = self.teams_components.create_welcome_card()
             attachment = self.teams_components.create_attachment_from_card(card_json)
             
             activity = MessageFactory.attachment(attachment)
-            activity.text = f"Welcome to {bot_name}! {bot_description}"
+            activity.text = f"Welcome to {TeamsTextConstants.get_bot_name()}! {TeamsTextConstants.get_bot_description()}"
             
             return activity
             
         except Exception as e:
             logger.error(f"Error formatting welcome response: {e}")
-            bot_name = os.getenv("AGENT_NAME", "Structural Engineering Assistant")
-            bot_description = os.getenv("AGENT_DESCRIPTION", "AI-powered structural engineering document search and analysis assistant")
-            return MessageFactory.text(
-                f"Welcome to {bot_name}! {bot_description}. I can help you analyze structural engineering documents, answer technical questions, and provide insights from your project files."
-            )
+            return MessageFactory.text(TeamsTextConstants.format_welcome_fallback())
     
     def format_help_response(self, turn_context: TurnContext) -> Activity:
         """
@@ -104,21 +96,13 @@ def format_help_response(self, turn_context: TurnContext) -> Activity:
             attachment = self.teams_components.create_attachment_from_card(card_json)
             
             activity = MessageFactory.attachment(attachment)
-            bot_name = os.getenv("AGENT_NAME", "Structural Engineering Assistant")
-            activity.text = f"Here's how to use {bot_name}:"
+            activity.text = TeamsTextConstants.format_help_main_text()
             
             return activity
             
         except Exception as e:
             logger.error(f"Error formatting help response: {e}")
-            bot_name = os.getenv("AGENT_NAME", "Structural Engineering Assistant")
-            return MessageFactory.text(
-                f"Here's how to use {bot_name}:\n\n"
-                f"• Mention me with @{bot_name}\n"
-                "• Upload structural drawings, specs, or reports\n"
-                "• Ask technical questions about your projects\n"
-                "• Use the buttons in my responses for quick actions"
-            )
+            return MessageFactory.text(TeamsTextConstants.format_help_fallback())
     
     def format_error_response(
         self,
@@ -404,10 +388,4 @@ def _create_suggested_actions(self) -> List[CardAction]:
         """
         Create suggested actions for Teams.
         """
-        return self.teams_components.create_suggested_actions([
-            "🔍 Analyze Drawing",
-            "📐 Review Calculation",
-            "❓ Ask Technical Question",
-            "📋 Upload Specification",
-            "❓ Help"
-        ])
+        return self.teams_components.get_default_suggested_actions()
diff --git a/agents/components/teams_components.py b/agents/components/teams_components.py
@@ -325,7 +325,7 @@ def create_file_upload_card(file_name: str, file_type: str) -> Dict[str, Any]:
                     "items": [
                         {
                             "type": "TextBlock",
-                            "text": "📎 File Uploaded",
+                            "text": TeamsTextConstants.FILE_UPLOAD_TITLE,
                             "weight": "Bolder",
                             "size": "Medium",
                             "color": "Accent"
@@ -334,21 +334,21 @@ def create_file_upload_card(file_name: str, file_type: str) -> Dict[str, Any]:
                 },
                 {
                     "type": "TextBlock",
-                    "text": f"I've received your file: **{file_name}**",
+                    "text": TeamsTextConstants.format_file_upload_message(file_name),
                     "wrap": True,
                     "size": "Medium",
                     "spacing": "Medium"
                 },
                 {
                     "type": "TextBlock",
-                    "text": f"File type: {file_type}",
+                    "text": TeamsTextConstants.format_file_upload_type(file_type),
                     "wrap": True,
                     "size": "Small",
                     "spacing": "Small"
                 },
                 {
                     "type": "TextBlock",
-                    "text": "I can help you search through this document and answer questions about its content. What would you like to know?",
+                    "text": TeamsTextConstants.FILE_UPLOAD_HELP,
                     "wrap": True,
                     "size": "Medium",
                     "spacing": "Medium"
@@ -370,8 +370,7 @@ def create_file_upload_card(file_name: str, file_type: str) -> Dict[str, Any]:
                     "data": {
                         "action": "summarize_document",
                         "file_name": file_name
-                    },
-                    "style": "default"
+                    }
                 }
             ]
         }
@@ -389,7 +388,7 @@ def create_quick_actions_card() -> Dict[str, Any]:
                     "items": [
                         {
                             "type": "TextBlock",
-                            "text": "⚡ Quick Actions",
+                            "text": TeamsTextConstants.QUICK_ACTIONS_TITLE,
                             "weight": "Bolder",
                             "size": "Medium",
                             "color": "Accent"
@@ -398,7 +397,7 @@ def create_quick_actions_card() -> Dict[str, Any]:
                 },
                 {
                     "type": "TextBlock",
-                    "text": "Choose a quick action to get started:",
+                    "text": TeamsTextConstants.QUICK_ACTIONS_MESSAGE,
                     "wrap": True,
                     "size": "Medium",
                     "spacing": "Medium"
@@ -418,24 +417,21 @@ def create_quick_actions_card() -> Dict[str, Any]:
                     "title": "📋 Get Summary",
                     "data": {
                         "action": "quick_summary"
-                    },
-                    "style": "default"
+                    }
                 },
                 {
                     "type": "Action.Submit",
                     "title": "❓ Ask Question",
                     "data": {
                         "action": "quick_question"
-                    },
-                    "style": "default"
+                    }
                 },
                 {
                     "type": "Action.Submit",
                     "title": "📚 Upload File",
                     "data": {
                         "action": "quick_upload"
-                    },
-                    "style": "default"
+                    }
                 }
             ]
         }
@@ -458,4 +454,9 @@ def create_suggested_actions(actions: List[str]) -> List[CardAction]:
                 value=action
             )
             for action in actions
-        ]
+        ]
+    
+    @staticmethod
+    def get_default_suggested_actions() -> List[CardAction]:
+        """Get default suggested actions for Teams."""
+        return TeamsComponents.create_suggested_actions(TeamsTextConstants.SUGGESTED_ACTIONS)
diff --git a/agents/handlers/teams_handler.py b/agents/handlers/teams_handler.py
@@ -16,6 +16,7 @@
 from adapters.response_adapter import ResponseAdapter
 from adapters.teams_response_adapter import TeamsResponseAdapter
 from components.teams_components import TeamsComponents, TeamsCardConfig
+from constants.teams_text import TeamsTextConstants
 
 
 logger = logging.getLogger(__name__)
@@ -166,14 +167,7 @@ async def _handle_follow_up_action(
         auth_claims: Dict[str, Any]
     ) -> Activity:
         """Handle follow-up action."""
-        return MessageFactory.text(
-            "I'd be happy to provide more details! What specific aspect would you like me to elaborate on? You can ask me to:\n\n"
-            "• Explain any part in more detail\n"
-            "• Provide examples\n"
-            "• Compare different options\n"
-            "• Answer related questions\n\n"
-            "Just type your question and I'll help you out!"
-        )
+        return MessageFactory.text(TeamsTextConstants.FOLLOW_UP_RESPONSE)
     
     async def _handle_search_related_action(
         self,
@@ -183,14 +177,7 @@ async def _handle_search_related_action(
         auth_claims: Dict[str, Any]
     ) -> Activity:
         """Handle search related action."""
-        return MessageFactory.text(
-            "I can help you find more information about this topic! Try asking me:\n\n"
-            "• 'What are the requirements for...?'\n"
-            "• 'How do I apply for...?'\n"
-            "• 'What are the steps to...?'\n"
-            "• 'Tell me more about...'\n\n"
-            "Or just describe what you're looking for and I'll search through the documents for you!"
-        )
+        return MessageFactory.text(TeamsTextConstants.SEARCH_RELATED_RESPONSE)
     
     async def _handle_summarize_action(
         self,
@@ -200,14 +187,7 @@ async def _handle_summarize_action(
         auth_claims: Dict[str, Any]
     ) -> Activity:
         """Handle summarize action."""
-        return MessageFactory.text(
-            "I can help you summarize information! You can ask me to:\n\n"
-            "• 'Summarize the key points'\n"
-            "• 'Give me a brief overview'\n"
-            "• 'What are the main takeaways?'\n"
-            "• 'Create a bullet point summary'\n\n"
-            "Just let me know what you'd like me to summarize!"
-        )
+        return MessageFactory.text(TeamsTextConstants.SUMMARIZE_RESPONSE)
     
     async def _is_bot_mentioned(self, turn_context: TurnContext) -> bool:
         """Check if the bot was mentioned in the message."""
@@ -493,17 +473,7 @@ async def _create_adaptive_card_response(
     
     async def _create_mention_reminder(self, turn_context: TurnContext) -> Activity:
         """Create a reminder to mention the bot."""
-        reminder_text = """
-👋 Hi! I'm your AI assistant. To ask me a question, please mention me using @RAG Assistant or type your question directly.
-
-**What I can help with:**
-• Search through your documents
-• Answer questions about your content
-• Provide summaries and insights
-
-Try asking me something like: "What are the main points in the latest policy document?"
-        """
-        
+        reminder_text = TeamsTextConstants.format_mention_reminder()
         return MessageFactory.text(reminder_text)
     
     async def handle_file_upload(
