🔧 chore: fix msteams client typing (#89449)

Author: iamrajjoshi

pyproject.toml

@@ -131,7 +131,6 @@ module = [
     "sentry.integrations.github.integration",
     "sentry.integrations.gitlab.issues",
     "sentry.integrations.jira.integration",
-    "sentry.integrations.msteams.client",
     "sentry.integrations.msteams.notifications",
     "sentry.integrations.pagerduty.actions.form",
     "sentry.integrations.pipeline",

src/sentry/integrations/msteams/client.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import time
+from abc import ABC
 from urllib.parse import urlencode
 
 from requests import PreparedRequest
@@ -11,14 +12,15 @@
 from sentry.integrations.services.integration import integration_service
 from sentry.integrations.services.integration.model import RpcIntegration
 from sentry.shared_integrations.client.proxy import IntegrationProxyClient, infer_org_integration
+from sentry.shared_integrations.exceptions import IntegrationError
 from sentry.silo.base import SiloMode, control_silo_function
 
 # five minutes which is industry standard clock skew tolerance
 CLOCK_SKEW = 60 * 5
 
 
-# MsTeamsClientMixin abstract client does not handle setting the base url or auth token
-class MsTeamsClientMixin:
+# MsTeamsClientABC abstract client does not handle setting the base url or auth token
+class MsTeamsClientABC(ApiClient, ABC):
     integration_name = "msteams"
     TEAM_URL = "/v3/teams/%s"
     CHANNEL_URL = "/v3/teams/%s/conversations"
@@ -33,7 +35,7 @@ def get_channel_list(self, team_id: str):
 
     def get_member_list(self, team_id: str, continuation_token: str | None = None):
         url = self.MEMBER_URL % team_id
-        params = {"pageSize": 500}
+        params: dict[str, int | str] = {"pageSize": 500}
         if continuation_token:
             params["continuationToken"] = continuation_token
         return self.get(url, params=params)
@@ -70,7 +72,7 @@ def update_card(self, conversation_id: str, activity_id: str, card):
 
 # MsTeamsPreInstallClient is used with the access token and service url as arguments to the constructor
 # It will not handle token refreshing
-class MsTeamsPreInstallClient(ApiClient, MsTeamsClientMixin):
+class MsTeamsPreInstallClient(MsTeamsClientABC):
     integration_name = "msteams"
 
     def __init__(self, access_token: str, service_url: str):
@@ -84,7 +86,7 @@ def request(self, method, path, data=None, params=None):
 
 
 # MsTeamsClient is used with an existing integration object and handles token refreshing
-class MsTeamsClient(IntegrationProxyClient, MsTeamsClientMixin):
+class MsTeamsClient(MsTeamsClientABC, IntegrationProxyClient):
     integration_name = "msteams"
 
     def __init__(self, integration: Integration | RpcIntegration):
@@ -117,10 +119,16 @@ def access_token(self):
                 access_token = token_data["access_token"]
                 new_metadata.update(token_data)
 
-                self.integration = integration_service.update_integration(
-                    integration_id=self.integration.id,
-                    metadata=new_metadata,
-                )
+                if (
+                    updated_integration := integration_service.update_integration(
+                        integration_id=self.integration.id,
+                        metadata=new_metadata,
+                    )
+                ) is None:
+                    # This should never happen, but if it does, fail loudly
+                    raise IntegrationError("Integration not found, failed to refresh access token")
+
+                self.integration = updated_integration
         return access_token
 
     @control_silo_function

tests/sentry/integrations/msteams/notifications/test_assigned.py

@@ -10,10 +10,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsAssignedNotificationTest(MSTeamsActivityNotificationTest):
     def test_assigned(self, mock_send_card: MagicMock):
         """

tests/sentry/integrations/msteams/notifications/test_deploy.py

@@ -11,10 +11,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsDeployNotificationTest(MSTeamsActivityNotificationTest):
     @skip("Flaky test")
     def test_deploy(self, mock_send_card: MagicMock):

tests/sentry/integrations/msteams/notifications/test_escalating.py

@@ -10,10 +10,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsEscalatingNotificationTest(MSTeamsActivityNotificationTest):
     def test_note(self, mock_send_card: MagicMock):
         """

tests/sentry/integrations/msteams/notifications/test_issue_alert.py

@@ -13,10 +13,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsIssueAlertNotificationTest(MSTeamsActivityNotificationTest):
     def test_issue_alert_user(self, mock_send_card: MagicMock):
         """Test that issue alerts are sent to a MS Teams user."""

tests/sentry/integrations/msteams/notifications/test_note.py

@@ -10,10 +10,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsNoteNotificationTest(MSTeamsActivityNotificationTest):
     def test_note(self, mock_send_card: MagicMock):
         """

tests/sentry/integrations/msteams/notifications/test_regression.py

@@ -10,10 +10,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsRegressionNotificationTest(MSTeamsActivityNotificationTest):
     def test_regression(self, mock_send_card: MagicMock):
         """

tests/sentry/integrations/msteams/notifications/test_resolved.py

@@ -13,10 +13,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsResolvedNotificationTest(MSTeamsActivityNotificationTest):
     def test_resolved(self, mock_send_card: MagicMock):
         """

tests/sentry/integrations/msteams/notifications/test_unassigned.py

@@ -10,10 +10,10 @@
 
 
 @patch(
-    "sentry.integrations.msteams.MsTeamsClientMixin.get_user_conversation_id",
+    "sentry.integrations.msteams.MsTeamsClientABC.get_user_conversation_id",
     Mock(return_value="some_conversation_id"),
 )
-@patch("sentry.integrations.msteams.MsTeamsClientMixin.send_card")
+@patch("sentry.integrations.msteams.MsTeamsClientABC.send_card")
 class MSTeamsUnassignedNotificationTest(MSTeamsActivityNotificationTest):
     def test_unassigned(self, mock_send_card: MagicMock):
         """