@scandipwa/magento-scripts 1.14.1-alpha.3 → 1.14.1-alpha.4

package/lib/tasks/magento/setup-magento/disable-2fa.js

@@ -1,23 +1,15 @@
+const configPhpToJson = require('../../../util/config-php-json');
 const runMagentoCommand = require('../../../util/run-magento');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
-    title: 'Disabling 2fa for admin.',
+    title: 'Disabling 2fa for admin',
     task: async ({ magentoVersion }, task) => {
-        const { result } = await runMagentoCommand('module:status Magento_TwoFactorAuth', {
-            magentoVersion,
-            throwNonZeroCode: false
-        });
+        const { modules } = await configPhpToJson(process.cwd(), { magentoVersion });
 
-        if (result.includes('Module is disabled')) {
-            task.skip();
-            return;
-        }
-
-        // Disable 2FA due admin login issue
-        if (result.includes('Module is enabled')) {
+        if (modules.Magento_TwoFactorAuth !== 0) {
             await runMagentoCommand('module:disable Magento_TwoFactorAuth', {
                 magentoVersion
             });

package/lib/tasks/magento/setup-magento/disable-full-page-cache.js

@@ -0,0 +1,20 @@
+const envPhpToJson = require('../../../util/env-php-json');
+const magentoTask = require('../../../util/magento-task');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const disableFullPageCache = () => ({
+    title: 'Disabling full_page cache in Magento',
+    task: async ({ magentoVersion }, task) => {
+        const { cache_types } = await envPhpToJson(process.cwd(), { magentoVersion });
+
+        if (cache_types.full_page !== 0) {
+            return task.newListr(magentoTask('cache:disable full_page'));
+        }
+
+        task.skip();
+    }
+});
+
+module.exports = disableFullPageCache;

package/lib/tasks/magento/setup-magento/increase-admin-session-lifetime.js

@@ -5,22 +5,20 @@ const { updateTableValues } = require('../../../util/database');
  */
 const increaseAdminSessionLifetime = () => ({
     title: 'Increase admin session lifetime to 1 month',
-    task: async (ctx, task) => {
-        const { mysqlConnection } = ctx;
-        await updateTableValues('core_config_data', [
-            {
-                path: 'admin/security/session_lifetime',
-                value: '2800000'
-            },
-            {
-                path: 'admin/security/password_lifetime',
-                value: null
-            }
-        ], {
-            mysqlConnection,
-            task
-        });
-    }
+    task: async ({ mysqlConnection }, task) => updateTableValues('core_config_data', [
+        {
+            path: 'admin/security/session_lifetime',
+            value: '2800000'
+        },
+        {
+            path: 'admin/security/password_lifetime',
+            value: null
+        }
+    ], {
+        mysqlConnection,
+        task
+    })
+
 });
 
 module.exports = increaseAdminSessionLifetime;

package/lib/tasks/magento/setup-magento/migrate-database.js

@@ -1,10 +1,10 @@
 const magentoTask = require('../../../util/magento-task');
 const runMagentoCommand = require('../../../util/run-magento');
-const adjustMagentoConfiguration = require('./adjust-magento-configuration');
 const configureElasticsearch = require('./configure-elasticsearch');
 const installMagento = require('./install-magento');
 const upgradeMagento = require('./upgrade-magento');
 const setupPersistedQuery = require('../../theme/setup-persisted-query');
+const varnishConfigSetup = require('./varnish-config');
 
 /**
  * @type {({ onlyInstallMagento: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -35,11 +35,15 @@ const migrateDatabase = (options = {}) => ({
                 setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         const { code } = await runMagentoCommand('setup:db:status', {
@@ -52,11 +56,15 @@ const migrateDatabase = (options = {}) => ({
             // no setup is needed, but still to be sure configure ES
             return task.newListr([
                 setupPersistedQuery(),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         case 1: {
@@ -71,23 +79,30 @@ const migrateDatabase = (options = {}) => ({
                 setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         case 2: {
             return task.newListr([
                 setupPersistedQuery(),
-                adjustMagentoConfiguration(),
+                varnishConfigSetup(),
                 configureElasticsearch(),
                 upgradeMagento()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         default: {

package/lib/tasks/magento/setup-magento/varnish-config.js

@@ -0,0 +1,63 @@
+const { updateTableValues } = require('../../../util/database');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const varnishConfigSetup = () => ({
+    title: 'Varnish setup',
+    task: async (ctx, task) => {
+        const {
+            config: {
+                overridenConfiguration: {
+                    configuration: {
+                        varnish: {
+                            enabled: varnishEnabled
+                        }
+                    }
+                }
+            },
+            mysqlConnection,
+            ports
+        } = ctx;
+
+        if (varnishEnabled) {
+            await updateTableValues('core_config_data', [
+                {
+                    path: 'system/full_page_cache/varnish/backend_host',
+                    value: 'localhost'
+                },
+                {
+                    path: 'system/full_page_cache/varnish/backend_port',
+                    value: ports.varnish
+                },
+                {
+                    path: 'system/full_page_cache/varnish/access_list',
+                    value: 'localhost'
+                },
+                {
+                    path: 'system/full_page_cache/caching_application',
+                    value: '2'
+                }
+            ], { mysqlConnection, task });
+        } else {
+            // delete varnish configuration if exists
+            await mysqlConnection.query(`
+                DELETE FROM core_config_data WHERE path LIKE '%varnish%';
+            `);
+
+            // update cache policy to not use varnish
+            // 0 - magento cache, 2 - varnish cache
+            await updateTableValues('core_config_data', [
+                {
+                    path: 'system/full_page_cache/caching_application',
+                    value: '0'
+                }
+            ], { mysqlConnection, task });
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = varnishConfigSetup;

package/lib/tasks/mysql/fix-db.js

@@ -1,8 +1,8 @@
-const adjustMagentoConfiguration = require('../magento/setup-magento/adjust-magento-configuration');
 const configureElasticsearch = require('../magento/setup-magento/configure-elasticsearch');
 const deleteAdminUsers = require('../magento/setup-magento/delete-admin-users');
 const deleteCustomers = require('../magento/setup-magento/delete-customers');
 const deleteOrders = require('../magento/setup-magento/delete-orders');
+const varnishConfigSetup = require('../magento/setup-magento/varnish-config');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -24,7 +24,7 @@ const disableForeignKeyCheck = () => ({
 const fixDB = () => ({
     title: 'Fixing database',
     task: async (ctx, task) => task.newListr([
-        adjustMagentoConfiguration(),
+        varnishConfigSetup(),
         configureElasticsearch(),
         {
             title: 'Deleting customers data',

package/lib/tasks/php/index.js

@@ -17,7 +17,7 @@ const installPhp = () => ({
         const phpBinExists = await pathExists(php.binPath);
 
         if (phpBinExists && !recompilePhp) {
-            task.title = `Using PHP version ${php.version}`;
+            task.title = `Using PHP version ${php.version} in project`;
 
             return;
         }

package/lib/tasks/php/update-env-php.js

@@ -14,8 +14,23 @@ const updateEnvPHP = () => ({
             return;
         }
 
+        const useVarinsh = ctx.config.overridenConfiguration.configuration.varnish.enabled ? '1' : '';
+        const varnishHost = '127.0.0.1';
+        const varnishPort = ctx.ports.varnish;
+        const previousVarnishPort = ctx.cachedPorts
+            ? ctx.cachedPorts.varnish
+            : ctx.cachedPorts;
+
         return task.newListr(
-            phpTask(`-f ${ path.join(__dirname, 'update-env.php') }`, { noTitle: true })
+            phpTask(`-f ${ path.join(__dirname, 'update-env.php') }`, {
+                noTitle: true,
+                env: {
+                    USE_VARNISH: useVarinsh,
+                    VARNISH_PORT: `${ varnishPort }`,
+                    VARNISH_HOST: varnishHost,
+                    PREVIOUS_VARNISH_PORT: `${ previousVarnishPort }`
+                }
+            })
         );
     }
 });

package/lib/tasks/php/update-env.php

@@ -1,13 +1,17 @@
 <?php
 
-function varexport($expression, $return=FALSE): string
+function varexport($expression, $return=false): string
 {
-    $export = var_export($expression, TRUE);
+    $export = var_export($expression, true);
     $export = preg_replace("/^([ ]*)(.*)/m", '$1$1$2', $export);
     $array = preg_split("/\r\n|\n|\r/", $export);
-    $array = preg_replace(["/\s*array\s\($/", "/\)(,)?$/", "/\s=>\s$/"], [NULL, ']$1', ' => ['], $array);
+    $array = preg_replace(["/\s*array\s\($/", "/\)(,)?$/", "/\s=>\s$/"], [null, ']$1', ' => ['], $array);
     $export = join(PHP_EOL, array_filter(["["] + $array));
-    if ((bool)$return) return $export; else echo $export;
+    if ((bool)$return) {
+        return $export;
+    } else {
+        echo $export;
+    }
 }
 
 function joinpaths(): string
@@ -15,13 +19,16 @@ function joinpaths(): string
     $paths = array();
 
     foreach (func_get_args() as $arg) {
-        if ($arg !== '') { $paths[] = $arg; }
+        if ($arg !== '') {
+            $paths[] = $arg;
+        }
     }
 
-    return preg_replace('#/+#','/',join('/', $paths));
+    return preg_replace('#/+#', '/', join('/', $paths));
 }
 
-class EnvUpdater {
+class EnvUpdater
+{
 
     /**
      * @var array
@@ -33,7 +40,8 @@ class EnvUpdater {
      */
     private $portConfig;
 
-    public function loadConfig() {
+    public function loadConfig()
+    {
         $this->config = require './app/etc/env.php';
     }
 
@@ -53,7 +61,8 @@ class EnvUpdater {
         return $this->portConfig;
     }
 
-    public function loadPortConfig() {
+    public function loadPortConfig()
+    {
         $portConfigContent = file_get_contents('./node_modules/.create-magento-app-cache/port-config.json');
         if ($portConfigContent === false) {
             throw new Error('Port config file does not exists in cache directory');
@@ -67,7 +76,8 @@ class EnvUpdater {
         $this->portConfig = $portConfigJsonData;
     }
 
-    public function modifyConfig() {
+    public function modifyConfig()
+    {
         // update mysql config
         if (isset($this->config['db']['connection']['default'])) {
             $conn = &$this->config['db']['connection']['default'];
@@ -122,16 +132,48 @@ class EnvUpdater {
                 }
             }
         }
+
+        $httpCacheHosts = &$this->config['http_cache_hosts'];
+        $httpCacheHosts = [];
+
+        if (getenv('USE_VARNISH') == '1') {
+            $varnishHost = getenv('VARNISH_HOST');
+            $varnishPort = getenv('VARNISH_PORT');
+            $previousVarnishPort = getenv('PREVIOUS_VARNISH_PORT');
+            $varnishConfig = [
+                'host' => $varnishHost,
+                'port' => $varnishPort
+            ];
+
+            if (isset($httpCacheHosts)) {
+                $varnishHostExists = false;
+                foreach ($httpCacheHosts as $host) {
+                    if ($host['host'] == $varnishHost && $host['port'] == $previousVarnishPort) {
+                        $host['port'] = $varnishPort;
+                        $varnishHostExists = true;
+                        break;
+                    }
+                }
+
+                if (!$varnishHostExists) {
+                    $httpCacheHosts = [$varnishConfig];
+                }
+            } else {
+                $this->config['http_cache_hosts'] = [$varnishConfig];
+            }
+        }
     }
 
-    public function saveConfig(string $filePath){
+    public function saveConfig(string $filePath)
+    {
         file_put_contents(
             $filePath,
             '<?php'.PHP_EOL.'return '.varexport($this->config, true).';' . PHP_EOL
         );
     }
 
-    public function update(){
+    public function update()
+    {
         $this->loadConfig();
         $this->loadPortConfig();
         $this->modifyConfig();

package/lib/tasks/requirements/index.js

@@ -13,17 +13,17 @@ const checkRequirements = () => ({
     task: (ctx, task) => task.newListr([
         // checking if user is on supported platform
         checkPlatform(),
+        // check the Docker installation
+        checkDocker(),
+        // check for Node.js version
+        checkNodeVersion(),
         // check the PHPBrew installation
         checkPHPbrew(),
         // check installed PHP version
         checkPHPVersion(),
-        // check the Docker installation
-        checkDocker(),
         // check for COMPOSER_AUTH or auth.json
         // localAuthJson(),
-        checkComposer(),
-        // check for Node.js version
-        checkNodeVersion()
+        checkComposer()
     ], {
         concurrent: false,
         exitOnError: true,

package/lib/tasks/requirements/php-version.js

@@ -99,7 +99,7 @@ const checkPHPVersion = () => ({
     task: async (ctx, task) => {
         const phpVersionResponse = await execAsyncSpawn('php --version');
 
-        const phpVersionResponseResult = phpVersionResponse.match(/PHP\s(\d\.\d\.\d)/i);
+        const phpVersionResponseResult = phpVersionResponse.match(/PHP\s(\d+\.\d+\.\d+)/i);
 
         if (phpVersionResponseResult && phpVersionResponseResult.length > 0) {
             const phpVersion = phpVersionResponseResult[1];
@@ -123,6 +123,8 @@ To fix that we will build special PHP version that will be used by PHPBrew, plea
                     );
                 }
             }
+
+            task.title = `Using PHP version ${phpVersion} in system`;
         }
     }
 });

package/lib/tasks/status/index.js

@@ -91,7 +91,7 @@ const prettyStatus = async (ctx) => {
             .addLine(`Image: ${logger.style.file(container.image)}`)
             .addLine(`Network: ${logger.style.link(container.network)}`);
 
-        if (container.ports.length > 0) {
+        if (container.ports && container.ports.length > 0) {
             block.addLine('Port forwarding:');
             container.ports.forEach((port) => {
                 const { host, hostPort, containerPort } = parsePort(port);

package/lib/tasks/theme/link-theme.js

@@ -1,6 +1,6 @@
 const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
-const disablePageCache = require('../magento/setup-magento/disable-page-cache');
+const disableFullPageCache = require('../magento/setup-magento/disable-full-page-cache');
 const disablePageBuilder = require('../magento/setup-magento/disable-page-builder');
 const buildTheme = require('./build-theme');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
@@ -53,7 +53,7 @@ const linkTheme = () => ({
             updateEnvPHP(),
             setupPersistedQuery(),
             upgradeMagento(),
-            disablePageCache(),
+            disableFullPageCache(),
             ...(isPageBuilderInstalled && Number(isPagebuilderEnabled) ? [disablePageBuilder()] : []),
             buildTheme(theme)
         ]);

package/lib/tasks/theme/setup-persisted-query.js

@@ -8,7 +8,7 @@ const runMagentoCommand = require('../../util/run-magento');
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const persistedQuerySetup = () => ({
-    title: 'Setting up redis configuration for persisted queries',
+    title: 'Setting up Redis configuration for persisted queries',
     task: async (ctx, task) => {
         const { ports, magentoVersion, verbose = false } = ctx;
         const composerLockData = await getJsonfileData(path.join(process.cwd(), 'composer.lock'));
@@ -29,8 +29,8 @@ const persistedQuerySetup = () => ({
         if (
             persistedQueryConfig
             && persistedQueryConfig.redis
-            && persistedQueryConfig.redis.port === ports.redis
-            && persistedQueryConfig.redis.localhost === 'localhost'
+            && persistedQueryConfig.redis.port === `${ ports.redis }`
+            && persistedQueryConfig.redis.host === 'localhost'
         ) {
             task.skip();
             return;

package/lib/tasks/theme/setup-themes.js

@@ -5,7 +5,7 @@ const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
 const setupPersistedQuery = require('./setup-persisted-query');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
-const disablePageCache = require('../magento/setup-magento/disable-page-cache');
+const disableFullPageCache = require('../magento/setup-magento/disable-full-page-cache');
 const buildTheme = require('./build-theme');
 
 /**
@@ -80,7 +80,7 @@ const setupThemes = () => ({
                 ])
             })).concat([
                 upgradeMagento(),
-                disablePageCache(),
+                disableFullPageCache(),
                 setupPersistedQuery()
             ])
         );

package/lib/util/config-file-validator.js

@@ -72,6 +72,15 @@ const nginxConfigurationSchema = Joi.object({
     configTemplate: Joi.string().optional().custom(fileExistsValidator)
 });
 
+/**
+ * @type {Joi.ObjectSchema<import('../../typings').NginxConfiguration>}
+ */
+const varnishConfigurationSchema = Joi.object({
+    enabled: Joi.boolean().optional(),
+    version: Joi.string().optional(),
+    configTemplate: Joi.string().optional().custom(fileExistsValidator)
+});
+
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ServiceWithVersion>}
  */
@@ -101,7 +110,8 @@ const configurationSchema = Joi.object({
     mysql: serviceConfigurationSchema.optional(),
     elasticsearch: serviceConfigurationSchema.optional(),
     redis: serviceConfigurationSchema.optional(),
-    composer: composerConfigurationSchema.optional()
+    composer: composerConfigurationSchema.optional(),
+    varnish: varnishConfigurationSchema.optional()
 });
 
 /**

package/lib/util/config-php-json.js

@@ -0,0 +1,19 @@
+const path = require('path');
+const runPhpCode = require('./run-php');
+
+const configPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
+    const { code, result } = await runPhpCode(`-r "echo json_encode(require '${path.join(projectPath, 'app', 'etc', 'config.php')}');"`, {
+        magentoVersion
+    });
+
+    if (code !== 0) {
+        throw new Error(result);
+    }
+    try {
+        return JSON.parse(result);
+    } catch (e) {
+        throw new Error(`Ooops! Something went wrong when trying to parse app/etc/config.php file!\n\n${e}\n\nFile result: ${result}`);
+    }
+};
+
+module.exports = configPhpToJson;

package/lib/util/php-task.js

@@ -1,7 +1,10 @@
 const runPhpCode = require('./run-php');
 
 /**
- * @type {(command: string, options: { noTitle: boolean }) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @type {(
+ * command: string,
+ * options: { noTitle: boolean, env: Record<string, string> }
+ * ) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const phpTask = (command, options = {}) => ({
     title: !options.noTitle ? `Running command 'php ${command}` : undefined,
@@ -10,7 +13,8 @@ const phpTask = (command, options = {}) => ({
             task.output = t;
         },
         throwNonZeroCode: true,
-        magentoVersion
+        magentoVersion,
+        env: options.env
     })
 });
 

package/lib/util/run-php.js

@@ -10,6 +10,7 @@ const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config
  * @param {() => {}} options.callback
  * @param {Boolean} options.throwNonZeroCode Throw if command return non 0 code.
  * @param {String} options.magentoVersion Magento version for config
+ * @param {Record<string, string>} options.env Environment variables
  */
 const runPhpCode = async (command, options = {}) => {
     const {
@@ -17,7 +18,12 @@ const runPhpCode = async (command, options = {}) => {
         magentoVersion = defaultConfiguration.magentoVersion
     } = options;
     const { php } = await getConfigFromMagentoVersion(magentoVersion);
-    const { code, result } = await execAsyncSpawn(`${php.binPath} -c ${php.iniPath} ${command}`, {
+    let spawnCommand = `${php.binPath} -c ${php.iniPath} ${command}`;
+    if (options.env && Object.keys(options.env).length > 0) {
+        const env = Object.entries(options.env).map(([key, value]) => `${key}=${value}`).join(' ');
+        spawnCommand = `${env} ${spawnCommand}`;
+    }
+    const { code, result } = await execAsyncSpawn(spawnCommand, {
         ...options,
         withCode: true
     });

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "1.14.1-alpha.3",
+    "version": "1.14.1-alpha.4",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -51,5 +51,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "262eae9eb5d71053f48d177426320182c5b5a9eb"
+    "gitHead": "41436e9871ef44477f79f93c751b5d7315de8187"
 }

package/typings/context.d.ts

@@ -12,6 +12,7 @@ export interface ListrContext {
         mysql: number
         redis: number
         elasticsearch: number
+        varnish: number
     }
     arch: 'arm64' | 'x64'
     isArm: boolean

package/typings/index.d.ts

@@ -21,6 +21,20 @@ export interface NginxConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
+export interface VarnishConfiguration extends ServiceWithVersion {
+    /**
+     * Enable or disable Varnish in the project
+     */
+    enabled: boolean
+
+    /**
+     * Configuration file location
+     *
+     * @example ./my-varnish-config.vcl
+     */
+    configTemplate: string
+}
+
 export interface PHPExtension extends Record<string, unknown> {
     version?: string
     /**
@@ -175,6 +189,11 @@ export interface CMAConfiguration {
          * Composer configuration
          */
         composer: ServiceWithVersion
+
+        /**
+         * Varnish configuration
+         */
+        varnish: VarnishConfiguration
     }
     /**
      * Magento configuration