Change to send slack invites only in production

Author: AllenAnthes

pybot/endpoints/api/slack_api.py

@@ -4,7 +4,11 @@
 from slack import ROOT_URL
 from slack.exceptions import SlackAPIError
 
-from pybot.endpoints.api.utils import _slack_info_from_email, handle_slack_invite_error
+from pybot.endpoints.api.utils import (
+    _slack_info_from_email,
+    handle_slack_invite_error,
+    production_only,
+)
 from pybot.plugins import APIPlugin
 from pybot.plugins.api.request import SlackApiRequest
 
@@ -32,13 +36,15 @@ async def verify(request: SlackApiRequest, app: SirBot) -> dict:
     return {"exists": False}
 
 
+@production_only
 async def invite(request: SlackApiRequest, app: SirBot):
     """
     Pulls an email out of the querystring and sends it an invite
     to the slack team
 
     :return: The request response from slack
     """
+
     admin_slack = app.plugins["admin_slack"].api
     slack = app.plugins["slack"].api
     body = await request.json()

pybot/endpoints/api/utils.py

@@ -1,14 +1,19 @@
+import logging
+from typing import Optional
+
+from slack import ROOT_URL
 from slack.exceptions import SlackAPIError
-from slack.methods import Methods
 from slack.io.abc import SlackAPI
-from slack import ROOT_URL
-from typing import Optional
+from slack.methods import Methods
 
-from pybot.endpoints.slack.utils import MODERATOR_CHANNEL
+from pybot.endpoints.slack.utils import MODERATOR_CHANNEL, PYBOT_ENV
 from pybot.endpoints.slack.utils.action_messages import (
     TICKET_OPTIONS,
     not_claimed_attachment,
 )
+from pybot.plugins.api.request import SlackApiRequest
+
+logger = logging.getLogger(__name__)
 
 
 async def _slack_info_from_email(
@@ -77,3 +82,24 @@ async def handle_slack_invite_error(email, error, slack):
     }
 
     return await slack.query(Methods.CHAT_POST_MESSAGE, response)
+
+
+def production_only(func):
+    """
+    Decorator for functions that shouldn't be called unless in
+    production environment.
+
+    Used to avoid doing things like sending slack workspace invites to
+    staging environments.
+    """
+
+    def not_prod(request: SlackApiRequest, app):
+        logger.info(
+            f"Received request on staging to {request.request.raw_path}.  Returning 200"
+        )
+        return {"ok": True, "details": "Development environment, returning 200"}
+
+    if PYBOT_ENV != "PRODUCTION":
+        return not_prod
+
+    return func

pybot/endpoints/slack/utils/__init__.py

@@ -15,6 +15,7 @@
 PYBACK_TOKEN = os.environ.get("PYBACK_TOKEN") or "token"
 PORT = os.environ.get("SIRBOT_PORT", 5000)
 HOST = os.environ.get("SIRBOT_ADDR", "0.0.0.0")
+PYBOT_ENV = os.environ.get("PYBOT_ENV", "dev")
 BOT_URL = "https://github.com/OperationCode/operationcode-pybot"
 
 slack_configs = {

pybot/plugins/api/endpoints.py

@@ -15,9 +15,7 @@ async def slack_api(request):
     try:
         slack_request = SlackApiRequest.from_request(request)
     except FailedVerification:
-        logger.info(
-            f"Failed verification to API route {request.url} from {request.remote}"
-        )
+        logger.info(f"Failed verification to API route {request.url}.")
         return Response(status=401)
 
     futures = list(_dispatch(api_plugin.routers["slack"], slack_request, request.app))