Merge pull request #80 from django-oscar/add_lookup_term_query

Add lookup term query

Author: samar-hassan

oscar_elasticsearch/search/api/base.py

@@ -15,3 +15,6 @@ def get_index_settings(self):
 
     def get_model(self):
         return self.Model
+
+    def get_queryset(self):
+        return self.Model.objects.all()

oscar_elasticsearch/search/api/lookup.py

@@ -0,0 +1,63 @@
+from oscar.core.loading import get_class
+
+BaseElasticSearchApi = get_class("search.api.search", "BaseElasticSearchApi")
+ESModelIndexer = get_class("search.indexing.indexer", "ESModelIndexer")
+
+
+class BaseLookupIndex(BaseElasticSearchApi, ESModelIndexer):
+    """
+    Subclass this class to create a custom lookup for your index.
+    https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html#query-dsl-terms-lookup
+
+    set LOOKUP_PATH as the field you want to save on the lookup index, that you can use to filter stuff on the main index you're using
+
+    Example for make_documents:
+    def make_documents(self, objects):
+        documents = []
+
+        for user in objects:
+            documents.append([
+                    {
+                        "_id": user.id,
+                        self.LOOKUP_PATH: [p.id, for p in user.products]
+                    }
+                ]
+            )
+
+        return documents
+
+    """
+
+    LOOKUP_PATH = None
+    INDEX_SETTINGS = {}
+
+    def get_index_mapping(self):
+        if self.LOOKUP_PATH is None:
+            raise NotImplementedError("Please set LOOKUP_PATH on your lookup index")
+
+        return {"properties": {self.LOOKUP_PATH: {"type": "keyword"}}}
+
+    def get_lookup_id(self, field_to_filter, **kwargs):
+        raise NotImplementedError(
+            """
+            Please implement 'get_lookup_id' on your lookup index. 
+            Return None to not apply this lookup filter, return the actual id to filter on that id, 
+            Id's should always be strings (elasticsearch), never integers
+            """
+        )
+
+    def get_lookup_query(self, field_to_filter, **kwargs):
+        lookup_id = self.get_lookup_id(field_to_filter, **kwargs)
+
+        if lookup_id is not None:
+            return {
+                "terms": {
+                    field_to_filter: {
+                        "index": self.get_index_name(),
+                        "id": lookup_id,
+                        "path": self.LOOKUP_PATH,
+                    }
+                }
+            }
+
+        return None

oscar_elasticsearch/search/management/commands/update_index_registered.py

@@ -0,0 +1,34 @@
+from oscar_elasticsearch.search.registry import elasticsearch_registry
+from django.core.management.base import BaseCommand
+
+from oscar.core.loading import get_class
+
+from oscar_elasticsearch.search import settings
+
+chunked = get_class("search.utils", "chunked")
+
+
+class Command(BaseCommand):
+    def handle(self, *args, **options):
+        for Index in elasticsearch_registry.indexes:
+            index = Index()
+
+            self.stdout.write(
+                self.style.SUCCESS(
+                    "\n Start indexing index: %s" % index.get_index_name()
+                )
+            )
+
+            index_queryset = index.get_queryset()
+            with index.reindex() as index:
+                for chunk in chunked(index_queryset, settings.INDEXING_CHUNK_SIZE):
+                    index.reindex_objects(chunk)
+                    self.stdout.write(".", ending="")
+                    self.stdout.flush()  # Ensure the dots are displayed immediately
+
+            self.stdout.write(
+                self.style.SUCCESS(
+                    "\n%i %s successfully indexed"
+                    % (index_queryset.count(), index.get_index_name())
+                )
+            )

oscar_elasticsearch/search/management/commands/update_oscar_index.py

@@ -6,3 +6,4 @@ class Command(BaseCommand):
     def handle(self, *args, **options):
         call_command("update_index_products")
         call_command("update_index_categories")
+        call_command("update_index_registered")

oscar_elasticsearch/search/registry.py

@@ -0,0 +1,13 @@
+class ElasticsearchRegistry:
+    _indexes = []
+
+    def register(self, cls):
+        self._indexes.append(cls)
+        return cls
+
+    @property
+    def indexes(self):
+        return self._indexes
+
+
+elasticsearch_registry = ElasticsearchRegistry()

pylintrc

@@ -4,6 +4,7 @@ load-plugins=pylint_django
 score=n
 ignore = migrations
 django-settings-module = sandbox.settings
+init-hook='import sys; sys.path.append("./sandbox/")'
 
 [MESSAGES CONTROL]
 disable=R,C

sandbox/__init__.py

@@ -0,0 +1,18 @@
+from django.contrib import admin
+
+from .models import AssortmentProduct, AssortmentUser
+
+
+class AssortmentProductAdmin(admin.TabularInline):
+    model = AssortmentProduct
+    list_display = search_fields = ["product"]
+
+
+class AssortmentUserAdmin(admin.ModelAdmin):
+    list_display = search_fields = ["user"]
+    inlines = [
+        AssortmentProductAdmin
+    ]
+    
+
+admin.site.register(AssortmentUser, AssortmentUserAdmin)

sandbox/assortment/__init__.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+class AssortmentConfig(AppConfig):
+    name = "assortment"
+    verbose_name = "Assortment"
+
+    def ready(self):
+        from . import index