Skip to content

Autocomplete for the contest search bar #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 203 additions & 0 deletions oioioi/contests/fixtures/test_contest_search.json
Original file line number Diff line number Diff line change
@@ -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"
}
}
]

32 changes: 32 additions & 0 deletions oioioi/contests/static/common/contest_hints.js
Original file line number Diff line number Diff line change
@@ -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;
},
});
});
}
9 changes: 8 additions & 1 deletion oioioi/contests/templates/contests/select_contest.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
59 changes: 59 additions & 0 deletions oioioi/contests/tests/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -4526,3 +4528,60 @@ def extra_filter(self):
self.assertNotContains(response, self.c.name)
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',])
5 changes: 5 additions & 0 deletions oioioi/contests/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,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:
Expand Down
2 changes: 1 addition & 1 deletion oioioi/contests/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ def visible_contests(request):
def visible_contests_queryset(request, filter_value):
contests = visible_contests_query(request)
contests = contests.filter(Q(name__icontains=filter_value) | Q(id__icontains=filter_value) | Q(school_year=filter_value))
return set(contests)
return contests

@request_cached
def administered_contests(request):
Expand Down
28 changes: 26 additions & 2 deletions oioioi/contests/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from oioioi.base.main_page import register_main_page_view
from oioioi.base.menu import menu_registry
from oioioi.base.permissions import enforce_condition, not_anonymous
from oioioi.base.utils import jsonify
from oioioi.base.utils.redirect import safe_redirect
from oioioi.base.utils.user_selection import get_user_hints_view
from oioioi.contests.attachment_registration import attachment_registry
Expand Down Expand Up @@ -842,7 +843,7 @@ def unarchive_contest(request):
return redirect('default_contest_view', contest_id=contest.id)

def filter_contests_view(request, filter_value=""):
contests = visible_contests_queryset(request, filter_value)
contests = set(visible_contests_queryset(request, filter_value))
contests = sorted(contests, key=lambda x: x.creation_date, reverse=True)

context = {
Expand All @@ -851,4 +852,27 @@ def filter_contests_view(request, filter_value=""):
}
return TemplateResponse(
request, 'contests/select_contest.html', context
)
)

def get_contest_hints(request, query):
contests = visible_contests_queryset(request, query)
contests = contests.filter(Q(is_archived=False)).distinct()
return [
{
'trigger': 'problem',
'name': contest.name,
'url': reverse('filter_contests', kwargs={'filter_value': contest.name})
}
for contest in contests[: getattr(settings, 'NUM_HINTS', 10)]
]

@jsonify
def get_contest_hints_view(request):
# Function works analogously to the auto-completion function implemented in the problemset

query = request.GET.get('q', '')

result = []
result.extend(list(get_contest_hints(request, query)))

return result