Merge pull request #101 from yuriboyko/feature/searchQuery-graphQl-Update-1

Add documentation to pull request #94 + bug fixes

Author: pkarw

config/default.json

@@ -182,8 +182,19 @@
       },
       "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
+        "includeFields": null,
+        "filterFieldMapping": {
+          "category.name": "category.name.keyword"
+        }
       }
     },
-  "usePriceTiers": false
+  "usePriceTiers": false,
+  "boost": {
+    "name": 3,
+    "category.name": 1,
+    "short_description": 1,
+    "description": 1,
+    "sku": 1,
+    "configurable_children.sku": 1
+  }
 }

doc/2. graphQl support.md

@@ -0,0 +1,89 @@
+# Introduction
+
+Vue storefront now supports using graphQl as an alternative API endpoint to get data for products, categories, products, and taxerules.
+For now Graphql uses resolver  what fetch data from Elasticsearch. But potentialy can have different resolvers working with different Search Engines / 3rd Party APIs
+
+## GraphQl Schema
+
+Graphql request to this API  have to match query schema defined
+For product it is
+
+```graphql
+type Query {
+    products (
+        search: String @doc(description: "Performs a full-text search using the specified key words."),
+        filter: ProductFilterInput @doc(description: "Identifies which product attributes to search for and return."),
+        pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. This attribute is optional."),
+        currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."),
+        sort: ProductSortInput @doc(description: "Specifies which attribute to sort on, and whether to return the results in ascending or descending order.")
+        ): Products
+}
+```
+
+which has result of type Products
+
+```graphql
+
+type Products @doc(description: "The Products object is the top-level object returned in a product search") {
+    items: JSON @doc(description: "An array of products that match the specified search criteria")
+    page_info: SearchResultPageInfo @doc(description: "An object that includes the page_info and currentPage values specified in the query")
+    total_count: Int @doc(description: "The number of products returned")
+    aggregations: JSON @doc(description: "Layered navigation filters array as aggregations")
+    sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields")
+}
+```
+
+and uses defined resolver
+```js
+const resolver = {
+  Query: {
+    products: (_, { search, filter, sort, currentPage, pageSize }, context, rootValue) =>
+      list(filter, sort, currentPage, pageSize, search, context, rootValue)
+  }
+};
+```
+
+For other entity types you can check schemas and resolvers in the /src/graphql/elasticsearch correspond subfolder
+
+
+## Example request
+
+Below is an example request for product
+
+```graphql
+{
+  products(search: "bag", filter: {
+    status: {
+      in: [0, 1], scope: "default"
+    },
+    stock: {
+      is_in_stock: {eq: true, scope: "default"}
+    },
+    visibility: {
+      in: [3, 4], scope: "default"}
+  },
+    sort: {
+      updated_at: DESC
+    }
+  ) {
+    items
+    total_count
+    aggregations
+    sort_fields {
+      options {
+        value
+      }
+    }
+    page_info {
+      page_size
+      current_page
+    }
+  }
+}
+
+
+```
+
+To see all available product filter options please check ProductFilterInput type in the graphQl product schema
+
+

src/graphql/elasticsearch/catalog/resolver.js

@@ -25,7 +25,7 @@ async function list(filter, sort, currentPage, pageSize, search, context, rootVa
   const parseURL = context.req.url.replace(/^\/+|\/+$/g, '');
   let urlParts = parseURL.split('/');
   let esIndex  = config.elasticsearch.indices[0]
-  if (urlParts.length >= 1 && urlParts[0] != '') {
+  if (urlParts.length >= 1 && urlParts[0] != '' && urlParts[0] != '?') {
     esIndex = config.storeViews[urlParts[0]].elasticsearch.index
   }
 

src/graphql/elasticsearch/catalog/schema.graphqls

@@ -142,11 +142,12 @@ input ProductFilterInput @doc(description: "ProductFilterInput defines the filte
     size: FilterTypeInput @doc(description: "The product size. Customers use this size to identify the product.")
     color: FilterTypeInput @doc(description: "The product color. Customers use this color to identify the product.")
     or: ProductFilterInput @doc(description: "The keyword required to perform a logical OR comparison")
-    category: ProductFilterInput @doc(description: "The product color. Customers use this color to identify the product.")
+    category: JSON @doc(description: "The product color. Customers use this color to identify the product.")
     category_id: FilterTypeInput @doc(description: "Category ID the product belongs to")
     configurable_children: ProductFilterInput @doc(description: "Configurable product childrens")
     stock: ProductFilterInput @doc(description: "The product stock. Customers use this stock to identify the product.")
     is_in_stock: FilterTypeInput @doc(description: "Is product in stock")
+    keyword: FilterTypeInput @doc(description: "keyword filter input")
 }
 
 type LayerFilter {

src/graphql/elasticsearch/mapping.js

@@ -0,0 +1,16 @@
+import config from 'config'
+
+export default function getMapping (attribute, entityType = 'product') {
+  let mapping = [
+  ]
+
+  if (typeof config.entities[entityType].filterFieldMapping !== 'undefined') {
+    mapping = config.entities[entityType].filterFieldMapping
+  }
+
+  if (typeof mapping[attribute] !== 'undefined') {
+    return mapping[attribute]
+  }
+
+  return attribute
+}

src/graphql/elasticsearch/queryBuilder.js

@@ -1,6 +1,7 @@
 import bodybuilder from 'bodybuilder';
 import getBoosts from '../../lib/boost'
 import map from 'lodash/map';
+import getMapping from './mapping'
 
 function processNestedFieldFilter(attribute, value) {
   let processedFilter = {
@@ -55,7 +56,7 @@ function applyFilters(filter, query, type) {
           if (!Array.isArray(filter.value)) {
             filter.value = [filter.value];
           }
-          query = query.filter('terms', filter.attribute, filter.value);
+          query = query.filter('terms', getMapping(filter.attribute), filter.value)
         }
       } else if (filter.scope == 'catalog') {
         hasCatalogFilters = true;
@@ -81,7 +82,11 @@ function applyFilters(filter, query, type) {
             if (!Array.isArray(newValue)) {
               newValue = [newValue];
             }
-            filterQr = filterQr.andFilter('terms', catalogfilter.attribute + attrPostfix, newValue);
+            if (attrPostfix === '') {
+              filterQr = filterQr.andFilter('terms', getMapping(catalogfilter.attribute), newValue)
+            } else {
+              filterQr = filterQr.andFilter('terms', catalogfilter.attribute + attrPostfix, newValue)
+            }
           }
         }
       })
@@ -98,7 +103,7 @@ function applyFilters(filter, query, type) {
       for (let attrToFilter of appliedFilters) {
         if (attrToFilter.scope == 'catalog') {
           if (attrToFilter.attribute != 'price') {
-            query = query.aggregation('terms', attrToFilter.attribute)
+            query = query.aggregation('terms', getMapping(attrToFilter.attribute))
             query = query.aggregation('terms', attrToFilter.attribute + optionsPrfeix)
           } else {
             query = query.aggregation('terms', attrToFilter.attribute)

src/lib/boost.js

@@ -9,7 +9,7 @@ export default function getBoosts (attribute = '') {
   }
 
   if (boosts.hasOwnProperty(attribute)) {
-    return boosts.attribute
+    return boosts[attribute]
   }
 
   return 1