improve magento performance, add varnish to setup

build-packages/magento-scripts/lib/commands/cli.js

@@ -7,6 +7,7 @@ const getProjectConfiguration = require('../config/get-project-configuration');
 const localAuthJson = require('../tasks/composer/local-auth-json');
 const checkConfigurationFile = require('../config/check-configuration-file');
 const { installComposer, installPrestissimo } = require('../tasks/composer');
+const ConsoleBlock = require('../util/console-block');
 
 /**
  * @param {import('yargs')} yargs
@@ -30,13 +31,39 @@ module.exports = (yargs) => {
             rendererOptions: { collapse: false, clearOutput: true }
         });
 
+        let ctx;
         try {
-            await tasks.run();
+            ctx = await tasks.run();
         } catch (e) {
             logger.error(e.message || e);
             process.exit(1);
         }
 
+        const block = new ConsoleBlock();
+
+        block
+            .addHeader('Create Magento App CLI')
+            .addEmptyLine()
+            .addLine(`Available aliases: ${logger.style.command('php')}, ${logger.style.command('magento')}, ${logger.style.command('composer')}`)
+            .addLine(`Available shortcuts: magento -> ${logger.style.command('m')}, composer -> ${logger.style.command('c')}`)
+            .addEmptyLine();
+
+        if (ctx.config.overridenConfiguration.configuration.varnish.enabled) {
+            block.addLine(`Clear Varnish cache: ${logger.style.command('cvc')}`);
+        }
+
+        block
+            .addLine(`Clear Magento cache: ${logger.style.command('m c:c')}`)
+            .addLine(`Magento setup upgrade: ${logger.style.command('m se:up')}`)
+            .addLine(`Magento DI compile: ${logger.style.command('m s:d:c')}`);
+
+        block
+            .addEmptyLine()
+            .addLine(`Clear Composer cache: ${logger.style.command('c cc')}`)
+            .addEmptyLine();
+
+        block.log();
+
         return cli();
     });
 };

build-packages/magento-scripts/lib/commands/execute.js

@@ -16,7 +16,8 @@ Available containers:
 - mysql
 - nginx
 - redis
-- elasticsearch`);
+- elasticsearch
+- varnish (if enabled)`);
         },
         async (argv) => {
             const containers = (await docker).getContainers();

build-packages/magento-scripts/lib/config/docker.js

@@ -12,7 +12,8 @@ module.exports = async ({ configuration, ssl, host }, config) => {
         redis,
         mysql,
         elasticsearch,
-        mariadb
+        mariadb,
+        varnish
     } = configuration;
 
     const {
@@ -42,7 +43,6 @@ module.exports = async ({ configuration, ssl, host }, config) => {
     const isLinux = os.platform() === 'linux';
     const isWsl = await getIsWsl();
     const isArm = (await getArch()) === 'arm64';
-    const isArmMac = (os.platform() === 'darwin') && isArm;
 
     if (!isLinux) {
         /**
@@ -53,7 +53,7 @@ module.exports = async ({ configuration, ssl, host }, config) => {
             name: `${ prefix }_nginx-data`,
             opts: {
                 type: 'nfs',
-                device: `${cacheDir}/nginx/conf.d`,
+                device: `${ path.join(cacheDir, 'nginx', 'conf.d') }`,
                 o: 'bind'
             }
         };
@@ -69,18 +69,28 @@ module.exports = async ({ configuration, ssl, host }, config) => {
             name: `${ prefix }_setup-data`,
             opts: {
                 type: 'nfs',
-                device: `${path.join(magentoDir, 'setup')}`,
+                device: `${ path.join(magentoDir, 'setup') }`,
                 o: 'bind'
             }
         };
+
+        if (varnish.enabled) {
+            volumes.varnish = {
+                name: `${ prefix }_varnish-vcl-data`,
+                opts: {
+                    type: 'nfs',
+                    device: `${ path.join(cacheDir, 'varnish', 'default.vcl') }`
+                }
+            };
+        }
     }
 
     const getContainers = (ports = {}) => {
         const dockerConfig = {
             nginx: {
                 _: 'Nginx',
                 ports: (!isLinux || isWsl) ? [
-                    `${isIpAddress(host) ? host : '127.0.0.1'}:${ ports.app }:80`
+                    `${ isIpAddress(host) ? host : '127.0.0.1' }:${ ports.app }:80`
                 ] : [],
                 healthCheck: {
                     cmd: 'service nginx status'
@@ -126,7 +136,7 @@ module.exports = async ({ configuration, ssl, host }, config) => {
                 connectCommand: ['redis-cli']
             },
             mysql: {
-                _: !isArmMac ? 'MySQL' : 'MariaDB',
+                _: !isArm ? 'MySQL' : 'MariaDB',
                 healthCheck: {
                     cmd: 'mysqladmin ping --silent'
                 },
@@ -154,15 +164,15 @@ module.exports = async ({ configuration, ssl, host }, config) => {
                     'seccomp=unconfined'
                 ],
                 network: network.name,
-                image: !isArmMac ? `mysql:${ mysql.version }` : `mariadb:${ mariadb.version }`,
-                imageDetails: !isArmMac ? {
+                image: !isArm ? `mysql:${ mysql.version }` : `mariadb:${ mariadb.version }`,
+                imageDetails: !isArm ? {
                     name: 'mysql',
                     tag: mysql.version
                 } : {
                     name: 'mariadb',
                     tag: mariadb.version
                 },
-                name: !isArmMac ? `${ prefix }_mysql` : `${ prefix }_mariadb`
+                name: !isArm ? `${ prefix }_mysql` : `${ prefix }_mariadb`
             },
             elasticsearch: {
                 _: 'ElasticSearch',
@@ -195,6 +205,32 @@ module.exports = async ({ configuration, ssl, host }, config) => {
             );
         }
 
+        if (varnish.enabled) {
+            dockerConfig.varnish = {
+                _: 'Varnish',
+                image: `varnish:${ varnish.version }`,
+                imageDetails: {
+                    name: 'varnish',
+                    tag: varnish.version
+                },
+                name: `${ prefix }_varnish`,
+                mountVolumes: isLinux ? [
+                    `${ path.join(cacheDir, 'varnish', 'default.vcl') }:/etc/varnish/default.vcl:ro`
+                ] : [
+                    `${ volumes.varnish.name }:/etc/varnish/default.vcl`
+                ],
+                env: {
+                    VARNISH_SIZE: '2G'
+                },
+                restart: 'on-failure:30',
+                network: (!isLinux || isWsl) ? network.name : 'host',
+                command: `varnishd -F -a :${ ports.varnish } -t 600 -f /etc/varnish/default.vcl`,
+                tmpfs: [
+                    '/var/lib/varnish:exec'
+                ]
+            };
+        }
+
         return dockerConfig;
     };
 

build-packages/magento-scripts/lib/config/get-port-config.js

@@ -51,7 +51,7 @@ const getAvailablePorts = () => ({
 });
 
 /**
- * @type {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const getCachedPorts = () => ({
     title: 'Getting cached ports',
@@ -65,6 +65,7 @@ const getCachedPorts = () => ({
                     'utf-8'
                 )
             );
+            ctx.cachedPorts = { ...ports };
         } else {
             ports = { ...defaultPorts };
         }

build-packages/magento-scripts/lib/config/port-config.js

@@ -55,6 +55,7 @@ const savePortsConfig = async (ports) => {
 // Map of default ports (key:value)
 const defaultPorts = {
     app: 80,
+    varnish: 8080,
     fpm: 9000,
     xdebug: 9111,
     mysql: 3306,

build-packages/magento-scripts/lib/config/templates/magentorc.template

@@ -3,10 +3,8 @@ alias magento="php $PWD/bin/magento"
 alias m="magento"
 alias composer="php $PWD/node_modules/.create-magento-app-cache/composer/composer.phar"
 alias c="composer"
+<% if (it.varnishEnabled) { %>
+alias cvc="npm run exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+<% } %>
 
 export BASH_SILENCE_DEPRECATION_WARNING=1
-
-echo ""
-echo "Available aliases: php, magento, composer"
-echo "Available shortcuts: magento -> m, composer -> c"
-echo ""

build-packages/magento-scripts/lib/config/templates/php.template.ini

@@ -1812,7 +1812,7 @@ ldap.max_links = -1
 
 [opcache]
 ; Determines if Zend OPCache is enabled
-; opcache.enable=1
+opcache.enable=1
 
 ; Determines if Zend OPCache is enabled for the CLI version of PHP
 ;opcache.enable_cli=0
@@ -1838,19 +1838,19 @@ ldap.max_links = -1
 
 ; When disabled, you must reset the OPcache manually or restart the
 ; webserver for changes to the filesystem to take effect.
-;opcache.validate_timestamps=1
+opcache.validate_timestamps=1
 
 ; How often (in seconds) to check file timestamps for changes to the shared
 ; memory storage allocation. ("1" means validate once per second, but only
 ; once per request. "0" means always validate)
-;opcache.revalidate_freq=2
+opcache.revalidate_freq=2
 
 ; Enables or disables file search in include_path optimization
 ;opcache.revalidate_path=0
 
 ; If disabled, all PHPDoc comments are dropped from the code to reduce the
 ; size of the optimized code.
-; opcache.save_comments=1
+opcache.save_comments=1
 
 ; If enabled, compilation warnings (including notices and deprecations) will
 ; be recorded and replayed each time a file is included. Otherwise, compilation
@@ -2038,3 +2038,5 @@ xdebug.mode=off
 <% } %>
 
 <% } %>
+
+apc.enabled=1