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

package/lib/tasks/magento/setup-magento/index.js

@@ -11,6 +11,7 @@ const updateEnvPHP = require('../../php/update-env-php');
 const increaseAdminSessionLifetime = require('./increase-admin-session-lifetime');
 const magentoTask = require('../../../util/magento-task');
 const urnHighlighter = require('./urn-highlighter');
+const waitingForVarnish = require('./waiting-for-varnish');
 
 /**
  * @type {({ onlyInstallMagento: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -48,7 +49,8 @@ const setupMagento = (options = {}) => ({
             disableMaintenanceMode(),
             disable2fa(),
             urnHighlighter(),
-            magentoTask('cache:flush')
+            magentoTask('cache:flush'),
+            waitingForVarnish()
         ], {
             concurrent: false,
             exitOnError: true,

package/lib/tasks/magento/setup-magento/install-magento.js

@@ -1,4 +1,5 @@
 const semver = require('semver');
+const UnknownError = require('../../../errors/unknown-error');
 const runMagentoCommand = require('../../../util/run-magento');
 
 /**
@@ -86,7 +87,7 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
 
         if (!installed) {
             const errorMessages = errors.map((e) => e.message).join('\n\n');
-            throw new Error(`Unable to install Magento!\n${errorMessages}`);
+            throw new UnknownError(`Unable to install Magento!\n${errorMessages}`);
         }
     },
     options: {

package/lib/tasks/magento/setup-magento/upgrade-magento.js

@@ -1,4 +1,6 @@
 const magentoTask = require('../../../util/magento-task');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const KnownError = require('../../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -12,7 +14,15 @@ const upgradeMagento = () => ({
         return false;
     },
     task: (_ctx, task) => task.newListr([
-        magentoTask('setup:upgrade --no-interaction'),
+        magentoTask('setup:upgrade --no-interaction', {
+            onError: (e) => {
+                throw new KnownError(`Magento setup:upgrade command failed!
+You can try disabling failed module and try again.
+To disable module, open ${logger.style.misc('cli')} and type the following command: ${logger.style.command('m module:disable <module-name>')}
+
+Error: ${e}`);
+            }
+        }),
         {
             task: (ctx) => {
                 ctx.isSetupUpgradeNeeded = false;

package/lib/tasks/magento/setup-magento/waiting-for-varnish.js

@@ -0,0 +1,41 @@
+const { request } = require('smol-request');
+const KnownError = require('../../../errors/known-error');
+const sleep = require('../../../util/sleep');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const waitingForVarnish = () => ({
+    title: 'Waiting for Varnish to return code 200',
+    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    task: async (ctx) => {
+        let tries = 0;
+        while (tries < 10) {
+            try {
+                const response = await request(`http://localhost:${ctx.ports.sslTerminator}/`, {
+                    responseType: 'headers'
+                });
+
+                if (response.status !== 200) {
+                    tries++;
+                    await sleep(2000);
+                } else {
+                    break;
+                }
+            } catch (e) {
+                tries++;
+                await sleep(200);
+            }
+        }
+
+        if (tries === 10) {
+            throw new KnownError(`After 20 seconds website is still responding with non-200 code, which might indicate issue with setup.
+Or Varnish is still loading...
+
+Please check the logs!`);
+        }
+    },
+    exitOnError: false
+});
+
+module.exports = waitingForVarnish;

package/lib/tasks/mysql/connect-to-mysql.js

@@ -1,4 +1,5 @@
 const mysql = require('mysql2/promise');
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const sleep = require('../../util/sleep');
 
@@ -44,7 +45,7 @@ Please wait, this will take some time and do not restart the MySQL container unt
         }
 
         if (tries === maxTries) {
-            throw new Error(`Unable to connect to MySQL server. Check your server configuration!\n\n${ errors.join(' ') }`);
+            throw new UnknownError(`Unable to connect to MySQL server. Check your server configuration!\n\n${ errors.join(' ') }`);
         }
 
         task.title = 'MySQL server connected!';

package/lib/tasks/mysql/import-dump-to-mysql.js

@@ -1,4 +1,6 @@
 /* eslint-disable max-len */
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const pathExists = require('../../util/path-exists');
 
