Fix #3 support elasticsearch-dsl-py v6.4 and fix bug in es-list - PD-25495

.github/workflows/ci.yml

@@ -66,7 +66,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Cache Pip Dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('requirements/test.txt') }}

CHANGELOG.rst

@@ -1,6 +1,15 @@
 Changelog
 ---------
 
+0.10.0 (2023-07-12)
+^^^^^^^^^^^^^^^^^^
+* support elasticsearch-dsl 6.4 - closes `#3 support elasticsearch-dsl-py v6.4`
+* fix `#90 Convert to GitHub Actions`
+* fix `#96 es_list doesn't list all indexes`
+* open up django to anything > 1.10
+* rename DEMDocType to DEMDocument, following elasticsearch-dsl-py
+  * DEMDocType will be removed in 1.X
+
 0.9.0 (2018-11-27)
 ^^^^^^^^^^^^^^^^^^
 * added postgres to docker-compose and travis, and started using postgres for all tests instead of sqlite

Makefile

@@ -74,3 +74,31 @@ selfcheck: ## check that the Makefile is well-formed
 
 pylintrc: ## check that the Makefile is well-formed
 	edx_lint write pylintrc
+
+nuke:
+	@echo "Removing containers, networks, and data... 🧨"
+	@echo
+	docker compose down -v
+
+es-health-local-api:
+	@echo "Assuming you've got docker up, getting health of elasticsearch... 📄"
+	@echo
+	curl 'localhost:9200/_cat/health?format=json&pretty=true'
+
+es-list-indexes-local-api:
+	@echo "Assuming you've got docker up, getting elasticsearch indexes via API call... 📄"
+	curl 'localhost:9200/_cat/indices?format=json&pretty=true'
+
+es-print-java-env:
+	@echo "printing runtime value of ES_JAVA_OPTS"
+	docker-compose run --rm elastic printenv ES_JAVA_OPTS
+
+up:
+	@echo "Bringing up elastic 6 in docker 🚀"
+	docker compose up -d --remove-orphans
+
+down:
+	@echo "Destroying local containers, but keeping data volumes intact... 😴"
+	docker compose down
+
+

README.rst

@@ -32,12 +32,11 @@ Django Elastic Migrations adapts these tools into a Django app which also:
 * Implements concurrent bulk indexing powered by python ``multiprocessing``
 * Gives Django test hooks for Elasticsearch
 * Records a history of all actions that change Elasticsearch indexes
-* Supports AWS Elasticsearch 6.0, 6.1 (6.2 TBD; see `#3 support elasticsearch-dsl 6.2`_)
+* Supports elasticsearch-dsl-py>=6.4 (support for 7.10.2 is in progress)
 * Enables having two or more servers share the same Elasticsearch cluster
 
 .. _elasticsearch-py: https://github.com/elastic/elasticsearch-py
 .. _elasticsearch-dsl-py: https://github.com/elastic/elasticsearch-dsl-py
-.. _#3 support elasticsearch-dsl 6.2: https://github.com/HBS-HBX/django-elastic-migrations/issues/3
 
 
 Models
@@ -123,15 +122,15 @@ Installation
 #. Create an ``DEMIndex``:
    ::
 
-       from django_elastic_migrations.indexes import DEMIndex, DEMDocType
+       from django_elastic_migrations.indexes import DEMIndex, DEMDocument
        from .models import Movie
        from elasticsearch_dsl import Text
 
        MoviesIndex = DEMIndex('movies')
 
 
        @MoviesIndex.doc_type
-       class MovieSearchDoc(DEMDocType):
+       class MovieSearchDoc(DEMDocument):
            text = TEXT_COMPLEX_ENGLISH_NGRAM_METAPHONE
 
            @classmethod
@@ -292,11 +291,11 @@ Tuning Bulk Indexing Parameters
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 By default, ``/.manage.py es_update`` will divide the result of 
-``DEMDocType.get_queryset()`` into batches of size ``DocType.BATCH_SIZE``. 
+``DEMDocument.get_queryset()`` into batches of size ``DocType.BATCH_SIZE``.
 Override this number to change the batch size. 
 
 There are many configurable paramters to Elasticsearch's `bulk updater <https://elasticsearch-py.readthedocs.io/en/master/helpers.html?highlight=bulk#elasticsearch.helpers.streaming_bulk>`_.
