Superevents

Adding superevents to GraceDB, including the necessary models, utility functions, and API resources. This has also resulted in changes to the overall configuration and some parts of the events model.

Many models in the events app, like Labels, Tags, EventLogs, etc. were needed in a similar form for superevents. We were able to completely reuse the existing Label and Tag models for superevents. In other cases, we had to abstract the main functionality of the class into an abstract base class and then implement separate models for events and superevents, due to foreign key requirements. This should leave the current functionality of the events models unchanged.

Some portions of the events API have been modified because of one of the following reasons:

• It didn't make sense and was unnecessarily difficult to duplicate for superevents
• It was inefficient or bad

These changes are documented here: https://bugs.ligo.org/redmine/issues/6133

gracedb/superevents/api/filters.py

+from rest_framework import filters, exceptions
+
+from django.http import HttpResponseBadRequest
+
+from ..query import parseSupereventQuery
+
+from pyparsing import ParseException
+import logging
+logger = logging.getLogger(__name__)
+
+class SupereventSearchFilter(filters.SearchFilter):
+    search_param = 'query'
+
+    def get_search_terms(self, request):
+        # Custom because we don't want default behavior of splitting on spaces
+        return request.query_params.get(self.search_param, '')
+
+    def filter_queryset(self, request, queryset, view):
+        query = self.get_search_terms(request)
+        
+        if not query:
+            return queryset
+
+        # Do filtering
+        try:
+            filter_params = parseSupereventQuery(query)
+        except ParseException as e:
+            raise exceptions.ParseError('Invalid query')
+
+        return queryset.filter(filter_params)
+
+
+class SupereventOrderingFilter(filters.OrderingFilter):
+    ordering_param = 'sort'
+    field_map = {
+        'created': u'date_created',
+        'preferred_event': u'preferred_event__id',
+        'id': [u't_0_date', u'is_gw', u'gw_date_number', 'base_date_number'],
+        'superevent_id': [u't_0_date', u'is_gw', u'gw_date_number',
+            'base_date_number'],
+    }
+
+    def custom_field_mapping(self, fields):
+        out_fields = []
+        for f in fields:
+            prefix = '-' if f.startswith('-') else ''
+            f_s = f.lstrip('-')
+            if f_s in self.field_map.keys():
+                mapped_fields = self.field_map[f_s]
+                if not isinstance(mapped_fields, list):
+                    mapped_fields = [mapped_fields]
+                if prefix:
+                    mapped_fields = [prefix + f for f in mapped_fields]
+                out_fields.extend(mapped_fields)
+            else:
+                out_fields.append(f)
+        return out_fields
+
+    def get_ordering(self, request, queryset, view):
+        """
+        Same as base class get_ordering method except we add in custom
+        mappings between ordering keywords and fields.
+        """
+        # Get ordering fields from request query params
+        params = request.query_params.get(self.ordering_param)
+        if params:
+            fields = [param.strip() for param in params.split(',')]
+
+            # Get custom field mappings
+            fields = self.custom_field_mapping(fields)
+
+            # Remove invalid fields
+            ordering = self.remove_invalid_fields(queryset, fields, view,
+                request)
+            if ordering:
+                return ordering
+
+        # No ordering was included, or all the ordering fields were invalid
+        return self.get_default_ordering(view)