Merge branch 'master' into hotfix/v1.11.3

Author: andrzejewsky

.github/workflows/deploy-storefrontcloud.yml

@@ -0,0 +1,83 @@
+name: Deploy to Storefrontcloud
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - hotfix/v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: "10.x"
+      - name: Build and publish docker image
+        uses: elgohr/Publish-Docker-Github-Action@master
+        with:
+          name: demo-storefrontcloud-io/vue-storefront:${{ github.sha }}
+          registry: registry.storefrontcloud.io
+          username: ${{ secrets.CLOUD_USERNAME }}
+          password: ${{ secrets.CLOUD_PASSWORD }}
+          dockerfile: dev/docker/Dockerfile
+          buildoptions: "--compress"
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: chrnorm/deployment-action@releases/v1
+        name: Create GitHub deployment
+        id: deployment
+        with:
+          token: "${{ github.token }}"
+          target_url: https://demo.storefrontcloud.io
+          environment: production
+          initial_status: in_progress
+      - name: Deploy on demo.storefrontcloud.io
+        if: github.ref == 'refs/heads/master'
+        run: |
+          if curl -s -u ${{ secrets.CLOUD_USERNAME }}:${{ secrets.CLOUD_PASSWORD }} -H 'Content-Type: application/json' -X POST -d '{"code":"demo","frontContainerVersion":"${{ github.sha }}"}' https://farmer.storefrontcloud.io/instances | grep -q '{"code":200,"result":"Instance updated!"}'; then
+            echo "Instance updated"
+          else
+            echo "Something went wrong during the update process..."
+            exit 1
+          fi
+      - name: Deploy on next.storefrontcloud.io
+        if: contains(github.ref, 'hotfix/v')
+        run: |
+          if curl -s -u ${{ secrets.CLOUD_USERNAME }}:${{ secrets.CLOUD_PASSWORD }} -H 'Content-Type: application/json' -X POST -d '{"code":"next","frontContainerVersion":"${{ github.sha }}"}' https://farmer.storefrontcloud.io/instances | grep -q '{"code":200,"result":"Instance updated!"}'; then
+            echo "Instance updated"
+          else
+            echo "Something went wrong during the update process..."
+            exit 1
+          fi
+      - name: Deploy on test.storefrontcloud.io
+        if: github.ref == 'refs/heads/develop'
+        run: |
+          if curl -s -u ${{ secrets.CLOUD_USERNAME }}:${{ secrets.CLOUD_PASSWORD }} -H 'Content-Type: application/json' -X POST -d '{"code":"test","frontContainerVersion":"${{ github.sha }}"}' https://farmer.storefrontcloud.io/instances | grep -q '{"code":200,"result":"Instance updated!"}'; then
+            echo "Instance updated"
+          else
+            echo "Something went wrong during the update process..."
+            exit 1
+          fi
+      - name: Update deployment status (success)
+        if: success()
+        uses: chrnorm/deployment-status@releases/v1
+        with:
+          token: "${{ github.token }}"
+          target_url: https://demo.storefrontcloud.io
+          state: "success"
+          description: Congratulations! The deploy is done.
+          deployment_id: ${{ steps.deployment.outputs.deployment_id }}
+      - name: Update deployment status (failure)
+        if: failure()
+        uses: chrnorm/deployment-status@releases/v1
+        with:
+          token: "${{ github.token }}"
+          target_url: https://demo.storefrontcloud.io
+          description: Unfortunately, the instance hasn't been updated.
+          state: "failure"
+          deployment_id: ${{ steps.deployment.outputs.deployment_id }}

README.md

@@ -32,6 +32,18 @@ See the ideas behind Vue Storefront [here](https://www.slideshare.net/FilipRakow
 **Read [contribution rules](https://github.com/DivanteLtd/vue-storefront/blob/master/CONTRIBUTING.md) before making any pull request. Pull request that doesn't meet these requirements will not be merged**
 
 PS: Check [StorefrontUI](https://github.com/DivanteLtd/storefront-ui/) - our UI library for eCommerce.
+## Vue Storefront Next
+
+We're developing a next version of Vue Storefront on the [`next` branch](https://github.com/DivanteLtd/vue-storefront/tree/next). 
+
+We're building the following integrations within Next architecture:
+- Shopware 6 (developer preview)
+- Commercetools (developer preview)
+- AboutYou Cloud
+- Shopify
+- Salesforce Commerce Cloud
+
+You can learn more about Vue Storefront Next from the README on the `next` branch and [this](https://www.youtube.com/watch?v=0e2wyhR0ZyQ&t=3s) video
 
 ## See it in action
 
@@ -964,28 +976,28 @@ Vue Storefront is a Community effort brought to You by our great Core Team and s
     </tr>
             <tr>
       <td align="center" valign="middle">
-<a href="">
+<a href="https://www.2hatslogic.com/">
           <img
-            src=""
-            alt=""
+            src="https://blog.vuestorefront.io/wp-content/uploads/2020/03/2hatslogic-logo.png"
+            alt="2hatslogic"
             height="40"
           >
         </a>
 </td>
   <td align="center" valign="middle">
-<a href="">
+<a href="https://beecommerce.pl/en/">
           <img
-            src=""
-            alt=""
+            src="https://blog.vuestorefront.io/wp-content/uploads/2020/04/beecommerce_color_horizontal.png"
+            alt="BeeCommerce"
             height="40"
           >
         </a>
 </td>
      <td align="center" valign="middle">
-<a href="">
+<a href="https://www.gpmd.co.uk/">
           <img
-            src=""
-            alt=""
+            src="https://blog.vuestorefront.io/wp-content/uploads/2020/04/[email protected]"
+            alt="GPMD"
             height="40"
           >
         </a>

config/default.json

@@ -30,7 +30,7 @@
     "invalidateCacheKey": "aeSu7aip",
     "invalidateCacheForwarding": false,
     "invalidateCacheForwardUrl": "http://localhost:8080/invalidate?key=aeSu7aip&tag=",
-    "dynamicConfigReload": false,
+    "dynamicConfigReload": true,
     "dynamicConfigContinueOnError": false,
     "dynamicConfigExclude": [
       "entities",

dev/docker/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:10
+
+ENV NODE_CONFIG_ENV=docker PM2_ARGS=--no-daemon BIND_HOST=0.0.0.0 VS_ENV=prod
+
+WORKDIR /var/www
+
+COPY . .
+
+# Should be yarn install --production
+RUN apt update && apt install -y git \
+  && yarn install \
+  && yarn build
+
+COPY dev/docker/vue-storefront.sh /usr/local/bin/
+RUN chmod a+x /usr/local/bin/vue-storefront.sh
+
+ENTRYPOINT ["vue-storefront.sh"]

dev/docker/vue-storefront.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+set -e
+
+if [ "$VS_ENV" = 'dev' ]; then
+  yarn dev
+else
+  yarn start
+fi

docs/guide/cookbook/elastic.md

@@ -623,7 +623,14 @@ module.exports = function (restClient) {
 }
 
  ````
-This library file only deals with _GET_ API to get a list of offline stores from Magento 2. 
+This library file only deals with _GET_ API to get a list of offline stores from Magento 2.
+
+:::tip NOTE
+```js
+var endpointUrl = util.format('/offline-stores');
+```
+ This line is particularly important, since `'/offline-stores'` is where the API url endpoint is determined. It should match the API url endpoint of Magento 2 side.
+:::
 
  5. Now we need to include this library in `index.js` : 
  ```bash
@@ -713,7 +720,7 @@ debug: Response received.
 2020-03-10T09:22:32.140Z - info: No tasks to process. All records processed!
 2020-03-10T09:22:32.140Z - info: Task done! Exiting in 30s...
  ```
-:::tip NOTE
+:::warning NOTE
 You should tell the machine the environment variable like this before running the command : 
 ```bash
 export MAGENTO_URL=http://localhost/rest
@@ -855,16 +862,16 @@ Now you are all set to use custom entity you just created. The next step lets yo
 import { currentStoreView } from '@vue-storefront/core/lib/multistore'
 import { registerModule } from '@vue-storefront/core/lib/modules'
 import { OrderModule } from '@vue-storefront/core/modules/order'
-import { quickSearchByQuery } from '@vue-storefront/core/lib/search';
+import { quickSearchByQuery } from '@vue-storefront/core/lib/search'; // Import the method to fetch data from ES
 
 const storeView = currentStoreView()
 
 // ... abridged
 
   methods: {
-    async showPayment () {
-      let offlineStores = await quickSearchByQuery({ entityType: 'offline_stores' });
-      alert("Your item will be sent from the shop at " + offlineStores.items[0].address);
+    async showPayment () { // the method should be done with async/await
+      let offlineStores = await quickSearchByQuery({ entityType: 'offline_stores' }); 
+      alert("Your item will be sent from the shop at " + offlineStores.items[0].address); 
       const payment = new PaymentRequest(this.paymentMethods, this.paymentDetails , this.paymentOptions)
 
       // abridged ...
@@ -875,18 +882,7 @@ Now go to your online shop, put an item to cart and open it, click __Instant Che
 ![instant_checkout_store_borderline](../images/stores.png)
 
 
-### 2-1. Recipe B (with GraphQL)
-
- 1. First off, we need to create an `graphql` folder under `src/search/adapter/` as follows :
- ```bash
-cd src/search/adapter
-mkdir graphql 
- ```
 
- 2. Copy `searchAdapter` file from `core` folder :
- ```bash
-cp ../../../core/lib/search/adapter/graphql/searchAdapter.ts graphql/
- ```
 
 ### 3. Peep into the kitchen (what happens internally)
 In this recipe, we iterated a whole journey of building custom entities on your online shop (it was Magento 2 for this time) for whatever reason to deal with various information for enhancing your customer experience.
@@ -898,7 +894,7 @@ Second, as an appetizer, we had to import data from shop using _mage2vuestorefro
 Third, main dish, we extended core adapters in `src` folder so we are safe for future updates :).
  It was actually very easy! you just need to `registerEntityType` for your custom entity! We also looked at how to implement it in real example though it was simplified version, you better follow `vuex` best practice. 
 
-We also have a variety of main dish, by giving you an option to go with _GraphQL_. This approach took us a little more to tweak with, but believe me, _GraphQL_ has pretty good advantage over its competitors. 
+We also have a variety of main dish, by giving you an option to go with _GraphQL_. This approach took us a little more to tweak with, but believe me, _GraphQL_ has [pretty good advantage](https://www.altexsoft.com/blog/engineering/graphql-core-features-architecture-pros-and-cons/) over its competitors. 
 
 Now we can extend our shop as good as it gets to handle more versatile information on your shop. Congratulation!
 

docs/guide/installation/production-setup.md

@@ -444,6 +444,14 @@ yarn start
 
 Both applications use [`PM2` process manager](https://pm2.keymetrics.io/docs/usage/process-management/) in production mode (`start` commands) to manage and respawn the node.js processes when needed.
 
+## Cache Strategies 
+
+### Varnish cache for VSF
+_Vue Storefront_ has multiple layers of cache, and the forefront cache is _Varnish_ which serves a request just as fast as a static HTML page once it's hit. You can install it from [here](https://github.com/new-fantastic/vsf-cache-varnish).
+
+### Vue Storefront Proxy
+_Vue Storefront_ can be set up with [OpenResty](http://openresty.org/en/) based reverse proxy serving cached pages from Redis without Vue StoreFront (VSF or VSF API) calls, using LUA. [Here](https://github.com/ClickAndMortar/docker/tree/master/vue-storefront/proxy) is the github repo. 
+
 ## Production setup - using Docker / Kubernetes
 
 To be prepared.