-To provide a custom value, override ``DEMDocType.get_bulk_indexing_kwargs()``
+To provide a custom value, override ``DEMDocument.get_bulk_indexing_kwargs()``
 and return the kwargs you would like to customize.
 
 Development

django_elastic_migrations/exceptions.py

@@ -63,22 +63,22 @@ class IndexNamePropertyCannotBeSet(DjangoElasticMigrationsException):
     """
 
 
-class DEMDocTypeRequiresGetReindexIterator(DjangoElasticMigrationsException):
+class DEMDocumentRequiresGetReindexIterator(DjangoElasticMigrationsException):
     """
-    Raised when ./manage.py es_update tries to call DEMDocType.get_reindex_iterator()
+    Raised when ./manage.py es_update tries to call DEMDocument.get_reindex_iterator()
     on a subclass, but the subclass has not implemented this.
     """
     message = ("To run ./manage.py es_update my_index, my_index needs to "
-               "implement DEMDocType.get_reindex_iterator(self, last_updated_datetime=None)")
+               "implement DEMDocument.get_reindex_iterator(self, last_updated_datetime=None)")
 
 
-class DEMDocTypeRequiresGetQueryset(DjangoElasticMigrationsException):
+class DEMDocumentRequiresGetQueryset(DjangoElasticMigrationsException):
     """
-    Raised when ./manage.py es_update tries to call DEMDocType.get_queryset()
+    Raised when ./manage.py es_update tries to call DEMDocument.get_queryset()
     on a subclass, but the subclass has not implemented this.
     """
     message = ("To run ./manage.py es_update my_index, my_index needs to "
-               "implement DEMDocType.get_queryset()")
+               "implement DEMDocument.get_queryset()")
 
 
 class DEMIndexVersionCodebaseMismatchError(DjangoElasticMigrationsException):

django_elastic_migrations/indexes.py

@@ -7,11 +7,11 @@
 from django.db import ProgrammingError
 from elasticsearch import TransportError
 from elasticsearch.helpers import expand_action, bulk
-from elasticsearch_dsl import Index as ESIndex, DocType as ESDocType, Q as ESQ, Search
+from elasticsearch_dsl import Index as ESIndex, Document as ESDocument, Q as ESQ, Search
 
 from django_elastic_migrations import es_client, environment_prefix, es_test_prefix, dem_index_paths, get_logger, codebase_id
-from django_elastic_migrations.exceptions import DEMIndexNotFound, DEMDocTypeRequiresGetReindexIterator, \
-    IllegalDEMIndexState, NoActiveIndexVersion, DEMDocTypeRequiresGetQueryset
+from django_elastic_migrations.exceptions import DEMIndexNotFound, DEMDocumentRequiresGetReindexIterator, \
+    IllegalDEMIndexState, NoActiveIndexVersion, DEMDocumentRequiresGetQueryset
 from django_elastic_migrations.utils.es_utils import get_index_hash_and_json
 from django_elastic_migrations.utils.loading import import_module_element
 from django_elastic_migrations.utils.multiprocessing_utils import DjangoMultiProcess, USE_ALL_WORKERS
@@ -273,7 +273,7 @@ def reinitialize_esindex_instances(cls):
         After our django-elastic-migrations app is ready
         to talk to the DB and find out the names of the indexes,
         go through and reinitialize each ES Index subclass instance
-        as well as their associated ES DocType subclasses
+        as well as their associated ES Document subclasses
         with the appropriate index names
         """
         for index_base_name, instance in cls.instances.items():
@@ -442,7 +442,7 @@ def _start_action_for_indexes(cls, action, index_name, exact_mode=False):
         raise DEMIndexNotFound()
 
 
-class _DEMDocTypeIndexHandler(object):
+class _DEMDocumentIndexHandler(object):
     """
     Internally, Elasticsearch-dsl-py uses a string stored in the
     DocType to determine which index to write to. This class is
@@ -478,12 +478,12 @@ def __getattribute__(self, item):
         return None
 
 
-class DEMDocType(ESDocType):
+class DEMDocument(ESDocument):
     """
-    Django users subclass DEMDocType instead of Elasticsearch's DocType
+    Django users should subclass DEMDocument instead of elasticsearch-dsl-py's Document
     to use Django Elastic Migrations. All documentation from their class
     applies here.