@@ -9,7 +11,7 @@ const importDumpToMySQL = () => ({
     title: 'Importing Database Dump To MySQL',
     task: async (ctx, task) => {
         if (!await pathExists(ctx.importDb)) {
-            throw new Error(`Dump file at ${ctx.importDb} does not exist. Please provide correct relative path to the file`);
+            throw new KnownError(`Dump file at ${ctx.importDb} does not exist. Please provide correct relative path to the file`);
         }
 
         const { config: { docker }, ports } = ctx;
@@ -42,7 +44,7 @@ const importDumpToMySQL = () => ({
                 }
             );
         } catch (e) {
-            throw new Error(`Unexpected error during dump import.\n\n${e}`);
+            throw new UnknownError(`Unexpected error during dump import.\n\n${e}`);
         }
 
         clearInterval(tickInterval);

package/lib/tasks/mysql/import-remote-db/index.js

@@ -1,3 +1,4 @@
+const UnknownError = require('../../../errors/unknown-error');
 const sshDb = require('./ssh');
 
 /**
@@ -30,7 +31,7 @@ It can be a SSH (ssh://<url>) connection or mysql (mysql://<url>) connection.
             );
         }
         default: {
-            throw new Error(`Unsupported protocol ${protocol}`);
+            throw new UnknownError(`Unsupported protocol ${protocol}`);
         }
         }
     }

package/lib/tasks/mysql/import-remote-db/ssh/index.js

@@ -3,6 +3,7 @@ const { NodeSSH } = require('node-ssh');
 const pathExists = require('../../../../util/path-exists');
 const regularSSHServer = require('./regular-server');
 const readymageSSH = require('./readymage');
+const KnownError = require('../../../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
@@ -25,7 +26,7 @@ const sshDb = () => ({
             });
 
             if (!(await pathExists(privateKey))) {
-                throw new Error(`Private key not found: ${privateKey}`);
+                throw new KnownError(`Private key not found: ${privateKey}`);
             }
 
             ctx.privateKey = privateKey;

package/lib/tasks/mysql/import-remote-db/ssh/regular-server.js

@@ -2,6 +2,7 @@ const mergeFiles = require('merge-files');
 const { orderTables, customerTables } = require('../../magento-tables');
 const { execAsyncSpawn } = require('../../../../util/exec-async-command');
 const mysqlDumpCommandWithOptions = require('./mysqldump-command');
+const KnownError = require('../../../../errors/known-error');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext & { ssh: import('node-ssh').NodeSSH }>}
  */
@@ -30,7 +31,7 @@ Do not enter "--result-file" option, we need to control that part.
             });
 
             if (dumpCommand.includes('--result-file')) {
-                throw new Error('--result-file option is not allowed in user input command');
+                throw new KnownError('--result-file option is not allowed in user input command');
             }
 
             if (!withCustomersData) {

package/lib/tasks/php/bundled-extensions.js

@@ -0,0 +1,28 @@
+const bundledExtensions = [
+    'bz2',
+    'bcmath',
+    'ctype',
+    'curl',
+    'intl',
+    'dom',
+    'filter',
+    'hash',
+    'sockets',
+    'iconv',
+    'json',
+    'mbstring',
+    'openssl',
+    'xml',
+    'mysql',
+    'pdo',
+    'soap',
+    'xmlrpc',
+    'xml',
+    'zip',
+    'fpm',
+    'gd'
+];
+
+module.exports = {
+    bundledExtensions
+};

package/lib/tasks/php/compile-options.js

@@ -1,30 +1,16 @@
+const { bundledExtensions } = require('./bundled-extensions');
+
+const darwinVariants = [
+    'openssl=$(brew --prefix openssl@1.1)', // ="$(brew --prefix openssl@1.1)"
+    'curl=$(brew --prefix curl)',
+    'intl=$(brew --prefix icu4c)',
+    'bz2="$(brew --prefix bzip2)"'
+];
+
 const compileOptions = {
     linux: {
         cpuCount: '$(nproc)',
-        variants: [
-            '+bz2',
-            '+bcmath',
-            '+ctype',
-            '+curl',
-            '+intl',
-            '+dom',
-            '+filter',
-            '+hash',
-            '+sockets',
-            '+iconv',
-            '+json',
-            '+mbstring',
-            '+openssl',
-            '+xml',
-            '+mysql',
-            '+pdo',
-            '+soap',
-            '+xmlrpc',
-            '+xml',
-            '+zip',
-            '+fpm',
-            '+gd'
-        ],
+        variants: bundledExtensions.map((ext) => `+${ext}`),
         extraOptions: [
             '--with-freetype-dir=/usr/include/freetype2',
             '--with-openssl=/usr/',
@@ -39,30 +25,14 @@ const compileOptions = {
     },
     darwin: {
         cpuCount: '$(sysctl -n hw.ncpu)',
-        variants: [
-            '+neutral',
-            '+bz2="$(brew --prefix bzip2)"',
-            '+bcmath',
-            '+ctype',
-            '+curl=$(brew --prefix curl)',
-            '+intl=$(brew --prefix icu4c)',
-            '+dom',
-            '+filter',
-            '+hash',
-            '+iconv',
-            '+json',
-            '+mbstring',
-            '+openssl=$(brew --prefix openssl@1.1)', // ="$(brew --prefix openssl@1.1)"
-            '+xml',
-            '+mysql',
-            '+pdo',
-            '+soap',
-            '+xmlrpc',
-            '+xml',
-            '+zip',
-            '+fpm',
-            '+gd'
-        ],
+        variants: bundledExtensions.map((ext) => {
+            const darwinVariant = darwinVariants.find((dv) => dv.startsWith(ext));
+            if (darwinVariant) {
+                return `+${darwinVariant}`;
+            }
+
+            return `+${ext}`;
+        }),
         extraOptions: [
             '--with-zlib-dir=$(brew --prefix zlib)',
             '--with-iconv=$(brew --prefix libiconv)',

package/lib/tasks/php/compile.js

@@ -2,11 +2,12 @@ const systeminformation = require('systeminformation');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const compileOptions = require('./compile-options');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const compile = () => ({
+const compilePHP = () => ({
     title: 'Compiling PHP',
     task: async ({ config: { php } }, task) => {
         const platformCompileOptions = compileOptions[process.platform];
@@ -31,7 +32,7 @@ const compile = () => ({
                 }
             );
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Failed to compile the required PHP version.
                 Tried compiling the PHP version ${ logger.style.misc(php.version) }.
                 Use your favorite search engine to resolve the issue.
@@ -44,4 +45,4 @@ const compile = () => ({
     }
 });
 
-module.exports = compile;
+module.exports = compilePHP;

package/lib/tasks/php/configure.js

@@ -1,76 +1,17 @@
 /* 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 enableExtension = require('./extensions/enable');
 const installExtension = require('./extensions/install');
 const disableExtension = require('./extensions/disable');
-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;
-};
+const {
+    getEnabledExtensions,
+    getInstalledExtensions,
+    getDisabledExtensions
+} = require('./extensions');
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const configure = () => ({
+const configurePHP = () => ({
     title: 'Configuring PHP extensions',
     task: async ({ config, debug }, task) => {
         const { php, php: { disabledExtensions = [] } } = config;
@@ -145,4 +86,4 @@ const configure = () => ({
     }
 });
 
-module.exports = configure;
+module.exports = configurePHP;

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>}
@@ -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-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!