Merge pull request #104 from DivanteLtd/develop

v1.3.1

Author: pkarw

.gitignore

@@ -4,7 +4,6 @@ dist/
 npm-debug.log
 .vscode/
 .idea/
-yarn.lock
 api_start.sh
 api_test.sh
 package-lock.json

README.md

@@ -93,6 +93,9 @@ Executing `docker exec -it vue-storefront-api_app_1 yarn install` will also down
 
 NOTE: `npm` users will still have to install the dependencies individually in their modules.
 
+## Reviews
+To use review feature you need to install custom module for Magento 2: [Divante ReviewApi](https://github.com/DivanteLtd/magento2-review-api)
+
 License
 -------
 

config/default.json

@@ -1,7 +1,8 @@
 {
   "server": {
     "host": "localhost",
-    "port": 8080
+    "port": 8080,
+    "searchEngine": "elasticsearch"
   },
   "elasticsearch": {
     "host": "localhost",
@@ -12,6 +13,13 @@
       "vue_storefront_catalog",
       "vue_storefront_catalog_de",
       "vue_storefront_catalog_it"
+    ],
+    "indexTypes": [
+      "product",
+      "category",
+      "cms",
+      "attribute",
+      "taxrule"
     ]
   },
   "redis": {
@@ -44,7 +52,7 @@
         "defaultCountry": "DE",
         "defaultRegion": "",
         "calculateServerSide": true,
-		"sourcePriceIncludesTax": false	
+		"sourcePriceIncludesTax": false
       },
       "i18n": {
         "fullCountryName": "Germany",
@@ -71,7 +79,7 @@
         "defaultCountry": "IT",
         "defaultRegion": "",
         "calculateServerSide": true,
-		"sourcePriceIncludesTax": false				
+		"sourcePriceIncludesTax": false
       },
       "i18n": {
         "fullCountryName": "Italy",
@@ -155,5 +163,38 @@
     "maxDownloadCacheSize": 1000,
     "tmpPathRoot": "/tmp",
     "debug": false
+  },
+  "entities": {
+      "category": {
+        "includeFields": [ "children_data", "id", "children_count", "sku", "name", "is_active", "parent_id", "level", "url_key" ]
+      },
+      "attribute": {
+        "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" ]
+      },
+      "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,
+        "filterFieldMapping": {
+          "category.name": "category.name.keyword"
+        }
+      }
+    },
+  "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
+
+

docker-compose.nodejs.yml

@@ -1,4 +1,4 @@
-version: '2.0'
+version: '3.0'
 services:
   app:
     # image: divante/vue-storefront-api:latest
@@ -13,6 +13,7 @@ services:
       VS_ENV: dev
     volumes:
       - './config:/var/www/config'
+      - './ecosystem.json:/var/www/ecosystem.json'
       - './migrations:/var/www/migrations'
       - './package.json:/var/www/package.json'
       - './scripts:/var/www/scripts'

docker-compose.yml

@@ -1,31 +1,30 @@
-version: '2.0'
+version: '3'
 services:
   es1:
-    # image: divante/vue-storefront-elasticsearch:5.6.9
+    container_name: elasticsearch
     build: docker/elasticsearch/
-    container_name: es1
-    env_file: docker/elasticsearch/default.env
     volumes:
+      - ./docker/elasticsearch/config/elasticsearch.yml:/usr/share/elasticsearch/config/elasticsearch.yml:ro
       - 'esdat1:/usr/share/elasticsearch/data'
-    networks:
-      default:
-        aliases:
-          - elasticsearch
     ports:
       - '9200:9200'
-    ulimits:
-      memlock:
-        soft: -1
-        hard: -1
+      - '9300:9300'
+    environment:
+      ES_JAVA_OPTS: "-Xmx512m -Xms512m"
+
   kibana:
-    # image: divante/vue-storefront-kibana:5.6.9
     build: docker/kibana/
-    env_file: docker/kibana/default.env
+    volumes:
+      - ./docker/kibana/config/:/usr/share/kibana/config:ro
     ports:
       - '5601:5601'
+    depends_on:
+      - es1
+
   redis:
     image: 'redis:4-alpine'
     ports:
       - '6379:6379'
+
 volumes:
   esdat1:

docker/elasticsearch/Dockerfile

@@ -1,12 +1,6 @@
-FROM docker.elastic.co/elasticsearch/elasticsearch:5.6.9
+FROM docker.elastic.co/elasticsearch/elasticsearch:5.6.11
 
 RUN bin/elasticsearch-plugin remove x-pack --purge
 
 # Add your elasticsearch plugins setup here
 # Example: RUN elasticsearch-plugin install analysis-icu
-
-USER root
-
-COPY wrapper.sh /usr/local/bin/
-
-CMD ["wrapper.sh"]

docker/elasticsearch/config/elasticsearch.yml

@@ -0,0 +1,16 @@
+---
+## Default Elasticsearch configuration from elasticsearch-docker.
+## from https://github.com/elastic/elasticsearch-docker/blob/master/build/elasticsearch/elasticsearch.yml
+#
+cluster.name: "docker-cluster"
+network.host: 0.0.0.0
+
+# minimum_master_nodes need to be explicitly set when bound on a public IP
+# set to 1 to allow single node clusters
+# Details: https://github.com/elastic/elasticsearch/pull/17288
+discovery.zen.minimum_master_nodes: 1
+
+## Use single node discovery in order to disable production mode and avoid bootstrap checks
+## see https://www.elastic.co/guide/en/elasticsearch/reference/current/bootstrap-checks.html
+#
+discovery.type: single-node