more refactor

Author: anthony-nhs

packages/slackBotFunction/app/core/config.py

@@ -14,12 +14,15 @@
 from aws_lambda_powertools.utilities.parameters import get_parameter
 from mypy_boto3_dynamodb.service_resource import Table
 
+# we use lru_cache for lots of configs so they are cached
+
 
 @lru_cache()
 def get_logger() -> Logger:
     return Logger(service="slackBotFunction")
 
 
+# set up logger as its used in other functions
 logger = get_logger()
 
 
@@ -58,6 +61,27 @@ def get_ssm_params() -> Tuple[str, str]:
     return bot_token, signing_secret
 
 
+@lru_cache
+def get_bot_token() -> str:
+    bot_token, _ = get_ssm_params()
+    return bot_token
+
+
+@lru_cache
+def get_guardrail_config() -> Tuple[str, str, str, str, str]:
+    # Bedrock configuration from environment
+    KNOWLEDGEBASE_ID = os.environ["KNOWLEDGEBASE_ID"]
+    RAG_MODEL_ID = os.environ["RAG_MODEL_ID"]
+    AWS_REGION = os.environ["AWS_REGION"]
+    GUARD_RAIL_ID = os.environ["GUARD_RAIL_ID"]
+    GUARD_VERSION = os.environ["GUARD_RAIL_VERSION"]
+
+    logger.info(
+        "Guardrail configuration loaded", extra={"guardrail_id": GUARD_RAIL_ID, "guardrail_version": GUARD_VERSION}
+    )
+    return KNOWLEDGEBASE_ID, RAG_MODEL_ID, AWS_REGION, GUARD_RAIL_ID, GUARD_VERSION
+
+
 @dataclass
 class Constants:
     FEEDBACK_PREFIX: str
@@ -98,37 +122,28 @@ class Constants:
 )
 
 
-@lru_cache
-def get_bot_token() -> str:
-    bot_token, _ = get_ssm_params()
-    return bot_token
+@dataclass
+class BotMessages:
+    EMPTY_QUERY: str
+    ERROR_RESPONSE: str
+    FEEDBACK_POSITIVE_THANKS: str
+    FEEDBACK_NEGATIVE_THANKS: str
+    FEEDBACK_THANKS: str
+    FEEDBACK_PROMPT: str
+    FEEDBACK_YES: str
+    FEEDBACK_NO: str
 
 
 # Bot response messages
