feat(user): Add option to only return verified emails from verify_user_emails (#69812)

Will be used to fetch only verified emails when notifying users that
their monitors have been in a broken state for an extended period of
time

Ensured that I only updated the function with an optional parameter, and
didn't have the callers use the new parameter yet.

Author: David Wang

src/sentry/services/hybrid_cloud/user/impl.py

@@ -277,14 +277,18 @@ def trigger_user_consent_email_if_applicable(self, *, user_id: int) -> None:
         user.send_confirm_emails(is_new_user=True)
 
     def verify_user_emails(
-        self, *, user_id_emails: list[UserIdEmailArgs]
+        self, *, user_id_emails: list[UserIdEmailArgs], only_verified: bool = False
     ) -> dict[int, RpcVerifyUserEmail]:
         results = {}
         for user_id_email in user_id_emails:
             user_id = user_id_email["user_id"]
             email = user_id_email["email"]
-            exists = UserEmail.objects.filter(user_id=user_id, email__iexact=email).exists()
-            results[user_id] = RpcVerifyUserEmail(email=email, exists=exists)
+
+            user_email_qs = UserEmail.objects.filter(user_id=user_id, email__iexact=email)
+            if only_verified:
+                user_email_qs = user_email_qs.filter(is_verified=True)
+
+            results[user_id] = RpcVerifyUserEmail(email=email, exists=user_email_qs.exists())
         return results
 
     def get_user_avatar(self, *, user_id: int) -> RpcAvatar | None:

src/sentry/services/hybrid_cloud/user/service.py

@@ -198,7 +198,7 @@ def trigger_user_consent_email_if_applicable(self, *, user_id: int) -> None:
     @rpc_method
     @abstractmethod
     def verify_user_emails(
-        self, *, user_id_emails: list[UserIdEmailArgs]
+        self, *, user_id_emails: list[UserIdEmailArgs], only_verified: bool = False
     ) -> dict[int, RpcVerifyUserEmail]:
         pass
 

tests/sentry/services/hybrid_cloud/user/test_impl.py

@@ -2,6 +2,7 @@
 from sentry.models.authidentity import AuthIdentity
 from sentry.models.authprovider import AuthProvider
 from sentry.models.user import User
+from sentry.models.useremail import UserEmail
 from sentry.services.hybrid_cloud.user.service import user_service
 from sentry.testutils.cases import TestCase
 from sentry.testutils.silo import control_silo_test
@@ -65,3 +66,35 @@ def test_get_user_with_ident(self):
         assert user2.id == fetched_user.id
         assert user1.id != fetched_user.id
         assert created is False
+
+    def test_verify_user_emails(self):
+        user1 = self.create_user(email="[email protected]")
+        user2 = self.create_user(email="[email protected]")
+        verified_emails = user_service.verify_user_emails(
+            user_id_emails=[
+                {"user_id": user1.id, "email": "[email protected]"},
+                {"user_id": user2.id, "email": "[email protected]"},
+            ],
+            only_verified=False,
+        )
+
+        # Tests that matching emails to user ids exist
+        assert verified_emails[user1.id].exists
+        assert not verified_emails[user2.id].exists
+
+    def test_verify_user_emails_only_verified(self):
+        user1 = self.create_user(email="[email protected]")
+        user2 = self.create_user(email="[email protected]")
+        UserEmail.objects.filter(user=user2, email="[email protected]").update(is_verified=False)
+
+        verified_emails = user_service.verify_user_emails(
+            user_id_emails=[
+                {"user_id": user1.id, "email": "[email protected]"},
+                {"user_id": user2.id, "email": "[email protected]"},
+            ],
+            only_verified=True,
+        )
+
+        # Tests that only verified emails are returned
+        assert verified_emails[user1.id].exists
+        assert not verified_emails[user2.id].exists