feat: support for aliased index (#460)

* fix: support index alias

* chore: remove debug code

Author: zacharis278

analytics_data_api/management/commands/create_elasticsearch_learners_indices.py

@@ -6,6 +6,12 @@
 from analytics_data_api.v0.documents import RosterEntry, RosterUpdate
 
 
+class TestRosterEntry(RosterEntry):
+    class Index:
+        name = settings.ELASTICSEARCH_LEARNERS_INDEX
+        aliases = {settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS: {}}
+
+
 class Command(BaseCommand):
     help = 'Creates Elasticsearch indices used by the Analytics Data API.'
 
@@ -20,7 +26,7 @@ def handle(self, *args, **options):
         if es.indices.exists(settings.ELASTICSEARCH_LEARNERS_INDEX):
             self.stderr.write(f'"{settings.ELASTICSEARCH_LEARNERS_INDEX}" index already exists.')
         else:
-            RosterEntry.init(using=es)
+            TestRosterEntry.init(using=es)
 
         if es.indices.exists(settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX):
             self.stderr.write(f'"{settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX}" index already exists.')

analytics_data_api/management/commands/delete_elasticsearch_learners_indices.py

@@ -9,5 +9,5 @@ class Command(BaseCommand):
     def handle(self, *args, **options):
         es = Elasticsearch([settings.ELASTICSEARCH_LEARNERS_HOST])
         for index in [settings.ELASTICSEARCH_LEARNERS_INDEX, settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX]:
-            if es.indices.exists(settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX):
+            if es.indices.exists(index):
                 es.indices.delete(index=index)

analytics_data_api/management/utils.py

@@ -6,6 +6,7 @@ def elasticsearch_settings_defined():
         setting is not None for setting in (
             settings.ELASTICSEARCH_LEARNERS_HOST,
             settings.ELASTICSEARCH_LEARNERS_INDEX,
+            settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS,
             settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX
         )
     )

analytics_data_api/v0/documents.py

@@ -1,4 +1,5 @@
 import logging
+from fnmatch import fnmatch
 
 from django.conf import settings
 from elasticsearch_dsl import Date, Document, Float, Integer, Keyword, Q
@@ -22,7 +23,7 @@ class Index:
 
     @classmethod
     def get_last_updated(cls):
-        return cls.search().query('term', target_index=settings.ELASTICSEARCH_LEARNERS_INDEX).execute()
+        return cls.search().query('term', target_index=settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS).execute()
 
 
 class RosterEntry(Document):
@@ -61,9 +62,19 @@ class RosterEntry(Document):
     last_updated = Date()
 
     class Index:
-        name = settings.ELASTICSEARCH_LEARNERS_INDEX
+        name = settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS
+        aliases = {settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS: {}}
         settings = settings.ELASTICSEARCH_INDEX_SETTINGS
 
+    @classmethod
+    def _matches(cls, hit):
+        # override _matches to match indices in a pattern instead of just index name.
+        # The search target may be an index or an alias but the default implementation will strictly
+        # match the return on index causing queries to fail to map back to this python type.
+        #
+        # hit is the raw dict as returned by elasticsearch
+        return fnmatch(hit["_index"], settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS + '_*')
+
     @classmethod
     def get_course_user(cls, course_id, username):
         """
@@ -149,14 +160,7 @@ def get_users_in_course(
             }
             for sort_policy in sort_policies
         ])
-        res = search_request.execute()
-        # debugging, to be removed
-        logger.warning(res.__class__.__name__)
-        items = res.hits
-        if items:
-            logger.warning(items[0])
-            logger.warning(dir(items[0]))
-        return items
+        return search_request.execute()
 
     @classmethod
     def get_course_metadata(cls, course_id):

analytics_data_api/v0/tests/views/test_learners.py

@@ -119,7 +119,7 @@ def create_update_index(self, date=None):
             index=settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX,
             body={
                 'date': date,
-                'target_index': settings.ELASTICSEARCH_LEARNERS_INDEX,
+                'target_index': settings.ELASTICSEARCH_LEARNERS_INDEX_ALIAS,
             }
         )
         self._es.indices.refresh(index=settings.ELASTICSEARCH_LEARNERS_UPDATE_INDEX)

analyticsdataserver/settings/base.py

@@ -84,6 +84,7 @@
 ########## ELASTICSEARCH CONFIGURATION
 ELASTICSEARCH_LEARNERS_HOST = environ.get('ELASTICSEARCH_LEARNERS_HOST', None)
 ELASTICSEARCH_LEARNERS_INDEX = environ.get('ELASTICSEARCH_LEARNERS_INDEX', None)
+ELASTICSEARCH_LEARNERS_INDEX_ALIAS = environ.get('ELASTICSEARCH_LEARNERS_INDEX_ALIAS', None)
 ELASTICSEARCH_LEARNERS_UPDATE_INDEX = environ.get('ELASTICSEARCH_LEARNERS_UPDATE_INDEX', None)
 
 # access credentials for signing requests to AWS.

analyticsdataserver/settings/local.py

@@ -106,4 +106,10 @@
 )
 CORS_ALLOW_CREDENTIALS = True
 
+# Default elasticsearch port when running locally
+ELASTICSEARCH_LEARNERS_HOST = environ.get("ELASTICSEARCH_LEARNERS_HOST", 'http://localhost:9223/')
+ELASTICSEARCH_LEARNERS_INDEX = 'roster_entry_001'
+ELASTICSEARCH_LEARNERS_INDEX_ALIAS = 'roster_entry'
+ELASTICSEARCH_LEARNERS_UPDATE_INDEX = 'index_update'
+
 ########## END ANALYTICS DATA API CONFIGURATION

analyticsdataserver/settings/test.py

@@ -25,7 +25,8 @@
 
 # Default elasticsearch port when running locally
 ELASTICSEARCH_LEARNERS_HOST = environ.get("ELASTICSEARCH_LEARNERS_HOST", 'http://localhost:9223/')
-ELASTICSEARCH_LEARNERS_INDEX = 'roster_test'
+ELASTICSEARCH_LEARNERS_INDEX = 'roster_test_001'
+ELASTICSEARCH_LEARNERS_INDEX_ALIAS = 'roster_test'
 ELASTICSEARCH_LEARNERS_UPDATE_INDEX = 'index_update_test'
 
 # Default the django-storage settings so we can test easily