refactor(slack): Improve slack integration

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docq"
-version = "0.10.2"
+version = "0.10.4"
 description = "Docq.AI - Your private ChatGPT alternative. Securely unlock knowledge from confidential documents."
 authors = ["Docq.AI Team <[email protected]>"]
 maintainers = ["Docq.AI Team <[email protected]>"]

source/docq/config.py

@@ -4,6 +4,7 @@
 
 ENV_VAR_DOCQ_DATA = "DOCQ_DATA"
 ENV_VAR_DOCQ_DEMO = "DOCQ_DEMO"
+ENV_VAR_DOCQ_LOGLEVEL = "DOCQ_LOGLEVEL"
 ENV_VAR_OPENAI_API_KEY = "DOCQ_OPENAI_API_KEY"
 ENV_VAR_DOCQ_COOKIE_HMAC_SECRET_KEY = "DOCQ_COOKIE_HMAC_SECRET_KEY"
 ENV_VAR_DOCQ_API_SECRET = "DOCQ_API_SECRET"

source/docq/setup.py

@@ -1,5 +1,6 @@
 """Initialize Docq."""
 import logging
+import os
 
 from opentelemetry import trace
 
@@ -16,13 +17,19 @@
     manage_users,
     services,
 )
+from .config import ENV_VAR_DOCQ_LOGLEVEL
 from .support import auth_utils, llm, store
 
 tracer = trace.get_tracer(__name__, docq.__version_str__)
 
 def _config_logging() -> None:
     """Configure logging."""
-    logging.basicConfig(level=logging.DEBUG, format="%(asctime)s %(process)d %(levelname)s %(message)s", force=True) # force over rides Otel (or other) logging config with this.
+    log_level = os.environ.get(ENV_VAR_DOCQ_LOGLEVEL, "ERROR")
+
+    logging.basicConfig(
+        level=log_level.upper(), format="%(asctime)s %(process)d %(levelname)s %(message)s", force=True
+    )  # force overrides Otel (or other) logging config with this.
+
 
 #FIXME: right now this will run everytime a user hits the home page. add a global lock using st.cache to make this only run once.
 def init() -> None:

web/api/integration/slack/slack_event_handler.py

@@ -1,15 +1,15 @@
-"""Slack chat action handler."""
+"""Slack event handlers aka listeners."""
 
 from docq.integrations.slack.slack_application import slack_app
 from opentelemetry import trace
+from slack_bolt import Ack
 from slack_bolt.context.say import Say
 
 from web.api.integration.utils import rag_completion
 
 from .slack_event_handler_middleware import (
     filter_duplicate_event_middleware,
     persist_message_middleware,
-    slack_event_tracker,
 )
 
 tracer = trace.get_tracer(__name__)
@@ -22,8 +22,9 @@
 
 @slack_app.event("app_mention", middleware=[filter_duplicate_event_middleware])
 @tracer.start_as_current_span(name="handle_app_mention")
-def handle_app_mention_event(body: dict, say: Say) -> None:
+def handle_app_mention_event(body: dict, ack: Ack, say: Say) -> None:
     """Handle of type app_mention. i.e. [at]botname."""
+    span = trace.get_current_span()
     is_thread_message = False
     if body["event"].get("thread_ts", False):
         # there's a documented bug in the Slack Events API. subtype=message_replied is not being sent. This is the official workaround.
@@ -34,23 +35,43 @@ def handle_app_mention_event(body: dict, say: Say) -> None:
     # always reply in a thread.
     # if thread_ts is missing it's an unthreaded message so set it as the parent in our response
     thread_ts = body["event"].get("thread_ts", ts)
+    text = body["event"]["text"]
     event_id = body.get("event_id")
     channel_id = body["event"]["channel"]
+    user_id = body["event"]["user"]
 
-    print("slack: unthreaded message ", is_thread_message)
-
-    response = rag_completion(body["event"]["text"], body["event"]["channel"], thread_ts)
-    say(
-        text=CHANNEL_TEMPLATE.format(user=body["event"]["user"], response=response),
-        channel=body["event"]["channel"],
-        thread_ts=thread_ts,
-        mrkdwn=True,
-    )
-    # if event_id:
-    #     slack_event_tracker.remove_event(event_id=event_id, channel_id=channel_id)
+    try:
+        ack()
+        response = rag_completion(text=text, channel_id=channel_id, thread_ts=thread_ts)
+        say(
+            text=CHANNEL_TEMPLATE.format(user=user_id, response=response),
+            channel=channel_id,
+            thread_ts=thread_ts,
+            mrkdwn=True,
+        )
+    except Exception as e:
+        span.record_exception(e)
+        span.set_status(trace.StatusCode.ERROR, str(e))
+        raise e
 
 
 @slack_app.event("message", middleware=[persist_message_middleware])
 @tracer.start_as_current_span(name="handle_message")
