@scandipwa/magento-scripts 1.14.1-alpha.2 → 1.14.1-alpha.5

package/lib/tasks/file-system/create-php-storm-config.js

@@ -0,0 +1,82 @@
+const setConfigFile = require('../../util/set-config');
+const pathExists = require('../../util/path-exists');
+const path = require('path');
+const fs = require('fs');
+
+const createPhpStormConfig = () => ({
+    title: 'Setting PHPStorm config',
+    task: async ({ config: { phpStorm }, ports }) => {
+        const { phpLanguageLevel } = phpStorm.php;
+        const jdbcUrl = `jdbc:mysql://localhost:${ports.mysql}/magento`;
+
+        try {
+            await setConfigFile({
+                configPathname: phpStorm.xdebug.path,
+                template: phpStorm.xdebug.templatePath,
+                overwrite: true,
+                templateArgs: {
+                    phpStorm
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during workspace.xml config creation\n\n${e}`);
+        }
+
+        try {
+            await setConfigFile({
+                configPathname: phpStorm.php.path,
+                template: phpStorm.php.templatePath,
+                overwrite: true,
+                templateArgs: {
+                    phpLanguageLevel
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during php.xml config creation\n\n${e}`);
+        }
+
+        try {
+            await setConfigFile({
+                configPathname: phpStorm.database.dataSourcesLocal.path,
+                template: phpStorm.database.dataSourcesLocal.templatePath,
+                overwrite: true,
+                templateArgs: {
+                    phpStorm
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during dataSources.local.xml config creation\n\n${e}`);
+        }
+
+        try {
+            await setConfigFile({
+                configPathname: phpStorm.database.dataSources.path,
+                template: phpStorm.database.dataSources.templatePath,
+                overwrite: true,
+                templateArgs: {
+                    phpStorm,
+                    jdbcUrl
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during dataSources.xml config creation\n\n${e}`);
+        }
+
+        if (!await pathExists(path.resolve('./.idea/dataSources'))) {
+            await fs.promises.mkdir(path.resolve('./.idea/dataSources'));
+        }
+
+        try {
+            await setConfigFile({
+                configPathname: phpStorm.inspectionTools.path,
+                template: phpStorm.inspectionTools.templatePath,
+                overwrite: true,
+                templateArgs: {}
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during Project_Default.xml config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createPhpStormConfig;

package/lib/tasks/file-system/create-varnish-config.js

@@ -0,0 +1,51 @@
+const os = require('os');
+const path = require('path');
+const setConfigFile = require('../../util/set-config');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createVarnishConfig = () => ({
+    title: 'Setting Varnish config',
+    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    task: async (ctx) => {
+        const {
+            ports,
+            config: {
+                overridenConfiguration,
+                baseConfig: {
+                    cacheDir
+                }
+            },
+            isWsl
+        } = ctx;
+
+        const {
+            configuration: {
+                varnish
+            }
+        } = overridenConfiguration;
+
+        const isLinux = os.platform() === 'linux';
+
+        try {
+            await setConfigFile({
+                configPathname: path.join(
+                    cacheDir,
+                    'varnish',
+                    'default.vcl'
+                ),
+                template: varnish.configTemplate,
+                overwrite: true,
+                templateArgs: {
+                    hostMachine: (isLinux && !isWsl) ? '127.0.0.1' : 'host.docker.internal',
+                    hostPort: (isLinux && !isWsl) ? ports.app : 80
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during varnish config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createVarnishConfig;

package/lib/tasks/file-system/index.js

@@ -1,7 +1,8 @@
 const createNginxConfig = require('./create-nginx-config');
 const createPhpConfig = require('./create-php-config');
 const createPhpFpmConfig = require('./create-php-fpm-config');
-const createPhpStormConfig = require('./create-phpstorm-config');
+const createPhpStormConfig = require('./create-php-storm-config');
+const createVarnishConfig = require('./create-varnish-config');
 const createVSCodeConfig = require('./create-vscode-config');
 
 /**
@@ -14,7 +15,8 @@ const prepareFileSystem = () => ({
         createPhpFpmConfig(),
         createPhpConfig(),
         createPhpStormConfig(),
-        createVSCodeConfig()
+        createVSCodeConfig(),
+        createVarnishConfig()
     ], {
         concurrent: true
     })

package/lib/tasks/magento/setup-magento/configure-elasticsearch.js

@@ -4,7 +4,7 @@ const { updateTableValues, isTableExists } = require('../../../util/database');
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
-    title: 'Configuring elasticsearch',
+    title: 'Configuring Elasticsearch',
     skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
     task: async ({ ports, mysqlConnection }, task) => {
         await updateTableValues('core_config_data', [

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,9 @@
 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>}
@@ -25,6 +24,7 @@ const migrateDatabase = (options = {}) => ({
 
         if (tableCount === 0) {
             if (options.onlyInstallMagento) {
+                ctx.isSetupUpgradeNeeded = false;
                 return task.newListr(
                     installMagento({ isDbEmpty: true })
                 );
@@ -32,14 +32,17 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento({ isDbEmpty: true }),
-                setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         const { code } = await runMagentoCommand('setup:db:status', {
@@ -49,18 +52,23 @@ const migrateDatabase = (options = {}) => ({
 
         switch (code) {
         case 0: {
+            ctx.isSetupUpgradeNeeded = false;
             // 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: {
             if (options.onlyInstallMagento) {
+                ctx.isSetupUpgradeNeeded = false;
                 return task.newListr(
                     installMagento()
                 );
@@ -68,26 +76,31 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento(),
-                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/upgrade-magento.js

@@ -4,9 +4,23 @@ const magentoTask = require('../../../util/magento-task');
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const upgradeMagento = () => ({
-    task: (ctx, task) => task.newListr(
-        magentoTask('setup:upgrade --no-interaction')
-    )
+    skip: (ctx) => {
+        if ('isSetupUpgradeNeeded' in ctx) {
+            return !ctx.isSetupUpgradeNeeded;
+        }
+
+        return false;
+    },
+    task: (_ctx, task) => task.newListr([
+        magentoTask('setup:upgrade --no-interaction'),
+        {
+            task: (ctx) => {
+                ctx.isSetupUpgradeNeeded = false;
+            }
+        }
+    ], {
+        concurrent: false
+    })
 });
 
 module.exports = upgradeMagento;

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/docker/index.js

@@ -4,6 +4,7 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const getIsWsl = require('../../../util/is-wsl');
 const installDocker = require('./install');
 const { checkDockerSocketPermissions } = require('./permissions');
+const checkDockerStatus = require('./running-status');
 const getDockerVersion = require('./version');
 
 /**
@@ -61,6 +62,7 @@ ${ logger.style.link('https://docs.create-magento-app.com/getting-started/prereq
         }
 
         return task.newListr([
+            checkDockerStatus(),
             getDockerVersion(),
             {
                 task: (ctx) => {