@scandipwa/magento-scripts 1.14.1-alpha.1 → 1.14.1-alpha.12

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,50 @@ 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];
+            }
+        } else {
+            unset($this->config['http_cache_hosts']);
+        }
     }
 
-    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/php/update-phpbrew.js

@@ -1,3 +1,4 @@
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 
 /**
@@ -7,7 +8,9 @@ const updatePhpBrew = () => ({
     title: 'Updating PHPBrew PHP versions',
     task: async ({ config: { php } }, task) => {
         try {
-            const knownPhpVersions = await execAsyncSpawn('phpbrew known');
+            const knownPhpVersions = await execAsyncSpawn('phpbrew known', {
+                useRosetta2: true
+            });
 
             if (knownPhpVersions.includes(`${php.version}`)) {
                 task.skip();
@@ -17,10 +20,11 @@ const updatePhpBrew = () => ({
             await execAsyncSpawn('phpbrew known --update', {
                 callback: (t) => {
                     task.output = t;
-                }
+                },
+                useRosetta2: true
             });
         } catch (e) {
-            throw new Error(`Unexpected error while updating phpbrew known php versions\n\n${e}`);
+            throw new UnknownError(`Unexpected error while updating phpbrew known php versions\n\n${e}`);
         }
     },
     options: {

package/lib/tasks/php/validate-php.js

@@ -0,0 +1,67 @@
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const { bundledExtensions } = require('./bundled-extensions');
+const configurePHP = require('./configure');
+const { getEnabledExtensions } = require('./extensions');
+const { installPhp } = require('./index');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const validatePHPInstallation = () => ({
+    title: 'Validating PHP installation',
+    task: async (ctx, task) => {
+        const enabledExtensions = await getEnabledExtensions(ctx.config);
+        const enabledExtensionsKeys = Object.keys(enabledExtensions);
+
+        enabledExtensionsKeys.push('fpm');
+
+        if (enabledExtensionsKeys.some((ext) => ext.includes('mysql'))) {
+            enabledExtensionsKeys.push('mysql');
+        }
+
+        const missingBundledExtensions = bundledExtensions.filter(
+            (ext) => !enabledExtensionsKeys.some(
+                (ex) => ex.toLowerCase() === ext.toLowerCase()
+            )
+        );
+
+        if (missingBundledExtensions.length > 0) {
+            const selectedOption = await task.prompt({
+                type: 'Select',
+                message: `Your PHP version compiled by PHPBrew is missing important extensions that are bundled by default by ${logger.style.misc('magento-scripts')}
+Maybe you ran PHPBrew by yourself?
+
+Please, consider recompiling PHP using ${logger.style.misc('magento-scripts')}.
+
+${logger.style.command('npm start -- --recompile-php')}
+`,
+                choices: [
+                    {
+                        name: 'recompile-php',
+                        message: `I want ${logger.style.misc('magento-scripts')} to recompile PHP`
+                    },
+                    {
+                        name: 'skip',
+                        message: 'I am sure that it is okay and want to continue with this setup'
+                    }
+                ]
+            });
+
+            if (selectedOption === 'skip') {
+                task.skip('User skipped PHP recompilation');
+                return;
+            }
+
+            ctx.recompilePhp = true;
+
+            return task.newListr([
+                installPhp(),
+                configurePHP()
+            ], {
+                concurrent: false
+            });
+        }
+    }
+});
+
+module.exports = validatePHPInstallation;

package/lib/tasks/php-fpm/start-php-fpm.js

@@ -2,6 +2,7 @@ const { execAsyncSpawn } = require('../../util/exec-async-command');
 const getPhpConfig = require('../../config/php-config');
 const { getBaseConfig } = require('../../config/index');
 const getProcessId = require('./get-process-id');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -31,11 +32,12 @@ const startPhpFpm = () => ({
                 {
                     callback: (t) => {
                         task.output = t;
-                    }
+                    },
+                    useRosetta2: true
                 }
             );
         } catch (e) {
-            throw new Error(`Error during PHP-FPM start\n\n${e}`);
+            throw new UnknownError(`Error during PHP-FPM start\n\n${e}`);
         }
     },
     options: {

package/lib/tasks/requirements/composer.js

@@ -3,6 +3,8 @@ const fs = require('fs');
 const os = require('os');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const pathExists = require('../../util/path-exists');
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
 
 const authJsonPath = path.join(process.cwd(), 'auth.json');
 const shellName = process.env.SHELL.split('/').pop();
@@ -86,8 +88,8 @@ ${ logger.style.misc('Password') } (${ logger.style.misc('Private key') }):`,
         const authContent = {
             'http-basic': {
                 'repo.magento.com': {
-                    username: usernameCredentials,
-                    password: passwordCredentials
+                    username: usernameCredentials.trim(),
+                    password: passwordCredentials.trim()
                 }
             }
         };
@@ -112,7 +114,7 @@ ${ logger.style.misc('Password') } (${ logger.style.misc('Private key') }):`,
             break;
         }
         default: {
-            throw new Error(
+            throw new KnownError(
                 `Unfortunately we cannot automatically add credentials for your shell ${process.env.SHELL}!
 
 You will need to that manually!
@@ -195,7 +197,7 @@ Would you like to load them now?`
 
                 process.env.COMPOSER_AUTH = composerAuthFileContent;
             } catch (e) {
-                throw new Error(
+                throw new UnknownError(
                     `We found an error in your ${ logger.style.file('./auth.json') } file.
 
 Make sure that this file contains a valid JSON!
@@ -211,7 +213,7 @@ Error message that we got: ${e}`
             try {
                 composerAuthContent = JSON.parse(process.env.COMPOSER_AUTH);
             } catch (e) {
-                throw new Error(
+                throw new UnknownError(
                     `We found an error in your ${ logger.style.misc('$COMPOSER_AUTH') } environment variable.
 
 Make sure that this variable contains a valid JSON!

package/lib/tasks/requirements/dependency/arch.js

@@ -1,4 +1,5 @@
 const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
+const UnknownError = require('../../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
 
@@ -15,7 +16,7 @@ const archDependenciesCheck = () => ({
                 const result = pkg.match(pkgRegex);
 
                 if (!result) {
-                    throw new Error(`Package without a version!\n\n${pkg}\n\nHOW?`);
+                    throw new UnknownError(`Package without a version!\n\n${pkg}\n\nHOW?`);
                 }
 
                 return result[1];

package/lib/tasks/requirements/dependency/centos.js

@@ -11,9 +11,10 @@ const centosDependenciesCheck = () => ({
         const installedDependencies = (await execAsyncSpawn('yum list installed')).split('\n')
             .filter((pkg) => !pkg.toLowerCase().includes('installed packages'))
             .map((pkg) => pkg.match(/^(\S+)/i))
-            .filter((pkg) => pkg)
+            .filter(Boolean)
             .map((pkg) => pkg[1])
             .map((pkg) => pkg.match(/^(\S+)\.\S+/i))
+            .filter(Boolean)
             .map((pkg) => pkg[1]);
 
         const dependenciesToInstall = dependenciesForPlatforms

package/lib/tasks/requirements/dependency/fedora.js

@@ -11,9 +11,10 @@ const fedoraDependenciesCheck = () => ({
         const installedDependencies = (await execAsyncSpawn('yum list installed')).split('\n')
             .filter((pkg) => !pkg.toLowerCase().includes('installed packages'))
             .map((pkg) => pkg.match(/^(\S+)/i))
-            .filter((pkg) => pkg)
+            .filter(Boolean)
             .map((pkg) => pkg[1])
             .map((pkg) => pkg.match(/^(\S+)\.\S+/i))
+            .filter(Boolean)
             .map((pkg) => pkg[1]);
 
         const dependenciesToInstall = dependenciesForPlatforms

package/lib/tasks/requirements/dependency/mac.js

@@ -1,14 +1,28 @@
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
+const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const {
+    BREW_BIN_PATH_ARM_NATIVE,
+    BREW_BIN_PATH_ARM_ROSETTA,
+    getBrewCommand
+} = require('../../../util/get-brew-bin-path');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
-
+const pathExists = require('../../../util/path-exists');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const macDependenciesCheck = () => ({
     title: 'Checking MacOS dependencies',
     task: async (ctx, task) => {
-        const installedDependencies = (await execAsyncSpawn('brew list')).split('\n');
+        if (ctx.arch === 'arm64') {
+            if (!await pathExists(BREW_BIN_PATH_ARM_ROSETTA) && await pathExists(BREW_BIN_PATH_ARM_NATIVE)) {
+                throw new KnownError(`Missing rosetta brew!
+Please make sure that you have installed brew in rosetta2 terminal!
+Follow the instructions: ${logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos/installation-on-macos-apple-silicon')}`);
+            }
+        }
+        const installedDependencies = (await execAsyncSpawn(`${await getBrewCommand()} list`)).split('\n');
 
         const dependenciesToInstall = dependenciesForPlatforms
             .darwin
@@ -19,7 +33,8 @@ const macDependenciesCheck = () => ({
             return task.newListr(
                 installDependenciesTask({
                     platform: 'darwin',
-                    dependenciesToInstall
+                    dependenciesToInstall,
+                    useMacNativeEnvironment: false
                 })
             );
         }

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

@@ -1,11 +1,94 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const os = require('os');
+const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const getIsWsl = require('../../../util/is-wsl');
+const openBrowser = require('../../../util/open-browser');
 const installDocker = require('./install');
+const installDockerOnMac = require('./install-on-mac');
 const { checkDockerSocketPermissions } = require('./permissions');
+const checkDockerStatus = require('./running-status');
 const getDockerVersion = require('./version');
 
+const dockerInstallPromptLinux = async (task) => {
+    const automaticallyInstallDocker = await task.prompt({
+        type: 'Confirm',
+        message: `You don't have Docker installed!
+Do you want to install it automatically?
+NOTE: After installation it's recommended to log out and log back in so your group membership is re-evaluated!`
+    });
+
+    if (automaticallyInstallDocker) {
+        return task.newListr([
+            installDocker(),
+            getDockerVersion(),
+            {
+                task: (ctx) => {
+                    task.title = `Using docker version ${ctx.dockerVersion}`;
+
+                    throw new KnownError(
+                        `Docker is installed successfully!
+Please log out and log back to so your group membership is re-evaluated!
+Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/linux-postinstall/') }`
+                    );
+                }
+            }
+        ]);
+    }
+
+    throw new KnownError('Docker is not installed!');
+};
+
+// maybe in the future docker will be possible to install on wsl from terminal...
+const dockerInstallPromptWindows = () => {
+    throw new KnownError(
+        `You don't have Docker installed!
+Follow this instructions to install Docker on Windows:
+${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements#2-install-docker-desktop-for-windows') }`
+    );
+};
+
+/**
+ *
+ * @param {import('listr2').ListrTaskWrapper} task
+ */
+const dockerInstallPromptMacOS = async (task) => {
+    const confirmationToInstallDocker = await task.prompt({
+        type: 'Select',
+        message: `You don't have Docker installed!
+Would you like to install it automatically using brew cask or you prefer to install it manually?`,
+        choices: [
+            {
+                name: 'automatic',
+                message: 'Install Docker using brew cask'
+            },
+            {
+                name: 'manually',
+                message: 'Install Docker manually'
+            }
+        ]
+    });
+
+    if (confirmationToInstallDocker === 'automatic') {
+        return task.newListr([
+            installDockerOnMac(),
+            checkDockerStatus(),
+            getDockerVersion(),
+            {
+                task: (ctx) => {
+                    task.title = `Using Docker version ${ctx.dockerVersion}`;
+                }
+            }
+        ]);
+    }
+
+    const dockerInstallLink = 'https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos#3.-install-docker-for-mac';
+    await openBrowser(dockerInstallLink);
+
+    throw new KnownError(
+        `Follow this instructions to install Docker on Mac:
+${ logger.style.link(dockerInstallLink) }`
+    );
+};
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -17,50 +100,23 @@ const checkDocker = () => ({
         });
 
         if (code !== 0) {
-            const isWsl = await getIsWsl();
-            if (os.platform() === 'linux' && !isWsl) {
-                const automaticallyInstallDocker = await task.prompt({
-                    type: 'Confirm',
-                    message: `You don't have Docker installed!
-Do you want to install it automatically?
-NOTE: After installation it's recommended to log out and log back in so your group membership is re-evaluated!`
-                });
-
-                if (automaticallyInstallDocker) {
-                    return task.newListr([
-                        installDocker(),
-                        getDockerVersion(),
-                        {
-                            task: (ctx) => {
-                                task.title = `Using docker version ${ctx.dockerVersion}`;
-
-                                throw new Error(
-                                    `Docker is installed successfully!
-Please log out and log back to so your group membership is re-evaluated!
-Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/linux-postinstall/') }`
-                                );
-                            }
-                        }
-                    ]);
+            if (ctx.platform === 'linux' && !ctx.isWsl) {
+                const result = await dockerInstallPromptLinux(task);
+                if (result) {
+                    return result;
                 }
-
-                throw new Error('Docker is not installed!');
-            } else if (isWsl) {
-                throw new Error(
-                    `You don't have Docker installed!
-Follow this instructions to install Docker on Windows:
-${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements#2-install-docker-desktop-for-windows') }`
-                );
+            } else if (ctx.isWsl) {
+                dockerInstallPromptWindows();
             } else {
-                throw new Error(
-                    `You don't have Docker installed!
-Follow this instructions to install Docker on Mac:
-${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos#3-install-docker-for-mac') }`
-                );
+                const result = await dockerInstallPromptMacOS(task);
+                if (result) {
+                    return result;
+                }
             }
         }
 
         return task.newListr([
+            checkDockerStatus(),
             getDockerVersion(),
             {
                 task: (ctx) => {

package/lib/tasks/requirements/docker/install-on-mac.js

@@ -0,0 +1,29 @@
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { getBrewCommand } = require('../../../util/get-brew-bin-path');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const installDockerOnMac = () => ({
+    title: 'Installing Docker on Mac OS',
+    task: async (ctx, task) => {
+        const interval = !ctx.verbose ? setInterval(() => {
+            task.output = `Installing Docker on Mac... Yep, still in progress ${new Date().toUTCString()}`;
+        }, 5000) : null;
+
+        await execAsyncSpawn(`${await getBrewCommand({ native: true })} install --cask docker`, {
+            callback: !ctx.verbose ? undefined : (t) => {
+                task.output = t;
+            }
+        });
+
+        if (!ctx.verbose) {
+            clearInterval(interval);
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = installDockerOnMac;

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

@@ -2,6 +2,11 @@ const osPlatform = require('../../../util/os-platform');
 const { execCommandTask } = require('../../../util/exec-async-command');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
 const executeSudoCommand = require('../../../util/execute-sudo-command');
+const KnownError = require('../../../errors/known-error');
+
+const downloadDockerInstallScriptCommand = () => execCommandTask('curl -fsSL https://get.docker.com -o get-docker.sh');
+const runDockerInstallScriptCommand = () => executeSudoCommand('sudo sh get-docker.sh');
+const enableAndStartDockerCommand = () => executeSudoCommand('sudo systemctl enable docker --now');
 
 const postInstallSteps = [
     executeSudoCommand('[ $(getent group docker) ] && sudo groupadd docker', {
@@ -9,7 +14,6 @@ const postInstallSteps = [
     }),
     executeSudoCommand(`sudo usermod -aG docker ${process.env.USER}`)
 ];
-
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -24,31 +28,28 @@ const installDocker = () => ({
                     platform: 'Arch Linux',
                     dependenciesToInstall: ['docker']
                 }),
-                executeSudoCommand('sudo systemctl start docker.service'),
-                executeSudoCommand('sudo systemctl enable docker.service'),
+                enableAndStartDockerCommand(),
                 ...postInstallSteps
             ]);
         }
         case 'Fedora':
         case 'CentOS': {
             return task.newListr([
-                execCommandTask('curl -fsSL https://get.docker.com -o get-docker.sh'),
-                executeSudoCommand('sudo sh get-docker.sh'),
-                executeSudoCommand('sudo systemctl start docker'),
-                executeSudoCommand('sudo systemctl enable docker')
+                downloadDockerInstallScriptCommand(),
+                runDockerInstallScriptCommand(),
+                enableAndStartDockerCommand()
             ]);
         }
         case 'Ubuntu': {
             return task.newListr([
-                execCommandTask('curl -fsSL https://get.docker.com -o get-docker.sh'),
-                executeSudoCommand('sudo sh get-docker.sh'),
-                executeSudoCommand('sudo service docker start'),
-                executeSudoCommand('sudo systemctl enable docker.service'),
+                downloadDockerInstallScriptCommand(),
+                runDockerInstallScriptCommand(),
+                enableAndStartDockerCommand(),
                 ...postInstallSteps
             ]);
         }
         default: {
-            throw new Error(`Docker is not installed!
+            throw new KnownError(`Docker is not installed!
 Your distro ${distro} is not supported by automatic installation.`);
         }
         }