From c6dfd896304cb4e36c4020f4704d9537fd3e8e9f Mon Sep 17 00:00:00 2001
From: Matteo Bertucci <matteobertucci2004@gmail.com>
Date: Tue, 27 Apr 2021 16:39:00 +0200
Subject: Filters: update tests to the new schema

---
 pydis_site/apps/api/tests/test_filterlists.py | 122 -----------
 pydis_site/apps/api/tests/test_filters.py     | 284 ++++++++++++++++++++++++++
 pydis_site/apps/api/tests/test_models.py      |  14 ++
 3 files changed, 298 insertions(+), 122 deletions(-)
 delete mode 100644 pydis_site/apps/api/tests/test_filterlists.py
 create mode 100644 pydis_site/apps/api/tests/test_filters.py

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/tests/test_filterlists.py b/pydis_site/apps/api/tests/test_filterlists.py
deleted file mode 100644
index 5a5bca60..00000000
--- a/pydis_site/apps/api/tests/test_filterlists.py
+++ /dev/null
@@ -1,122 +0,0 @@
-from django.urls import reverse
-
-from pydis_site.apps.api.models import FilterList
-from pydis_site.apps.api.tests.base import AuthenticatedAPITestCase
-
-URL = reverse('api:bot:filterlist-list')
-JPEG_ALLOWLIST = {
-    "type": 'FILE_FORMAT',
-    "allowed": True,
-    "content": ".jpeg",
-}
-PNG_ALLOWLIST = {
-    "type": 'FILE_FORMAT',
-    "allowed": True,
-    "content": ".png",
-}
-
-
-class UnauthenticatedTests(AuthenticatedAPITestCase):
-    def setUp(self):
-        super().setUp()
-        self.client.force_authenticate(user=None)
-
-    def test_cannot_read_allowedlist_list(self):
-        response = self.client.get(URL)
-
-        self.assertEqual(response.status_code, 401)
-
-
-class EmptyDatabaseTests(AuthenticatedAPITestCase):
-    @classmethod
-    def setUpTestData(cls):
-        FilterList.objects.all().delete()
-
-    def test_returns_empty_object(self):
-        response = self.client.get(URL)
-
-        self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json(), [])
-
-
-class FetchTests(AuthenticatedAPITestCase):
-    @classmethod
-    def setUpTestData(cls):
-        FilterList.objects.all().delete()
-        cls.jpeg_format = FilterList.objects.create(**JPEG_ALLOWLIST)
-        cls.png_format = FilterList.objects.create(**PNG_ALLOWLIST)
-
-    def test_returns_name_in_list(self):
-        response = self.client.get(URL)
-
-        self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json()[0]["content"], self.jpeg_format.content)
-        self.assertEqual(response.json()[1]["content"], self.png_format.content)
-
-    def test_returns_single_item_by_id(self):
-        response = self.client.get(f'{URL}/{self.jpeg_format.id}')
-
-        self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json().get("content"), self.jpeg_format.content)
-
-    def test_returns_filter_list_types(self):
-        response = self.client.get(f'{URL}/get-types')
-
-        self.assertEqual(response.status_code, 200)
-        for api_type, model_type in zip(response.json(), FilterList.FilterListType.choices):
-            self.assertEquals(api_type[0], model_type[0])
-            self.assertEquals(api_type[1], model_type[1])
-
-
-class CreationTests(AuthenticatedAPITestCase):
-    @classmethod
-    def setUpTestData(cls):
-        FilterList.objects.all().delete()
-
-    def test_returns_400_for_missing_params(self):
-        no_type_json = {
-            "allowed": True,
-            "content": ".jpeg"
-        }
-        no_allowed_json = {
-            "type": "FILE_FORMAT",
-            "content": ".jpeg"
-        }
-        no_content_json = {
-            "allowed": True,
-            "type": "FILE_FORMAT"
-        }
-        cases = [{}, no_type_json, no_allowed_json, no_content_json]
-
-        for case in cases:
-            with self.subTest(case=case):
-                response = self.client.post(URL, data=case)
-                self.assertEqual(response.status_code, 400)
-
-    def test_returns_201_for_successful_creation(self):
-        response = self.client.post(URL, data=JPEG_ALLOWLIST)
-        self.assertEqual(response.status_code, 201)
-
-    def test_returns_400_for_duplicate_creation(self):
-        self.client.post(URL, data=JPEG_ALLOWLIST)
-        response = self.client.post(URL, data=JPEG_ALLOWLIST)
-        self.assertEqual(response.status_code, 400)
-
-
-class DeletionTests(AuthenticatedAPITestCase):
-    @classmethod
-    def setUpTestData(cls):
-        FilterList.objects.all().delete()
-        cls.jpeg_format = FilterList.objects.create(**JPEG_ALLOWLIST)
-        cls.png_format = FilterList.objects.create(**PNG_ALLOWLIST)
-
-    def test_deleting_unknown_id_returns_404(self):
-        response = self.client.delete(f"{URL}/200")
-        self.assertEqual(response.status_code, 404)
-
-    def test_deleting_known_id_returns_204(self):
-        response = self.client.delete(f"{URL}/{self.jpeg_format.id}")
-        self.assertEqual(response.status_code, 204)
-
-        response = self.client.get(f"{URL}/{self.jpeg_format.id}")
-        self.assertNotIn(self.png_format.content, response.json())
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
new file mode 100644
index 00000000..de78ecfd
--- /dev/null
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -0,0 +1,284 @@
+import contextlib
+from dataclasses import dataclass
+from typing import Any, Dict, Tuple, Type
+
+from django.db.models import Model
+from django_hosts import reverse
+
+from pydis_site.apps.api.models.bot.filters import (  # noqa: I101 - Preserving the filter order
+    FilterList,
+    FilterSettings,
+    FilterAction,
+    ChannelRange,
+    Filter,
+    FilterOverride
+)
+from pydis_site.apps.api.tests.base import APISubdomainTestCase
+
+
+@dataclass()
+class TestSequence:
+    model: Type[Model]
+    route: str
+    object: Dict[str, Any]
+    ignored_fields: Tuple[str] = ()
+
+    def url(self, detail: bool = False) -> str:
+        return reverse(f'bot:{self.route}-{"detail" if detail else "list"}', host='api')
+
+
+FK_FIELDS: Dict[Type[Model], Tuple[str]] = {
+    FilterList: ("default_settings",),
+    FilterSettings: ("default_action", "default_range"),
+    FilterAction: (),
+    ChannelRange: (),
+    Filter: (),
+    FilterOverride: ("filter_action", "filter_range")
+}
+
+
+def get_test_sequences() -> Dict[str, TestSequence]:
+    return {
+        "filter_list": TestSequence(
+            FilterList,
+            "filterlist",
+            {
+                "name": "testname",
+                "list_type": 0,
+                "default_settings": FilterSettings(
+                    ping_type=[],
+                    filter_dm=False,
+                    dm_ping_type=[],
+                    delete_messages=False,
+                    bypass_roles=[],
+                    enabled=False,
+                    default_action=FilterAction(
+                        user_dm=None,
+                        infraction_type=None,
+                        infraction_reason="",
+                        infraction_duration=None
+                    ),
+                    default_range=ChannelRange(
+                        disallowed_channels=[],
+                        disallowed_categories=[],
+                        allowed_channels=[],
+                        allowed_category=[],
+                        default=False
+                    )
+                )
+            },
+            ignored_fields=("filters",)
+        ),
+        "filter_settings": TestSequence(
+            FilterSettings,
+            "filtersettings",
+            {
+                "ping_type": ["onduty"],
+                "filter_dm": True,
+                "dm_ping_type": ["123456"],
+                "delete_messages": True,
+                "bypass_roles": [123456],
+                "enabled": True,
+                "default_action": FilterAction(
+                    user_dm=None,
+                    infraction_type=None,
+                    infraction_reason="",
+                    infraction_duration=None
+                ),
+                "default_range": ChannelRange(
+                    disallowed_channels=[],
+                    disallowed_categories=[],
+                    allowed_channels=[],
+                    allowed_category=[],
+                    default=False
+                )
+            }
+        ),
+        "filter_action": TestSequence(
+            FilterAction,
+            "filteraction",
+            {
+                "user_dm": "This is a DM message.",
+                "infraction_type": "Mute",
+                "infraction_reason": "Too long beard",
+                "infraction_duration": "1 02:03:00"
+            }
+        ),
+        "channel_range": TestSequence(
+            ChannelRange,
+            "channelrange",
+            {
+                "disallowed_channels": [1234],
+                "disallowed_categories": [5678],
+                "allowed_channels": [9101],
+                "allowed_category": [1121],
+                "default": True
+            }
+        ),
+        "filter": TestSequence(
+            Filter,
+            "filter",
+            {
+                "content": "bad word",
+                "description": "This is a really bad word.",
+                "additional_field": None,
+                "override": None
+            }
+        ),
+        "filter_override": TestSequence(
+            FilterOverride,
+            "filteroverride",
+            {
+                "ping_type": ["everyone"],
+                "filter_dm": False,
+                "dm_ping_type": ["here"],
+                "delete_messages": False,
+                "bypass_roles": [9876],
+                "enabled": True,
+                "filter_action": None,
+                "filter_range": None
+            }
+        )
+    }
+
+
+def save_nested_objects(object_: Model, save_root: bool = True) -> None:
+    for field in FK_FIELDS[object_.__class__]:
+        value = getattr(object_, field)
+
+        if value is not None:
+            save_nested_objects(value)
+
+    if save_root:
+        object_.save()
+
+
+def clean_test_json(json: dict) -> dict:
+    for key, value in json.items():
+        if isinstance(value, Model):
+            json[key] = value.id
+
+    return json
+
+
+def clean_api_json(json: dict, sequence: TestSequence) -> dict:
+    for field in sequence.ignored_fields + ("id",):
+        with contextlib.suppress(KeyError):
+            del json[field]
+
+    return json
+
+
+class GenericFilterTest(APISubdomainTestCase):
+    def test_cannot_read_unauthenticated(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                self.client.force_authenticate(user=None)
+
+                response = self.client.get(sequence.url())
+                self.assertEqual(response.status_code, 401)
+
+    def test_empty_database(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                sequence.model.objects.all().delete()
+
+                response = self.client.get(sequence.url())
+                self.assertEqual(response.status_code, 200)
+                self.assertEqual(response.json(), [])
+
+    def test_fetch(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                sequence.model.objects.all().delete()
+
+                save_nested_objects(sequence.model(**sequence.object))
+
+                response = self.client.get(sequence.url())
+                self.assertDictEqual(
+                    clean_test_json(sequence.object),
+                    clean_api_json(response.json()[0], sequence)
+                )
+
+    def test_fetch_by_id(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                sequence.model.objects.all().delete()
+
+                saved = sequence.model(**sequence.object)
+                save_nested_objects(saved)
+
+                response = self.client.get(f"{sequence.url()}/{saved.id}")
+                self.assertDictEqual(
+                    clean_test_json(sequence.object),
+                    clean_api_json(response.json(), sequence)
+                )
+
+    def test_fetch_non_existing(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                sequence.model.objects.all().delete()
+
+                response = self.client.get(f"{sequence.url()}/42")
+                self.assertEqual(response.status_code, 404)
+                self.assertDictEqual(response.json(), {'detail': 'Not found.'})
+
+    def test_creation(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                sequence.model.objects.all().delete()
+
+                save_nested_objects(sequence.model(**sequence.object), False)
+                data = clean_test_json(sequence.object.copy())
+                response = self.client.post(sequence.url(), data=data)
+
+                self.assertEqual(response.status_code, 201)
+                self.assertDictEqual(
+                    clean_api_json(response.json(), sequence),
+                    clean_test_json(sequence.object)
+                )
+
+    def test_creation_missing_field(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                save_nested_objects(sequence.model(**sequence.object), False)
+                data = clean_test_json(sequence.object.copy())
+
+                for field in sequence.model._meta.get_fields():
+                    with self.subTest(field=field):
+                        if field.null or field.name in sequence.ignored_fields + ("id",):
+                            continue
+
+                        test_data = data.copy()
+                        del test_data[field.name]
+
+                        response = self.client.post(sequence.url(), data=test_data)
+                        self.assertEqual(response.status_code, 400)
+
+    def test_deletion(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                saved = sequence.model(**sequence.object)
+                save_nested_objects(saved)
+
+                response = self.client.delete(f"{sequence.url()}/{saved.id}")
+                self.assertEqual(response.status_code, 204)
+
+    def test_deletion_non_existing(self) -> None:
+        for name, sequence in get_test_sequences().items():
+            with self.subTest(name=name):
+                sequence.model.objects.all().delete()
+
+                response = self.client.delete(f"{sequence.url()}/42")
+                self.assertEqual(response.status_code, 404)
+
+    def test_reject_invalid_ping(self) -> None:
+        url = reverse('bot:filteroverride-list', host='api')
+        data = {
+            "ping_type": ["invalid"]
+        }
+
+        response = self.client.post(url, data=data)
+
+        self.assertEqual(response.status_code, 400)
+        self.assertDictEqual(response.json(), {'ping_type': ["'invalid' isn't a valid ping type."]})
diff --git a/pydis_site/apps/api/tests/test_models.py b/pydis_site/apps/api/tests/test_models.py
index 5c9ddea4..c8f4e1b1 100644
--- a/pydis_site/apps/api/tests/test_models.py
+++ b/pydis_site/apps/api/tests/test_models.py
@@ -7,6 +7,9 @@ from django.utils import timezone
 from pydis_site.apps.api.models import (
     DeletedMessage,
     DocumentationLink,
+    Filter,
+    FilterList,
+    FilterSettings,
     Infraction,
     Message,
     MessageDeletionContext,
@@ -106,6 +109,17 @@ class StringDunderMethodTests(SimpleTestCase):
             DocumentationLink(
                 'test', 'http://example.com', 'http://example.com'
             ),
+            FilterList(
+                name="forbidden_duckies",
+                list_type=0,
+                default_settings=FilterSettings()
+            ),
+            Filter(
+                content="ducky_nsfw",
+                description="This ducky is totally inappropriate!",
+                additional_field=None,
+                override=None
+            ),
             OffensiveMessage(
                 id=602951077675139072,
                 channel_id=291284109232308226,
-- 
cgit v1.2.3


From 71a5e0d854c587ca2ae70aaec80f1110ea8800e5 Mon Sep 17 00:00:00 2001
From: Matteo Bertucci <matteobertucci2004@gmail.com>
Date: Tue, 27 Apr 2021 16:41:18 +0200
Subject: Filters: allowed_category -> allowed_categories

---
 pydis_site/apps/api/migrations/0070_new_filter_schema.py | 4 ++--
 pydis_site/apps/api/models/bot/filters.py                | 2 +-
 pydis_site/apps/api/serializers.py                       | 2 +-
 pydis_site/apps/api/tests/test_filters.py                | 6 +++---
 pydis_site/apps/api/viewsets/bot/filters.py              | 8 ++++----
 5 files changed, 11 insertions(+), 11 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0070_new_filter_schema.py b/pydis_site/apps/api/migrations/0070_new_filter_schema.py
index de75e677..eb55e329 100644
--- a/pydis_site/apps/api/migrations/0070_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0070_new_filter_schema.py
@@ -33,7 +33,7 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
             disallowed_channels=[],
             disallowed_categories=[],
             allowed_channels=[],
-            allowed_category=[],
+            allowed_categories=[],
             default=True
         )
         default_range.save()
@@ -85,7 +85,7 @@ class Migration(migrations.Migration):
                 ('disallowed_channels', django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), size=None)),
                 ('disallowed_categories', django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), size=None)),
                 ('allowed_channels', django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), size=None)),
-                ('allowed_category', django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), size=None)),
+                ('allowed_categories', django.contrib.postgres.fields.ArrayField(base_field=models.IntegerField(), size=None)),
                 ('default', models.BooleanField()),
             ],
         ),
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index 869f947c..c2f776d3 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -142,7 +142,7 @@ class ChannelRange(models.Model):
     disallowed_channels = ArrayField(models.IntegerField())
     disallowed_categories = ArrayField(models.IntegerField())
     allowed_channels = ArrayField(models.IntegerField())
