chore: Sync with master

Author: BURG3R5

bot/slack/base.py

@@ -1,3 +1,5 @@
+from slack.web.client import WebClient
+
 from bot.storage import SubscriptionStorage
 
 
@@ -6,5 +8,6 @@ class SlackBotBase:
     Class containing common attributes for `Messenger` and `Runner`
     """
 
-    def __init__(self):
+    def __init__(self, token: str):
         self.storage = SubscriptionStorage()
+        self.client: WebClient = WebClient(token)

bot/slack/bot.py

@@ -6,8 +6,6 @@
 * `.run` to execute slash commands.
 """
 
-from typing import Optional
-
 from ..utils.log import Logger
 from .messenger import Messenger
 from .runner import Runner
@@ -27,6 +25,7 @@ def __init__(
         logger: Logger,
         base_url: str,
         secret: str,
+        bot_id: str,
     ):
         Messenger.__init__(self, token)
-        Runner.__init__(self, logger, base_url, secret)
+        Runner.__init__(self, logger, base_url, secret, token, bot_id)

bot/slack/messenger.py

@@ -14,9 +14,8 @@ class Messenger(SlackBotBase):
     Sends Slack messages according to received GitHub events.
     """
 
-    def __init__(self, token: str):
-        SlackBotBase.__init__(self)
-        self.client: WebClient = WebClient(token)
+    def __init__(self, token):
+        SlackBotBase.__init__(self, token)
 
     def inform(self, event: GitHubEvent):
         """

bot/slack/runner.py

@@ -8,13 +8,16 @@
 from json import dumps as json_dumps
 from typing import Any
 
+from sentry_sdk import capture_message
+from slack.errors import SlackApiError
 from werkzeug.datastructures import Headers, ImmutableMultiDict
 
 from ..models.github import EventType, convert_keywords_to_events
 from ..utils.json import JSON
 from ..utils.list_manip import intersperse
 from ..utils.log import Logger
 from .base import SlackBotBase
+from .templates import error_message
 
 
 class Runner(SlackBotBase):
@@ -29,11 +32,14 @@ def __init__(
         logger: Logger,
         base_url: str,
         secret: str,
+        token: str,
+        bot_id: str,
     ):
-        SlackBotBase.__init__(self)
+        super(self.__class__, self).__init__(token)
         self.logger = logger
         self.base_url = base_url
         self.secret = secret.encode("utf-8")
+        self.bot_id = bot_id
 
     def verify(
         self,
@@ -126,6 +132,13 @@ def run_subscribe_command(
         :param args: `list` of events to subscribe to.
         """
 
+        in_channel = self.check_bot_in_channel(current_channel=current_channel)
+        if not in_channel:
+            return error_message(
+                "Unable to subscribe. To receive notifications, "
+                "you need to invite @GitHub to this conversation "
+                "using `/invite @Selene`")
+
         repository = args[0]
         if repository.find('/') == -1:
             return self.send_wrong_syntax_message()
@@ -301,6 +314,24 @@ def run_list_command(
             "blocks": blocks,
         }
 
+    def check_bot_in_channel(
+        self,
+        current_channel: str,
+    ) -> bool:
+        subscriptions = self.storage.get_subscriptions(channel=current_channel)
+
+        if len(subscriptions) != 0:
+            return True
+        try:
+            response = self.client.conversations_members(
+                channel=current_channel)
+            return self.bot_id in response["members"]
+
+        except SlackApiError as E:
+            capture_message(
+                f"SlackApiError {E} Failed to fetch conversation member for {current_channel}"
+            )
+
     @staticmethod
     def run_help_command(args: list[str]) -> dict[str, Any]:
         """

bot/slack/templates.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+
+def error_message(text: str) -> dict[str, Any]:
+    attachments = [
+        {
+            "color":
+            "#bb2124",
+            "blocks": [
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": text,
+                    },
+                },
+            ],
+        },
+    ]
+
+    return {
+        "response_type": "ephemeral",
+        "attachments": attachments,
+    }

bot/storage/subscriptions.py

@@ -64,7 +64,7 @@ def get_subscriptions(
         self,
         channel: Optional[str] = None,
         repository: Optional[str] = None,
-    ) -> tuple["Subscription"]:
+    ) -> tuple["Subscription", ...]:
         """
         Queries the subscriptions database. Filters are applied depending on arguments passed.
 

bot/utils/log.py

@@ -12,6 +12,11 @@ def log_command(self, log_text: str):
         Logs the latest command to `./data/logs`.
         :param log_text: Information about the latest command to be saved.
         """
