Merge pull request #647 from python-discord/voice-mute-in-metricity-endpoint

Use voice_mute and voice_ban to determine voice_gate

Author: lemonsaurus

pydis_site/apps/api/tests/test_users.py

@@ -1,10 +1,9 @@
-from unittest.mock import patch
+from unittest.mock import Mock, patch
 
-from django.core.exceptions import ObjectDoesNotExist
 from django.urls import reverse
 
 from .base import AuthenticatedAPITestCase
-from ..models import Role, User
+from ..models import Infraction, Role, User
 from ..models.bot.metricity import NotFoundError
 from ..viewsets.bot.user import UserListPagination
 
@@ -424,7 +423,7 @@ def test_get_metricity_data(self):
         self.assertCountEqual(response.json(), {
             "joined_at": joined_at,
             "total_messages": total_messages,
-            "voice_banned": False,
+            "voice_gate_blocked": False,
             "activity_blocks": total_blocks
         })
 
@@ -451,23 +450,36 @@ def test_no_metricity_user_for_review(self):
         self.assertEqual(response.status_code, 404)
 
     def test_metricity_voice_banned(self):
+        queryset_with_values = Mock(spec=Infraction.objects)
+        queryset_with_values.filter.return_value = queryset_with_values
+        queryset_with_values.exists.return_value = True
+
+        queryset_without_values = Mock(spec=Infraction.objects)
+        queryset_without_values.filter.return_value = queryset_without_values
+        queryset_without_values.exists.return_value = False
         cases = [
-            {'exception': None, 'voice_banned': True},
-            {'exception': ObjectDoesNotExist, 'voice_banned': False},
+            {'voice_infractions': queryset_with_values, 'voice_gate_blocked': True},
+            {'voice_infractions': queryset_without_values, 'voice_gate_blocked': False},
         ]
 
         self.mock_metricity_user("foo", 1, 1, [["bar", 1]])
 
         for case in cases:
-            with self.subTest(exception=case['exception'], voice_banned=case['voice_banned']):
-                with patch("pydis_site.apps.api.viewsets.bot.user.Infraction.objects.get") as p:
-                    p.side_effect = case['exception']
+            with self.subTest(
+                voice_infractions=case['voice_infractions'],
+                voice_gate_blocked=case['voice_gate_blocked']
+            ):
+                with patch("pydis_site.apps.api.viewsets.bot.user.Infraction.objects.filter") as p:
+                    p.return_value = case['voice_infractions']
 
                     url = reverse('api:bot:user-metricity-data', args=[0])
                     response = self.client.get(url)
 
                     self.assertEqual(response.status_code, 200)
-                    self.assertEqual(response.json()["voice_banned"], case["voice_banned"])
+                    self.assertEqual(
+                        response.json()["voice_gate_blocked"],
+                        case["voice_gate_blocked"]
+                    )
 
     def test_metricity_review_data(self):
         # Given

pydis_site/apps/api/viewsets/bot/user.py

@@ -1,7 +1,7 @@
 import typing
 from collections import OrderedDict
 
-from django.core.exceptions import ObjectDoesNotExist
+from django.db.models import Q
 from rest_framework import status
 from rest_framework.decorators import action
 from rest_framework.pagination import PageNumberPagination
@@ -261,12 +261,10 @@ def metricity_data(self, request: Request, pk: str = None) -> Response:
         """Request handler for metricity_data endpoint."""
         user = self.get_object()
 
-        try:
-            Infraction.objects.get(user__id=user.id, active=True, type="voice_ban")
-        except ObjectDoesNotExist:
-            voice_banned = False
-        else:
-            voice_banned = True
+        has_voice_infraction = Infraction.objects.filter(
+            Q(user__id=user.id, active=True),
+            Q(type="voice_ban") | Q(type="voice_mute")
+        ).exists()
 
         with Metricity() as metricity:
             try:
@@ -275,7 +273,7 @@ def metricity_data(self, request: Request, pk: str = None) -> Response:
                 data["total_messages"] = metricity.total_messages(user.id)
                 data["activity_blocks"] = metricity.total_message_blocks(user.id)
 
-                data["voice_banned"] = voice_banned
+                data["voice_gate_blocked"] = has_voice_infraction
                 return Response(data, status=status.HTTP_200_OK)
             except NotFoundError:
                 return Response(dict(detail="User not found in metricity"),