-    allowed_category = ArrayField(models.IntegerField())
+    allowed_categories = ArrayField(models.IntegerField())
     default = models.BooleanField()
 
 
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 306dccb3..54acf366 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -180,7 +180,7 @@ class FilterChannelRangeSerializer(ModelSerializer):
             'disallowed_channels',
             'disallowed_categories',
             'allowed_channels',
-            'allowed_category',
+            'allowed_categories',
             'default'
         )
 
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index de78ecfd..f38f3659 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -62,7 +62,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                         disallowed_channels=[],
                         disallowed_categories=[],
                         allowed_channels=[],
-                        allowed_category=[],
+                        allowed_categories=[],
                         default=False
                     )
                 )
@@ -89,7 +89,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                     disallowed_channels=[],
                     disallowed_categories=[],
                     allowed_channels=[],
-                    allowed_category=[],
+                    allowed_categories=[],
                     default=False
                 )
             }
@@ -111,7 +111,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                 "disallowed_channels": [1234],
                 "disallowed_categories": [5678],
                 "allowed_channels": [9101],
-                "allowed_category": [1121],
+                "allowed_categories": [1121],
                 "default": True
             }
         ),
diff --git a/pydis_site/apps/api/viewsets/bot/filters.py b/pydis_site/apps/api/viewsets/bot/filters.py
index fea53265..e290fc65 100644
--- a/pydis_site/apps/api/viewsets/bot/filters.py
+++ b/pydis_site/apps/api/viewsets/bot/filters.py
@@ -350,7 +350,7 @@ class FilterChannelRangeViewSet(ModelViewSet):
     ...         "disallowed_channels": [],
     ...         "disallowed_categories": [],
     ...         "allowed_channels": [],
-    ...         "allowed_category": [],
+    ...         "allowed_categories": [],
     ...         "default": True
     ...     },
     ...     ...
@@ -369,7 +369,7 @@ class FilterChannelRangeViewSet(ModelViewSet):
     ...     "disallowed_channels": [],
     ...     "disallowed_categories": [],
     ...     "allowed_channels": [],
-    ...     "allowed_category": [],
+    ...     "allowed_categories": [],
     ...     "default": True
     ... }
 
@@ -385,7 +385,7 @@ class FilterChannelRangeViewSet(ModelViewSet):
     ...     "disallowed_channels": [],
     ...     "disallowed_categories": [],
     ...     "allowed_channels": [],
-    ...     "allowed_category": [],
+    ...     "allowed_categories": [],
     ...     "default": True
     ... }
 
@@ -402,7 +402,7 @@ class FilterChannelRangeViewSet(ModelViewSet):
     ...     "disallowed_channels": [],
     ...     "disallowed_categories": [],
     ...     "allowed_channels": [],
-    ...     "allowed_category": [],
+    ...     "allowed_categories": [],
     ...     "default": True
     ... }
 
-- 
cgit v1.2.3


From 1095346a1f86e43d5d5c39045a54354d1290fe0e Mon Sep 17 00:00:00 2001
From: kosayoda <kieransiek@protonmail.com>
Date: Sun, 11 Jul 2021 16:35:41 +0800
Subject: Improve name of dm sent to triggered user.

---
 pydis_site/apps/api/migrations/0070_new_filter_schema.py | 4 ++--
 pydis_site/apps/api/models/bot/filters.py                | 2 +-
 pydis_site/apps/api/serializers.py                       | 2 +-
 pydis_site/apps/api/tests/test_filters.py                | 6 +++---
 pydis_site/apps/api/viewsets/bot/filters.py              | 8 ++++----
 5 files changed, 11 insertions(+), 11 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0070_new_filter_schema.py b/pydis_site/apps/api/migrations/0070_new_filter_schema.py