-    https://elasticsearch-dsl.readthedocs.io/en/latest/api.html#elasticsearch_dsl.DocType
+    https://elasticsearch-dsl.readthedocs.io/en/latest/api.html#elasticsearch_dsl.Document
 
     Change from Elasticsearch: we manage the doc type's index name to
     make it the activated version of the index by default.
@@ -507,29 +507,29 @@ class DEMDocType(ESDocType):
     MAX_RETRIES = 5
 
     def __init__(self, *args, **kwargs):
-        super(DEMDocType, self).__init__(*args, **kwargs)
+        super(DEMDocument, self).__init__(*args, **kwargs)
         # super.__init__ creates the self._doc_type property that we
         # modify here
-        self._doc_type = _DEMDocTypeIndexHandler(
+        self._doc_type = _DEMDocumentIndexHandler(
             getattr(self, '_doc_type', None))
 
     @classmethod
     def get_reindex_iterator(cls, queryset):
         """
         Django users override this method. It must return an iterator
-        or generator of instantiated DEMDocType subclasses, ready
+        or generator of instantiated DEMDocument subclasses, ready
         for inserting into Elasticsearch. For example:
 
-        class UsersDocType(DEMDocType)
+        class UsersDocument(DEMDocument)
 
             @classmethod
             def get_reindex_iterator(cls, queryset):
                 return [cls.getDocForUser(u) for user in queryset]
 
         :param queryset: queryset of objects to index; result of get_queryset()
-        :return: iterator / generator of *DEMDocType instances*
+        :return: iterator / generator of *DEMDocument instances*
         """
-        raise DEMDocTypeRequiresGetReindexIterator()
+        raise DEMDocumentRequiresGetReindexIterator()
 
     @classmethod
     def get_queryset(cls, last_updated_datetime=None):
@@ -539,15 +539,15 @@ def get_queryset(cls, last_updated_datetime=None):
         :param last_updated_datetime:
         :return:
         """
-        raise DEMDocTypeRequiresGetQueryset()
+        raise DEMDocumentRequiresGetQueryset()
 
     @classmethod
     def get_db_objects_by_id(cls, ids):
         return cls.get_queryset().filter(**{"{}__in".format(cls.PK_ATTRIBUTE): ids})
 
     @classmethod
     def get_dem_index(cls):
-        # TODO: what should happen if DEMDocType instance has no active version?
+        # TODO: what should happen if DEMDocument instance has no active version?
         # currently, if this exact version is not found, it will return None
         return DEMIndexManager.get_dem_index(cls._doc_type.index, exact_mode=True)
 
@@ -686,7 +686,7 @@ def bulk_index(cls, reindex_iterator):
         """
         Execute Elasticsearch's bulk indexing helper, passing in the result of
         cls.get_bulk_indexing_kwargs()
-        :param reindex_iterator: an iterator of DocType instances from cls.get_reindex_iterator()
+        :param reindex_iterator: an iterator of Document instances from cls.get_reindex_iterator()
         :return: (num_success, num_failed)
         """
         kwargs = cls.get_bulk_indexing_kwargs()
@@ -771,6 +771,28 @@ def batched_bulk_index(cls, queryset=None, workers=0, last_updated_datetime=None
                     num_failures += result_failures
         return num_successes, num_failures
 
+    def _get_index(self, index=None, required=True):
+        """
+        We have chosen to override this method to allow for the use of
+        a dynamic index at runtime. This is necessary to support the
+        key use case of Django Elastic Migrations: being able to index
+        into a new index version while the old index version is still
+        being used by the application.
+
+        A future version of DEM may instead elect to use a different
+        technique to supply this information. The inheritance hierarchy
+        for elasticsearch-dsl-py is not very friendly to overriding.
+        """
+        if index is None:
+            index = self.get_dem_index().get_es_index_name()
+        if index is None:
+            index = super(DEMDocument, self)._get_index(index, required)
+        return index
+
+
+# until we can support only elasticsearch 7.x, we need to support both DocType and Document
+DEMDocType = DEMDocument
+
 
 class DEMIndex(ESIndex):
     """
@@ -863,25 +885,25 @@ def delete(self, **kwargs):
         if index_version:
             index_version.delete()
 
-    def doc_type(self, doc_type=None) -> DEMDocType:
+    def doc_type(self, doc_type=None) -> DEMDocument:
         """
         Overrides elasticsearch_dsl.Index.doc_type() and called during DEMIndexManager.initialize().
 
-        Associates a DEMDocType with this DEMIndex, so that commands
+        Associates a DEMDocument with this DEMIndex, so that commands
         directed to this DEMIndex always go to the active index version by
         querying the DEMIndexManager.
 
-        Sets the active index version name into the DEMDocType, so that
-        DEMDocType.search() queries the active index version.
+        Sets the active index version name into the DEMDocument, so that
+        DEMDocument.search() queries the active index version.
 
-        :returns DEMDocType associated with this DEMIndex (if any)
+        :returns DEMDocument associated with this DEMIndex (if any)
         """
         if doc_type:
             self.__doc_type = doc_type
             active_version_name = self.get_active_version_index_name()
 
-            # set the active index version name into the DEMDocType,
-            # so DEMDocType.search() is directed to the active index in elasticsearch
+            # set the active index version name into the DEMDocument,
+            # so DEMDocument.search() is directed to the active index in elasticsearch
             if active_version_name and self.__doc_type._doc_type:
                 self.__doc_type._doc_type.index = active_version_name
 
@@ -900,7 +922,7 @@ def doc_type(self, doc_type=None) -> DEMDocType:
                     our_tag = codebase_id
                     msg = (
                         "DEMIndex.doc_type received a request to use an elasticsearch index whose exact "
-                        "schema / DEMDocType was not accessible in this codebase. "
+                        "schema / DEMDocument was not accessible in this codebase. "
                         "This may lead to undefined behavior (for example if this codebase searches or indexes "
                         "a field that has changed in the requested index, it may not return correctly). "
                         "\n - requested index: {version_name} "

django_elastic_migrations/management/commands/es.py

@@ -122,7 +122,7 @@ def get_index_specifying_options(cls, options, require_one_include_list=None):
         if apply_all and indexes:
             logger.warning(
                 "Received --all along with index names: '{indexes}'."
-                "Noramlly you would not specify names of indexes "
+                "Normally you would not specify names of indexes "
                 "with --all, since --all covers all the indexes. "
                 "The --all has been canceled; operating on just '{indexes}'."
                 "To clear *all* the indexes, just use --all.".format(

django_elastic_migrations/management/commands/es_list.py

@@ -64,7 +64,6 @@ def handle(self, *args, **options):
                 for dem_index in indexes:
                     dem_index_model = dem_index.get_index_model()
                     index_versions = dem_index_model.get_available_versions_with_prefix()
-                    row = None
                     if index_versions:
                         for index_version in index_versions:
                             num_docs = DEMIndexManager.get_es_index_doc_count(index_version.name)
@@ -74,9 +73,9 @@ def handle(self, *args, **options):
                                             index_version.is_active or 0,
                                             num_docs,
                                             index_version.tag)
+                            rows.append(row)
                     else:
                         row = EsListRow(dem_index.get_base_name(), "", False, False, 0, "Current (not created)")
-                    if row:
                         rows.append(row)
             except AttributeError:
                 raise FirstMigrationNotRunError()

django_elastic_migrations/management/commands/es_update.py

@@ -15,7 +15,7 @@ def add_arguments(self, parser):
         parser.add_argument(
             '--resume', action='store_true',
             help=("Only update documents that have changed since "
-                  "the last ./manage.py es_update. NOTE: DEMDocType subclass "
+                  "the last ./manage.py es_update. NOTE: DEMDocument subclass "
                   "needs to implement this.")
         )
         parser.add_argument(

django_elastic_migrations/models.py

@@ -30,7 +30,7 @@ class Index(models.Model):
     """
     name = models.CharField(verbose_name="Index Name", max_length=32, unique=True)
 
-    # Django convention is to use '+' for related name when you don't need the
+    # Django's convention is to use '+' for related name when you don't need the
     # reverse relation. in this case, we already have IndexVersion pointing
     # back to Index, so we don't need that reverse name.
     # See https://docs.djangoproject.com/en/2.0/ref/models/fields/#django.db.models.ForeignKey.related_name