@scandipwa/magento-scripts 1.16.0-alpha.4 → 2.0.0-alpha.0

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

@@ -2,9 +2,10 @@ const path = require('path');
 const envPhpToJson = require('../../util/env-php-json');
 const getJsonfileData = require('../../util/get-jsonfile-data');
 const pathExists = require('../../util/path-exists');
-const phpTask = require('../../util/php-task');
+const { containerApi } = require('../docker/containers');
 
 const composerLockPath = path.join(process.cwd(), 'composer.lock');
+const envPhpPath = path.join(process.cwd(), 'app', 'etc', 'env.php');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
@@ -12,13 +13,19 @@ const updateEnvPHP = () => ({
     title: 'Updating env.php',
     task: async (ctx, task) => {
         // update env.php only if it's exist
-        if (!await pathExists(path.join(process.cwd(), 'app', 'etc', 'env.php'))) {
+        if (!await pathExists(envPhpPath)) {
             task.skip();
             return;
         }
 
-        const useVarnish = ctx.config.overridenConfiguration.configuration.varnish.enabled ? '1' : '';
-        const varnishHost = '127.0.0.1';
+        const { php } = ctx.config.docker.getContainers(ctx.ports);
+
+        const isLinux = ctx.platform === 'linux';
+        const isNativeLinux = isLinux && !ctx.isWsl;
+        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+
+        const useVarnish = (!ctx.debug && ctx.config.overridenConfiguration.configuration.varnish.enabled) ? '1' : '';
+        const varnishHost = hostMachine;
         const varnishPort = ctx.ports.varnish;
         const previousVarnishPort = ctx.cachedPorts
             ? ctx.cachedPorts.varnish
@@ -34,7 +41,7 @@ const updateEnvPHP = () => ({
                     ctx.CSAThemeInstalled = true;
                 }
 
-                const envPhp = await envPhpToJson(process.cwd(), { magentoVersion: ctx.magentoVersion });
+                const envPhp = await envPhpToJson(ctx);
 
                 const persistedQueryConfig = envPhp.cache && envPhp.cache['persisted-query'];
 
@@ -50,20 +57,29 @@ const updateEnvPHP = () => ({
             }
         }
 
-        return task.newListr(
-            phpTask(`-f ${ path.join(__dirname, 'update-env.php') }`, {
-                noTitle: true,
-                env: {
-                    USE_VARNISH: useVarnish,
-                    VARNISH_PORT: `${ varnishPort }`,
-                    VARNISH_HOST: varnishHost,
-                    PREVIOUS_VARNISH_PORT: `${ previousVarnishPort }`,
-                    SETUP_PQ,
-                    REDIS_PORT: ctx.ports.redis,
-                    ADMIN_URI: ctx.config.overridenConfiguration.magento.adminuri
-                }
-            })
-        );
+        const result = await containerApi.run({
+            env: {
+                USE_VARNISH: useVarnish,
+                VARNISH_PORT: `${ varnishPort }`,
+                VARNISH_HOST: varnishHost,
+                PREVIOUS_VARNISH_PORT: `${ previousVarnishPort }`,
+                SETUP_PQ,
+                REDIS_PORT: ctx.ports.redis,
+                ADMIN_URI: ctx.config.overridenConfiguration.magento.adminuri,
+                HOST_MACHINE: hostMachine,
+                PORTS: JSON.stringify(ctx.ports)
+            },
+            command: 'php ./update-env-php.php',
+            mountVolumes: [
+                `${path.join(__dirname, 'update-env.php')}:${ctx.config.baseConfig.containerMagentoDir}/update-env-php.php`,
+                `${envPhpPath}:/${ctx.config.baseConfig.containerMagentoDir}/env.php`
+            ],
+            image: php.image,
+            detach: false,
+            rm: true
+        });
+
+        task.output = result;
     }
 });
 

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

@@ -3,9 +3,9 @@
 function varexport($expression, $return=false): string
 {
     $export = var_export($expression, true);
-    $export = preg_replace("/^([ ]*)(.*)/m", '$1$1$2', $export);
+    $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;
@@ -19,12 +19,12 @@ function joinpaths(): string
     $paths = array();
 
     foreach (func_get_args() as $arg) {
-        if ($arg !== '') {
+        if ($arg !== "") {
             $paths[] = $arg;
         }
     }
 
-    return preg_replace('#/+#', '/', join('/', $paths));
+    return preg_replace("#/+#", "/", join("/", $paths));
 }
 
 class EnvUpdater
@@ -42,7 +42,7 @@ class EnvUpdater
 
     public function loadConfig()
     {
-        $this->config = require './app/etc/env.php';
+        $this->config = require "./env.php";
     }
 
     /**
@@ -63,14 +63,14 @@ class EnvUpdater
 
     public function loadPortConfig()
     {
-        $portConfigContent = file_get_contents('./node_modules/.create-magento-app-cache/port-config.json');
+        $portConfigContent = getenv("PORTS");
         if ($portConfigContent === false) {
-            throw new Error('Port config file does not exists in cache directory');
+            throw new Error("Ports env does not exists");
         }
 
         $portConfigJsonData = json_decode($portConfigContent, true);
         if ($portConfigJsonData === null) {
-            throw new Error('Port config file is not content');
+            throw new Error("Ports env is not parseable");
         }
 
         $this->portConfig = $portConfigJsonData;
@@ -79,91 +79,96 @@ class EnvUpdater
     public function modifyConfig()
     {
         // set admin uri
-        $this->config['backend']['frontName'] = getenv('ADMIN_URI');
+        $this->config["backend"]["frontName"] = getenv("ADMIN_URI");
+        $hostMachine = getenv("HOST_MACHINE");
+        if ($hostMachine === false) {
+            $hostMachine = '127.0.0.1';
+        }
 
         // update mysql config
-        if (isset($this->config['db']['connection']['default'])) {
-            $conn = &$this->config['db']['connection']['default'];
+        if (isset($this->config["db"]["connection"]["default"])) {
+            $conn = &$this->config["db"]["connection"]["default"];
+            $mysqlHost = $hostMachine . ":" . $this->portConfig["mysql"];
             if (
-                isset($conn['engine']) &&
-                isset($conn['host']) &&
-                $conn['engine'] === 'innodb' &&
-                $conn['host'] !== '127.0.0.1:' . $this->portConfig['mysql']
+                isset($conn["engine"]) &&
+                isset($conn["host"]) &&
+                $conn["engine"] === "innodb" &&
+                $conn["host"] !== $mysqlHost
             ) {
-                $conn['host'] = '127.0.0.1:' . $this->portConfig['mysql'];
+                $conn["host"] = $mysqlHost;
             }
         }
 
         // update redis session config
         if (
-            isset($this->config['session']) &&
-            $this->config['session']['save'] === 'redis' &&
-            $this->config['session']['redis']['port'] !== strval($this->portConfig['redis'])
+            isset($this->config["session"]) &&
+            $this->config["session"]["save"] === "redis" &&
+            $this->config["session"]["redis"]["port"] !== strval($this->portConfig["redis"])
         ) {
-            $this->config['session']['redis']['port'] = strval($this->portConfig['redis']);
+            $this->config["session"]["redis"]["port"] = strval($this->portConfig["redis"]);
         }
 
         if (
-            isset($this->config['session']) &&
-            $this->config['session']['save'] === 'redis' &&
-            $this->config['session']['redis']['host'] !== '127.0.0.1'
+            isset($this->config["session"]) &&
+            $this->config["session"]["save"] === "redis" &&
+            $this->config["session"]["redis"]["host"] !== $hostMachine
         ) {
-            $this->config['session']['redis']['host'] = '127.0.0.1';
+            $this->config["session"]["redis"]["host"] = $hostMachine;
         }
 
         // update redis frontend config
-        if (isset($this->config['cache']['frontend']['default'])) {
-            $frontendCache = &$this->config['cache']['frontend']['default'];
-            if ($frontendCache['backend_options']['port'] !== strval($this->portConfig['redis'])) {
-                $frontendCache['backend_options']['port'] = strval($this->portConfig['redis']);
+        if (isset($this->config["cache"]["frontend"]["default"])) {
+            $frontendCache = &$this->config["cache"]["frontend"]["default"];
+            if ($frontendCache["backend_options"]["port"] !== strval($this->portConfig["redis"])) {
+                $frontendCache["backend_options"]["port"] = strval($this->portConfig["redis"]);
             }
-            if ($frontendCache['backend_options']['server'] !== '127.0.0.1') {
-                $frontendCache['backend_options']['server'] = '127.0.0.1';
+            if ($frontendCache["backend_options"]["server"] !== $hostMachine) {
+                $frontendCache["backend_options"]["server"] = $hostMachine;
             }
         }
 
         // update persisted query redis config
-        if (getenv('SETUP_PQ') == '1') {
-            $cacheConfig = &$this->config['cache'];
-            $redisPort = getenv('REDIS_PORT');
+        if (getenv("SETUP_PQ") == "1") {
+            $cacheConfig = &$this->config["cache"];
+            $redisPort = getenv("REDIS_PORT");
 
-            if (isset($cacheConfig) && isset($cacheConfig['persisted-query']) && isset($cacheConfig['persisted-query']['redis']) && $cacheConfig['persisted-query']['redis']['port'] != $redisPort) {
-                $cacheConfig['persisted-query']['redis']['port'] = $redisPort;
+            if (isset($cacheConfig) && isset($cacheConfig["persisted-query"]) && isset($cacheConfig["persisted-query"]["redis"]) && $cacheConfig["persisted-query"]["redis"]["port"] != $redisPort) {
+                $cacheConfig["persisted-query"]["redis"]["port"] = $redisPort;
             } else {
                 if (!isset($cacheConfig)) {
-                    $this->config['cache'] = [];
+                    $this->config["cache"] = [];
                 }
-                $this->config['cache']['persisted-query'] = [
-                    'redis' => [
-                        'host' => 'localhost',
-                        'port' => $redisPort,
-                        'database' => '5',
-                        'scheme' => 'tcp'
+                $this->config["cache"]["persisted-query"] = [
+                    "redis" => [
+                        "host" => $hostMachine,
+                        "port" => $redisPort,
+                        "database" => "5",
+                        "scheme" => "tcp"
                     ]
                 ];
             }
         } else {
-            unset($this->config['cache']['persisted-query']);
+            unset($this->config["cache"]["persisted-query"]);
         }
 
         // set varnish config
-        $httpCacheHosts = &$this->config['http_cache_hosts'];
+        $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');
+        if (getenv("USE_VARNISH") == "1") {
+            $varnishHost = getenv("VARNISH_HOST");
+            $varnishPort = getenv("VARNISH_PORT");
+            $previousVarnishPort = getenv("PREVIOUS_VARNISH_PORT");
             $varnishConfig = [
-                'host' => $varnishHost,
-                'port' => $varnishPort
+                "host" => $varnishHost,
+                "port" => $varnishPort
             ];
 
             if (isset($httpCacheHosts)) {
                 $varnishHostExists = false;
                 foreach ($httpCacheHosts as $host) {
-                    if ($host['host'] == $varnishHost && $host['port'] == $previousVarnishPort) {
-                        $host['port'] = $varnishPort;
+                    if ($host["host"] == $varnishHost && $host["port"] == $previousVarnishPort) {
+                        $host["port"] = $varnishPort;
                         $varnishHostExists = true;
                         break;
                     }
@@ -173,10 +178,10 @@ class EnvUpdater
                     $httpCacheHosts = [$varnishConfig];
                 }
             } else {
-                $this->config['http_cache_hosts'] = [$varnishConfig];
+                $this->config["http_cache_hosts"] = [$varnishConfig];
             }
         } else {
-            unset($this->config['http_cache_hosts']);
+            unset($this->config["http_cache_hosts"]);
         }
     }
 
@@ -184,7 +189,7 @@ class EnvUpdater
     {
         file_put_contents(
             $filePath,
-            '<?php'.PHP_EOL.'return '.varexport($this->config, true).';' . PHP_EOL
+            "<?php".PHP_EOL."return ".varexport($this->config, true).";" . PHP_EOL
         );
     }
 
@@ -193,7 +198,7 @@ class EnvUpdater
         $this->loadConfig();
         $this->loadPortConfig();
         $this->modifyConfig();
-        $this->saveConfig(joinpaths(getcwd(), './app/etc/env.php'));
+        $this->saveConfig("./env.php");
     }
 }
 

package/lib/tasks/php/working_health_check.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\Framework\Config\ConfigOptionsListConstants;
+
+register_shutdown_function("fatalErrorHandler");
+
+try {
+    // phpcs:ignore Magento2.Security.IncludeFile
+    require __DIR__ . '/../app/bootstrap.php';
+    /** @var \Magento\Framework\App\ObjectManagerFactory $objectManagerFactory */
+    $objectManagerFactory = \Magento\Framework\App\Bootstrap::createObjectManagerFactory(BP, []);
+    /** @var \Magento\Framework\ObjectManagerInterface $objectManager */
+    $objectManager = $objectManagerFactory->create([]);
+    /** @var \Magento\Framework\App\DeploymentConfig $deploymentConfig */
+    $deploymentConfig = $objectManager->get(\Magento\Framework\App\DeploymentConfig::class);
+    /** @var \Psr\Log\LoggerInterface $logger */
+    $logger = $objectManager->get(\Psr\Log\LoggerInterface::class);
+} catch (\Exception $e) {
+    http_response_code(500);
+    // phpcs:ignore Magento2.Security.LanguageConstruct
+    exit(1);
+}
+
+// check mysql connectivity
+foreach ($deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTIONS) as $connectionData) {
+    try {
+        /** @var \Magento\Framework\DB\Adapter\Pdo\Mysql $dbAdapter */
+        $dbAdapter = $objectManager->create(
+            \Magento\Framework\DB\Adapter\Pdo\Mysql::class,
+            ['config' => $connectionData]
+        );
+        $dbAdapter->getConnection();
+    } catch (\Exception $e) {
+        http_response_code(500);
+        $logger->error("MySQL connection failed: " . $e->getMessage());
+        // phpcs:ignore Magento2.Security.LanguageConstruct
+        exit(1);
+    }
+}
+// check cache storage availability
+$cacheConfigs = $deploymentConfig->get(ConfigOptionsListConstants::KEY_CACHE_FRONTEND);
+if ($cacheConfigs) {
+    foreach ($cacheConfigs as $cacheConfig) {
+        // allow config if only available "id_prefix"
+        if (count($cacheConfig) === 1 && isset($cacheConfig['id_prefix'])) {
+            continue;
+        } elseif (!isset($cacheConfig[ConfigOptionsListConstants::CONFIG_PATH_BACKEND]) ||
+            !isset($cacheConfig[ConfigOptionsListConstants::CONFIG_PATH_BACKEND_OPTIONS])) {
+            http_response_code(500);
+            $logger->error("Cache configuration is invalid");
+            // phpcs:ignore Magento2.Security.LanguageConstruct
+            exit(1);
+        }
+        $cacheBackendClass = $cacheConfig[ConfigOptionsListConstants::CONFIG_PATH_BACKEND];
+        try {
+            /** @var \Magento\Framework\App\Cache\Frontend\Factory $cacheFrontendFactory */
+            $cacheFrontendFactory = $objectManager->get(Magento\Framework\App\Cache\Frontend\Factory::class);
+            /** @var \Zend_Cache_Backend_Interface $backend */
+            $backend = $cacheFrontendFactory->create($cacheConfig);
+            $backend->test('test_cache_id');
+        } catch (\Exception $e) {
+            http_response_code(500);
+            $logger->error("Cache storage is not accessible");
+            // phpcs:ignore Magento2.Security.LanguageConstruct
+            exit(1);
+        }
+    }
+}
+
+/**
+ * Handle any fatal errors
+ *
+ * @return void
+ */
+function fatalErrorHandler()
+{
+    $error = error_get_last();
+    if ($error !== null && $error['type'] === E_ERROR) {
+        http_response_code(500);
+    }
+}

package/lib/tasks/requirements/{composer.js → composer-credentials.js}

@@ -279,4 +279,6 @@ Error message that we got: ${e}`
     }
 });
 
-module.exports = checkComposerCredentials;
+module.exports = {
+    checkComposerCredentials
+};

package/lib/tasks/requirements/docker/index.js

@@ -4,10 +4,21 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const openBrowser = require('../../../util/open-browser');
 const installDocker = require('./install');
 const installDockerOnMac = require('./install-on-mac');
+const { checkDockerPerformance } = require('./performance');
 const { checkDockerSocketPermissions } = require('./permissions');
 const checkDockerStatus = require('./running-status');
 const getDockerVersion = require('./version');
 
+const setVersionInContextTask = (task) => ({
+    task: (ctx) => {
+        if (ctx.platform === 'darwin' && ctx.dockerServerData && ctx.dockerServerData.Platform && ctx.dockerServerData.Platform.Name) {
+            task.title = `Using ${ctx.dockerServerData.Platform.Name} for Mac`;
+        } else {
+            task.title = `Using Docker version ${ctx.dockerVersion}`;
+        }
+    }
+});
+
 const dockerInstallPromptLinux = async (task) => {
     const automaticallyInstallDocker = await task.prompt({
         type: 'Confirm',
@@ -47,7 +58,6 @@ ${ logger.style.link('https://docs.create-magento-app.com/getting-started/prereq
 };
 
 /**
- *
  * @param {import('listr2').ListrTaskWrapper} task
  */
 const dockerInstallPromptMacOS = async (task) => {
@@ -72,11 +82,7 @@ Would you like to install it automatically using brew cask or you prefer to inst
             installDockerOnMac(),
             checkDockerStatus(),
             getDockerVersion(),
-            {
-                task: (ctx) => {
-                    task.title = `Using Docker version ${ctx.dockerVersion}`;
-                }
-            }
+            setVersionInContextTask(task)
         ]);
     }
 
@@ -118,11 +124,7 @@ const checkDocker = () => ({
         return task.newListr([
             checkDockerStatus(),
             getDockerVersion(),
-            {
-                task: (ctx) => {
-                    task.title = `Using Docker version ${ctx.dockerVersion}`;
-                }
-            }
+            setVersionInContextTask(task)
         ]);
     }
 });
@@ -133,7 +135,8 @@ const checkDocker = () => ({
 module.exports = () => ({
     task: (ctx, task) => task.newListr([
         checkDockerSocketPermissions(),
-        checkDocker()
+        checkDocker(),
+        checkDockerPerformance()
     ], {
         concurrent: false
     })

package/lib/tasks/requirements/docker/performance.js

@@ -0,0 +1,54 @@
+const os = require('os');
+const path = require('path');
+const semver = require('semver');
+const getJsonfileData = require('../../../util/get-jsonfile-data');
+const pathExists = require('../../../util/path-exists');
+
+const dockerSettingsJsonPath = path.join(
+    os.homedir(),
+    'Library',
+    'Group Containers',
+    'group.com.docker',
+    'settings.json'
+);
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const checkDockerPerformance = () => ({
+    title: 'Checking Docker Performance',
+    // eslint-disable-next-line no-return-await
+    skip: async (ctx) => ctx.platform !== 'darwin' || (ctx.platform === 'darwin' && !(await pathExists(dockerSettingsJsonPath))),
+    task: async (ctx, task) => {
+        const dockerSettings = await getJsonfileData(dockerSettingsJsonPath);
+
+        if (!dockerSettings) {
+            task.skip();
+            return;
+        }
+
+        const dockerForMacVersionMatch = ctx.dockerServerData.Platform.Name.match(/(\d+\.\d+\.\d+)/i);
+
+        const dockerForMacVersion = dockerForMacVersionMatch && dockerForMacVersionMatch[1];
+
+        if (ctx.arch === 'arm64'
+        && semver.gt('12.2.0', ctx.platformVersion)
+        && semver.gt(dockerForMacVersion, '4.6.0')) {
+            if (!dockerSettings.useVirtualizationFrameworkVirtioFS) {
+                task.title = 'Performance is not optimal. VirtioFS is not enabled.';
+            }
+        }
+
+        if (ctx.arch === 'x64'
+        && semver.gt('12.3.0', ctx.platformVersion)
+        && semver.gt(dockerForMacVersion, '4.6.0')) {
+            if (!dockerSettings.useVirtualizationFrameworkVirtioFS) {
+                task.title = 'Performance is not optimal. VirtioFS is not enabled.';
+            }
+        }
+    }
+});
+
+module.exports = {
+    checkDockerPerformance
+};

package/lib/tasks/requirements/docker/version.js

@@ -1,21 +1,21 @@
 const UnknownError = require('../../../errors/unknown-error');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { version } = require('../../docker/api');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const getDockerVersion = () => ({
     task: async (ctx) => {
-        const { result, code } = await execAsyncSpawn('docker version --format {{.Server.Version}}', {
-            withCode: true
+        const dockerVersion = await version({
+            formatToJSON: true
         });
 
-        if (code === 0) {
-            const dockerVersion = result.split('').filter((c) => /[\d.]/i.test(c)).join('') || result;
-
-            ctx.dockerVersion = dockerVersion;
+        if (dockerVersion) {
+            ctx.dockerServerData = dockerVersion.Server;
+            ctx.dockerClientData = dockerVersion.Client;
+            ctx.dockerVersion = dockerVersion.Server.Version;
         } else {
-            throw new UnknownError(`Got unexpected result during Docker version retrieval!\n\n${ result }`);
+            throw new UnknownError(`Got unexpected result during Docker version retrieval!\n\n${ dockerVersion }`);
         }
     }
 });

package/lib/tasks/requirements/index.js

@@ -1,9 +1,8 @@
 const checkPlatform = require('./platform');
-const checkPHPbrew = require('./phpbrew');
-const checkComposer = require('./composer');
+const { checkComposerCredentials } = require('./composer-credentials');
+const localAuthJson = require('../composer/local-auth-json');
 const checkDocker = require('./docker');
 const checkNodeVersion = require('./node-version');
-const checkPHPVersion = require('./php-version');
 const checkRosetta = require('./rosetta');
 
 /**
@@ -12,21 +11,19 @@ const checkRosetta = require('./rosetta');
 const checkRequirements = () => ({
     title: 'Checking requirements',
     task: (ctx, task) => task.newListr([
-        // checking if user is on supported platform
-        checkPlatform(),
         // check if rosetta 2 is installed or not on m1 macs
         checkRosetta(),
+        // 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(),
+        // checkPHPVersion(),
         // check for COMPOSER_AUTH or auth.json
-        // localAuthJson(),
-        checkComposer()
+        localAuthJson(),
+        checkComposerCredentials()
     ], {
         concurrent: false,
         exitOnError: true,