index eb55e329..8580033a 100644
--- a/pydis_site/apps/api/migrations/0070_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0070_new_filter_schema.py
@@ -23,7 +23,7 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
         objects = filter_list_old.objects.filter(type=name)
 
         default_action = filter_action.objects.create(
-            user_dm=None,
+            dm_content=None,
             infraction_type=None,
             infraction_reason="",
             infraction_duration=None
@@ -102,7 +102,7 @@ class Migration(migrations.Migration):
             name='FilterAction',
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('user_dm', models.CharField(help_text='The DM to send to a user triggering this filter.', max_length=1000, null=True)),
+                ('dm_content', models.CharField(help_text='The DM to send to a user triggering this filter.', max_length=1000, null=True)),
                 ('infraction_type', models.CharField(choices=[('Note', 'Note'), ('Warn', 'Warn'), ('Mute', 'Mute'), ('Kick', 'Kick'), ('Ban', 'Ban')], help_text='The infraction to apply to this user.', max_length=4, null=True)),
                 ('infraction_reason', models.CharField(help_text='The reason to give for the infraction.', max_length=1000)),
                 ('infraction_duration', models.DurationField(help_text='The duration of the infraction. Null if permanent.', null=True)),
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index 6f35bfb0..b5c80bda 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -106,7 +106,7 @@ class FilterSettings(models.Model):
 class FilterAction(models.Model):
     """The action to take when a filter is triggered."""
 
-    user_dm = models.CharField(
+    dm_content = models.CharField(
         max_length=1000,
         null=True,
         help_text="The DM to send to a user triggering this filter."
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 54acf366..584d1f22 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -165,7 +165,7 @@ class FilterActionSerializer(ModelSerializer):
         """Metadata defined for the Django REST Framework."""
 
         model = FilterAction
-        fields = ('id', 'user_dm', 'infraction_type', 'infraction_reason', 'infraction_duration')
+        fields = ('id', 'dm_content', 'infraction_type', 'infraction_reason', 'infraction_duration')
 
 
 class FilterChannelRangeSerializer(ModelSerializer):
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index f38f3659..2df671e0 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -53,7 +53,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                     bypass_roles=[],
                     enabled=False,
                     default_action=FilterAction(
-                        user_dm=None,
+                        dm_content=None,
                         infraction_type=None,
                         infraction_reason="",
                         infraction_duration=None
@@ -80,7 +80,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                 "bypass_roles": [123456],
                 "enabled": True,
                 "default_action": FilterAction(
-                    user_dm=None,
+                    dm_content=None,
                     infraction_type=None,
                     infraction_reason="",
                     infraction_duration=None
@@ -98,7 +98,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
             FilterAction,
             "filteraction",
             {
-                "user_dm": "This is a DM message.",
+                "dm_content": "This is a DM message.",
                 "infraction_type": "Mute",
                 "infraction_reason": "Too long beard",
                 "infraction_duration": "1 02:03:00"
diff --git a/pydis_site/apps/api/viewsets/bot/filters.py b/pydis_site/apps/api/viewsets/bot/filters.py
index e290fc65..9553fcac 100644
--- a/pydis_site/apps/api/viewsets/bot/filters.py
+++ b/pydis_site/apps/api/viewsets/bot/filters.py
@@ -264,7 +264,7 @@ class FilterActionViewSet(ModelViewSet):
     >>> [
     ...     {
     ...         "id": 1,
-    ...         "user_dm": "message",
+    ...         "dm_content": "message",
     ...         "infraction_type": "Warn",
     ...         "infraction_reason": "",
     ...         "infraction_duration": "01 12:34:56.123456"
@@ -282,7 +282,7 @@ class FilterActionViewSet(ModelViewSet):
     #### Response format
     >>> {
     ...     "id": 1,
-    ...     "user_dm": "message",
+    ...     "dm_content": "message",
     ...     "infraction_type": "Warn",
     ...     "infraction_reason": "",
     ...     "infraction_duration": "01 12:34:56.123456"
@@ -297,7 +297,7 @@ class FilterActionViewSet(ModelViewSet):
 
     #### Request body
     >>> {
-    ...     "user_dm": "message",
+    ...     "dm_content": "message",
     ...     "infraction_type": "Warn",
     ...     "infraction_reason": "",
     ...     "infraction_duration": "01 12:34:56.123456"
@@ -313,7 +313,7 @@ class FilterActionViewSet(ModelViewSet):
     #### Response format
     >>> {
     ...     "id": 1,
-    ...     "user_dm": "message",
+    ...     "dm_content": "message",
     ...     "infraction_type": "Warn",
     ...     "infraction_reason": "",
     ...     "infraction_duration": "01 12:34:56.123456"
-- 
cgit v1.2.3


From b082de6662e1b57f6831d219b44d95f93ed8a884 Mon Sep 17 00:00:00 2001
From: kosayoda <kieransiek@protonmail.com>
Date: Fri, 23 Jul 2021 18:58:35 +0800
Subject: Correct Filter-FilterList relationship.

Instead of a many-many relationship, one filterlist has multiple
filters. Nested serialization is read-only by default, so not
all CRUD methods are implemented yet for the FilterList viewset.
---
 .../apps/api/migrations/0070_new_filter_schema.py  | 11 ++--
 pydis_site/apps/api/models/bot/filters.py          |  6 +-
 pydis_site/apps/api/serializers.py                 | 22 ++++----
 pydis_site/apps/api/tests/test_filters.py          | 29 +++++++++-
 pydis_site/apps/api/viewsets/bot/filters.py        | 64 +++++++---------------
 5 files changed, 68 insertions(+), 64 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0070_new_filter_schema.py b/pydis_site/apps/api/migrations/0070_new_filter_schema.py
index 8580033a..237ce7d7 100644
--- a/pydis_site/apps/api/migrations/0070_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0070_new_filter_schema.py
@@ -54,17 +54,14 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
             list_type=1 if type_ == "ALLOW" else 0
         )
 
-        new_objects = []
         for object_ in objects:
             new_object = filter_.objects.create(
                 content=object_.content,
+                filter_list = list_,
                 description=object_.comment or "<no description provided>",
                 additional_field=None, override=None
             )
             new_object.save()
-            new_objects.append(new_object)
-
-        list_.filters.add(*new_objects)
 
 
 class Migration(migrations.Migration):
@@ -143,7 +140,6 @@ class Migration(migrations.Migration):
                 ('name', models.CharField(help_text='The unique name of this list.', max_length=50)),
                 ('list_type', models.IntegerField(choices=[], help_text='Whenever this list is an allowlist or denylist')),
                 ('default_settings', models.ForeignKey(help_text='Default parameters of this list.', on_delete=django.db.models.deletion.CASCADE, to='api.FilterSettings')),
-                ('filters', models.ManyToManyField(help_text='The content of this list.', to='api.Filter', default=[])),
             ],
         ),
         migrations.AddField(
@@ -151,6 +147,11 @@ class Migration(migrations.Migration):
             name='override',
             field=models.ForeignKey(help_text='Override the default settings.', null=True, on_delete=django.db.models.deletion.SET_NULL, to='api.FilterOverride'),
         ),
+        migrations.AddField(
+            model_name='filter',
+            name='filter_list',
+            field=models.ForeignKey(help_text='The filter list containing this filter.', on_delete=django.db.models.deletion.CASCADE, related_name='filters', to='api.FilterList'),
+        ),
         migrations.AddConstraint(
             model_name='filterlist',
             constraint=models.UniqueConstraint(fields=('name', 'list_type'), name='unique_name_type'),
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index b5c80bda..99d6d5e4 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -48,8 +48,6 @@ class FilterList(models.Model):
         choices=FilterListType.choices,
         help_text="Whether this list is an allowlist or denylist"
     )
-
-    filters = models.ManyToManyField("Filter", help_text="The content of this list.", default=[])
     default_settings = models.ForeignKey(
         "FilterSettings",
         models.CASCADE,
@@ -152,6 +150,10 @@ class Filter(models.Model):
     content = models.CharField(max_length=100, help_text="The definition of this filter.")
     description = models.CharField(max_length=200, help_text="Why this filter has been added.")
     additional_field = models.BooleanField(null=True, help_text="Implementation specific field.")
+    filter_list = models.ForeignKey(
+        FilterList, models.CASCADE, related_name="filters",
+        help_text="The filter list containing this filter."
+    )
     override = models.ForeignKey(
         "FilterOverride",
         models.SET_NULL,
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 584d1f22..afcf4d55 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -117,9 +117,21 @@ class DocumentationLinkSerializer(ModelSerializer):
         fields = ('package', 'base_url', 'inventory_url')
 
 
+class FilterSerializer(ModelSerializer):
+    """A class providing (de-)serialization of `Filter` instances."""
+
+    class Meta:
+        """Metadata defined for the Django REST Framework."""
+
+        model = Filter
+        fields = ('id', 'content', 'description', 'additional_field', 'filter_list', 'override')
+
+
 class FilterListSerializer(ModelSerializer):
     """A class providing (de-)serialization of `FilterList` instances."""
 
+    filters = FilterSerializer(many=True, read_only=True)
+
     class Meta:
         """Metadata defined for the Django REST Framework."""
 
@@ -185,16 +197,6 @@ class FilterChannelRangeSerializer(ModelSerializer):
         )
 
 
-class FilterSerializer(ModelSerializer):
-    """A class providing (de-)serialization of `Filter` instances."""
-
-    class Meta:
-        """Metadata defined for the Django REST Framework."""
-
-        model = Filter
-        fields = ('id', 'content', 'description', 'additional_field', 'override')
-
-
 class FilterOverrideSerializer(ModelSerializer):
     """A class providing (de-)serialization of `FilterOverride` instances."""
 
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index 2df671e0..f694053d 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -32,7 +32,7 @@ FK_FIELDS: Dict[Type[Model], Tuple[str]] = {
     FilterSettings: ("default_action", "default_range"),
     FilterAction: (),
     ChannelRange: (),
-    Filter: (),
+    Filter: ("filter_list",),
     FilterOverride: ("filter_action", "filter_range")
 }
 
@@ -122,7 +122,32 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                 "content": "bad word",
                 "description": "This is a really bad word.",
                 "additional_field": None,
-                "override": None
+                "override": None,
+                "filter_list": FilterList(
+                    name="testname",
+                    list_type=0,
+                    default_settings=FilterSettings(
+                        ping_type=[],
+                        filter_dm=False,
+                        dm_ping_type=[],
+                        delete_messages=False,
+                        bypass_roles=[],
+                        enabled=False,
+                        default_action=FilterAction(
+                            dm_content=None,
+                            infraction_type=None,
+                            infraction_reason="",
+                            infraction_duration=None
+                        ),
+                        default_range=ChannelRange(
+                            disallowed_channels=[],
+                            disallowed_categories=[],
+                            allowed_channels=[],
+                            allowed_categories=[],
+                            default=False
+                        )
+                    )
+                )
             }
         ),
         "filter_override": TestSequence(
diff --git a/pydis_site/apps/api/viewsets/bot/filters.py b/pydis_site/apps/api/viewsets/bot/filters.py
index 9553fcac..1b893f8c 100644
--- a/pydis_site/apps/api/viewsets/bot/filters.py
+++ b/pydis_site/apps/api/viewsets/bot/filters.py
@@ -20,7 +20,7 @@ from pydis_site.apps.api.serializers import (  # noqa: I101 - Preserving the fil
 
 class FilterListViewSet(ModelViewSet):
     """
-    View providing CRUD operations on lists of items allowed or denied by our bot.
+    View providing GET/DELETE on lists of items allowed or denied by our bot.
 
     ## Routes
     ### GET /bot/filter/filter_lists
@@ -33,8 +33,14 @@ class FilterListViewSet(ModelViewSet):
     ...         "name": "guild_invite",
     ...         "list_type": 1,
     ...         "filters": [
-    ...             1,
-    ...             2,
+    ...             {
+    ...                 "id": 1,
+    ...                 "content": "267624335836053506",
+    ...                 "description": "Python Discord",
+    ...                 "additional_field": None,
+    ...                 "override": 1,
+    ...                 "filter_list": 1
+    ...             },
     ...             ...
     ...         ],
     ...         "default_settings": 1
@@ -55,8 +61,14 @@ class FilterListViewSet(ModelViewSet):
     ...     "name": "guild_invite",
     ...     "list_type": 1,
     ...     "filters": [
-    ...         1,
-    ...         2,
+    ...         {
+    ...             "id": 1,
+    ...             "content": "267624335836053506",
+    ...             "description": "Python Discord",
+    ...             "additional_field": None,
+    ...             "override": 1,
+    ...             "filter_list": 1
+    ...         },
     ...         ...
     ...     ],
     ...     "default_settings": 1
@@ -66,45 +78,6 @@ class FilterListViewSet(ModelViewSet):
     - 200: returned on success
     - 404: returned if the id was not found.
 
-    ### POST /bot/filter/filter_lists
-    Adds a single FilterList item to the database.
-
-    #### Request body
-    >>> {
-    ...     "name": "guild_invite",
-    ...     "list_type": 1,
-    ...     "filters": [
-    ...         1,
-    ...         2,
-    ...         ...
-    ...     ],
-    ...     "default_settings": 1
-    ... }
-
-    #### Status codes
-    - 201: returned on success
-    - 400: if one of the given fields is invalid
-
-    ### PATCH /bot/filter/filter_lists/<id:int>
-    Updates a specific FilterList item from the database.
-
-    #### Response format
-    >>> {
-    ...     "id": 1,
-    ...     "name": "guild_invite",
-    ...     "list_type": 1,
-    ...     "filters": [
-    ...         1,
-    ...         2,
-    ...         ...
-    ...     ],
-    ...     "default_settings": 1
-    ... }
-
-    #### Status codes
-    - 200: returned on success
-    - 400: if one of the given fields is invalid
-
     ### DELETE /bot/filter/filter_lists/<id:int>
     Deletes the FilterList item with the given `id`.
 
@@ -437,7 +410,8 @@ class FilterViewSet(ModelViewSet):
     ...         "content": "267624335836053506",
     ...         "description": "Python Discord",
     ...         "additional_field": None,
-    ...         "override": 1
+    ...         "override": 1,
+    ...         "filter_list": 1
     ...     },
     ...     ...
     ... ]
-- 
cgit v1.2.3


From 05e2bce1e82e422755396d1e6e489d6792ec0115 Mon Sep 17 00:00:00 2001
From: mbaruh <mbaruh@hotmail.com>
Date: Thu, 10 Mar 2022 20:56:47 +0200
Subject: Remove role validation

Roles can be either IDs or names, so the current validation is not relevant anymore. Furthermore the ping fields can accept user IDs or names.
---
 .../apps/api/migrations/0079_new_filter_schema.py  | 12 ++++----
 pydis_site/apps/api/models/bot/filters.py          | 32 ----------------------
 pydis_site/apps/api/tests/test_filters.py          | 11 --------
 3 files changed, 6 insertions(+), 49 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0079_new_filter_schema.py b/pydis_site/apps/api/migrations/0079_new_filter_schema.py
index b67740d2..053f9782 100644
--- a/pydis_site/apps/api/migrations/0079_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0079_new_filter_schema.py
@@ -97,11 +97,11 @@ class Migration(migrations.Migration):
                 ('content', models.CharField(help_text='The definition of this filter.', max_length=100)),
                 ('description', models.CharField(help_text='Why this filter has been added.', max_length=200, null=True)),
                 ('additional_field', django.contrib.postgres.fields.jsonb.JSONField(help_text='Implementation specific field.', null=True)),
-                ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None, validators=[pydis_site.apps.api.models.bot.filters.validate_ping_field], null=True)),
+                ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None, null=True)),
                 ('filter_dm', models.BooleanField(help_text='Whether DMs should be filtered.', null=True)),
-                ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None, validators=[pydis_site.apps.api.models.bot.filters.validate_ping_field], null=True)),
+                ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None, null=True)),
                 ('delete_messages', models.BooleanField(help_text='Whether this filter should delete messages triggering it.', null=True)),
-                ('bypass_roles', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Roles and users who can bypass this filter.', size=None, validators=[pydis_site.apps.api.models.bot.filters.validate_bypass_roles_field], null=True)),
+                ('bypass_roles', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Roles and users who can bypass this filter.', size=None, null=True)),
                 ('enabled', models.BooleanField(help_text='Whether this filter is currently enabled.', null=True)),
                 ('dm_content', models.CharField(help_text='The DM to send to a user triggering this filter.', max_length=1000, null=True)),
                 ('dm_embed', models.CharField(help_text='The content of the DM embed', max_length=2000, null=True)),
@@ -120,11 +120,11 @@ class Migration(migrations.Migration):
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('name', models.CharField(help_text='The unique name of this list.', max_length=50)),
                 ('list_type', models.IntegerField(choices=[(1, 'Allow'), (0, 'Deny')], help_text='Whether this list is an allowlist or denylist')),
-                ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None, validators=[pydis_site.apps.api.models.bot.filters.validate_ping_field])),
+                ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None)),
                 ('filter_dm', models.BooleanField(help_text='Whether DMs should be filtered.')),
-                ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None, validators=[pydis_site.apps.api.models.bot.filters.validate_ping_field])),
+                ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None)),
                 ('delete_messages', models.BooleanField(help_text='Whether this filter should delete messages triggering it.')),
-                ('bypass_roles', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Roles and users who can bypass this filter.', size=None, validators=[pydis_site.apps.api.models.bot.filters.validate_bypass_roles_field])),
+                ('bypass_roles', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Roles and users who can bypass this filter.', size=None)),
                 ('enabled', models.BooleanField(help_text='Whether this filter is currently enabled.')),
                 ('dm_content', models.CharField(help_text='The DM to send to a user triggering this filter.', max_length=1000, null=True)),
                 ('dm_embed', models.CharField(help_text='The content of the DM embed', max_length=2000, null=True)),
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index 4dbf1875..13b332d2 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -16,32 +16,6 @@ class FilterListType(models.IntegerChoices):
     DENY = 0
 
 
-# Valid special values in ping related fields
-VALID_PINGS = ("everyone", "here", "moderators", "onduty", "admins")
-VALID_BYPASS_ROLES = ("staff",)
-
-
-def validate_ping_field(value_list: List[str]) -> None:
-    """Validate that the values are either a special value or a UID."""
-    for value in value_list:
-        # Check if it is a special value
-        if value in VALID_PINGS:
-            continue
-        # Check if it is a UID
-        if value.isnumeric():
-            continue
-
-        raise ValidationError(f"{value!r} isn't a valid ping type.")
-
-
-def validate_bypass_roles_field(value_list: List[str]) -> None:
-    """Validate that the vclues are either a special value or a Role ID."""
-    for value in value_list:
-        if value.isnumeric() or value in VALID_BYPASS_ROLES:
-            continue
-        raise ValidationError(f"{value!r} isn't a valid (bypass) role.")
-
-
 class FilterSettingsMixin(models.Model):
     """Mixin for common settings of a filters and filter lists."""
 
@@ -86,14 +60,12 @@ class FilterList(FilterSettingsMixin):
     )
     guild_pings = ArrayField(
         models.CharField(max_length=20),
-        validators=(validate_ping_field,),
         help_text="Who to ping when this filter triggers.",
         null=False
     )
     filter_dm = models.BooleanField(help_text="Whether DMs should be filtered.", null=False)
     dm_pings = ArrayField(
         models.CharField(max_length=20),
-        validators=(validate_ping_field,),
         help_text="Who to ping when this filter triggers on a DM.",
         null=False
     )
@@ -104,7 +76,6 @@ class FilterList(FilterSettingsMixin):
     bypass_roles = ArrayField(
         models.CharField(max_length=100),
         help_text="Roles and users who can bypass this filter.",
-        validators=(validate_bypass_roles_field,),
         null=False
     )
     enabled = models.BooleanField(
@@ -149,14 +120,12 @@ class Filter(FilterSettingsMixin):
     )
     guild_pings = ArrayField(
         models.CharField(max_length=20),
-        validators=(validate_ping_field,),
         help_text="Who to ping when this filter triggers.",
         null=True
     )
     filter_dm = models.BooleanField(help_text="Whether DMs should be filtered.", null=True)
     dm_pings = ArrayField(
         models.CharField(max_length=20),
-        validators=(validate_ping_field,),
         help_text="Who to ping when this filter triggers on a DM.",
         null=True
     )
@@ -167,7 +136,6 @@ class Filter(FilterSettingsMixin):
     bypass_roles = ArrayField(
         models.CharField(max_length=100),
         help_text="Roles and users who can bypass this filter.",
-        validators=(validate_bypass_roles_field,),
         null=True
     )
     enabled = models.BooleanField(
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index f694053d..5f40c6f9 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -296,14 +296,3 @@ class GenericFilterTest(APISubdomainTestCase):
 
                 response = self.client.delete(f"{sequence.url()}/42")
                 self.assertEqual(response.status_code, 404)
-
-    def test_reject_invalid_ping(self) -> None:
-        url = reverse('bot:filteroverride-list', host='api')
-        data = {
-            "ping_type": ["invalid"]
-        }
-
-        response = self.client.post(url, data=data)
-
-        self.assertEqual(response.status_code, 400)
-        self.assertDictEqual(response.json(), {'ping_type': ["'invalid' isn't a valid ping type."]})
-- 
cgit v1.2.3


From c39ae63d407663f47bf2d824a259335234066801 Mon Sep 17 00:00:00 2001
From: mbaruh <mbaruh@hotmail.com>
Date: Wed, 9 Nov 2022 21:27:26 +0200
Subject: Rename delete_messages to the more generic remove_context

---
 pydis_site/apps/api/migrations/0085_new_filter_schema.py     |  8 ++++----
 .../apps/api/migrations/0086_unique_constraint_filters.py    |  2 +-
 pydis_site/apps/api/migrations/0087_unique_filter_list.py    |  8 ++++----
 pydis_site/apps/api/migrations/0088_antispam_filter_list.py  |  2 +-
 pydis_site/apps/api/models/bot/filters.py                    |  8 ++++----
 pydis_site/apps/api/serializers.py                           |  4 ++--
 pydis_site/apps/api/tests/test_filters.py                    |  8 ++++----
 pydis_site/apps/api/viewsets/bot/filters.py                  | 12 ++++++------
 8 files changed, 26 insertions(+), 26 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0085_new_filter_schema.py b/pydis_site/apps/api/migrations/0085_new_filter_schema.py
index d902be7f..96d03bf4 100644
--- a/pydis_site/apps/api/migrations/0085_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0085_new_filter_schema.py
@@ -41,7 +41,7 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
             guild_pings=(["Moderators"] if name != "FILE_FORMAT" else []),
             filter_dm=True,
             dm_pings=[],
-            delete_messages=(True if name != "FILTER_TOKEN" else False),
+            remove_context=(True if name != "FILTER_TOKEN" else False),
             bypass_roles=["Helpers"],
             enabled=True,
             dm_content=dm_content,
@@ -68,7 +68,7 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
                 guild_pings=None,
                 filter_dm=None,
                 dm_pings=None,
-                delete_messages=None,
+                remove_context=None,
                 bypass_roles=None,
                 enabled=None,
                 dm_content=None,
@@ -109,7 +109,7 @@ class Migration(migrations.Migration):
                 ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None, null=True)),
                 ('filter_dm', models.BooleanField(help_text='Whether DMs should be filtered.', null=True)),
                 ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None, null=True)),
-                ('delete_messages', models.BooleanField(help_text='Whether this filter should delete messages triggering it.', null=True)),
+                ('remove_context', models.BooleanField(help_text='Whether this filter should remove the context (such as a message) triggering it.', null=True)),
                 ('bypass_roles', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Roles and users who can bypass this filter.', size=None, null=True)),
                 ('enabled', models.BooleanField(help_text='Whether this filter is currently enabled.', null=True)),
                 ('dm_content', models.CharField(help_text='The DM to send to a user triggering this filter.', max_length=1000, null=True, blank=True)),
@@ -136,7 +136,7 @@ class Migration(migrations.Migration):
                 ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None)),
                 ('filter_dm', models.BooleanField(help_text='Whether DMs should be filtered.')),
                 ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None)),
-                ('delete_messages', models.BooleanField(help_text='Whether this filter should delete messages triggering it.')),
+                ('remove_context', models.BooleanField(help_text='Whether this filter should remove the context (such as a message) triggering it.')),
                 ('bypass_roles', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Roles and users who can bypass this filter.', size=None)),
                 ('enabled', models.BooleanField(help_text='Whether this filter is currently enabled.')),
                 ('dm_content', models.CharField(help_text='The DM to send to a user triggering this filter.', max_length=1000, blank=True)),
diff --git a/pydis_site/apps/api/migrations/0086_unique_constraint_filters.py b/pydis_site/apps/api/migrations/0086_unique_constraint_filters.py
index 6fa99e9e..b83e395c 100644
--- a/pydis_site/apps/api/migrations/0086_unique_constraint_filters.py
+++ b/pydis_site/apps/api/migrations/0086_unique_constraint_filters.py
@@ -25,7 +25,7 @@ class Migration(migrations.Migration):
                 'guild_pings',
                 'filter_dm',
                 'dm_pings',
-                'delete_messages',
+                'remove_context',
                 'bypass_roles',
                 'enabled',
                 'send_alert',
diff --git a/pydis_site/apps/api/migrations/0087_unique_filter_list.py b/pydis_site/apps/api/migrations/0087_unique_filter_list.py
index 96c2b17a..b8087d9c 100644
--- a/pydis_site/apps/api/migrations/0087_unique_filter_list.py
+++ b/pydis_site/apps/api/migrations/0087_unique_filter_list.py
@@ -17,7 +17,7 @@ def create_unique_list(apps: Apps, _):
         guild_pings=[],
         filter_dm=True,
         dm_pings=[],
-        delete_messages=False,
+        remove_context=False,
         bypass_roles=[],
         enabled=True,
         dm_content="",
@@ -37,7 +37,7 @@ def create_unique_list(apps: Apps, _):
         content="everyone",
         filter_list=list_,
         description="",
-        delete_messages=True,
+        remove_context=True,
         bypass_roles=["Helpers"],
         dm_content=(
             "Please don't try to ping `@everyone` or `@here`. Your message has been removed. "
@@ -51,7 +51,7 @@ def create_unique_list(apps: Apps, _):
         content="webhook",
         filter_list=list_,
         description="",
-        delete_messages=True,
+        remove_context=True,
         dm_content=(
             "Looks like you posted a Discord webhook URL. "
             "Therefore, your message has been removed, and your webhook has been deleted. "
@@ -74,7 +74,7 @@ def create_unique_list(apps: Apps, _):
         content="discord_token",
         filter_list=list_,
         filter_dm=False,
-        delete_messages=True,
+        remove_context=True,
         dm_content=(
             "I noticed you posted a seemingly valid Discord API "
             "token in your message and have removed your message. "
diff --git a/pydis_site/apps/api/migrations/0088_antispam_filter_list.py b/pydis_site/apps/api/migrations/0088_antispam_filter_list.py
index 354e4520..fcb56781 100644
--- a/pydis_site/apps/api/migrations/0088_antispam_filter_list.py
+++ b/pydis_site/apps/api/migrations/0088_antispam_filter_list.py
@@ -17,7 +17,7 @@ def create_antispam_list(apps: Apps, _):
         guild_pings=["Moderators"],
         filter_dm=False,
         dm_pings=[],
-        delete_messages=True,
+        remove_context=True,
         bypass_roles=["Helpers"],
         enabled=True,
         dm_content="",
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index 1ea21a48..4d8a4025 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -75,8 +75,8 @@ class FilterList(ModelTimestampMixin, ModelReprMixin, models.Model):
         help_text="Who to ping when this filter triggers on a DM.",
         null=False
     )
-    delete_messages = models.BooleanField(
-        help_text="Whether this filter should delete messages triggering it.",
+    remove_context = models.BooleanField(
+        help_text="Whether this filter should remove the context (such as a message) triggering it.",
         null=False
     )
     bypass_roles = ArrayField(
@@ -185,8 +185,8 @@ class FilterBase(ModelTimestampMixin, ModelReprMixin, models.Model):
         help_text="Who to ping when this filter triggers on a DM.",
         null=True
     )
-    delete_messages = models.BooleanField(
-        help_text="Whether this filter should delete messages triggering it.",
+    remove_context = models.BooleanField(
+        help_text="Whether this filter should remove the context (such as a message) triggering it.",
         null=True
     )
     bypass_roles = ArrayField(
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index d6bae2cb..eabca66e 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -154,7 +154,7 @@ SETTINGS_FIELDS = (
     'guild_pings',
     'filter_dm',
     'dm_pings',
-    'delete_messages',
+    'remove_context',
     'send_alert',
     'bypass_roles',
     'enabled',
@@ -187,7 +187,7 @@ BASE_SETTINGS_FIELDS = (
     "bypass_roles",
     "filter_dm",
     "enabled",
-    "delete_messages",
+    "remove_context",
     "send_alert"
 )
 INFRACTION_AND_NOTIFICATION_FIELDS = (
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index 5f40c6f9..f3afdaeb 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -49,7 +49,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                     ping_type=[],
                     filter_dm=False,
                     dm_ping_type=[],
-                    delete_messages=False,
+                    remove_context=False,
                     bypass_roles=[],
                     enabled=False,
                     default_action=FilterAction(
@@ -76,7 +76,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                 "ping_type": ["onduty"],
                 "filter_dm": True,
                 "dm_ping_type": ["123456"],
-                "delete_messages": True,
+                "remove_context": True,
                 "bypass_roles": [123456],
                 "enabled": True,
                 "default_action": FilterAction(
@@ -130,7 +130,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                         ping_type=[],
                         filter_dm=False,
                         dm_ping_type=[],
-                        delete_messages=False,
+                        remove_context=False,
                         bypass_roles=[],
                         enabled=False,
                         default_action=FilterAction(
@@ -157,7 +157,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
                 "ping_type": ["everyone"],
                 "filter_dm": False,
                 "dm_ping_type": ["here"],
-                "delete_messages": False,
+                "remove_context": False,
                 "bypass_roles": [9876],
                 "enabled": True,
                 "filter_action": None,
diff --git a/pydis_site/apps/api/viewsets/bot/filters.py b/pydis_site/apps/api/viewsets/bot/filters.py
index dd9a7d87..1eb05053 100644
--- a/pydis_site/apps/api/viewsets/bot/filters.py
+++ b/pydis_site/apps/api/viewsets/bot/filters.py
@@ -36,7 +36,7 @@ class FilterListViewSet(ModelViewSet):
     ...                        "filter_dm": None,
     ...                        "enabled": None
     ...                        "send_alert": True,
-    ...                        "delete_messages": None
+    ...                        "remove_context": None
     ...                        "infraction_and_notification": {
     ...                            "infraction_type": None,
     ...                            "infraction_reason": "",
@@ -64,7 +64,7 @@ class FilterListViewSet(ModelViewSet):
     ...              ],
     ...              "filter_dm": True,
     ...              "enabled": True
-    ...              "delete_messages": True,
+    ...              "remove_context": True,
     ...              "send_alert": True
     ...              "infraction_and_notification": {
     ...                   "infraction_type": "",
@@ -111,7 +111,7 @@ class FilterListViewSet(ModelViewSet):
     ...                        "bypass_roles": None
     ...                        "filter_dm": None,
     ...                        "enabled": None
-    ...                        "delete_messages": None,
+    ...                        "remove_context": None,
     ...                        "send_alert": None
     ...                        "infraction_and_notification": {
     ...                            "infraction_type": None,
@@ -140,7 +140,7 @@ class FilterListViewSet(ModelViewSet):
     ...              ],
     ...              "filter_dm": True,
     ...              "enabled": True
-    ...              "delete_messages": True
+    ...              "remove_context": True
     ...              "send_alert": True
     ...              "infraction_and_notification": {
     ...                   "infraction_type": "",
@@ -198,7 +198,7 @@ class FilterViewSet(ModelViewSet):
     ...                        "bypass_roles": None
     ...                        "filter_dm": None,
     ...                        "enabled": None
-    ...                        "delete_messages": True,
+    ...                        "remove_context": True,
     ...                        "send_alert": True
     ...                        "infraction": {
     ...                            "infraction_type": None,
@@ -237,7 +237,7 @@ class FilterViewSet(ModelViewSet):
     ...                        "bypass_roles": None
     ...                        "filter_dm": None,
     ...                        "enabled": None
-    ...                        "delete_messages": True,
+    ...                        "remove_context": True,
     ...                        "send_alert": True
     ...                        "infraction": {
     ...                            "infraction_type": None,
-- 
cgit v1.2.3


From 3862e051407061186609dbeaab23ec53aeca2f94 Mon Sep 17 00:00:00 2001
From: mbaruh <mbaruh@hotmail.com>
Date: Fri, 27 Jan 2023 22:20:10 +0200
Subject: Update tests

---
 pydis_site/apps/api/models/__init__.py    |   1 -
 pydis_site/apps/api/tests/test_filters.py | 309 ++++++++++++++++--------------
 pydis_site/apps/api/tests/test_models.py  |   3 -
 3 files changed, 170 insertions(+), 143 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/models/__init__.py b/pydis_site/apps/api/models/__init__.py
index 580c95a0..fee4c8d5 100644
--- a/pydis_site/apps/api/models/__init__.py
+++ b/pydis_site/apps/api/models/__init__.py
@@ -6,7 +6,6 @@ from .bot import (
     BumpedThread,
     DocumentationLink,
     DeletedMessage,
-    FilterList,
     Infraction,
     Message,
     MessageDeletionContext,
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index f3afdaeb..cae78cd6 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -1,19 +1,13 @@
 import contextlib
 from dataclasses import dataclass
+from datetime import timedelta
 from typing import Any, Dict, Tuple, Type
 
 from django.db.models import Model
-from django_hosts import reverse
+from django.urls import reverse
 
-from pydis_site.apps.api.models.bot.filters import (  # noqa: I101 - Preserving the filter order
-    FilterList,
-    FilterSettings,
-    FilterAction,
-    ChannelRange,
-    Filter,
-    FilterOverride
-)
-from pydis_site.apps.api.tests.base import APISubdomainTestCase
+from pydis_site.apps.api.models.bot.filters import FilterList, Filter
+from pydis_site.apps.api.tests.base import AuthenticatedAPITestCase
 
 
 @dataclass()
@@ -21,99 +15,76 @@ class TestSequence:
     model: Type[Model]
     route: str
     object: Dict[str, Any]
-    ignored_fields: Tuple[str] = ()
+    ignored_fields: Tuple[str, ...] = ()
 
     def url(self, detail: bool = False) -> str:
-        return reverse(f'bot:{self.route}-{"detail" if detail else "list"}', host='api')
+        return reverse(f'api:bot:{self.route}-{"detail" if detail else "list"}')
 
 
-FK_FIELDS: Dict[Type[Model], Tuple[str]] = {
-    FilterList: ("default_settings",),
-    FilterSettings: ("default_action", "default_range"),
-    FilterAction: (),
-    ChannelRange: (),
+FK_FIELDS: Dict[Type[Model], Tuple[str, ...]] = {
+    FilterList: (),
     Filter: ("filter_list",),
-    FilterOverride: ("filter_action", "filter_range")
 }
 
 
 def get_test_sequences() -> Dict[str, TestSequence]:
+    filter_list1_deny_dict = {
+        "name": "testname",
+        "list_type": 0,
+        "guild_pings": [],
+        "filter_dm": True,
+        "dm_pings": [],
+        "remove_context": False,
+        "bypass_roles": [],
+        "enabled": True,
+        "dm_content": "",
+        "dm_embed": "",
+        "infraction_type": "NONE",
+        "infraction_reason": "",
+        "infraction_duration": timedelta(seconds=0),
+        "infraction_channel": 0,
+        "disabled_channels": [],
+        "disabled_categories": [],
+        "enabled_channels": [],
+        "enabled_categories": [],
+        "send_alert": True
+    }
+    filter_list1_allow_dict = filter_list1_deny_dict.copy()
+    filter_list1_allow_dict["list_type"] = 1
+    filter_list1_allow = FilterList(**filter_list1_allow_dict)
+
     return {
-        "filter_list": TestSequence(
+        "filter_list1": TestSequence(
             FilterList,
             "filterlist",
-            {
-                "name": "testname",
-                "list_type": 0,
-                "default_settings": FilterSettings(
-                    ping_type=[],
-                    filter_dm=False,
-                    dm_ping_type=[],
-                    remove_context=False,
-                    bypass_roles=[],
-                    enabled=False,
-                    default_action=FilterAction(
-                        dm_content=None,
-                        infraction_type=None,
-                        infraction_reason="",
-                        infraction_duration=None
-                    ),
-                    default_range=ChannelRange(
-                        disallowed_channels=[],
-                        disallowed_categories=[],
-                        allowed_channels=[],
-                        allowed_categories=[],
-                        default=False
-                    )
-                )
-            },
-            ignored_fields=("filters",)
+            filter_list1_deny_dict,
+            ignored_fields=("filters", "created_at", "updated_at")
         ),
-        "filter_settings": TestSequence(
-            FilterSettings,
-            "filtersettings",
+        "filter_list2": TestSequence(
+            FilterList,
+            "filterlist",
             {
-                "ping_type": ["onduty"],
-                "filter_dm": True,
-                "dm_ping_type": ["123456"],
+                "name": "testname2",
+                "list_type": 1,
+                "guild_pings": ["Moderators"],
+                "filter_dm": False,
+                "dm_pings": ["here"],
                 "remove_context": True,
-                "bypass_roles": [123456],
-                "enabled": True,
-                "default_action": FilterAction(
-                    dm_content=None,
-                    infraction_type=None,
-                    infraction_reason="",
-                    infraction_duration=None
-                ),
-                "default_range": ChannelRange(
-                    disallowed_channels=[],
-                    disallowed_categories=[],
-                    allowed_channels=[],
-                    allowed_categories=[],
-                    default=False
-                )
-            }
-        ),
-        "filter_action": TestSequence(
-            FilterAction,
-            "filteraction",
-            {
-                "dm_content": "This is a DM message.",
-                "infraction_type": "Mute",
-                "infraction_reason": "Too long beard",
-                "infraction_duration": "1 02:03:00"
-            }
-        ),
-        "channel_range": TestSequence(
-            ChannelRange,
-            "channelrange",
-            {
-                "disallowed_channels": [1234],
-                "disallowed_categories": [5678],
-                "allowed_channels": [9101],
-                "allowed_categories": [1121],
-                "default": True
-            }
+                "bypass_roles": ["123456"],
+                "enabled": False,
+                "dm_content": "testing testing",
+                "dm_embed": "one two three",
+                "infraction_type": "MUTE",
+                "infraction_reason": "stop testing",
+                "infraction_duration": timedelta(seconds=10.5),
+                "infraction_channel": 123,
+                "disabled_channels": ["python-general"],
+                "disabled_categories": ["CODE JAM"],
+                "enabled_channels": ["mighty-mice"],
+                "enabled_categories": ["Lobby"],
+                "send_alert": False
+            },
+            ignored_fields=("filters", "created_at", "updated_at")
         ),
         "filter": TestSequence(
             Filter,
@@ -121,58 +92,35 @@ def get_test_sequences() -> Dict[str, TestSequence]:
             {
                 "content": "bad word",
                 "description": "This is a really bad word.",
-                "additional_field": None,
-                "override": None,
-                "filter_list": FilterList(
-                    name="testname",
-                    list_type=0,
-                    default_settings=FilterSettings(
-                        ping_type=[],
-                        filter_dm=False,
-                        dm_ping_type=[],
-                        remove_context=False,
-                        bypass_roles=[],
-                        enabled=False,
-                        default_action=FilterAction(
-                            dm_content=None,
-                            infraction_type=None,
-                            infraction_reason="",
-                            infraction_duration=None
-                        ),
-                        default_range=ChannelRange(
-                            disallowed_channels=[],
-                            disallowed_categories=[],
-                            allowed_channels=[],
-                            allowed_categories=[],
-                            default=False
-                        )
-                    )
-                )
-            }
+                "additional_field": "{'hi': 'there'}",
+                "guild_pings": None,
+                "filter_dm": None,
+                "dm_pings": None,
+                "remove_context": None,
+                "bypass_roles": None,
+                "enabled": None,
+                "dm_content": None,
+                "dm_embed": None,
+                "infraction_type": None,
+                "infraction_reason": None,
+                "infraction_duration": None,
+                "infraction_channel": None,
+                "disabled_channels": None,
+                "disabled_categories": None,
+                "enabled_channels": None,
+                "enabled_categories": None,
+                "send_alert": None,
+                "filter_list": filter_list1_allow
+            },
+            ignored_fields=("created_at", "updated_at")
         ),
-        "filter_override": TestSequence(
-            FilterOverride,
-            "filteroverride",
-            {
-                "ping_type": ["everyone"],
-                "filter_dm": False,
-                "dm_ping_type": ["here"],
-                "remove_context": False,
-                "bypass_roles": [9876],
-                "enabled": True,
-                "filter_action": None,
-                "filter_range": None
-            }
-        )
     }
 
 
 def save_nested_objects(object_: Model, save_root: bool = True) -> None:
-    for field in FK_FIELDS[object_.__class__]:
+    for field in FK_FIELDS.get(object_.__class__, ()):
         value = getattr(object_, field)
-
-        if value is not None:
-            save_nested_objects(value)
+        save_nested_objects(value)
 
     if save_root:
         object_.save()
@@ -182,6 +130,8 @@ def clean_test_json(json: dict) -> dict:
     for key, value in json.items():
         if isinstance(value, Model):
             json[key] = value.id
+        elif isinstance(value, timedelta):
+            json[key] = str(value.total_seconds())
 
     return json
 
@@ -194,7 +144,22 @@ def clean_api_json(json: dict, sequence: TestSequence) -> dict:
     return json
 
 
-class GenericFilterTest(APISubdomainTestCase):
+def flatten_settings(json: dict) -> dict:
+    settings = json.pop("settings", {})
+    flattened_settings = {}
+    for entry, value in settings.items():
+        if isinstance(value, dict):
+            flattened_settings.update(value)
+        else:
+            flattened_settings[entry] = value
+
+    json.update(flattened_settings)
+
+    return json
+
+
+class GenericFilterTests(AuthenticatedAPITestCase):
+
     def test_cannot_read_unauthenticated(self) -> None:
         for name, sequence in get_test_sequences().items():
             with self.subTest(name=name):
@@ -222,7 +187,7 @@ class GenericFilterTest(APISubdomainTestCase):
                 response = self.client.get(sequence.url())
                 self.assertDictEqual(
                     clean_test_json(sequence.object),
-                    clean_api_json(response.json()[0], sequence)
+                    clean_api_json(flatten_settings(response.json()[0]), sequence)
                 )
 
     def test_fetch_by_id(self) -> None:
@@ -236,7 +201,7 @@ class GenericFilterTest(APISubdomainTestCase):
                 response = self.client.get(f"{sequence.url()}/{saved.id}")
                 self.assertDictEqual(
                     clean_test_json(sequence.object),
-                    clean_api_json(response.json(), sequence)
+                    clean_api_json(flatten_settings(response.json()), sequence)
                 )
 
     def test_fetch_non_existing(self) -> None:
@@ -259,14 +224,15 @@ class GenericFilterTest(APISubdomainTestCase):
 
                 self.assertEqual(response.status_code, 201)
                 self.assertDictEqual(
-                    clean_api_json(response.json(), sequence),
+                    clean_api_json(flatten_settings(response.json()), sequence),
                     clean_test_json(sequence.object)
                 )
 
     def test_creation_missing_field(self) -> None:
         for name, sequence in get_test_sequences().items():
             with self.subTest(name=name):
-                save_nested_objects(sequence.model(**sequence.object), False)
+                saved = sequence.model(**sequence.object)
+                save_nested_objects(saved)
                 data = clean_test_json(sequence.object.copy())
 
                 for field in sequence.model._meta.get_fields():
@@ -296,3 +262,68 @@ class GenericFilterTest(APISubdomainTestCase):
 
                 response = self.client.delete(f"{sequence.url()}/42")
                 self.assertEqual(response.status_code, 404)
+
+
+class FilterValidationTests(AuthenticatedAPITestCase):
+
+    def test_filter_validation(self) -> None:
+        test_sequences = get_test_sequences()
+        base_filter = test_sequences["filter"]
+        base_filter_list = test_sequences["filter_list1"]
+        cases = (
+            ({"infraction_reason": "hi"}, {}, 400), ({"infraction_duration": timedelta(seconds=10)}, {}, 400),
+            ({"infraction_reason": "hi"}, {"infraction_type": "NOTE"}, 200),
+            ({"infraction_duration": timedelta(seconds=10)}, {"infraction_type": "MUTE"}, 200),
+            ({"enabled_channels": ["admins"]}, {}, 200), ({"disabled_channels": ["123"]}, {}, 200),
+            ({"enabled_categories": ["CODE JAM"]}, {}, 200), ({"disabled_categories": ["CODE JAM"]}, {}, 200),
+            ({"enabled_channels": ["admins"], "disabled_channels": ["123", "admins"]}, {}, 400),
+            ({"enabled_categories": ["admins"], "disabled_categories": ["123", "admins"]}, {}, 400),
+            ({"enabled_channels": ["admins"]}, {"disabled_channels": ["123", "admins"]}, 400),
+            ({"enabled_categories": ["admins"]}, {"disabled_categories": ["123", "admins"]}, 400),
+        )
+
+        for filter_settings, filter_list_settings, response_code in cases:
+            with self.subTest(f_settings=filter_settings, fl_settings=filter_list_settings, response=response_code):
+                base_filter.model.objects.all().delete()
+                base_filter_list.model.objects.all().delete()
+
+                case_filter_dict = base_filter.object.copy()
+                case_fl_dict = base_filter_list.object.copy()
+                case_fl_dict.update(filter_list_settings)
+
+                case_fl = base_filter_list.model(**case_fl_dict)
+                case_filter_dict["filter_list"] = case_fl
+                case_filter = base_filter.model(**case_filter_dict)
+                save_nested_objects(case_filter)
+
+                filter_settings["filter_list"] = case_fl
+                response = self.client.patch(
+                    f"{base_filter.url()}/{case_filter.id}", data=clean_test_json(filter_settings)
+                )
+                self.assertEqual(response.status_code, response_code)
+
+    def test_filter_list_validation(self) -> None:
+        test_sequences = get_test_sequences()
+        base_filter_list = test_sequences["filter_list1"]
+        cases = (
+            ({"infraction_reason": "hi"}, 400), ({"infraction_duration": timedelta(seconds=10)}, 400),
+            ({"infraction_reason": "hi", "infraction_type": "NOTE"}, 200),
+            ({"infraction_duration": timedelta(seconds=10), "infraction_type": "MUTE"}, 200),
+            ({"enabled_channels": ["admins"]}, 200), ({"disabled_channels": ["123"]}, 200),
+            ({"enabled_categories": ["CODE JAM"]}, 200), ({"disabled_categories": ["CODE JAM"]}, 200),
+            ({"enabled_channels": ["admins"], "disabled_channels": ["123", "admins"]}, 400),
+            ({"enabled_categories": ["admins"], "disabled_categories": ["123", "admins"]}, 400),
+        )
+
+        for filter_list_settings, response_code in cases:
+            with self.subTest(fl_settings=filter_list_settings, response=response_code):
+                base_filter_list.model.objects.all().delete()
+
+                case_fl_dict = base_filter_list.object.copy()
+                case_fl = base_filter_list.model(**case_fl_dict)
+                save_nested_objects(case_fl)
+
+                response = self.client.patch(
+                    f"{base_filter_list.url()}/{case_fl.id}", data=clean_test_json(filter_list_settings)
+                )
+                self.assertEqual(response.status_code, response_code)
diff --git a/pydis_site/apps/api/tests/test_models.py b/pydis_site/apps/api/tests/test_models.py
index b9b14a84..25d771cc 100644
--- a/pydis_site/apps/api/tests/test_models.py
+++ b/pydis_site/apps/api/tests/test_models.py
@@ -8,7 +8,6 @@ from pydis_site.apps.api.models import (
     DocumentationLink,
     Filter,
     FilterList,
-    FilterSettings,
     Infraction,
     MessageDeletionContext,
     Nomination,
@@ -110,13 +109,11 @@ class StringDunderMethodTests(SimpleTestCase):
             FilterList(
                 name="forbidden_duckies",
                 list_type=0,
-                default_settings=FilterSettings()
             ),
             Filter(
                 content="ducky_nsfw",
                 description="This ducky is totally inappropriate!",
                 additional_field=None,
-                override=None
             ),
             OffensiveMessage(
                 id=602951077675139072,
-- 
cgit v1.2.3


From 5f538e9e876adc7f4a459fe230b46bdde61b3f64 Mon Sep 17 00:00:00 2001
From: mbaruh <mbaruh@hotmail.com>
Date: Fri, 27 Jan 2023 23:37:26 +0200
Subject: Make filter unique constraint use NULLS NOT DISTINCT

The existing constraint was ineffective as null values were considered distinct, and so two filters with the same content and no overrides were considered different.

This change uses a new PSQL 15 feature unsupported in django currently, and so it is added with raw SQL.
---
 .../migrations/0087_unique_constraint_filters.py   | 39 ++++++++--------------
 pydis_site/apps/api/serializers.py                 |  9 +++++
 pydis_site/apps/api/tests/test_filters.py          | 12 +++++++
 3 files changed, 34 insertions(+), 26 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0087_unique_constraint_filters.py b/pydis_site/apps/api/migrations/0087_unique_constraint_filters.py
index b2ff91f1..910e7b1b 100644
--- a/pydis_site/apps/api/migrations/0087_unique_constraint_filters.py
+++ b/pydis_site/apps/api/migrations/0087_unique_constraint_filters.py
@@ -1,5 +1,3 @@
-# Generated by Django 3.1.14 on 2022-03-22 16:31
-
 from django.db import migrations, models
 
 
@@ -10,29 +8,18 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.AddConstraint(
-            model_name='filter',
-            constraint=models.UniqueConstraint(fields=(
-                'content',
-                'additional_field',
-                'filter_list',
-                'dm_content',
-                'dm_embed',
-                'infraction_type',
-                'infraction_reason',
-                'infraction_duration',
-                'infraction_channel',
-                'guild_pings',
-                'filter_dm',
-                'dm_pings',
-                'remove_context',
-                'bypass_roles',
-                'enabled',
-                'send_alert',
-                'enabled_channels',
-                'disabled_channels',
-                'enabled_categories',
-                'disabled_categories'
-            ), name='unique_filters'),
+        migrations.RunSQL(
+            "ALTER TABLE api_filter "
+            "ADD CONSTRAINT unique_filters UNIQUE NULLS NOT DISTINCT "
+            "(content, additional_field, filter_list_id, dm_content, dm_embed, infraction_type, infraction_reason, infraction_duration, infraction_channel, guild_pings, filter_dm, dm_pings, remove_context, bypass_roles, enabled, send_alert, enabled_channels, disabled_channels, enabled_categories, disabled_categories)",
+            state_operations=[
+                migrations.AddConstraint(
+                    model_name='filter',
+                    constraint=models.UniqueConstraint(
+                        fields=('content', 'additional_field', 'filter_list', 'dm_content', 'dm_embed', 'infraction_type', 'infraction_reason', 'infraction_duration', 'infraction_channel', 'guild_pings', 'filter_dm', 'dm_pings', 'remove_context', 'bypass_roles', 'enabled', 'send_alert', 'enabled_channels', 'disabled_channels', 'enabled_categories', 'disabled_categories'),
+                        name='unique_filters'
+                    ),
+                ),
+            ],
         ),
     ]
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 7f9461ec..8da47802 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -257,6 +257,15 @@ class FilterSerializer(ModelSerializer):
         ) + SETTINGS_FIELDS
         extra_kwargs = _create_filter_meta_extra_kwargs()
 
+    def create(self, validated_data: dict) -> User:
+        """Override the create method to catch violations of the custom uniqueness constraint."""
+        try:
+            return super().create(validated_data)
+        except IntegrityError:
+            raise ValidationError(
+                "Check if a filter with this combination of content and settings already exists in this filter list."
+            )
+
     def to_representation(self, instance: Filter) -> dict:
         """
         Provides a custom JSON representation to the Filter Serializers.
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index cae78cd6..73c8e0d9 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -327,3 +327,15 @@ class FilterValidationTests(AuthenticatedAPITestCase):
                     f"{base_filter_list.url()}/{case_fl.id}", data=clean_test_json(filter_list_settings)
                 )
                 self.assertEqual(response.status_code, response_code)
+
+    def test_filter_unique_constraint(self) -> None:
+        test_filter = get_test_sequences()["filter"]
+        test_filter.model.objects.all().delete()
+        test_filter_object = test_filter.model(**test_filter.object)
+        save_nested_objects(test_filter_object, False)
+
+        response = self.client.post(test_filter.url(), data=clean_test_json(test_filter.object))
+        self.assertEqual(response.status_code, 201)
+
+        response = self.client.post(test_filter.url(), data=clean_test_json(test_filter.object))
+        self.assertEqual(response.status_code, 400)
-- 
cgit v1.2.3


From d52a8c955aceccd719dd1511700aac9f2a564b0a Mon Sep 17 00:00:00 2001
From: mbaruh <mbaruh@hotmail.com>
Date: Sat, 28 Jan 2023 16:24:58 +0200
Subject: Update viewsets, fix linting

---
 .../apps/api/migrations/0088_unique_filter_list.py |   2 +-
 pydis_site/apps/api/models/bot/filters.py          |  12 +-
 pydis_site/apps/api/serializers.py                 |  50 +-
 pydis_site/apps/api/tests/test_filters.py          |  24 +-
 pydis_site/apps/api/viewsets/bot/filters.py        | 532 ++++++++++++++-------
 5 files changed, 428 insertions(+), 192 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0088_unique_filter_list.py b/pydis_site/apps/api/migrations/0088_unique_filter_list.py
index 3f3a34bb..98d14e2b 100644
--- a/pydis_site/apps/api/migrations/0088_unique_filter_list.py
+++ b/pydis_site/apps/api/migrations/0088_unique_filter_list.py
@@ -99,4 +99,4 @@ class Migration(migrations.Migration):
             code=create_unique_list,
             reverse_code=None
         ),
-    ]
\ No newline at end of file
+    ]
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index 4d8a4025..1eab79ba 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -4,8 +4,8 @@ from django.db import models
 from django.db.models import UniqueConstraint
 
 # Must be imported that way to avoid circular imports
+from pydis_site.apps.api.models.mixins import ModelReprMixin, ModelTimestampMixin
 from .infraction import Infraction
-from pydis_site.apps.api.models.mixins import ModelTimestampMixin, ModelReprMixin
 
 
 class FilterListType(models.IntegerChoices):
@@ -76,7 +76,10 @@ class FilterList(ModelTimestampMixin, ModelReprMixin, models.Model):
         null=False
     )
     remove_context = models.BooleanField(
-        help_text="Whether this filter should remove the context (such as a message) triggering it.",
+        help_text=(
+            "Whether this filter should remove the context (such as a message) "
+            "triggering it."
+        ),
         null=False
     )
     bypass_roles = ArrayField(
@@ -186,7 +189,10 @@ class FilterBase(ModelTimestampMixin, ModelReprMixin, models.Model):
         null=True
     )
     remove_context = models.BooleanField(
-        help_text="Whether this filter should remove the context (such as a message) triggering it.",
+        help_text=(
+            "Whether this filter should remove the context (such as a message) "
+            "triggering it."
+        ),
         null=True
     )
     bypass_roles = ArrayField(
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index 8da47802..a6328eff 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -21,9 +21,9 @@ from .models import (
     BumpedThread,
     DeletedMessage,
     DocumentationLink,
-    Infraction,
-    FilterList,
     Filter,
+    FilterList,
+    Infraction,
     MessageDeletionContext,
     Nomination,
     NominationEntry,
@@ -183,7 +183,9 @@ ALLOW_EMPTY_SETTINGS = (
 )
 
 # Required fields for custom JSON representation purposes
-BASE_FILTER_FIELDS = ('id', 'created_at', 'updated_at', 'content', 'description', 'additional_field')
+BASE_FILTER_FIELDS = (
+    'id', 'created_at', 'updated_at', 'content', 'description', 'additional_field'
+)
 BASE_FILTERLIST_FIELDS = ('id', 'created_at', 'updated_at', 'name', 'list_type')
 BASE_SETTINGS_FIELDS = (
     "bypass_roles",
@@ -235,16 +237,31 @@ class FilterSerializer(ModelSerializer):
     def validate(self, data: dict) -> dict:
         """Perform infraction data + allowed and disallowed lists validation."""
         if (
-            (get_field_value(data, "infraction_reason") or get_field_value(data, "infraction_duration"))
+            (
+                get_field_value(data, "infraction_reason")
+                or get_field_value(data, "infraction_duration")
+            )
             and get_field_value(data, "infraction_type") == "NONE"
         ):
-            raise ValidationError("Infraction type is required with infraction duration or reason.")
+            raise ValidationError(
+                "Infraction type is required with infraction duration or reason."
+            )
 
-        if set(get_field_value(data, "disabled_channels")) & set(get_field_value(data, "enabled_channels")):
-            raise ValidationError("You can't have the same value in both enabled and disabled channels lists.")
+        if (
+            set(get_field_value(data, "disabled_channels"))
+            & set(get_field_value(data, "enabled_channels"))
+        ):
+            raise ValidationError(
+                "You can't have the same value in both enabled and disabled channels lists."
+            )
 
-        if set(get_field_value(data, "disabled_categories")) & set(get_field_value(data, "enabled_categories")):
-            raise ValidationError("You can't have the same value in both enabled and disabled categories lists.")
+        if (
+            set(get_field_value(data, "disabled_categories"))
+            & set(get_field_value(data, "enabled_categories"))
+        ):
+            raise ValidationError(
+                "You can't have the same value in both enabled and disabled categories lists."
+            )
 
         return data
 
@@ -253,7 +270,13 @@ class FilterSerializer(ModelSerializer):
 
         model = Filter
         fields = (
-            'id', 'created_at', 'updated_at', 'content', 'description', 'additional_field', 'filter_list'
+            'id',
+            'created_at',
+            'updated_at',
+            'content',
+            'description',
+            'additional_field',
+            'filter_list'
         ) + SETTINGS_FIELDS
         extra_kwargs = _create_filter_meta_extra_kwargs()
 
@@ -263,7 +286,8 @@ class FilterSerializer(ModelSerializer):
             return super().create(validated_data)
         except IntegrityError:
             raise ValidationError(
-                "Check if a filter with this combination of content and settings already exists in this filter list."
+                "Check if a filter with this combination of content "
+                "and settings already exists in this filter list."
             )
 
     def to_representation(self, instance: Filter) -> dict:
@@ -340,7 +364,9 @@ class FilterListSerializer(ModelSerializer):
         """Metadata defined for the Django REST Framework."""
 
         model = FilterList
-        fields = ('id', 'created_at', 'updated_at', 'name', 'list_type', 'filters') + SETTINGS_FIELDS
+        fields = (
+            'id', 'created_at', 'updated_at', 'name', 'list_type', 'filters'
+        ) + SETTINGS_FIELDS
         extra_kwargs = _create_filter_list_meta_extra_kwargs()
 
         # Ensure there can only be one filter list with the same name and type.
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index 73c8e0d9..62de23c4 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -6,7 +6,7 @@ from typing import Any, Dict, Tuple, Type
 from django.db.models import Model
 from django.urls import reverse
 
-from pydis_site.apps.api.models.bot.filters import FilterList, Filter
+from pydis_site.apps.api.models.bot.filters import Filter, FilterList
 from pydis_site.apps.api.tests.base import AuthenticatedAPITestCase
 
 
@@ -271,11 +271,14 @@ class FilterValidationTests(AuthenticatedAPITestCase):
         base_filter = test_sequences["filter"]
         base_filter_list = test_sequences["filter_list1"]
         cases = (
-            ({"infraction_reason": "hi"}, {}, 400), ({"infraction_duration": timedelta(seconds=10)}, {}, 400),
+            ({"infraction_reason": "hi"}, {}, 400),
+            ({"infraction_duration": timedelta(seconds=10)}, {}, 400),
             ({"infraction_reason": "hi"}, {"infraction_type": "NOTE"}, 200),
             ({"infraction_duration": timedelta(seconds=10)}, {"infraction_type": "MUTE"}, 200),
-            ({"enabled_channels": ["admins"]}, {}, 200), ({"disabled_channels": ["123"]}, {}, 200),
-            ({"enabled_categories": ["CODE JAM"]}, {}, 200), ({"disabled_categories": ["CODE JAM"]}, {}, 200),
+            ({"enabled_channels": ["admins"]}, {}, 200),
+            ({"disabled_channels": ["123"]}, {}, 200),
+            ({"enabled_categories": ["CODE JAM"]}, {}, 200),
+            ({"disabled_categories": ["CODE JAM"]}, {}, 200),
             ({"enabled_channels": ["admins"], "disabled_channels": ["123", "admins"]}, {}, 400),
             ({"enabled_categories": ["admins"], "disabled_categories": ["123", "admins"]}, {}, 400),
             ({"enabled_channels": ["admins"]}, {"disabled_channels": ["123", "admins"]}, 400),
@@ -283,7 +286,9 @@ class FilterValidationTests(AuthenticatedAPITestCase):
         )
 
         for filter_settings, filter_list_settings, response_code in cases:
-            with self.subTest(f_settings=filter_settings, fl_settings=filter_list_settings, response=response_code):
+            with self.subTest(
+                f_settings=filter_settings, fl_settings=filter_list_settings, response=response_code
+            ):
                 base_filter.model.objects.all().delete()
                 base_filter_list.model.objects.all().delete()
 
@@ -306,11 +311,13 @@ class FilterValidationTests(AuthenticatedAPITestCase):
         test_sequences = get_test_sequences()
         base_filter_list = test_sequences["filter_list1"]
         cases = (
-            ({"infraction_reason": "hi"}, 400), ({"infraction_duration": timedelta(seconds=10)}, 400),
+            ({"infraction_reason": "hi"}, 400),
+            ({"infraction_duration": timedelta(seconds=10)}, 400),
             ({"infraction_reason": "hi", "infraction_type": "NOTE"}, 200),
             ({"infraction_duration": timedelta(seconds=10), "infraction_type": "MUTE"}, 200),
             ({"enabled_channels": ["admins"]}, 200), ({"disabled_channels": ["123"]}, 200),
-            ({"enabled_categories": ["CODE JAM"]}, 200), ({"disabled_categories": ["CODE JAM"]}, 200),
+            ({"enabled_categories": ["CODE JAM"]}, 200),
+            ({"disabled_categories": ["CODE JAM"]}, 200),
             ({"enabled_channels": ["admins"], "disabled_channels": ["123", "admins"]}, 400),
             ({"enabled_categories": ["admins"], "disabled_categories": ["123", "admins"]}, 400),
         )
@@ -324,7 +331,8 @@ class FilterValidationTests(AuthenticatedAPITestCase):
                 save_nested_objects(case_fl)
 
                 response = self.client.patch(
-                    f"{base_filter_list.url()}/{case_fl.id}", data=clean_test_json(filter_list_settings)
+                    f"{base_filter_list.url()}/{case_fl.id}",
+                    data=clean_test_json(filter_list_settings)
                 )
                 self.assertEqual(response.status_code, response_code)
 
diff --git a/pydis_site/apps/api/viewsets/bot/filters.py b/pydis_site/apps/api/viewsets/bot/filters.py
index 1eb05053..8e677612 100644
--- a/pydis_site/apps/api/viewsets/bot/filters.py
+++ b/pydis_site/apps/api/viewsets/bot/filters.py
@@ -22,69 +22,79 @@ class FilterListViewSet(ModelViewSet):
     >>> [
     ...     {
     ...         "id": 1,
-    ...         "name": "invites",
+    ...         "created_at": "2023-01-27T21:26:34.027293Z",
+    ...         "updated_at": "2023-01-27T21:26:34.027308Z",
+    ...         "name": "invite",
     ...         "list_type": 1,
     ...         "filters": [
     ...             {
     ...                 "id": 1,
+    ...                 "created_at": "2023-01-27T21:26:34.029539Z",
+    ...                 "updated_at": "2023-01-27T21:26:34.030532Z",
     ...                 "content": "267624335836053506",
     ...                 "description": "Python Discord",
     ...                 "additional_field": None,
-    ...                 "filter_list": 1
+    ...                 "filter_list": 1,
     ...                 "settings": {
-    ...                        "bypass_roles": None
-    ...                        "filter_dm": None,
-    ...                        "enabled": None
-    ...                        "send_alert": True,
-    ...                        "remove_context": None
-    ...                        "infraction_and_notification": {
-    ...                            "infraction_type": None,
-    ...                            "infraction_reason": "",
-    ...                            "infraction_duration": None
-    ...                            "dm_content": None,
-    ...                            "dm_embed": None
-    ...                        },
-    ...                        "channel_scope": {
-    ...                            "disabled_channels": None,
-    ...                            "disabled_categories": None,
-    ...                            "enabled_channels": None
-    ...                        }
-    ...                        "mentions": {
-    ...                            "ping_type": None
-    ...                            "dm_ping_type": None
-    ...                         }
-    ...                    }
-    ...
+    ...                     "bypass_roles": None,
+    ...                     "filter_dm": None,
+    ...                     "enabled": None,
+    ...                     "remove_context": None,
+    ...                     "send_alert": None,
+    ...                     "infraction_and_notification": {
+    ...                         "infraction_type": None,
+    ...                         "infraction_reason": None,
+    ...                         "infraction_duration": None,
+    ...                         "infraction_channel": None,
+    ...                         "dm_content": None,
+    ...                         "dm_embed": None
+    ...                     },
+    ...                     "channel_scope": {
+    ...                         "disabled_channels": None,
+    ...                         "disabled_categories": None,
+    ...                         "enabled_channels": None,
+    ...                         "enabled_categories": None
+    ...                     },
+    ...                     "mentions": {
+    ...                         "guild_pings": None,
+    ...                         "dm_pings": None
+    ...                     }
+    ...                 }
     ...             },
     ...             ...
     ...         ],
-    ...            "settings": {
-    ...              "bypass_roles": [
-    ...                  "staff"
-    ...              ],
-    ...              "filter_dm": True,
-    ...              "enabled": True
-    ...              "remove_context": True,
-    ...              "send_alert": True
-    ...              "infraction_and_notification": {
-    ...                   "infraction_type": "",
-    ...                   "infraction_reason": "",
-    ...                   "infraction_duration": "0.0",
-    ...                   "dm_content": "",
-    ...                   "dm_embed": ""
-    ...               }
-    ...               "channel_scope": {
+    ...         "settings": {
+    ...             "bypass_roles": [
+    ...                 "Helpers"
+    ...             ],
+    ...             "filter_dm": True,
+    ...             "enabled": True,
+    ...             "remove_context": True,
+    ...             "send_alert": True,
+    ...             "infraction_and_notification": {
+    ...                 "infraction_type": "NONE",
+    ...                 "infraction_reason": "",
+    ...                 "infraction_duration": "0.0",
+    ...                 "infraction_channel": 0,
+    ...                 "dm_content": "Per Rule 6, your invite link has been removed...",
+    ...                 "dm_embed": ""
+    ...             },
+    ...             "channel_scope": {
     ...                 "disabled_channels": [],
-    ...                 "disabled_categories": [],
-    ...                 "enabled_channels": []
-    ...               }
-    ...               "mentions": {
-    ...                 "ping_type": [
-    ...                     "onduty"
-    ...                 ]
-    ...                 "dm_ping_type": []
-    ...                }
-    ...           },
+    ...                 "disabled_categories": [
+    ...                     "CODE JAM"
+    ...                 ],
+    ...                 "enabled_channels": [],
+    ...                 "enabled_categories": []
+    ...             },
+    ...             "mentions": {
+    ...                 "guild_pings": [
+    ...                     "Moderators"
+    ...                 ],
+    ...                 "dm_pings": []
+    ...             }
+    ...         }
+    ...     },
     ...     ...
     ... ]
 
@@ -97,75 +107,205 @@ class FilterListViewSet(ModelViewSet):
 
     #### Response format
     >>> {
-    ...         "id": 1,
-    ...         "name": "invites",
-    ...         "list_type": 1,
-    ...         "filters": [
-    ...             {
-    ...                 "id": 1,
-    ...                 "filter_list": 1
-    ...                 "content": "267624335836053506",
-    ...                 "description": "Python Discord",
-    ...                 "additional_field": None,
-    ...                 "settings": {
-    ...                        "bypass_roles": None
-    ...                        "filter_dm": None,
-    ...                        "enabled": None
-    ...                        "remove_context": None,
-    ...                        "send_alert": None
-    ...                        "infraction_and_notification": {
-    ...                            "infraction_type": None,
-    ...                            "infraction_reason": "",
-    ...                            "infraction_duration": None
-    ...                            "dm_content": None,
-    ...                            "dm_embed": None
-    ...                        },
-    ...                        "channel_scope": {
-    ...                            "disabled_channels": None,
-    ...                            "disabled_categories": None,
-    ...                            "enabled_channels": None
-    ...                        }
-    ...                        "mentions": {
-    ...                            "ping_type": None
-    ...                            "dm_ping_type": None
-    ...                         }
-    ...                    }
-    ...
-    ...             },
-    ...             ...
+    ...     "id": 1,
+    ...     "created_at": "2023-01-27T21:26:34.027293Z",
+    ...     "updated_at": "2023-01-27T21:26:34.027308Z",
+    ...     "name": "invite",
+    ...     "list_type": 1,
+    ...     "filters": [
+    ...         {
+    ...             "id": 1,
+    ...             "created_at": "2023-01-27T21:26:34.029539Z",
+    ...             "updated_at": "2023-01-27T21:26:34.030532Z",
+    ...             "content": "267624335836053506",
+    ...             "description": "Python Discord",
+    ...             "additional_field": None,
+    ...             "filter_list": 1,
+    ...             "settings": {
+    ...                 "bypass_roles": None,
+    ...                 "filter_dm": None,
+    ...                 "enabled": None,
+    ...                 "remove_context": None,
+    ...                 "send_alert": None,
+    ...                 "infraction_and_notification": {
+    ...                     "infraction_type": None,
+    ...                     "infraction_reason": None,
+    ...                     "infraction_duration": None,
+    ...                     "infraction_channel": None,
+    ...                     "dm_content": None,
+    ...                     "dm_embed": None
+    ...                 },
+    ...                 "channel_scope": {
+    ...                     "disabled_channels": None,
+    ...                     "disabled_categories": None,
+    ...                     "enabled_channels": None,
+    ...                     "enabled_categories": None
+    ...                 },
+    ...                 "mentions": {
+    ...                     "guild_pings": None,
+    ...                     "dm_pings": None
+    ...                 }
+    ...             }
+    ...         },
+    ...         ...
+    ...     ],
+    ...     "settings": {
+    ...         "bypass_roles": [
+    ...             "Helpers"
     ...         ],
-    ...            "settings": {
-    ...              "bypass_roles": [
-    ...                  "staff"
-    ...              ],
-    ...              "filter_dm": True,
-    ...              "enabled": True
-    ...              "remove_context": True
-    ...              "send_alert": True
-    ...              "infraction_and_notification": {
-    ...                   "infraction_type": "",
-    ...                   "infraction_reason": "",
-    ...                   "infraction_duration": "0.0",
-    ...                   "dm_content": "",
-    ...                   "dm_embed": ""
-    ...               }
-    ...               "channel_scope": {
-    ...                 "disabled_channels": [],
-    ...                 "disabled_categories": [],
-    ...                 "enabled_channels": []
-    ...                }
-    ...               "mentions": {
-    ...                 "ping_type": [
-    ...                     "onduty"
-    ...                 ]
-    ...                 "dm_ping_type": []
-    ...                }
+    ...         "filter_dm": True,
+    ...         "enabled": True,
+    ...         "remove_context": True,
+    ...         "send_alert": True,
+    ...         "infraction_and_notification": {
+    ...             "infraction_type": "NONE",
+    ...             "infraction_reason": "",
+    ...             "infraction_duration": "0.0",
+    ...             "infraction_channel": 0,
+    ...             "dm_content": "Per Rule 6, your invite link has been removed...",
+    ...             "dm_embed": ""
+    ...         },
+    ...         "channel_scope": {
+    ...             "disabled_channels": [],
+    ...             "disabled_categories": [
+    ...                 "CODE JAM"
+    ...             ],
+    ...             "enabled_channels": [],
+    ...             "enabled_categories": []
+    ...         },
+    ...         "mentions": {
+    ...             "guild_pings": [
+    ...                 "Moderators"
+    ...             ],
+    ...             "dm_pings": []
+    ...         }
+    ...     }
     ... }
 
     #### Status codes
     - 200: returned on success
     - 404: returned if the id was not found.
 
+    ### POST /bot/filter/filter_lists
+    Adds a single FilterList item to the database.
+
+    #### Request body
+    >>> {
+    ...     "name": "invite",
+    ...     "list_type": 1,
+    ...     "bypass_roles": [
+    ...         "Helpers"
+    ...     ],
+    ...     "filter_dm": True,
+    ...     "enabled": True,
+    ...     "remove_context": True,
+    ...     "send_alert": True,
+    ...     "infraction_type": "NONE",
+    ...     "infraction_reason": "",
+    ...     "infraction_duration": "0.0",
+    ...     "infraction_channel": 0,
+    ...     "dm_content": "Per Rule 6, your invite link has been removed...",
+    ...     "dm_embed": "",
+    ...     "disabled_channels": [],
+    ...     "disabled_categories": [
+    ...         "CODE JAM"
+    ...     ],
+    ...     "enabled_channels": [],
+    ...     "enabled_categories": []
+    ...     "guild_pings": [
+    ...         "Moderators"
+    ...     ],
+    ...     "dm_pings": []
+    ... }
+
+    #### Status codes
+    - 201: returned on success
+    - 400: if one of the given fields is invalid
+
+    ### PATCH /bot/filter/filter_lists/<id:int>
+    Updates a specific FilterList item from the database.
+
+    #### Response format
+    >>> {
+    ...     "id": 1,
+    ...     "created_at": "2023-01-27T21:26:34.027293Z",
+    ...     "updated_at": "2023-01-27T21:26:34.027308Z",
+    ...     "name": "invite",
+    ...     "list_type": 1,
+    ...     "filters": [
+    ...         {
+    ...             "id": 1,
+    ...             "created_at": "2023-01-27T21:26:34.029539Z",
+    ...             "updated_at": "2023-01-27T21:26:34.030532Z",
+    ...             "content": "267624335836053506",
+    ...             "description": "Python Discord",
+    ...             "additional_field": None,
+    ...             "filter_list": 1,
+    ...             "settings": {
+    ...                 "bypass_roles": None,
+    ...                 "filter_dm": None,
+    ...                 "enabled": None,
+    ...                 "remove_context": None,
+    ...                 "send_alert": None,
+    ...                 "infraction_and_notification": {
+    ...                     "infraction_type": None,
+    ...                     "infraction_reason": None,
+    ...                     "infraction_duration": None,
+    ...                     "infraction_channel": None,
+    ...                     "dm_content": None,
+    ...                     "dm_embed": None
+    ...                 },
+    ...                 "channel_scope": {
+    ...                     "disabled_channels": None,
+    ...                     "disabled_categories": None,
+    ...                     "enabled_channels": None,
+    ...                     "enabled_categories": None
+    ...                 },
+    ...                 "mentions": {
+    ...                     "guild_pings": None,
+    ...                     "dm_pings": None
+    ...                 }
+    ...             }
+    ...         },
+    ...         ...
+    ...     ],
+    ...     "settings": {
+    ...         "bypass_roles": [
+    ...             "Helpers"
+    ...         ],
+    ...         "filter_dm": True,
+    ...         "enabled": True,
+    ...         "remove_context": True,
+    ...         "send_alert": True,
+    ...         "infraction_and_notification": {
+    ...             "infraction_type": "NONE",
+    ...             "infraction_reason": "",
+    ...             "infraction_duration": "0.0",
+    ...             "infraction_channel": 0,
+    ...             "dm_content": "Per Rule 6, your invite link has been removed...",
+    ...             "dm_embed": ""
+    ...         },
+    ...         "channel_scope": {
+    ...             "disabled_channels": [],
+    ...             "disabled_categories": [
+    ...                 "CODE JAM"
+    ...             ],
+    ...             "enabled_channels": [],
+    ...             "enabled_categories": []
+    ...         },
+    ...         "mentions": {
+    ...             "guild_pings": [
+    ...                 "Moderators"
+    ...             ],
+    ...             "dm_pings": []
+    ...         }
+    ...     }
+    ... }
+
+    #### Status codes
+    - 200: returned on success
+    - 400: if one of the given fields is invalid
+
     ### DELETE /bot/filter/filter_lists/<id:int>
     Deletes the FilterList item with the given `id`.
 
@@ -188,33 +328,39 @@ class FilterViewSet(ModelViewSet):
 
     #### Response format
     >>> [
-    ...     {
-    ...                 "id": 1,
-    ...                 "filter_list": 1
-    ...                 "content": "267624335836053506",
-    ...                 "description": "Python Discord",
-    ...                 "additional_field": None,
-    ...                 "settings": {
-    ...                        "bypass_roles": None
-    ...                        "filter_dm": None,
-    ...                        "enabled": None
-    ...                        "remove_context": True,
-    ...                        "send_alert": True
-    ...                        "infraction": {
-    ...                            "infraction_type": None,
-    ...                            "infraction_reason": None,
-    ...                            "infraction_duration": None
-    ...                        },
-    ...                        "channel_scope": {
-    ...                          "disabled_channels": None,
-    ...                          "disabled_categories": None,
-    ...                          "enabled_channels": None
-    ...                        }
-    ...                        "mentions": {
-    ...                          "ping_type": None,
-    ...                          "dm_ping_type": None
-    ...                       }
-    ...                    }
+    ...         {
+    ...         "id": 1,
+    ...         "created_at": "2023-01-27T21:26:34.029539Z",
+    ...         "updated_at": "2023-01-27T21:26:34.030532Z",
+    ...         "content": "267624335836053506",
+    ...         "description": "Python Discord",
+    ...         "additional_field": None,
+    ...         "filter_list": 1,
+    ...         "settings": {
+    ...             "bypass_roles": None,
+    ...             "filter_dm": None,
+    ...             "enabled": None,
+    ...             "remove_context": None,
+    ...             "send_alert": None,
+    ...             "infraction_and_notification": {
+    ...                 "infraction_type": None,
+    ...                 "infraction_reason": None,
+    ...                 "infraction_duration": None,
+    ...                 "infraction_channel": None,
+    ...                 "dm_content": None,
+    ...                 "dm_embed": None
+    ...             },
+    ...             "channel_scope": {
+    ...                 "disabled_channels": None,
+    ...                 "disabled_categories": None,
+    ...                 "enabled_channels": None,
+    ...                 "enabled_categories": None
+    ...             },
+    ...             "mentions": {
+    ...                 "guild_pings": None,
+    ...                 "dm_pings": None
+    ...             }
+    ...         }
     ...     },
     ...     ...
     ... ]
@@ -228,32 +374,38 @@ class FilterViewSet(ModelViewSet):
 
     #### Response format
     >>> {
-    ...                 "id": 1,
-    ...                 "filter_list": 1
-    ...                 "content": "267624335836053506",
-    ...                 "description": "Python Discord",
-    ...                 "additional_field": None,
-    ...                 "settings": {
-    ...                        "bypass_roles": None
-    ...                        "filter_dm": None,
-    ...                        "enabled": None
-    ...                        "remove_context": True,
-    ...                        "send_alert": True
-    ...                        "infraction": {
-    ...                            "infraction_type": None,
-    ...                            "infraction_reason": None,
-    ...                            "infraction_duration": None
-    ...                        },
-    ...                        "channel_scope": {
-    ...                          "disabled_channels": None,
-    ...                          "disabled_categories": None,
-    ...                          "enabled_channels": None,
-    ...                        }
-    ...                       "mentions": {
-    ...                         "ping_type": None
-    ...                         "dm_ping_type": None
-    ...                       }
-    ...                    }
+    ...     "id": 1,
+    ...     "created_at": "2023-01-27T21:26:34.029539Z",
+    ...     "updated_at": "2023-01-27T21:26:34.030532Z",
+    ...     "content": "267624335836053506",
+    ...     "description": "Python Discord",
+    ...     "additional_field": None,
+    ...     "filter_list": 1,
+    ...     "settings": {
+    ...         "bypass_roles": None,
+    ...         "filter_dm": None,
+    ...         "enabled": None,
+    ...         "remove_context": None,
+    ...         "send_alert": None,
+    ...         "infraction_and_notification": {
+    ...             "infraction_type": None,
+    ...             "infraction_reason": None,
+    ...             "infraction_duration": None,
+    ...             "infraction_channel": None,
+    ...             "dm_content": None,
+    ...             "dm_embed": None
+    ...         },
+    ...         "channel_scope": {
+    ...             "disabled_channels": None,
+    ...             "disabled_categories": None,
+    ...             "enabled_channels": None,
+    ...             "enabled_categories": None
+    ...         },
+    ...         "mentions": {
+    ...             "guild_pings": None,
+    ...             "dm_pings": None
+    ...         }
+    ...     }
     ... }
 
     #### Status codes
@@ -265,10 +417,27 @@ class FilterViewSet(ModelViewSet):
 
     #### Request body
     >>> {
+    ...     "filter_list": 1,
     ...     "content": "267624335836053506",
     ...     "description": "Python Discord",
     ...     "additional_field": None,
-    ...     "override": 1
+    ...     "bypass_roles": None,
+    ...     "filter_dm": None,
+    ...     "enabled": False,
+    ...     "remove_context": None,
+    ...     "send_alert": None,
+    ...     "infraction_type": None,
+    ...     "infraction_reason": None,
+    ...     "infraction_duration": None,
+    ...     "infraction_channel": None,
+    ...     "dm_content": None,
+    ...     "dm_embed": None
+    ...     "disabled_channels": None,
+    ...     "disabled_categories": None,
+    ...     "enabled_channels": None,
+    ...     "enabled_categories": None
+    ...     "guild_pings": None,
+    ...     "dm_pings": None
     ... }
 
     #### Status codes
@@ -281,10 +450,37 @@ class FilterViewSet(ModelViewSet):
     #### Response format
     >>> {
     ...     "id": 1,
+    ...     "created_at": "2023-01-27T21:26:34.029539Z",
+    ...     "updated_at": "2023-01-27T21:26:34.030532Z",
     ...     "content": "267624335836053506",
     ...     "description": "Python Discord",
     ...     "additional_field": None,
-    ...     "override": 1
+    ...     "filter_list": 1,
+    ...     "settings": {
+    ...         "bypass_roles": None,
+    ...         "filter_dm": None,
+    ...         "enabled": None,
+    ...         "remove_context": None,
+    ...         "send_alert": None,
+    ...         "infraction_and_notification": {
+    ...             "infraction_type": None,
+    ...             "infraction_reason": None,
+    ...             "infraction_duration": None,
+    ...             "infraction_channel": None,
+    ...             "dm_content": None,
+    ...             "dm_embed": None
+    ...         },
+    ...         "channel_scope": {
+    ...             "disabled_channels": None,
+    ...             "disabled_categories": None,
+    ...             "enabled_channels": None,
+    ...             "enabled_categories": None
+    ...         },
+    ...         "mentions": {
+    ...             "guild_pings": None,
+    ...             "dm_pings": None
+    ...         }
+    ...     }
     ... }
 
     #### Status codes
-- 
cgit v1.2.3


From 0f40b114940164c65b10d1312b5a419ce025c799 Mon Sep 17 00:00:00 2001
From: mbaruh <mbaruh@hotmail.com>
Date: Sun, 26 Mar 2023 23:12:34 +0300
Subject: Rename additional_field to additional_settings

---
 pydis_site/apps/api/migrations/0088_new_filter_schema.py   |  4 ++--
 .../apps/api/migrations/0089_unique_constraint_filters.py  |  4 ++--
 pydis_site/apps/api/models/bot/filters.py                  |  4 +++-
 pydis_site/apps/api/serializers.py                         |  9 +++++----
 pydis_site/apps/api/tests/test_filters.py                  |  2 +-
 pydis_site/apps/api/tests/test_models.py                   |  2 +-
 pydis_site/apps/api/viewsets/bot/filters.py                | 14 +++++++-------
 7 files changed, 21 insertions(+), 18 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0088_new_filter_schema.py b/pydis_site/apps/api/migrations/0088_new_filter_schema.py
index 1506e4d7..2e1d78c9 100644
--- a/pydis_site/apps/api/migrations/0088_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0088_new_filter_schema.py
@@ -64,7 +64,7 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
                 updated_at=object_.updated_at,
                 filter_list=list_,
                 description=object_.comment,
-                additional_field=None,
+                additional_settings=None,
                 guild_pings=None,
                 filter_dm=None,
                 dm_pings=None,
@@ -105,7 +105,7 @@ class Migration(migrations.Migration):
                 ('updated_at', models.DateTimeField(auto_now=True)),
                 ('content', models.CharField(help_text='The definition of this filter.', max_length=100)),
                 ('description', models.CharField(help_text='Why this filter has been added.', max_length=200, null=True)),
-                ('additional_field', models.JSONField(help_text='Implementation specific field.', null=True)),
+                ('additional_settings', models.JSONField(help_text='Additional settings which are specific to this filter.', null=True)),
                 ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None, null=True)),
                 ('filter_dm', models.BooleanField(help_text='Whether DMs should be filtered.', null=True)),
                 ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None, null=True)),
diff --git a/pydis_site/apps/api/migrations/0089_unique_constraint_filters.py b/pydis_site/apps/api/migrations/0089_unique_constraint_filters.py
index 0bcfd8a3..cb230a27 100644
--- a/pydis_site/apps/api/migrations/0089_unique_constraint_filters.py
+++ b/pydis_site/apps/api/migrations/0089_unique_constraint_filters.py
@@ -11,13 +11,13 @@ class Migration(migrations.Migration):
         migrations.RunSQL(
             "ALTER TABLE api_filter "
             "ADD CONSTRAINT unique_filters UNIQUE NULLS NOT DISTINCT "
-            "(content, additional_field, filter_list_id, dm_content, dm_embed, infraction_type, infraction_reason, infraction_duration, infraction_channel, guild_pings, filter_dm, dm_pings, remove_context, bypass_roles, enabled, send_alert, enabled_channels, disabled_channels, enabled_categories, disabled_categories)",
+            "(content, additional_settings, filter_list_id, dm_content, dm_embed, infraction_type, infraction_reason, infraction_duration, infraction_channel, guild_pings, filter_dm, dm_pings, remove_context, bypass_roles, enabled, send_alert, enabled_channels, disabled_channels, enabled_categories, disabled_categories)",
             reverse_sql="ALTER TABLE api_filter DROP CONSTRAINT unique_filters",
             state_operations=[
                 migrations.AddConstraint(
                     model_name='filter',
                     constraint=models.UniqueConstraint(
-                        fields=('content', 'additional_field', 'filter_list', 'dm_content', 'dm_embed', 'infraction_type', 'infraction_reason', 'infraction_duration', 'infraction_channel', 'guild_pings', 'filter_dm', 'dm_pings', 'remove_context', 'bypass_roles', 'enabled', 'send_alert', 'enabled_channels', 'disabled_channels', 'enabled_categories', 'disabled_categories'),
+                        fields=('content', 'additional_settings', 'filter_list', 'dm_content', 'dm_embed', 'infraction_type', 'infraction_reason', 'infraction_duration', 'infraction_channel', 'guild_pings', 'filter_dm', 'dm_pings', 'remove_context', 'bypass_roles', 'enabled', 'send_alert', 'enabled_channels', 'disabled_channels', 'enabled_categories', 'disabled_categories'),
                         name='unique_filters'
                     ),
                 ),
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index c6f6f851..aadb39aa 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -131,7 +131,9 @@ class FilterBase(ModelTimestampMixin, ModelReprMixin, models.Model):
         max_length=200,
         help_text="Why this filter has been added.", null=True
     )
-    additional_field = models.JSONField(null=True, help_text="Implementation specific field.")
+    additional_settings = models.JSONField(
+        null=True, help_text="Additional settings which are specific to this filter."
+    )
     filter_list = models.ForeignKey(
         FilterList, models.CASCADE, related_name="filters",
         help_text="The filter list containing this filter."
diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index da02c837..a3779094 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -184,7 +184,7 @@ ALLOW_EMPTY_SETTINGS = (
 
 # Required fields for custom JSON representation purposes
 BASE_FILTER_FIELDS = (
-    'id', 'created_at', 'updated_at', 'content', 'description', 'additional_field'
+    'id', 'created_at', 'updated_at', 'content', 'description', 'additional_settings'
 )
 BASE_FILTERLIST_FIELDS = ('id', 'created_at', 'updated_at', 'name', 'list_type')
 BASE_SETTINGS_FIELDS = (
@@ -279,7 +279,7 @@ class FilterSerializer(ModelSerializer):
             'updated_at',
             'content',
             'description',
-            'additional_field',
+            'additional_settings',
             'filter_list'
         ) + SETTINGS_FIELDS
         extra_kwargs = _create_meta_extra_kwargs(for_filter=True)
@@ -382,9 +382,10 @@ class FilterListSerializer(ModelSerializer):
         Provides a custom JSON representation to the FilterList Serializers.
 
         This representation restructures how the Filter is represented.
-        It groups the Infraction, Channel and Mention related fields into their own separated group.
+        It groups the Infraction, Channel, and Mention related fields
+        into their own separated groups.
 
-        Furthermore, it puts the fields that meant to represent FilterList settings,
+        Furthermore, it puts the fields that are meant to represent FilterList settings,
         into a sub-field called `settings`.
         """
         schema = {name: getattr(instance, name) for name in BASE_FILTERLIST_FIELDS}
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index f36e0617..3d3be51e 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -92,7 +92,7 @@ def get_test_sequences() -> Dict[str, TestSequence]:
             {
                 "content": "bad word",
                 "description": "This is a really bad word.",
-                "additional_field": "{'hi': 'there'}",
+                "additional_settings": "{'hi': 'there'}",
                 "guild_pings": None,
                 "filter_dm": None,
                 "dm_pings": None,
diff --git a/pydis_site/apps/api/tests/test_models.py b/pydis_site/apps/api/tests/test_models.py
index 25d771cc..d3341b35 100644
--- a/pydis_site/apps/api/tests/test_models.py
+++ b/pydis_site/apps/api/tests/test_models.py
@@ -113,7 +113,7 @@ class StringDunderMethodTests(SimpleTestCase):
             Filter(
                 content="ducky_nsfw",
                 description="This ducky is totally inappropriate!",
-                additional_field=None,
+                additional_settings=None,
             ),
             OffensiveMessage(
                 id=602951077675139072,
diff --git a/pydis_site/apps/api/viewsets/bot/filters.py b/pydis_site/apps/api/viewsets/bot/filters.py
index c84da909..d6c2d18c 100644
--- a/pydis_site/apps/api/viewsets/bot/filters.py
+++ b/pydis_site/apps/api/viewsets/bot/filters.py
@@ -33,7 +33,7 @@ class FilterListViewSet(ModelViewSet):
     ...                 "updated_at": "2023-01-27T21:26:34.030532Z",
     ...                 "content": "267624335836053506",
     ...                 "description": "Python Discord",
-    ...                 "additional_field": None,
+    ...                 "additional_settings": None,
     ...                 "filter_list": 1,
     ...                 "settings": {
     ...                     "bypass_roles": None,
@@ -119,7 +119,7 @@ class FilterListViewSet(ModelViewSet):
     ...             "updated_at": "2023-01-27T21:26:34.030532Z",
     ...             "content": "267624335836053506",
     ...             "description": "Python Discord",
-    ...             "additional_field": None,
+    ...             "additional_settings": None,
     ...             "filter_list": 1,
     ...             "settings": {
     ...                 "bypass_roles": None,
@@ -239,7 +239,7 @@ class FilterListViewSet(ModelViewSet):
     ...             "updated_at": "2023-01-27T21:26:34.030532Z",
     ...             "content": "267624335836053506",
     ...             "description": "Python Discord",
-    ...             "additional_field": None,
+    ...             "additional_settings": None,
     ...             "filter_list": 1,
     ...             "settings": {
     ...                 "bypass_roles": None,
@@ -334,7 +334,7 @@ class FilterViewSet(ModelViewSet):
     ...         "updated_at": "2023-01-27T21:26:34.030532Z",
     ...         "content": "267624335836053506",
     ...         "description": "Python Discord",
-    ...         "additional_field": None,
+    ...         "additional_settings": None,
     ...         "filter_list": 1,
     ...         "settings": {
     ...             "bypass_roles": None,
@@ -379,7 +379,7 @@ class FilterViewSet(ModelViewSet):
     ...     "updated_at": "2023-01-27T21:26:34.030532Z",
     ...     "content": "267624335836053506",
     ...     "description": "Python Discord",
-    ...     "additional_field": None,
+    ...     "additional_settings": None,
     ...     "filter_list": 1,
     ...     "settings": {
     ...         "bypass_roles": None,
@@ -420,7 +420,7 @@ class FilterViewSet(ModelViewSet):
     ...     "filter_list": 1,
     ...     "content": "267624335836053506",
     ...     "description": "Python Discord",
-    ...     "additional_field": None,
+    ...     "additional_settings": None,
     ...     "bypass_roles": None,
     ...     "filter_dm": None,
     ...     "enabled": False,
@@ -454,7 +454,7 @@ class FilterViewSet(ModelViewSet):
     ...     "updated_at": "2023-01-27T21:26:34.030532Z",
     ...     "content": "267624335836053506",
     ...     "description": "Python Discord",
-    ...     "additional_field": None,
+    ...     "additional_settings": None,
     ...     "filter_list": 1,
     ...     "settings": {
     ...         "bypass_roles": None,
-- 
cgit v1.2.3


From 4c923fa1cd6f1f5144036317b116aac745b3c345 Mon Sep 17 00:00:00 2001
From: Boris Muratov <8bee278@gmail.com>
Date: Wed, 5 Apr 2023 03:10:05 +0300
Subject: Add maximum auto-timeout duration validation

---
 pydis_site/apps/api/serializers.py        | 31 +++++++++++++++++++++++++------
 pydis_site/apps/api/tests/test_filters.py |  2 ++
 2 files changed, 27 insertions(+), 6 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
index a3779094..2186b02c 100644
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -1,4 +1,5 @@
 """Converters from Django models to data interchange formats and back."""
+from datetime import timedelta
 from typing import Any
 
 from django.db.models.query import QuerySet
@@ -210,6 +211,8 @@ CHANNEL_SCOPE_FIELDS = (
 )
 MENTIONS_FIELDS = ('guild_pings', 'dm_pings')
 
+MAX_TIMEOUT_DURATION = timedelta(days=28)
+
 
 def _create_meta_extra_kwargs(*, for_filter: bool) -> dict[str, dict[str, bool]]:
     """Create the extra kwargs for the Meta classes of the Filter and FilterList serializers."""
@@ -236,17 +239,24 @@ class FilterSerializer(ModelSerializer):
 
     def validate(self, data: dict) -> dict:
         """Perform infraction data + allowed and disallowed lists validation."""
+        infraction_type = get_field_value(data, 'infraction_type')
+        infraction_duration = get_field_value(data, 'infraction_duration')
         if (
-            (
-                get_field_value(data, 'infraction_reason')
-                or get_field_value(data, 'infraction_duration')
-            )
-            and get_field_value(data, 'infraction_type') == 'NONE'
+            (get_field_value(data, 'infraction_reason') or infraction_duration)
+            and infraction_type == 'NONE'
         ):
             raise ValidationError(
                 "Infraction type is required with infraction duration or reason."
             )
 
+        if (
+            infraction_type == 'TIMEOUT'
+            and (not infraction_duration or infraction_duration > MAX_TIMEOUT_DURATION)
+        ):
+            raise ValidationError(
+                f"A timeout cannot be longer than {MAX_TIMEOUT_DURATION.days} days."
+            )
+
         common_channels = (
             set(get_field_value(data, 'disabled_channels'))
             & set(get_field_value(data, 'enabled_channels'))
@@ -328,8 +338,9 @@ class FilterListSerializer(ModelSerializer):
 
     def validate(self, data: dict) -> dict:
         """Perform infraction data + allow and disallowed lists validation."""
+        infraction_duration = data.get('infraction_duration')
         if (
-            data.get('infraction_reason') or data.get('infraction_duration')
+            data.get('infraction_reason') or infraction_duration
         ) and not data.get('infraction_type'):
             raise ValidationError("Infraction type is required with infraction duration or reason")
 
@@ -344,6 +355,14 @@ class FilterListSerializer(ModelSerializer):
                     f" {', '.join(repr(channel) for channel in common_channels)}."
                 )
 
+        if (
+            data.get('infraction_type') == 'TIMEOUT'
+            and (not infraction_duration or infraction_duration > MAX_TIMEOUT_DURATION)
+        ):
+            raise ValidationError(
+                f"A timeout cannot be longer than {MAX_TIMEOUT_DURATION.days} days."
+            )
+
         if (
             data.get('disabled_categories') is not None
             and data.get('enabled_categories') is not None
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index 3d3be51e..ebc4a2cf 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -274,6 +274,7 @@ class FilterValidationTests(AuthenticatedAPITestCase):
             ({"infraction_reason": "hi"}, {}, 400),
             ({"infraction_duration": timedelta(seconds=10)}, {}, 400),
             ({"infraction_reason": "hi"}, {"infraction_type": "NOTE"}, 200),
+            ({"infraction_type": "TIMEOUT", "infraction_duration": timedelta(days=30)}, {}, 400),
             ({"infraction_duration": timedelta(seconds=10)}, {"infraction_type": "TIMEOUT"}, 200),
             ({"enabled_channels": ["admins"]}, {}, 200),
             ({"disabled_channels": ["123"]}, {}, 200),
@@ -313,6 +314,7 @@ class FilterValidationTests(AuthenticatedAPITestCase):
         cases = (
             ({"infraction_reason": "hi"}, 400),
             ({"infraction_duration": timedelta(seconds=10)}, 400),
+            ({"infraction_type": "TIMEOUT", "infraction_duration": timedelta(days=30)}, 400),
             ({"infraction_reason": "hi", "infraction_type": "NOTE"}, 200),
             ({"infraction_duration": timedelta(seconds=10), "infraction_type": "TIMEOUT"}, 200),
             ({"enabled_channels": ["admins"]}, 200), ({"disabled_channels": ["123"]}, 200),
-- 
cgit v1.2.3


From b8ddedc31d54f46bb86a7e7d200c163ea8806ee0 Mon Sep 17 00:00:00 2001
From: Boris Muratov <8bee278@gmail.com>
Date: Thu, 6 Apr 2023 01:09:09 +0300
Subject: Make additional_settings non-null with dict default

This makes sure that the value in the DB is always a valid JSON, ensuring the unique constraint will work properly.
---
 pydis_site/apps/api/migrations/0088_new_filter_schema.py | 4 ++--
 pydis_site/apps/api/models/bot/filters.py                | 2 +-
 pydis_site/apps/api/tests/test_filters.py                | 3 ++-
 3 files changed, 5 insertions(+), 4 deletions(-)

(limited to 'pydis_site/apps/api/tests')

diff --git a/pydis_site/apps/api/migrations/0088_new_filter_schema.py b/pydis_site/apps/api/migrations/0088_new_filter_schema.py
index 2e1d78c9..675fdcec 100644
--- a/pydis_site/apps/api/migrations/0088_new_filter_schema.py
+++ b/pydis_site/apps/api/migrations/0088_new_filter_schema.py
@@ -64,7 +64,7 @@ def forward(apps: Apps, schema_editor: BaseDatabaseSchemaEditor) -> None:
                 updated_at=object_.updated_at,
                 filter_list=list_,
                 description=object_.comment,
-                additional_settings=None,
+                additional_settings={},
                 guild_pings=None,
                 filter_dm=None,
                 dm_pings=None,
@@ -105,7 +105,7 @@ class Migration(migrations.Migration):
                 ('updated_at', models.DateTimeField(auto_now=True)),
                 ('content', models.CharField(help_text='The definition of this filter.', max_length=100)),
                 ('description', models.CharField(help_text='Why this filter has been added.', max_length=200, null=True)),
-                ('additional_settings', models.JSONField(help_text='Additional settings which are specific to this filter.', null=True)),
+                ('additional_settings', models.JSONField(help_text='Additional settings which are specific to this filter.', default=dict)),
                 ('guild_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers.', size=None, null=True)),
                 ('filter_dm', models.BooleanField(help_text='Whether DMs should be filtered.', null=True)),
                 ('dm_pings', django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=100), help_text='Who to ping when this filter triggers on a DM.', size=None, null=True)),
diff --git a/pydis_site/apps/api/models/bot/filters.py b/pydis_site/apps/api/models/bot/filters.py
index aadb39aa..71f8771f 100644
--- a/pydis_site/apps/api/models/bot/filters.py
+++ b/pydis_site/apps/api/models/bot/filters.py
@@ -132,7 +132,7 @@ class FilterBase(ModelTimestampMixin, ModelReprMixin, models.Model):
         help_text="Why this filter has been added.", null=True
     )
     additional_settings = models.JSONField(
-        null=True, help_text="Additional settings which are specific to this filter."
+        help_text="Additional settings which are specific to this filter.", default=dict
     )
     filter_list = models.ForeignKey(
         FilterList, models.CASCADE, related_name="filters",
diff --git a/pydis_site/apps/api/tests/test_filters.py b/pydis_site/apps/api/tests/test_filters.py
index ebc4a2cf..5059d651 100644
--- a/pydis_site/apps/api/tests/test_filters.py
+++ b/pydis_site/apps/api/tests/test_filters.py
@@ -230,6 +230,7 @@ class GenericFilterTests(AuthenticatedAPITestCase):
 
     def test_creation_missing_field(self) -> None:
         for name, sequence in get_test_sequences().items():
+            ignored_fields = sequence.ignored_fields + ("id", "additional_settings")
             with self.subTest(name=name):
                 saved = sequence.model(**sequence.object)
                 save_nested_objects(saved)
@@ -237,7 +238,7 @@ class GenericFilterTests(AuthenticatedAPITestCase):
 
                 for field in sequence.model._meta.get_fields():
                     with self.subTest(field=field):
-                        if field.null or field.name in sequence.ignored_fields + ("id",):
+                        if field.null or field.name in ignored_fields:
                             continue
 
                         test_data = data.copy()
-- 
cgit v1.2.3