-def handle_message(body: dict, say: Say) -> None:
+def handle_message(body: dict, ack: Ack, say: Say) -> None:
     """Events of type message. This fires for multiple types including app_mention."""
+    Ack()
+
+@slack_app.event("reaction_added", middleware=[filter_duplicate_event_middleware])
+@tracer.start_as_current_span(name="handle_reaction_added")
+def handle_reaction_added(body: dict, ack: Ack) -> None:
+    """Handle reaction added events."""
+    reaction_emoji_name = body["event"]["reaction"]
+    ack()
+
+
+@slack_app.event("reaction_added", middleware=[filter_duplicate_event_middleware])
+@tracer.start_as_current_span(name="handle_reaction_added")
+def handle_reaction_removed(body: dict, ack: Ack) -> None:
+    """Handle reaction added events."""
+    reaction_emoji_name = body["event"]["reaction"]
+    ack()

web/api/integration/slack/slack_event_handler_middleware.py

@@ -4,27 +4,28 @@
 
 import docq.integrations.slack.manage_slack_messages as manage_slack_messages
 from opentelemetry import trace
+from slack_bolt import Ack
 
 from .slack_event_tracker import SlackEventTracker
 from .slack_utils import get_org_id
 
 tracer = trace.get_tracer(__name__)
 
-slack_event_tracker = SlackEventTracker()  # global scope
+slack_event_tracker = SlackEventTracker()  # global scope #TODO: move to a function decorator
 
-# NOTE: middleware calls inject args so name needs to match. See for all available args https://slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html
+# NOTE: middleware calls inject args so name needs to match. See for all available args
+# @see https://slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html
 
 
 @tracer.start_as_current_span(name="filter_duplicate_event_middleware")
-def filter_duplicate_event_middleware(ack: Callable, body: dict, next_: Callable) -> None:
+def filter_duplicate_event_middleware(ack: Ack, body: dict, next_: Callable) -> None:
     """Middleware to check if an event has already been seen and handled. This prevents duplicate processing of messages.
 
     Duplicate events are legit. Slack can send the same event multiple times.
     """
     span = trace.get_current_span()
-    ack()
 
-    print("\033[32mmessage_handled_middleware\033[0m body: ", json.dumps(body, indent=4))
+    # print("\033[32mmessage_handled_middleware\033[0m body: ", json.dumps(body, indent=4))
 
     client_msg_id = body["event"]["client_msg_id"]
     type_ = body["event"]["type"]
@@ -54,22 +55,16 @@ def filter_duplicate_event_middleware(ack: Callable, body: dict, next_: Callable
             "org_id": org_id if org_id else "None",
         }
     )
-    # if org_id is None:
-    #     span.record_exception(ValueError(f"No Org ID found for Slack team ID '{team_id}'"))
-    #     span.set_status(trace.StatusCode.ERROR, "No Org ID found")
-    #     raise ValueError(f"No Org ID found for Slack team ID '{team_id}'")
-    # message_handled = manage_slack_messages.is_message_handled(client_msg_id, ts, org_id)
-
-    print(f"\033[32mmessage_handled_middleware\033[0m: duplicate message '{is_duplicate}'. event_id: {event_id}")
 
     if not is_duplicate:
-        next_()
+        next_()  # continue processing the event. The main handler will ack
+    else:
+        ack()  # acknowledge the duplicate event to prevent Slack from resending it
 
 
 @tracer.start_as_current_span(name="persist_message_middleware")
 def persist_message_middleware(body: dict, next_: Callable) -> None:
     """Middleware to persist messages."""
-    print("\033[32mpersist_message_middleware\033[0m: persisting slack message")
     span = trace.get_current_span()
     client_msg_id = body["event"]["client_msg_id"]
     type_ = body["event"]["type"]

web/api/integration/slack/slack_utils.py

@@ -1,13 +1,12 @@
 """Slack application utils."""
-import streamlit as st
 from docq.integrations import manage_slack
 from opentelemetry import trace
 from slack_sdk import WebClient
 
 tracer = trace.get_tracer(__name__)
 
 
-@st.cache_data(ttl=6000)
+
 def get_org_id(team_id: str) -> int | None:
     """Get the org id for a Slack team / workspace."""
     result = manage_slack.list_docq_slack_installations(org_id=None, team_id=team_id)