code quality

backend/api/save_query.py

@@ -1,8 +1,11 @@
 from datetime import datetime, timedelta
 
-def save_query(user, es_query):
+IGNORE_KEYS = ['size', 'scroll', 'from', 'aggs']
+'Keys that should be ignored when comparing if two queries are identical'
+
+def should_save_query(user, es_query):
     '''
-    Whether to save a query in the search history for a user
+    Whether a query should be saved in the search history for a user
     '''
 
     if not user.profile.enable_search_history:
@@ -25,12 +28,6 @@ def recent_queries(user):
 def has_aggregations(es_query):
     return 'aggs' in es_query
 
-IGNORE_KEYS = [
-    'size',
-    'scroll',
-    'from',
-    'aggs',
-]
 
 def _filter_relevant_keys(es_query):
     return {

backend/es/views.py

@@ -9,7 +9,7 @@
 from addcorpus.permissions import CorpusAccessPermission
 from tag.filter import handle_tags_in_request
 from tag.permissions import CanSearchTags
-from api.save_query import save_query
+from api.save_query import should_save_query
 from addcorpus.models import Corpus
 from api.models import Query
 
@@ -56,7 +56,7 @@ def post(self, request, *args, **kwargs):
             **get_query_parameters(request)
         }
 
-        history_obj = self._log_query_started(request, corpus_name, query)
+        history_obj = self._save_query_started(request, corpus_name, query)
 
         try:
             results = client.search(
@@ -69,20 +69,20 @@ def post(self, request, *args, **kwargs):
             raise APIException('Search failed')
 
         if history_obj and results:
-            self._log_query_done(history_obj, results)
+            self._save_query_done(history_obj, results)
 
         return Response(results)
 
-    def _log_query_started(self, request, corpus_name, es_query):
-        if save_query(request.user, es_query):
+    def _save_query_started(self, request, corpus_name, es_query):
+        if should_save_query(request.user, es_query):
             corpus = Corpus.objects.get(name=corpus_name)
             return Query.objects.create(
                 user=request.user,
                 corpus=corpus,
                 query_json=es_query,
             )
 
-    def _log_query_done(self, query, results):
+    def _save_query_done(self, query, results):
         query.completed = timezone.now()
         query.total_results = total_hits(results)
         query.transferred = len(hits(results))