fix: Call Redisearch index creation functions on enabling redisearch in settings
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 d5fb969..62505e6 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
@@ -47,6 +47,7 @@
"item_search_settings_section",
"redisearch_warning",
"search_index_fields",
+ "is_redisearch_enabled",
"show_categories_in_search_autocomplete",
"is_redisearch_loaded",
"shop_by_category_section",
@@ -303,6 +304,7 @@
},
{
"default": "1",
+ "depends_on": "is_redisearch_enabled",
"fieldname": "show_categories_in_search_autocomplete",
"fieldtype": "Check",
"label": "Show Categories in Search Autocomplete",
@@ -365,12 +367,19 @@
"fieldname": "show_price_in_quotation",
"fieldtype": "Check",
"label": "Show Price in Quotation"
+ },
+ {
+ "default": "0",
+ "fieldname": "is_redisearch_enabled",
+ "fieldtype": "Check",
+ "label": "Enable Redisearch",
+ "read_only_depends_on": "eval:!doc.is_redisearch_loaded"
}
],
"index_web_pages_for_search": 1,
"issingle": 1,
"links": [],
- "modified": "2021-09-02 14:02:44.785824",
+ "modified": "2022-03-31 16:01:46.308663",
"modified_by": "Administrator",
"module": "E-commerce",
"name": "E Commerce Settings",
@@ -389,5 +398,6 @@
],
"sort_field": "modified",
"sort_order": "DESC",
+ "states": [],
"track_changes": 1
}
\ No newline at end of file
diff --git a/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.py b/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.py
index b5cd067..2bb4ad6 100644
--- a/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.py
+++ b/erpnext/e_commerce/doctype/e_commerce_settings/e_commerce_settings.py
@@ -9,6 +9,7 @@
from erpnext.e_commerce.redisearch_utils import (
create_website_items_index,
+ define_autocomplete_dictionary,
get_indexable_web_fields,
is_search_module_loaded,
)
@@ -21,6 +22,8 @@
class ECommerceSettings(Document):
def onload(self):
self.get("__onload").quotation_series = frappe.get_meta("Quotation").get_options("naming_series")
+
+ # flag >> if redisearch is installed and loaded
self.is_redisearch_loaded = is_search_module_loaded()
def validate(self):
@@ -34,6 +37,20 @@
frappe.clear_document_cache("E Commerce Settings", "E Commerce Settings")
+ self.is_redisearch_enabled_pre_save = frappe.db.get_single_value(
+ "E Commerce Settings", "is_redisearch_enabled"
+ )
+
+ def after_save(self):
+ self.create_redisearch_indexes()
+
+ def create_redisearch_indexes(self):
+ # if redisearch is enabled (value changed) create indexes and dictionary
+ value_changed = self.is_redisearch_enabled != self.is_redisearch_enabled_pre_save
+ if self.is_redisearch_loaded and self.is_redisearch_enabled and value_changed:
+ define_autocomplete_dictionary()
+ create_website_items_index()
+
def validate_field_filters(self):
if not (self.enable_field_filters and self.filter_fields):
return
diff --git a/erpnext/e_commerce/redisearch_utils.py b/erpnext/e_commerce/redisearch_utils.py
index 82829bf..78cc05a 100644
--- a/erpnext/e_commerce/redisearch_utils.py
+++ b/erpnext/e_commerce/redisearch_utils.py
@@ -22,6 +22,12 @@
return [df.fieldname for df in valid_fields]
+def is_redisearch_enabled():
+ "Return True only if redisearch is loaded and enabled."
+ is_redisearch_enabled = frappe.db.get_single_value("E Commerce Settings", "is_redisearch_enabled")
+ return is_search_module_loaded() and is_redisearch_enabled
+
+
def is_search_module_loaded():
try:
cache = frappe.cache()
@@ -35,11 +41,11 @@
return False
-def if_redisearch_loaded(function):
- "Decorator to check if Redisearch is loaded."
+def if_redisearch_enabled(function):
+ "Decorator to check if Redisearch is enabled."
def wrapper(*args, **kwargs):
- if is_search_module_loaded():
+ if is_redisearch_enabled():
func = function(*args, **kwargs)
return func
return
@@ -51,7 +57,7 @@
return "{0}|{1}".format(frappe.conf.db_name, key).encode("utf-8")
-@if_redisearch_loaded
+@if_redisearch_enabled
def create_website_items_index():
"Creates Index Definition."
@@ -91,7 +97,7 @@
return TextField(field)
-@if_redisearch_loaded
+@if_redisearch_enabled
def insert_item_to_index(website_item_doc):
# Insert item to index
key = get_cache_key(website_item_doc.name)
@@ -104,7 +110,7 @@
insert_to_name_ac(website_item_doc.web_item_name, website_item_doc.name)
-@if_redisearch_loaded
+@if_redisearch_enabled
def insert_to_name_ac(web_name, doc_name):
ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=frappe.cache())
ac.add_suggestions(Suggestion(web_name, payload=doc_name))
@@ -120,14 +126,14 @@
return web_item
-@if_redisearch_loaded
+@if_redisearch_enabled
def update_index_for_item(website_item_doc):
# Reinsert to Cache
insert_item_to_index(website_item_doc)
define_autocomplete_dictionary()
-@if_redisearch_loaded
+@if_redisearch_enabled
def delete_item_from_index(website_item_doc):
cache = frappe.cache()
key = get_cache_key(website_item_doc.name)
@@ -141,7 +147,7 @@
return True
-@if_redisearch_loaded
+@if_redisearch_enabled
def delete_from_ac_dict(website_item_doc):
"""Removes this items's name from autocomplete dictionary"""
cache = frappe.cache()
@@ -149,7 +155,7 @@
name_ac.delete(website_item_doc.web_item_name)
-@if_redisearch_loaded
+@if_redisearch_enabled
def define_autocomplete_dictionary():
"""Creates an autocomplete search dictionary for `name`.
Also creats autocomplete dictionary for `categories` if
@@ -182,7 +188,7 @@
return True
-@if_redisearch_loaded
+@if_redisearch_enabled
def reindex_all_web_items():
items = frappe.get_all("Website Item", fields=get_fields_indexed(), filters={"published": True})
@@ -208,9 +214,3 @@
fields_to_index = fields_to_index + mandatory_fields
return fields_to_index
-
-
-# TODO: Remove later
-# # Figure out a way to run this at startup
-define_autocomplete_dictionary()
-create_website_items_index()
diff --git a/erpnext/templates/pages/product_search.py b/erpnext/templates/pages/product_search.py
index 77a749e..ce04068 100644
--- a/erpnext/templates/pages/product_search.py
+++ b/erpnext/templates/pages/product_search.py
@@ -9,7 +9,7 @@
WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE,
WEBSITE_ITEM_INDEX,
WEBSITE_ITEM_NAME_AUTOCOMPLETE,
- is_search_module_loaded,
+ is_redisearch_enabled,
make_key,
)
from erpnext.e_commerce.shopping_cart.product_info import set_product_info_for_website
@@ -74,8 +74,8 @@
def product_search(query, limit=10, fuzzy_search=True):
search_results = {"from_redisearch": True, "results": []}
- if not is_search_module_loaded():
- # Redisearch module not loaded
+ if not is_redisearch_enabled():
+ # Redisearch module not enabled
search_results["from_redisearch"] = False
search_results["results"] = get_product_data(query, 0, limit)
return search_results
@@ -121,8 +121,8 @@
def get_category_suggestions(query):
search_results = {"results": []}
- if not is_search_module_loaded():
- # Redisearch module not loaded, query db
+ if not is_redisearch_enabled():
+ # Redisearch module not enabled, query db
categories = frappe.db.get_all(
"Item Group",
filters={"name": ["like", "%{0}%".format(query)], "show_in_website": 1},