+
+        if self.N == 0:
+            # Early exit
+            return
+
         # Read
         with open('data/logs', 'a+') as file:
             file.seek(0)

main.py

@@ -25,6 +25,7 @@
 from bot.github import GitHubApp
 from bot.models.github.event import GitHubEvent
 from bot.slack import SlackBot
+from bot.slack.templates import error_message
 from bot.utils.log import Logger
 
 app = Flask(__name__)
@@ -39,9 +40,9 @@ def manage_github_events():
     Then uses an instance of `SlackBot` to send appropriate messages to appropriate channels.
     """
 
-    is_valid_request, error_message = github_app.verify(request)
+    is_valid_request, message = github_app.verify(request)
     if not is_valid_request:
-        return make_response(error_message, 400)
+        return make_response(message, 400)
 
     event: Optional[GitHubEvent] = github_app.parse(
         event_type=request.headers["X-GitHub-Event"],
@@ -68,21 +69,7 @@ def manage_slack_commands() -> Union[dict, str, None]:
         headers=request.headers,
     )
     if not is_valid_request:
-        attachments = [{
-            "color":
-            "#bb2124",
-            "blocks": [{
-                "type": "section",
-                "text": {
-                    "type": "mrkdwn",
-                    "text": f"⚠️ Couldn't fulfill your request: {message}"
-                }
-            }]
-        }]
-        return {
-            "response_type": "ephemeral",
-            "attachments": attachments,
-        }
+        return error_message(f"⚠️ Couldn't fulfill your request: {message}")
 
     # Unlike GitHub webhooks, Slack does not send the data in `requests.json`.
     # Instead, the data is passed in `request.form`.
@@ -119,6 +106,7 @@ def complete_auth():
         logger=Logger(int(os.environ.get("LOG_LAST_N_COMMANDS", 100))),
         base_url=os.environ["BASE_URL"],
         secret=os.environ["SLACK_SIGNING_SECRET"],
+        bot_id=os.environ["SLACK_BOT_ID"],
     )
 
     github_app = GitHubApp(

samples/.env

@@ -8,4 +8,5 @@ GITHUB_WEBHOOK_SECRET=3dbd2c253813c65b296b7acf67470b7e7bc116e3
 HOST_PORT=9999
 LOG_LAST_N_COMMANDS=100
 SENTRY_DSN=https://exampledsn.ingest.sentry.io/123
+SLACK_BOT_ID=B0101010101
 SLACK_OAUTH_TOKEN=xoxb-3943959636919-3982289583824-iKtJsairxpmjH2yrVMg99nFG

samples/.env.dev

@@ -8,7 +8,7 @@ GITHUB_APP_CLIENT_SECRET=e2fbe2fbe2fbe2fbe2fbe2e2fbe2fbe2e2fbe2fb
 GITHUB_WEBHOOK_SECRET=3dbd2c253813c65b296b7acf67470b7e7bc116e3
 HOST_PORT=9999
 LOG_LAST_N_COMMANDS=100
-MANIFEST_ACCESS_TOKEN=xoxe.xoxp-1-Mi0yLTM5NDM5NTk2MzY5MTktMzk3MTE1NDE0MTcyOS00NDU5MTIxNTI0NTgyLTQ0ODk0MjE4NTMzOTItOGVhYmFmOTQ4ZDkyNGQzNTZhMjFiYThkMjU0ZDA4MzFhNTY4NTFkNzdlNGIzMDM1ZTM3NGYyZjUwYjIwYmUxMA
-MANIFEST_REFRESH_TOKEN=xoxe-1-My0xLTM5NDM5NTk2MzY5MTktNDQ1OTEyMTUyNDU4Mi00NDY4MTc4OTUxNzk2LTk4ZWU5Zjg0ZGQ5YTg3OTYzMDU2YjJiODNiMjU3ZTAzOTZkNmMxOGI3MTEyM2UyMmZhZDcyNWJhN2NjOWU1MDM
+MANIFEST_REFRESH_TOKEN=xoxe-1-randomTOKENstringPRODUCEDbySLACK
 SENTRY_DSN=https://[email protected]/6227373
+SLACK_BOT_ID=B0101010101
 SLACK_OAUTH_TOKEN=xoxb-3943959636919-3982289583824-iKtJsairxpmjH2yrVMg99nFG