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/search/forms.py

@@ -17,6 +17,7 @@ logger = logging.getLogger(__name__)
 htmlEntityStar = "★"
 errorMarker = '<span style="color:red;">'+htmlEntityStar+'</span>'
 
+
 class MainSearchForm(forms.Form):
     QUERY_TYPE_CHOICES = (
         ('E', 'Event'),
@@ -31,7 +32,7 @@ class MainSearchForm(forms.Form):
     query = forms.CharField(required=False, widget=forms.TextInput(
         attrs={'size': 60}))
     query_type = forms.ChoiceField(required=True,
-        choices=QUERY_TYPE_CHOICES, label="Search for", initial='S')
+        choices=QUERY_TYPE_CHOICES, label="Search for", initial='E')
     get_neighbors = forms.BooleanField(required=False,
         help_text="(Events only)")
     results_format = forms.ChoiceField(required=False, initial='S',
@@ -47,19 +48,28 @@ class MainSearchForm(forms.Form):
         query_string = self.cleaned_data.get('query')
         query_type = self.cleaned_data.get('query_type')
 
+        # Set attributes based on object type
+        # Add fields to use with select_related and prefetch_related
+        # for optimization
         if query_type == 'S':
             model = Superevent
             parse_func = parseSupereventQuery
+            s_rel = ['preferred_event__group', 'submitter']
+            p_rel = ['labelling_set__label', 'labelling_set__creator']
         elif query_type == 'E':
             model = Event
             parse_func = parseQuery
+            s_rel = ['group', 'pipeline', 'search', 'submitter']
+            p_rel = ['labelling_set__label', 'labelling_set__creator']
+
         # Don't need to check anything else here, can expect data to be good
         # thanks to base class clean
 
         # Parse query and get resulting objects
         try:
-            qs = model.objects.filter(parse_func(query_string))
-            qs = filter_for_labels(qs,query_string).distinct()
+            qs = model.objects.filter(parse_func(query_string)) \
+                .select_related(*s_rel).prefetch_related(*p_rel)
+            qs = filter_for_labels(qs, query_string).distinct()
             cleaned_data['query'] = qs
             return cleaned_data
         except ParseException as e: