@scandipwa/magento-scripts 1.14.1-alpha.0 → 1.14.1-alpha.11

package/lib/config/templates/varnish.template.vcl

@@ -0,0 +1,250 @@
+# VCL version 5.0 is not supported so it should be 4.0 even though actually used Varnish version is 6
+vcl 4.0;
+
+import std;
+# The minimal Varnish version is 6.0
+# For SSL offloading, pass the following header in your proxy server or load balancer: 'X-Forwarded-Proto: https'
+
+backend default {
+    .host = "<%= it.hostMachine %>";
+    .host_header = "Host: localhost";
+    .port = "<%= it.nginxPort %>";
+    .first_byte_timeout = 600s;
+    .probe = {
+        # .url = "/health_check.php";
+        .request =
+            "GET /health_check.php HTTP/1.1"
+            "Host: localhost"
+            "Connection: close"
+            "User-Agent: Varnish Health Probe";
+        .interval  = 10s;
+        .timeout   = 5s;
+        .window    = 5;
+        .threshold = 3;
+   }
+}
+
+acl purge {
+    "<%= it.hostMachine %>";
+    "localhost";
+    "172.0.0.0"/8;
+    "192.168.0.0"/16;
+}
+
+sub vcl_recv {
+    if (req.restarts > 0) {
+        set req.hash_always_miss = true;
+    }
+
+    if (req.method == "PURGE") {
+        if (client.ip !~ purge) {
+            return (synth(405, "Method not allowed"));
+        }
+        # To use the X-Pool header for purging varnish during automated deployments, make sure the X-Pool header
+        # has been added to the response in your backend server config. This is used, for example, by the
+        # capistrano-magento2 gem for purging old content from varnish during it's deploy routine.
+        if (!req.http.X-Magento-Tags-Pattern && !req.http.X-Pool) {
+            return (synth(400, "X-Magento-Tags-Pattern or X-Pool header required"));
+        }
+        if (req.http.X-Magento-Tags-Pattern) {
+          ban("obj.http.X-Magento-Tags ~ " + req.http.X-Magento-Tags-Pattern);
+        }
+        if (req.http.X-Pool) {
+          ban("obj.http.X-Pool ~ " + req.http.X-Pool);
+        }
+        return (synth(200, "Purged"));
+    }
+
+    if (req.method != "GET" &&
+        req.method != "HEAD" &&
+        req.method != "PUT" &&
+        req.method != "POST" &&
+        req.method != "TRACE" &&
+        req.method != "OPTIONS" &&
+        req.method != "DELETE") {
+          /* Non-RFC2616 or CONNECT which is weird. */
+          return (pipe);
+    }
+
+    # We only deal with GET and HEAD by default
+    if (req.method != "GET" && req.method != "HEAD") {
+        return (pass);
+    }
+
+    # Bypass customer, shopping cart, checkout
+    if (req.url ~ "/customer" || req.url ~ "/checkout") {
+        return (pass);
+    }
+
+    # Bypass health check requests
+    if (req.url ~ "^/(pub/)?(health_check.php)$") {
+        return (pass);
+    }
+
+    # Set initial grace period usage status
+    set req.http.grace = "none";
+
+    # normalize url in case of leading HTTP scheme and domain
+    set req.url = regsub(req.url, "^http[s]?://", "");
+
+    # collect all cookies
+    std.collect(req.http.Cookie);
+
+    # Compression filter. See https://www.varnish-cache.org/trac/wiki/FAQ/Compression
+    if (req.http.Accept-Encoding) {
+        if (req.url ~ "\.(jpg|jpeg|png|gif|gz|tgz|bz2|tbz|mp3|ogg|swf|flv)$") {
+            # No point in compressing these
+            unset req.http.Accept-Encoding;
+        } elsif (req.http.Accept-Encoding ~ "gzip") {
+            set req.http.Accept-Encoding = "gzip";
+        } elsif (req.http.Accept-Encoding ~ "deflate" && req.http.user-agent !~ "MSIE") {
+            set req.http.Accept-Encoding = "deflate";
+        } else {
+            # unknown algorithm
+            unset req.http.Accept-Encoding;
+        }
+    }
+
+    # Remove all marketing get parameters to minimize the cache objects
+    if (req.url ~ "(\?|&)(gclid|cx|ie|cof|siteurl|zanpid|origin|fbclid|mc_[a-z]+|utm_[a-z]+|_bta_[a-z]+)=") {
+        set req.url = regsuball(req.url, "(gclid|cx|ie|cof|siteurl|zanpid|origin|fbclid|mc_[a-z]+|utm_[a-z]+|_bta_[a-z]+)=[-_A-z0-9+()%.]+&?", "");
+        set req.url = regsub(req.url, "[?|&]+$", "");
+    }
+
+    # Static files caching
+    if (req.url ~ "^/(pub/)?(media|static)/") {
+        # Static files should not be cached by default
+        return (pass);
+
+        # But if you use a few locales and don't use CDN you can enable caching static files by commenting previous line (#return (pass);) and uncommenting next 3 lines
+        #unset req.http.Https;
+        #unset req.http.X-Forwarded-Proto;
+        #unset req.http.Cookie;
+    }
+
+    # Authenticated GraphQL requests should not be cached by default
+    if (req.url ~ "/graphql" && req.http.Authorization ~ "^Bearer") {
+        return (pass);
+    }
+
+    return (hash);
+}
+
+sub vcl_hash {
+    if (req.http.cookie ~ "X-Magento-Vary=") {
+        hash_data(regsub(req.http.cookie, "^.*?X-Magento-Vary=([^;]+);*.*$", "\1"));
+    }
+
+    # To make sure http users don't see ssl warning
+    if (req.http.X-Forwarded-Proto) {
+        hash_data(req.http.X-Forwarded-Proto);
+    }
+
+    if (req.url ~ "/graphql") {
+        call process_graphql_headers;
+    }
+}
+
+sub process_graphql_headers {
+    if (req.http.Store) {
+        hash_data(req.http.Store);
+    }
+    if (req.http.Content-Currency) {
+        hash_data(req.http.Content-Currency);
+    }
+}
+
+sub vcl_backend_response {
+
+    set beresp.grace = 3d;
+
+    if (beresp.http.content-type ~ "text") {
+        set beresp.do_esi = true;
+    }
+
+    if (bereq.url ~ "\.js$" || beresp.http.content-type ~ "text") {
+        set beresp.do_gzip = true;
+    }
+
+    if (beresp.http.X-Magento-Debug) {
+        set beresp.http.X-Magento-Cache-Control = beresp.http.Cache-Control;
+    }
+
+    # cache only successfully responses and 404s
+    if (beresp.status != 200 && beresp.status != 404) {
+        set beresp.ttl = 0s;
+        set beresp.uncacheable = true;
+        return (deliver);
+    } elsif (beresp.http.Cache-Control ~ "private") {
+        set beresp.uncacheable = true;
+        set beresp.ttl = 86400s;
+        return (deliver);
+    }
+
+    # validate if we need to cache it and prevent from setting cookie
+    if (beresp.ttl > 0s && (bereq.method == "GET" || bereq.method == "HEAD")) {
+        unset beresp.http.set-cookie;
+    }
+
+   # If page is not cacheable then bypass varnish for 2 minutes as Hit-For-Pass
+   if (beresp.ttl <= 0s ||
+       beresp.http.Surrogate-control ~ "no-store" ||
+       (!beresp.http.Surrogate-Control &&
+       beresp.http.Cache-Control ~ "no-cache|no-store") ||
+       beresp.http.Vary == "*") {
+        # Mark as Hit-For-Pass for the next 2 minutes
+        set beresp.ttl = 120s;
+        set beresp.uncacheable = true;
+    }
+
+    return (deliver);
+}
+
+sub vcl_deliver {
+    if (resp.http.X-Magento-Debug) {
+        if (resp.http.x-varnish ~ " ") {
+            set resp.http.X-Magento-Cache-Debug = "HIT";
+            set resp.http.Grace = req.http.grace;
+        } else {
+            set resp.http.X-Magento-Cache-Debug = "MISS";
+        }
+    } else {
+        unset resp.http.Age;
+    }
+
+    # Not letting browser to cache non-static files.
+    if (resp.http.Cache-Control !~ "private" && req.url !~ "^/(pub/)?(media|static)/") {
+        set resp.http.Pragma = "no-cache";
+        set resp.http.Expires = "-1";
+        set resp.http.Cache-Control = "no-store, no-cache, must-revalidate, max-age=0";
+    }
+
+    unset resp.http.X-Magento-Debug;
+    unset resp.http.X-Magento-Tags;
+    unset resp.http.X-Powered-By;
+    unset resp.http.Server;
+    unset resp.http.X-Varnish;
+    unset resp.http.Via;
+    unset resp.http.Link;
+}
+
+sub vcl_hit {
+    if (obj.ttl >= 0s) {
+        # Hit within TTL period
+        return (deliver);
+    }
+    if (std.healthy(req.backend_hint)) {
+        if (obj.ttl + 300s > 0s) {
+            # Hit after TTL expiration, but within grace period
+            set req.http.grace = "normal (healthy server)";
+            return (deliver);
+        } else {
+            # Hit after TTL and grace expiration
+            return (restart);
+        }
+    } else {
+        # server is not healthy, retrieve from cache
+        set req.http.grace = "unlimited (unhealthy server)";
+        return (deliver);
+    }
+}

package/lib/config/varnish/varnish-6-0.js

@@ -0,0 +1,11 @@
+const path = require('path');
+
+const varnish60 = ({ templateDir }) => ({
+    enabled: true,
+    version: '6.0',
+    configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
+});
+
+module.exports = {
+    varnish60
+};

package/lib/config/varnish/varnish-6-6.js

@@ -0,0 +1,11 @@
+const path = require('path');
+
+const varnish66 = ({ templateDir }) => ({
+    enabled: true,
+    version: '6.6',
+    configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
+});
+
+module.exports = {
+    varnish66
+};

package/lib/config/varnish/varnish-7-0.js

@@ -0,0 +1,11 @@
+const path = require('path');
+
+const varnish70 = ({ templateDir }) => ({
+    enabled: true,
+    version: '7.0',
+    configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
+});
+
+module.exports = {
+    varnish70
+};

package/lib/config/versions/magento-2.3.0.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.0',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.1.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.1',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.2-p2.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.2-p2',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.2.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.2',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.3-p1.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.3-p1',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.3.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.3',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.4-p2.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.4-p2',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.4.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.4',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.5-p1.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.5-p1',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.5-p2.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.5-p2',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.5.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.5',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.6-p1.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.6-p1',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.6.js

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.6',
@@ -18,6 +20,10 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -39,7 +45,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '1'
-        }
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',