-BOT_MESSAGES = {
-    "empty_query": "Hi there! Please ask me a question and I'll help you find information from our knowledge base.",
-    "error_response": "Sorry, an error occurred while processing your request. Please try again later.",
-    "feedback_positive_thanks": "Thank you for your feedback.",
-    "feedback_negative_thanks": (
+bot_messages = BotMessages(
+    EMPTY_QUERY="Hi there! Please ask me a question and I'll help you find information from our knowledge base.",
+    ERROR_RESPONSE="Sorry, an error occurred while processing your request. Please try again later.",
+    FEEDBACK_POSITIVE_THANKS="Thank you for your feedback.",
+    FEEDBACK_NEGATIVE_THANKS=(
         'Please let us know how the answer could be improved. Start your message with "feedback:"'
     ),
-    "feedback_thanks": "Thank you for your feedback.",
-    "feedback_prompt": "Was this helpful?",
-    "feedback_yes": "Yes",
-    "feedback_no": "No",
-}
-
-
-@lru_cache
-def get_guardrail_config() -> Tuple[str, str, str, str, str]:
-    # Bedrock configuration from environment
-    KNOWLEDGEBASE_ID = os.environ["KNOWLEDGEBASE_ID"]
-    RAG_MODEL_ID = os.environ["RAG_MODEL_ID"]
-    AWS_REGION = os.environ["AWS_REGION"]
-    GUARD_RAIL_ID = os.environ["GUARD_RAIL_ID"]
-    GUARD_VERSION = os.environ["GUARD_RAIL_VERSION"]
-
-    logger.info(
-        "Guardrail configuration loaded", extra={"guardrail_id": GUARD_RAIL_ID, "guardrail_version": GUARD_VERSION}
-    )
-    return KNOWLEDGEBASE_ID, RAG_MODEL_ID, AWS_REGION, GUARD_RAIL_ID, GUARD_VERSION
+    FEEDBACK_THANKS="Thank you for your feedback.",
+    FEEDBACK_PROMPT="Was this helpful?",
+    FEEDBACK_YES="Yes",
+    FEEDBACK_NO="No",
+)

packages/slackBotFunction/app/services/slack.py

@@ -1,7 +1,7 @@
 import traceback
 
 from slack_sdk import WebClient
-from app.core.config import get_logger
+from app.core.config import bot_messages, get_bot_token, get_logger
 
 
 logger = get_logger()
@@ -21,3 +21,15 @@ def get_friendly_channel_name(channel_id: str, client: WebClient) -> str:
     except Exception:
         logger.warning("There was an error getting the friendly channel name", extra={"error": traceback.format_exc()})
     return friendly_channel_name
+
+
+def post_error_message(channel: str, thread_ts: str | None) -> None:
+    try:
+        token = get_bot_token()
+        client = WebClient(token=token)
+        post_params = {"channel": channel, "text": bot_messages.ERROR_RESPONSE}
+        if thread_ts:  # Only add thread_ts for channel threads, not DMs
+            post_params["thread_ts"] = thread_ts
+        client.chat_postMessage(**post_params)
+    except Exception:
+        logger.error("Failed to post error message", extra={"error": traceback.format_exc()})

packages/slackBotFunction/app/slack/slack_events.py

@@ -11,7 +11,7 @@
 from botocore.exceptions import ClientError
 from slack_sdk import WebClient
 from app.core.config import (
-    BOT_MESSAGES,
+    bot_messages,
     constants,
     get_bot_token,
     get_logger,
@@ -24,7 +24,7 @@
     update_state_information,
 )
 from app.services.query_reformulator import reformulate_query
-from app.services.slack import get_friendly_channel_name
+from app.services.slack import get_friendly_channel_name, post_error_message
 from app.utils.handler_utils import extract_pull_request_id, is_duplicate_event
 
 logger = get_logger()
@@ -155,20 +155,20 @@ def _create_feedback_blocks(
     feedback_value = json.dumps(feedback_data, separators=(",", ":"))
     return [
         {"type": "section", "text": {"type": "mrkdwn", "text": response_text}},
-        {"type": "section", "text": {"type": "plain_text", "text": BOT_MESSAGES["feedback_prompt"]}},
+        {"type": "section", "text": {"type": "plain_text", "text": bot_messages.FEEDBACK_PROMPT}},
         {
             "type": "actions",
             "block_id": "feedback_block",
             "elements": [
                 {
                     "type": "button",
-                    "text": {"type": "plain_text", "text": BOT_MESSAGES["feedback_yes"]},
+                    "text": {"type": "plain_text", "text": bot_messages.FEEDBACK_YES},
                     "action_id": "feedback_yes",
                     "value": feedback_value,
                 },
                 {
                     "type": "button",
-                    "text": {"type": "plain_text", "text": BOT_MESSAGES["feedback_no"]},
+                    "text": {"type": "plain_text", "text": bot_messages.FEEDBACK_NO},
                     "action_id": "feedback_no",
                     "value": feedback_value,
                 },
@@ -210,7 +210,7 @@ def process_async_slack_event(slack_event_data: Dict[str, Any]) -> None:
 
         # handles empty messages
         if not user_query:
-            post_params = {"channel": channel, "text": BOT_MESSAGES["empty_query"]}
+            post_params = {"channel": channel, "text": bot_messages.EMPTY_QUERY}
             if thread_ts:  # Only add thread_ts for channel threads, not DMs
                 post_params["thread_ts"] = thread_ts
             client.chat_postMessage(**post_params)
@@ -262,13 +262,7 @@ def process_async_slack_event(slack_event_data: Dict[str, Any]) -> None:
         logger.error("Error processing message", extra={"event_id": event_id, "error": traceback.format_exc()})
 
         # Try to notify user of error via Slack
-        try:
-            post_params = {"channel": channel, "text": BOT_MESSAGES["error_response"]}
-            if thread_ts:  # Only add thread_ts for channel threads, not DMs
-                post_params["thread_ts"] = thread_ts
-            client.chat_postMessage(**post_params)
-        except Exception:
-            logger.error("Failed to post error message", extra={"error": traceback.format_exc()})
+        post_error_message(channel=channel, thread_ts=thread_ts)
 
 
 def process_pull_request_slack_event(slack_event_data: Dict[str, Any]) -> None:

packages/slackBotFunction/app/slack/slack_handlers.py

@@ -15,7 +15,7 @@
 from slack_bolt import Ack, App
 from slack_sdk import WebClient
 from app.core.config import (
-    BOT_MESSAGES,
+    bot_messages,
     get_logger,
     constants,
 )
@@ -183,10 +183,10 @@ def feedback_handler(ack: Ack, body: Dict[str, Any], client: WebClient) -> None:
         # Determine feedback type and response message based on action_id
         if action_id == "feedback_yes":
             feedback_type = "positive"
-            response_message = BOT_MESSAGES["feedback_positive_thanks"]
+            response_message = bot_messages.FEEDBACK_POSITIVE_THANKS
         elif action_id == "feedback_no":
             feedback_type = "negative"
-            response_message = BOT_MESSAGES["feedback_negative_thanks"]
+            response_message = bot_messages.FEEDBACK_NEGATIVE_THANKS
         else:
             logger.error(f"Unknown feedback action: {action_id}")
             return
@@ -252,7 +252,7 @@ def _common_message_handler(
         try:
             params = {
                 "channel": channel_id,
-                "text": BOT_MESSAGES["feedback_thanks"],
+                "text": bot_messages.FEEDBACK_THANKS,
             }
 
             if post_to_thread:

packages/slackBotFunction/tests/test_async_processing.py

@@ -80,24 +80,22 @@ def test_process_async_slack_event_empty_query(mock_webclient: Mock, mock_get_pa
     )
 
 
-@patch("slack_sdk.WebClient")
 @patch("app.services.dynamo.get_state_information")
 @patch("app.services.bedrock.query_bedrock")
 @patch("app.services.query_reformulator.reformulate_query")
 @patch("app.slack.slack_events.get_conversation_session")
+@patch("app.services.slack.post_error_message")
 def test_process_async_slack_event_error(
+    mock_post_error_message: Mock,
     mock_get_session: Mock,
     mock_reformulate_query: Mock,
     mock_query_bedrock: Mock,
     mock_get_state_information: Mock,
-    mock_webclient: Mock,
     mock_get_parameter: Mock,
     mock_env: Mock,
 ):
     """Test async event processing with error"""
     # set up mocks
-    mock_client = Mock()
-    mock_webclient.return_value = mock_client
     mock_query_bedrock.side_effect = Exception("Bedrock error")
     mock_reformulate_query.return_value = "test question"
     mock_get_session.return_value = None  # No existing session
@@ -116,9 +114,8 @@ def test_process_async_slack_event_error(
     process_async_slack_event(slack_event_data)
 
     # assertions
-    mock_client.chat_postMessage.assert_called_once_with(
+    mock_post_error_message.assert_called_once_with(
         channel="C789",
-        text="Sorry, an error occurred while processing your request. Please try again later.",
         thread_ts="1234567890.123",
     )