From a06e7eac4da8715203815165da1047bfee1d178d Mon Sep 17 00:00:00 2001
From: Sam <samuel.molina@enreda.coop>
Date: Thu, 18 Feb 2021 13:25:35 +0000
Subject: [PATCH] added comments

---
 products/utils.py | 22 +++++++++++++++++++++-
 products/views.py |  4 ++--
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/products/utils.py b/products/utils.py
index 5bbbe75..22c1a92 100644
--- a/products/utils.py
+++ b/products/utils.py
@@ -58,6 +58,12 @@ def extract_search_filters(result_set):
 
 
 def find_related_products_v1(keyword):
+    """
+    Classical approach to the search
+
+    Using Q objects
+
+    """
     # search in tags
     tags = Product.tags.tag_model.objects.filter(name__icontains=keyword)
     # search in category
@@ -76,6 +82,11 @@ def find_related_products_v1(keyword):
 
 
 def find_related_products_v2(keyword):
+    """
+    More advanced search
+
+    Using search vectors
+    """
     fields=('name', 'description', 'tags__label', 'attributes__label', 'category__name')
     vector = SearchVector(*fields)
     products_qs = Product.objects.annotate(
@@ -84,7 +95,16 @@ def find_related_products_v2(keyword):
     return products_qs
 
 
-def alt_rank_find_related_products(keyword):
+def find_related_products_v3(keyword):
+    """
+    Fully loaded product search
+
+    SearchVectors for the fields
+    SearchQuery for the value
+    SearchRank for relevancy scoring and ranking
+
+    PROBLEM: returns unrelated instances
+    """
     # TODO: figure out why it includes unrelated instances
     fields=('name', 'description', 'tags__label', 'attributes__label', 'category__name')
     vector = SearchVector(*fields)
diff --git a/products/views.py b/products/views.py
index 2e6d44f..2c697d6 100644
--- a/products/views.py
+++ b/products/views.py
@@ -23,7 +23,7 @@ from companies.models import Company
 from history.models import HistorySync
 
 from back_latienda.permissions import IsCreator
-from .utils import extract_search_filters, find_related_products_v1, find_related_products_v2, alt_rank_find_related_products
+from .utils import extract_search_filters, find_related_products_v1, find_related_products_v2, find_related_products_v3
 from utils.tag_serializers import TaggitSerializer
 from utils.tag_filters import ProductTagFilter
 
@@ -157,7 +157,7 @@ def product_search(request):
             for chunk in chunks:
                   products_qs = find_related_products_v1(chunk)
                   # products_qs = find_related_products_v2(chunk)
-                  # products_qs = alt_rank_find_related_products(chunk)
+                  # products_qs = find_related_products_v3(chunk)
                   for instance in products_qs:
                         result_set.add(instance)