fix: Use Payload in AutoCompleter (categories in search) and misc
- Separate Item group and Item autocomplete dict definition
- Add payload along with Item group, containing namke and route
- Pass weightage while defining item group autocomplete dict (auto sort)
- Use payload while getting results for categories in search
- Remove check to show categories, always show
- Search fields mandatory if reidsearch enabled
- Code separation (rough)
diff --git a/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.json b/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.json
index 62505e6..e6f08f7 100644
--- a/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.json
+++ b/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.json
@@ -48,7 +48,6 @@
"redisearch_warning",
"search_index_fields",
"is_redisearch_enabled",
- "show_categories_in_search_autocomplete",
"is_redisearch_loaded",
"shop_by_category_section",
"slideshow",
@@ -294,6 +293,7 @@
"fieldname": "search_index_fields",
"fieldtype": "Small Text",
"label": "Search Index Fields",
+ "mandatory_depends_on": "is_redisearch_enabled",
"read_only_depends_on": "eval:!doc.is_redisearch_loaded"
},
{
@@ -303,14 +303,6 @@
"label": "Item Search Settings"
},
{
- "default": "1",
- "depends_on": "is_redisearch_enabled",
- "fieldname": "show_categories_in_search_autocomplete",
- "fieldtype": "Check",
- "label": "Show Categories in Search Autocomplete",
- "read_only_depends_on": "eval:!doc.is_redisearch_loaded"
- },
- {
"default": "0",
"fieldname": "is_redisearch_loaded",
"fieldtype": "Check",
@@ -379,7 +371,7 @@
"index_web_pages_for_search": 1,
"issingle": 1,
"links": [],
- "modified": "2022-03-31 16:01:46.308663",
+ "modified": "2022-04-01 18:35:56.106756",
"modified_by": "Administrator",
"module": "E-commerce",
"name": "E Commerce Settings",
diff --git a/erpnext/e_commerce/redisearch_utils.py b/erpnext/e_commerce/redisearch_utils.py
index 78cc05a..32b35db 100644
--- a/erpnext/e_commerce/redisearch_utils.py
+++ b/erpnext/e_commerce/redisearch_utils.py
@@ -157,17 +157,14 @@
@if_redisearch_enabled
def define_autocomplete_dictionary():
- """Creates an autocomplete search dictionary for `name`.
- Also creats autocomplete dictionary for `categories` if
- checked in E Commerce Settings"""
+ """
+ Defines/Redefines an autocomplete search dictionary for Website Item Name.
+ Also creats autocomplete dictionary for Published Item Groups.
+ """
cache = frappe.cache()
- name_ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=cache)
- cat_ac = AutoCompleter(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE), conn=cache)
-
- ac_categories = frappe.db.get_single_value(
- "E Commerce Settings", "show_categories_in_search_autocomplete"
- )
+ item_ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=cache)
+ item_group_ac = AutoCompleter(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE), conn=cache)
# Delete both autocomplete dicts
try:
@@ -176,16 +173,39 @@
except Exception:
return False
+ create_items_autocomplete_dict(autocompleter=item_ac)
+ create_item_groups_autocomplete_dict(autocompleter=item_group_ac)
+
+
+@if_redisearch_enabled
+def create_items_autocomplete_dict(autocompleter):
+ "Add items as suggestions in Autocompleter."
items = frappe.get_all(
"Website Item", fields=["web_item_name", "item_group"], filters={"published": 1}
)
for item in items:
- name_ac.add_suggestions(Suggestion(item.web_item_name))
- if ac_categories and item.item_group:
- cat_ac.add_suggestions(Suggestion(item.item_group))
+ autocompleter.add_suggestions(Suggestion(item.web_item_name))
- return True
+
+@if_redisearch_enabled
+def create_item_groups_autocomplete_dict(autocompleter):
+ "Add item groups with weightage as suggestions in Autocompleter."
+ published_item_groups = frappe.get_all(
+ "Item Group", fields=["name", "route", "weightage"], filters={"show_in_website": 1}
+ )
+ if not published_item_groups:
+ return
+
+ for item_group in published_item_groups:
+ payload = {"name": item_group, "route": item_group.route}
+ autocompleter.add_suggestions(
+ Suggestion(
+ string=item_group.name,
+ score=item_group.weightage,
+ payload=payload, # additional info that can be retrieved later
+ )
+ )
@if_redisearch_enabled
diff --git a/erpnext/templates/pages/product_search.py b/erpnext/templates/pages/product_search.py
index ce04068..94e893e 100644
--- a/erpnext/templates/pages/product_search.py
+++ b/erpnext/templates/pages/product_search.py
@@ -1,6 +1,8 @@
# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt
+import json
+
import frappe
from frappe.utils import cint, cstr
from redisearch import AutoCompleter, Client, Query
@@ -135,8 +137,10 @@
return search_results
ac = AutoCompleter(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE), conn=frappe.cache())
- suggestions = ac.get_suggestions(query, num=10)
+ suggestions = ac.get_suggestions(query, num=10, with_payloads=True)
- search_results["results"] = [s.string for s in suggestions]
+ results = [json.loads(s.payload) for s in suggestions]
+
+ search_results["results"] = results
return search_results