197 | Enhance events/all API Search Filter by enabling Fuzzy Matching with Priority Based Inclusion (#61)

* Update Event search filter to enable fuzzy search with priority-based inclusion

* Update unittests for event filters

Author: Palwisha-18

arbisoft_sessions_portal/settings/base.py

@@ -58,6 +58,7 @@
     'django.contrib.contenttypes',
     'django.contrib.sessions',
     'django.contrib.messages',
+    'django.contrib.postgres',
     'django.contrib.staticfiles',
     'rest_framework',
     'django_filters',

events/factories.py

@@ -4,7 +4,7 @@
 from django.contrib.auth import get_user_model
 from django.utils import timezone
 
-from events.models import Event, Playlist, Tag, VideoAsset
+from events.models import Event, EventPresenter, Playlist, Tag, VideoAsset
 
 fake = Faker()
 User = get_user_model()
@@ -61,3 +61,13 @@ class Meta:
     status = VideoAsset.VideoStatus.READY
     duration = factory.Faker("random_int", min=60, max=3600)  # Duration in seconds
     file_size = factory.Faker("random_int", min=1024, max=10485760)  # File size in bytes
+
+
+class EventPresenterFactory(factory.django.DjangoModelFactory):
+    """Factory for EventPresenter model"""
+
+    class Meta:
+        model = EventPresenter
+
+    event = factory.SubFactory(EventFactory)
+    user = factory.SubFactory(UserFactory)

events/migrations/0011_add_pg_trgm_extension.py

@@ -0,0 +1,15 @@
+# Generated by Django 4.2.21 on 2025-06-14 03:23
+
+from django.contrib.postgres.operations import CreateExtension
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('events', '0010_populate_event_slugs'),
+    ]
+
+    operations = [
+        CreateExtension('pg_trgm'),
+    ]

events/signals.py

@@ -6,7 +6,7 @@
 
 
 @receiver(post_save, sender=Event)
-def set_slug_on_create(_sender, instance, created, **kwargs):
+def set_slug_on_create(sender, instance, created, **kwargs):  # pylint: disable=unused-argument
     """
     Set a slug for the event instance if it is created and does not have a slug.
     The slug is generated from the title and includes the event ID to ensure uniqueness.

events/tests/conftest.py

@@ -1,5 +1,6 @@
 import pytest
 
+from django.db import connection
 from django.db.models.signals import post_save
 
 from events.models import Event
@@ -12,3 +13,11 @@ def disable_event_signals():
     post_save.disconnect(set_slug_on_create, sender=Event)
     yield
     post_save.connect(set_slug_on_create, sender=Event)
+
+
+@pytest.fixture(scope='session', autouse=True)
+def setup_test_database(django_db_setup, django_db_blocker):  # pylint: disable=unused-argument
+    """Ensure test database has trigram extension"""
+    with django_db_blocker.unblock():
+        with connection.cursor() as cursor:
+            cursor.execute("CREATE EXTENSION IF NOT EXISTS pg_trgm;")

events/tests/test_filters.py

@@ -1,3 +1,5 @@
+from datetime import datetime, timezone
+
 import pytest
 from rest_framework import status
 from rest_framework.test import APIClient
@@ -6,7 +8,14 @@
 from django.urls import reverse
 
 # pylint: disable=duplicate-code
-from events.factories import EventFactory, PlaylistFactory, TagFactory, UserFactory, VideoAssetFactory
+from events.factories import (
+    EventFactory,
+    EventPresenterFactory,
+    PlaylistFactory,
+    TagFactory,
+    UserFactory,
+    VideoAssetFactory,
+)
 
 User = get_user_model()
 
@@ -49,20 +58,6 @@ def test_events_search_filter_by_description(self, api_client):
         assert len(response.data["results"]) == 1
         assert response.data["results"][0]["title"] == "Tech Event 1"
 
-    def test_events_search_filter_by_creator_name(self, api_client):
-        """ Test filtering events by creator's first or last name """
-        creator1 = UserFactory(first_name="John", last_name="Doe")
-        creator2 = UserFactory(first_name="Jane", last_name="Smith")
-
-        self._create_event_with_video(title="Event 1", creator=creator1)
-        self._create_event_with_video(title="Event 2", creator=creator2)
-
-        response = api_client.get(reverse("events-list"), {'search': 'John'})
-
-        assert response.status_code == status.HTTP_200_OK
-        assert len(response.data["results"]) == 1
-        assert response.data["results"][0]["title"] == "Event 1"
-
     def test_events_tag_filter(self, api_client):
         """ Test filtering events by tag """
         python_tag = TagFactory(name="Python")
