feat(elasticsearch): add request filter configuration

Author: iams18i

config/default.json

@@ -40,7 +40,9 @@
       "review"
     ],
     "apiVersion": "5.6",
-
+    "useRequestFilter": false,
+    "overwriteRequestSourceParams": false,
+    "requestParamsBlacklist": [],
     "searchScoring": {
       "attributes": {
         "attribute_code": {
@@ -81,21 +83,21 @@
       "tax_class_id": "tci",
       "description": "desc",
       "minimal_regular_price": "mrp",
-      "final_price": "fp", 
-      "price": "p", 
+      "final_price": "fp",
+      "price": "p",
       "special_price": "sp",
       "original_final_price": "ofp",
       "original_price": "op",
       "original_special_price": "osp",
-      "final_price_incl_tax": "fpit", 
+      "final_price_incl_tax": "fpit",
       "original_price_incl_tax": "opit",
       "price_incl_tax": "pit",
-      "special_price_incl_tax": "spit", 
+      "special_price_incl_tax": "spit",
       "final_price_tax": "fpt",
       "price_tax": "pt",
       "special_price_tax": "spt",
       "original_price_tax": "opt",
-      "image": "i", 
+      "image": "i",
       "small_image": "si",
       "thumbnail": "t"
     },
@@ -106,7 +108,7 @@
       "default": 10,
       "size": 10,
       "color": 10
-    },    
+    },
     "priceFilterKey": "final_price",
     "priceFilters": {
       "ranges": [
@@ -115,7 +117,7 @@
         { "from": 100, "to": 150 },
         { "from": 150 }
       ]
-    }    
+    }
   },
   "varnish": {
     "host": "185.246.52.88",
@@ -234,7 +236,7 @@
     "useOnlyDefaultUserGroupId": false
   },
   "review": {
-    "defaultReviewStatus": 2 
+    "defaultReviewStatus": 2
   },
   "bodyLimit": "100kb",
   "corsHeaders": [
@@ -347,15 +349,6 @@
         "includeFields": [ "attribute_code", "id", "entity_type_id", "options", "default_value", "is_user_defined", "frontend_label", "attribute_id", "default_frontend_label", "is_visible_on_front", "is_visible", "is_comparable" ],
         "loadByAttributeMetadata": false
       },
-      "productList": {
-        "sort": "",
-        "includeFields": [ "type_id", "sku", "product_links", "tax_class_id", "special_price", "special_to_date", "special_from_date", "name", "price", "priceInclTax", "originalPriceInclTax", "originalPrice", "specialPriceInclTax", "id", "image", "sale", "new", "url_key" ],
-        "excludeFields": [ "configurable_children", "description", "configurable_options", "sgn" ]
-      },
-      "productListWithChildren": {
-        "includeFields": [ "type_id", "sku", "name", "tax_class_id", "special_price", "special_to_date", "special_from_date", "price", "priceInclTax", "originalPriceInclTax", "originalPrice", "specialPriceInclTax", "id", "image", "sale", "new", "configurable_children.image", "configurable_children.sku", "configurable_children.price", "configurable_children.special_price", "configurable_children.priceInclTax", "configurable_children.specialPriceInclTax", "configurable_children.originalPrice", "configurable_children.originalPriceInclTax", "configurable_children.color", "configurable_children.size", "product_links", "url_key"],
-        "excludeFields": [ "description", "sgn"]
-      },
       "product": {
         "excludeFields": [ "updated_at", "created_at", "attribute_set_id", "status", "visibility", "tier_prices", "options_container", "msrp_display_actual_price_type", "has_options", "stock.manage_stock", "stock.use_config_min_qty", "stock.use_config_notify_stock_qty", "stock.stock_id",  "stock.use_config_backorders", "stock.use_config_enable_qty_inc", "stock.enable_qty_increments", "stock.use_config_manage_stock", "stock.use_config_min_sale_qty", "stock.notify_stock_qty", "stock.use_config_max_sale_qty", "stock.use_config_max_sale_qty", "stock.qty_increments", "small_image"],
         "includeFields": null,

src/api/catalog.ts

@@ -111,13 +111,30 @@ export default ({config, db}) => async function (req, res, body) {
   const s = Date.now()
   const reqHash = sha3_224(`${JSON.stringify(requestBody)}${req.url}`)
   const dynamicRequestHandler = () => {
-    if (typeof config.entities[entityType] === 'object') {
+    // filter request parameters
+    if (config.elasticsearch.useRequestFilter && typeof config.entities[entityType] === 'object') {
       const urlParts = elasticBackendUrl.split('?')
       const { includeFields, excludeFields } = config.entities[entityType]
+
+      const filteredParams = Object.keys(req.query)
+        .filter(key => !config.elasticsearch.requestParamsBlacklist.includes(key))
+        .reduce((object, key) => {
+          object[key] = req.query[key]
+          return object
+        }, {})
+
+      let _source_include = includeFields
+      let _source_exclude = excludeFields
+
+      if (!config.elasticsearch.overwriteRequestSourceParams) {
+        _source_include = [...includeFields, ...req.query._source_include]
+        _source_exclude = [...excludeFields, ...req.query._source_exclude]
+      }
+
       const urlParams = {
-        ...req.query,
-        _source_include: includeFields,
-        _source_exclude: excludeFields
+        ...filteredParams,
+        _source_include,
+        _source_exclude
       }
       elasticBackendUrl = `${urlParts[0]}?${querystring.stringify(urlParams)}`
     }