@scandipwa/magento-scripts 1.14.1-alpha.0 → 1.14.1-alpha.11

package/lib/tasks/php/extensions/index.js

@@ -0,0 +1,71 @@
+/* eslint-disable max-len */
+const path = require('path');
+const fs = require('fs');
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const pathExists = require('../../../util/path-exists');
+const phpbrewConfig = require('../../../config/phpbrew');
+
+/**
+ * Get enabled extensions list with versions
+ * @param {import('../../../../typings/context').ListrContext['config']} param0
+ * @returns {Promise<{[key: string]: string}}>}
+ */
+const getEnabledExtensions = async ({ php }) => {
+    const output = await execAsyncSpawn(
+        `${ php.binPath } -c ${php.iniPath} -r 'foreach (get_loaded_extensions() as $extension) echo "$extension:" . phpversion($extension) . "\n";'`
+    );
+
+    return output
+        .split('\n')
+        .map((m) => {
+            // eslint-disable-next-line no-unused-vars
+            const [_, moduleName, moduleVersion] = m.match(/(.+):(.+)/i);
+
+            return [moduleName, moduleVersion];
+        })
+        .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
+};
+
+/**
+ * Get disabled extensions list
+ * @param {import('../../../../typings/context').ListrContext['config']} param0
+ * @returns {Promise<string[]>}
+ */
+const getDisabledExtensions = async ({ php }) => {
+    const extensionsIniDirectory = path.join(phpbrewConfig.phpPath, `php-${php.version}`, 'var', 'db');
+
+    if (!await pathExists(extensionsIniDirectory)) {
+        return [];
+    }
+
+    const extensionIniList = await fs.promises.readdir(
+        extensionsIniDirectory,
+        {
+            encoding: 'utf-8',
+            withFileTypes: true
+        }
+    );
+
+    return extensionIniList.filter((f) => f.isFile() && f.name.endsWith('.disabled')).map((f) => f.name.replace('.disabled', ''));
+};
+
+/**
+ * Get installed extensions
+ * @param {import('../../../../typings/context').ListrContext['config']} param0
+ * @returns {Promise<string[]>}
+ */
+const getInstalledExtensions = async ({ php }) => {
+    const extensionDirectory = path.join(phpbrewConfig.buildPath, `php-${php.version}`, 'ext');
+
+    const availableExtensions = await fs.promises.readdir(extensionDirectory, {
+        encoding: 'utf-8'
+    });
+
+    return availableExtensions;
+};
+
+module.exports = {
+    getEnabledExtensions,
+    getDisabledExtensions,
+    getInstalledExtensions
+};

package/lib/tasks/php/index.js

@@ -2,10 +2,11 @@ const fs = require('fs');
 const path = require('path');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const pathExists = require('../../util/path-exists');
-const compile = require('./compile');
-const configure = require('./configure');
+const compilePhp = require('./compile');
+const configurePhp = require('./configure');
 const updatePhpBrew = require('./update-phpbrew');
 const phpbrewConfig = require('../../config/phpbrew');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -17,7 +18,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;
         }
@@ -52,7 +53,7 @@ const installPhp = () => ({
                 return;
             }
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Failed to extract the list of installed PHP versions.
                 Possibly, you forgot to setup PHPBrew?
                 Follow these instruction: ${ logger.style.link('https://phpbrew.github.io/phpbrew/#setting-up') }
@@ -63,7 +64,7 @@ const installPhp = () => ({
         // eslint-disable-next-line consistent-return
         return task.newListr([
             updatePhpBrew(),
-            compile()
+            compilePhp()
         ], {
             concurrent: false,
             exitOnError: true
@@ -73,6 +74,6 @@ const installPhp = () => ({
 
 module.exports = {
     installPhp,
-    compilePhp: compile,
-    configurePhp: configure
+    compilePhp,
+    configurePhp
 };

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

@@ -14,8 +14,23 @@ const updateEnvPHP = () => ({
             return;
         }
 
+        const useVarnish = 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: useVarnish,
+                    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,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');
 
 /**
@@ -20,7 +21,7 @@ const updatePhpBrew = () => ({
                 }
             });
         } 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>}
@@ -35,7 +36,7 @@ const startPhpFpm = () => ({
                 }
             );
         } 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();
@@ -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/docker/index.js

@@ -1,9 +1,11 @@
 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 installDocker = require('./install');
 const { checkDockerSocketPermissions } = require('./permissions');
+const checkDockerStatus = require('./running-status');
 const getDockerVersion = require('./version');
 
 /**
@@ -34,7 +36,7 @@ NOTE: After installation it's recommended to log out and log back in so your gro
                             task: (ctx) => {
                                 task.title = `Using docker version ${ctx.dockerVersion}`;
 
-                                throw new Error(
+                                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/') }`
@@ -44,15 +46,15 @@ Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/li
                     ]);
                 }
 
-                throw new Error('Docker is not installed!');
+                throw new KnownError('Docker is not installed!');
             } else if (isWsl) {
-                throw new Error(
+                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') }`
                 );
             } else {
-                throw new Error(
+                throw new KnownError(
                     `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') }`
@@ -61,6 +63,7 @@ ${ logger.style.link('https://docs.create-magento-app.com/getting-started/prereq
         }
 
         return task.newListr([
+            checkDockerStatus(),
             getDockerVersion(),
             {
                 task: (ctx) => {

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.`);
         }
         }