@@ -136,3 +131,164 @@ def test_events_ordering_by_featured(self, api_client):
         assert response.status_code == status.HTTP_200_OK
         assert len(response.data["results"]) == 3
         assert response.data["results"][0]["title"] != "Non-Featured Event"
+
+    def test_events_search_filter_fuzzy_matching_title(self, api_client):
+        """ Test fuzzy matching in title search """
+        self._create_event_with_video(title="All-Hands Meeting 2024")
+        self._create_event_with_video(title="Machine Learning Summit")
+
+        response = api_client.get(reverse("events-list"), {'search': 'All Hands'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "All-Hands Meeting 2024"
+
+    def test_events_search_filter_fuzzy_matching_description(self, api_client):
+        """ Test fuzzy matching in description search """
+        self._create_event_with_video(title="Tech Event", description="Learn about Python programming")
+        self._create_event_with_video(title="Other Event", description="Data science basics")
+
+        response = api_client.get(reverse("events-list"), {'search': 'Python'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Tech Event"
+
+    def test_events_search_filter_by_playlist_name(self, api_client):
+        """ Test filtering events by search term matching playlist name """
+        demo_playlist = PlaylistFactory(name="Demo Hour")
+        tech_playlist = PlaylistFactory(name="Tech Talks")
+
+        event1 = self._create_event_with_video(title="Weekly Demo Session", description="Demo of new features")
+        event1.playlists.add(demo_playlist)
+
+        event2 = self._create_event_with_video(title="Architecture Discussion", description="Tech stack overview")
+        event2.playlists.add(tech_playlist)
+
+        response = api_client.get(reverse("events-list"), {'search': 'Demo'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Weekly Demo Session"
+
+    def test_events_search_filter_by_presenter_name(self, api_client):
+        """ Test filtering events by presenter name """
+        presenter_user = UserFactory(first_name="Alice", last_name="Johnson")
+        other_user = UserFactory(first_name="Bob", last_name="Wilson")
+
+        event1 = self._create_event_with_video(title="Python Workshop")
+        event2 = self._create_event_with_video(title="Data Science Talk")
+
+        EventPresenterFactory(event=event1, user=presenter_user)
+        EventPresenterFactory(event=event2, user=other_user)
+
+        response = api_client.get(reverse("events-list"), {'search': 'Alice'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Python Workshop"
+
+        response = api_client.get(reverse("events-list"), {'search': 'Johnson'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Python Workshop"
+
+    def test_events_search_multiple_presenters(self, api_client):
+        """ Test event with multiple presenters """
+        presenter1 = UserFactory(first_name="Alice", last_name="Johnson")
+        presenter2 = UserFactory(first_name="Bob", last_name="Smith")
+        other_presenter = UserFactory(first_name="Carol", last_name="Davis")
+
+        event1 = self._create_event_with_video(title="Team Presentation")
+        event2 = self._create_event_with_video(title="Solo Talk")
+
+        EventPresenterFactory(event=event1, user=presenter1)
+        EventPresenterFactory(event=event1, user=presenter2)
+
+        EventPresenterFactory(event=event2, user=other_presenter)
+
+        response = api_client.get(reverse("events-list"), {'search': 'Alice'})
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Team Presentation"
+
+        response = api_client.get(reverse("events-list"), {'search': 'Bob'})
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Team Presentation"
+
+        response = api_client.get(reverse("events-list"), {'search': 'Carol'})
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Solo Talk"
+
+    def test_events_search_filter_by_tag_name(self, api_client):
+        """ Test filtering events by search term matching tag name """
+        python_tag = TagFactory(name="Python")
+        javascript_tag = TagFactory(name="JavaScript")
+
+        event1 = self._create_event_with_video(title="Backend Development")
+        event1.tags.add(python_tag)
+
+        event2 = self._create_event_with_video(title="Frontend Development")
+        event2.tags.add(javascript_tag)
+
+        response = api_client.get(reverse("events-list"), {'search': 'Python'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Backend Development"
+
+    def test_events_search_no_results(self, api_client):
+        """ Test search with no matching results """
+        self._create_event_with_video(title="Python Conference")
+        self._create_event_with_video(title="Machine Learning Summit")
+
+        response = api_client.get(reverse("events-list"), {'search': 'NonExistentTerm'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 0
+
+    def test_events_search_ordering_by_event_time(self, api_client):
+        """ Test that search results are ordered by event_time (newest first) """
+        # pylint: disable=unused-variable
+        old_event = self._create_event_with_video(
+            title="Python Old Event",
+            event_time=datetime(2024, 1, 1, tzinfo=timezone.utc)
+        )
+        new_event = self._create_event_with_video(
+            title="Python New Event",
+            event_time=datetime(2024, 12, 1, tzinfo=timezone.utc)
+        )
+        middle_event = self._create_event_with_video(
+            title="Python Middle Event",
+            event_time=datetime(2024, 6, 1, tzinfo=timezone.utc)
+        )
+
+        response = api_client.get(reverse("events-list"), {'search': 'Python'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 3
+
+        assert response.data["results"][0]["title"] == "Python New Event"
+        assert response.data["results"][1]["title"] == "Python Middle Event"
+        assert response.data["results"][2]["title"] == "Python Old Event"
+
+    def test_events_search_multiple_criteria_match(self, api_client):
+        """ Test event matching multiple search criteria """
+        python_tag = TagFactory(name="Python")
+        demo_playlist = PlaylistFactory(name="Demo Hour")
+
+        event = self._create_event_with_video(
+            title="Python Programming Demo",
+            description="Advanced Python techniques"
+        )
+        event.tags.add(python_tag)
+        event.playlists.add(demo_playlist)
+
+        response = api_client.get(reverse("events-list"), {'search': 'Python'})
+
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 1
+        assert response.data["results"][0]["title"] == "Python Programming Demo"

events/v1/filters.py

@@ -1,8 +1,9 @@
 import django_filters
 
-from django.db.models import Q
+from django.contrib.postgres.search import TrigramSimilarity
+from django.db.models import Exists, OuterRef, Q
 
-from events.models import Event, Playlist, Tag
+from events.models import Event, EventPresenter, Playlist, Tag
 
 
 class EventFilter(django_filters.rest_framework.FilterSet):
@@ -19,14 +20,63 @@ class Meta:
         fields = ('event_type', 'is_featured', 'status')
 
     def filter_search(self, queryset, _, value):
-        """ Filter the queryset based on the search value """
-        return queryset.filter(
-            Q(title__icontains=value) |
-            Q(description__icontains=value) |
-            Q(creator__first_name__icontains=value) |
-            Q(creator__last_name__icontains=value)
+        """
+        Filter the queryset based on fuzzy search with priority-based inclusion
+        Priority order for inclusion:
+        1. Title match
+        2. Description match
+        3. Playlist match
+        4. Presenter match
+        5. Tag match
+
+        Final results ordered by event_time (newest to oldest)
+        """
+        if not value:
+            return queryset
+
+        search_term = value.strip()
+        similarity_threshold = 0.3
+
+        playlist_match = Playlist.objects.filter(
+            events=OuterRef('pk'),
+            name__icontains=search_term
+        )
+
+        tag_match = Tag.objects.filter(
+            events=OuterRef('pk'),
+            name__icontains=search_term
         )
 
+        presenter_match = EventPresenter.objects.filter(
+            event=OuterRef('pk')
+        ).filter(
+            Q(user__first_name__icontains=search_term) |
+            Q(user__last_name__icontains=search_term)
+        )
+
+        queryset = queryset.annotate(
+            title_similarity=TrigramSimilarity('title', search_term),
+            desc_similarity=TrigramSimilarity('description', search_term),
+            has_playlist_match=Exists(playlist_match),
+            has_tag_match=Exists(tag_match),
+            has_presenter_match=Exists(presenter_match)
+        )
+
+        filtered_queryset = queryset.filter(
+            Q(title__icontains=search_term) |
+            Q(title_similarity__gt=similarity_threshold) |
+            Q(description__icontains=search_term) |
+            Q(desc_similarity__gt=similarity_threshold) |
+            Q(has_playlist_match=True) |
+            Q(has_presenter_match=True) |
+            Q(has_tag_match=True)
+        )
+
+        if not filtered_queryset.exists():
+            return queryset.none()
+
+        return filtered_queryset.order_by('-event_time')
+
     def filter_tag(self, queryset, _, value):
         """ Filter the queryset based on the tag value """
         return queryset.filter(

events/v1/views.py

@@ -15,7 +15,7 @@
 class EventsListView(ListAPIView):
     """ View for listing the events """
 
-    queryset = Event.objects.filter(videos__isnull=False).order_by("-status")
+    queryset = Event.objects.filter(videos__isnull=False)
     serializer_class = EventSerializer
     pagination_class = CustomPageNumberPagination
     filterset_class = EventFilter