Autocomplete for the contest search bar (#518)

steewoo · twalen · kamilszymczak1 · commit 971f22e0d43e · 2025-06-30T20:08:10.000+01:00
* Autocomplete contest search

* Bug fix

* Add tests

* Contest visibility bug fix

* fixing some code conflicts with szkopul patches

* fixing some code conflicts with szkopul patches part2

---------

Co-authored-by: Tomasz Waleń &lt;walen@mimuw.edu.pl&gt;
diff --git a/oioioi/contests/fixtures/test_contest_search.json b/oioioi/contests/fixtures/test_contest_search.json
@@ -0,0 +1,203 @@
+[
+    {
+      "pk": "cs1",
+      "model": "contests.contest",
+      "fields": {
+        "name": "AAAcontest",
+        "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+        "creation_date": "2011-07-31T20:27:58.768Z",
+        "is_archived": "False"
+      }
+    },
+    {
+      "pk": 1,
+      "model": "contests.round",
+      "fields": {
+        "name": "Round 1",
+        "contest": "cs1",
+        "start_date": "2011-07-31T20:27:58.768Z",
+        "results_date": "2012-07-31T20:27:58.768Z"
+      }
+    },
+    {
+        "pk": "cs2",
+        "model": "contests.contest",
+        "fields": {
+          "name": "ABAcontest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs2",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs3",
+        "model": "contests.contest",
+        "fields": {
+          "name": "ACAcontest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs3",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs4",
+        "model": "contests.contest",
+        "fields": {
+          "name": "AA contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs4",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs5",
+        "model": "contests.contest",
+        "fields": {
+          "name": "BA contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs5",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs6",
+        "model": "contests.contest",
+        "fields": {
+          "name": "CA contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs6",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs7",
+        "model": "contests.contest",
+        "fields": {
+          "name": "DA contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs7",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs8",
+        "model": "contests.contest",
+        "fields": {
+          "name": "EA contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs8",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs9",
+        "model": "contests.contest",
+        "fields": {
+          "name": "FA contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "False"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs9",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      },
+      {
+        "pk": "cs10",
+        "model": "contests.contest",
+        "fields": {
+          "name": "Archived contest",
+          "controller_name": "oioioi.programs.controllers.ProgrammingContestController",
+          "creation_date": "2011-07-31T20:27:58.768Z",
+          "is_archived": "True"
+        }
+      },
+      {
+        "pk": 1,
+        "model": "contests.round",
+        "fields": {
+          "name": "Round 1",
+          "contest": "cs10",
+          "start_date": "2011-07-31T20:27:58.768Z",
+          "results_date": "2012-07-31T20:27:58.768Z"
+        }
+      }
+  ]
+  
diff --git a/oioioi/contests/static/common/contest_hints.js b/oioioi/contests/static/common/contest_hints.js
@@ -0,0 +1,32 @@
+function init_search_selection(id) {
+    $(function(){
+        const input = $('#' + id);
+
+        const source_default = function(query, process) {
+            $.getJSON(input.data("hintsUrl"), {q: query}, process);
+        };
+
+        input.typeahead({
+            source: source_default,
+            minLength: 2,
+            fitToElement: true,
+            autoSelect: false,
+            followLinkOnSelect: true,
+            itemLink: function(item) {
+                return item.url;
+            },
+            matcher: function(item) {
+                if(!input.val()) {
+                    return false;
+                }
+                return true;
+            },
+            updater: function(item) {
+                const typeahead = input.data('typeahead');
+                let result = item.search_name || item.name;
+
+                return result;
+            },
+        });
+    });
+}
diff --git a/oioioi/contests/templates/contests/select_contest.html b/oioioi/contests/templates/contests/select_contest.html
@@ -11,7 +11,14 @@ <h1>{% trans "Select contest" %}</h1>
     <div style="width: 20%; margin-bottom: 1rem;">
             <form method="GET" action="{% url 'filter_contests' filter_value='PLACEHOLDER' %}" id="filter_form">
                 <div class="input-group">
-                <input type="text" id="filter_input" class="form-control search-query" style="width: 20%;" placeholder="Search" name="filter_field" value="{{ filter }}">
+                <input type="text" 
+                        id="filter_input" 
+                        class="form-control search-query"
+                        autocomplete="off"
+                        data-hints-url="{% url 'get_contest_hints' %}" 
+                        style="width: 20%;" placeholder="Search" name="q" value="{{ filter }}">
+                
+                <script>init_search_selection('filter_input');</script>
                 <span class="input-group-btn">
                     <button type="submit" class="btn btn-outline-secondary "  name="submit_button"> <i class="fa-solid fa-magnifying-glass"> </i> </button>
                 </span>
diff --git a/oioioi/contests/tests/tests.py b/oioioi/contests/tests/tests.py
@@ -9,6 +9,8 @@
 import pytest
 import pytz
 
+import urllib.parse
+
 from django.conf import settings
 from django.contrib.admin.utils import quote
 from django.contrib.auth.models import AnonymousUser, User
@@ -4960,6 +4962,62 @@ def extra_filter(self):
         self.assertContains(response, self.c1.name)
         self.assertContains(response, self.c2.name)
 
+class TestContestSearchHints(TestCase):
+    fixtures = [
+        'test_contest_search',
+        'test_contest',
+        'test_extra_contests',
+    ]
+    url = reverse('get_contest_hints')
+
+    allowed_values = [
+        'AAAcontest',
+        'ABAcontest',
+        'ACAcontest',
+        'AA contest',
+        'BA contest',
+        'CA contest',
+        'DA contest',
+        'EA contest',
+        'Extra test contest 1',
+        'Extra test contest 2',
+        'FA contest',
+        'Test contest',
+        'Archived contest',
+    ]
+
+    def get_query_url(self, parameter):
+        return self.url + '?' + urllib.parse.urlencode(parameter)
+
+    def assert_contains_only(self, response, allowed_values):
+        for contest in self.allowed_values:
+            if contest in allowed_values:
+                self.assertContains(response, contest)
+            else:
+                self.assertNotContains(response, contest)
+
+    def test_contest_search_basic(self):
+        self.client.get('/c/c1/')
+
+        response = self.client.get(self.get_query_url({'q' : 'XX'}), follow=True)
+        self.assertEqual(response.status_code, 200)
+        self.assert_contains_only(response, [])
+
+        response = self.client.get(self.get_query_url({'q' : 'AA'}), follow=True)
+        self.assertEqual(response.status_code, 200)
+        self.assert_contains_only(response, ['AAAcontest', 'AA contest'])
+
+        response = self.client.get(self.get_query_url({'q' : 'Archived'}), follow=True)
+        self.assertEqual(response.status_code, 200)
+        self.assert_contains_only(response, [])
+
+        response = self.client.get(self.get_query_url({'q' : 'DA'}), follow=True)
+        self.assertEqual(response.status_code, 200)
+        self.assert_contains_only(response, ['DA contest'])
+
+        response = self.client.get(self.get_query_url({'q' : 'Extra test'}), follow=True)
+        self.assertEqual(response.status_code, 200)
+        self.assert_contains_only(response, ['Extra test contest 1', 'Extra test contest 2',])
 
 class TestProblemsLimits(TestCase):
     fixtures = [
diff --git a/oioioi/contests/urls.py b/oioioi/contests/urls.py
@@ -207,6 +207,11 @@ def glob_namespaced_patterns(namespace):
         views.filter_contests_view, 
         name='filter_contests',
     ),
+    re_path(
+        r'^get_contest_hints/$',
+        views.get_contest_hints_view,
+        name='get_contest_hints',
+    ),
 ]
 
 if settings.USE_API:
diff --git a/oioioi/contests/utils.py b/oioioi/contests/utils.py
@@ -451,18 +451,56 @@ def visible_contests_query(request):
         ) & controller.registration_controller().visible_contests_query(request)
     return Contest.objects.filter(visible_query).distinct()
 
+
+def visible_contests_as_django_queryset(request):
+    """Returns query set of contests visible to the logged in user."""
+    if request.GET.get('living', 'safely') == 'dangerously':
+        visible_query = Contest.objects.none()
+        for controller_name in used_controllers():
+            controller_class = import_string(controller_name)
+            # HACK: we pass None contest just to call visible_contests_query.
+            # This is a workaround for mixins not taking classmethods very well.
+            controller = controller_class(None)
+            subquery = Contest.objects.filter(controller_name=controller_name).filter(
+                controller.registration_controller().visible_contests_query(request)
+            )
+            visible_query = visible_query.union(subquery, all=False)
+        return visible_query
+    visible_query = Q_always_false()
+    for controller_name in used_controllers():
+        controller_class = import_string(controller_name)
+        # HACK: we pass None contest just to call visible_contests_query.
+        # This is a workaround for mixins not taking classmethods very well.
+        controller = controller_class(None)
+        visible_query |= Q(
+            controller_name=controller_name
+        ) & controller.registration_controller().visible_contests_query(request)
+    return Contest.objects.filter(visible_query).distinct()
+
+
 @request_cached
 def visible_contests(request):
-    contests = visible_contests_query(request)
+    contests = visible_contests_as_django_queryset(request)
     return set(contests)
 
+
 @request_cached_complex
 def visible_contests_queryset(request, filter_value=None):
-    contests = visible_contests_query(request)
+    contests = visible_contests_as_django_queryset(request)
     if filter_value is not None:
-        contests = contests.filter(Q(name__icontains=filter_value) | Q(id__icontains=filter_value) | Q(school_year=filter_value))    
+        contests = contests.filter(Q(name__icontains=filter_value) | Q(id__icontains=filter_value) | Q(school_year=filter_value))
     return set(contests)
 
+
+@request_cached_complex
+def visible_filtered_contests_as_django_queryset(request, filter_value=None):
+    """TODO: remove code duplication visible_contests_queryset/visible_contests_query"""
+    contests = visible_contests_as_django_queryset(request)
+    if filter_value is not None:
+        contests = contests.filter(Q(name__icontains=filter_value) | Q(id__icontains=filter_value) | Q(school_year=filter_value))
+    return contests
+
+
 # why is there no `can_admin_contest_query`?
 @request_cached
 def administered_contests(request):
diff --git a/oioioi/contests/views.py b/oioioi/contests/views.py
