@scandipwa/magento-scripts 1.14.1-alpha.7 → 1.15.0

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

@@ -1,8 +1,11 @@
+/* eslint-disable no-nested-ternary */
 const path = require('path');
 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 +89,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 +115,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!
@@ -193,9 +196,60 @@ Would you like to load them now?`
 
                 composerAuthContent = JSON.parse(composerAuthFileContent);
 
+                // eslint-disable-next-line max-len
+                const repoMagentoCredentials = composerAuthContent && composerAuthContent['http-basic'] && composerAuthContent['http-basic']['repo.magento.com'];
+
+                const hasEmptyCharacterInUsername = repoMagentoCredentials && /\s/i.test(repoMagentoCredentials.username);
+                const hasEmptyCharacterInPassword = repoMagentoCredentials && /\s/i.test(repoMagentoCredentials.password);
+
+                // TODO refactor to check all fields, not only for magento
+                const message = (hasEmptyCharacterInUsername && hasEmptyCharacterInPassword)
+                    ? `Both ${logger.style.misc('username')} and ${logger.style.misc('password')} fields in ${logger.style.misc('http-basic -> repo.magento.com')} in ${logger.style.file('./auth.json')} contains empty characters (spaces).
+Do you want to remove them now? File will be overwritten.`
+                    : hasEmptyCharacterInUsername
+                        ? `Your ${logger.style.misc('http-basic -> repo.magento.com -> username')} field in ${logger.style.file('./auth.json')} contains empty characters (spaces).
+Do you want to remove them now? File will be overwritten.`
+                        : hasEmptyCharacterInPassword
+                            ? `Your ${logger.style.misc('http-basic -> repo.magento.com -> password')} field in ${logger.style.file('./auth.json')} contains empty characters (spaces).
+Do you want to remove them now? File will be overwritten.`
+                            : null;
+
+                if (message) {
+                    const response = await task.prompt({
+                        message,
+                        type: 'Select',
+                        choices: [
+                            {
+                                name: 'overwrite',
+                                message: 'Yes, please!'
+                            },
+                            {
+                                name: 'skip',
+                                message: 'No, I know what I\'m doing'
+                            }
+                        ]
+                    });
+
+                    if (response === 'overwrite') {
+                        if (repoMagentoCredentials.username) {
+                            repoMagentoCredentials.username = repoMagentoCredentials.username.replace(/\s/i, '');
+                        }
+
+                        if (repoMagentoCredentials.password) {
+                            repoMagentoCredentials.password = repoMagentoCredentials.password.replace(/\s/i, '');
+                        }
+
+                        await fs.promises.writeFile(
+                            authJsonPath,
+                            JSON.stringify(composerAuthContent, null, 4),
+                            'utf-8'
+                        );
+                    }
+                }
+
                 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 +265,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,12 +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>}
  */
@@ -18,46 +100,18 @@ 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;
+                }
             }
         }
 

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,7 @@ 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');
@@ -48,7 +49,7 @@ const installDocker = () => ({
             ]);
         }
         default: {
-            throw new Error(`Docker is not installed!
+            throw new KnownError(`Docker is not installed!
 Your distro ${distro} is not supported by automatic installation.`);
         }
         }

package/lib/tasks/requirements/docker/running-status.js

@@ -1,6 +1,5 @@
-const os = require('os');
+const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const getIsWsl = require('../../../util/is-wsl');
 const pathExists = require('../../../util/path-exists');
 const sleep = require('../../../util/sleep');
 const { systemctlControl } = require('../../../util/systemctl');
@@ -19,38 +18,40 @@ const checkDockerStatusMacOS = () => ({
     task: async (ctx, task) => {
         const { result, code } = await getDockerVersion();
 
-        if (code !== 0 && result.includes('Is the docker daemon running?')) {
-            const dockerOpenAppConfirmation = await task.prompt({
-                type: 'Confirm',
-                message: 'Looks like Docker is not running, would you like us to open a Docker for Mac application and wait for it to start up?'
-            });
-
-            if (dockerOpenAppConfirmation && await pathExists(pathToDockerApplication)) {
-                await execAsyncSpawn(`open ${pathToDockerApplication}`);
-                let ready = false;
-                let attempts = 0;
-                while (!ready) {
-                    if (attempts > 24 && !ready) {
-                        throw new Error('Docker haven\'t started in 2 mins, exiting...');
-                    }
-                    try {
-                        const { code: startupCode } = await getDockerVersion();
-                        if (startupCode !== 0) {
-                            task.output = `Waiting for Docker to startup for ${attempts * 5} seconds...`;
-                            attempts++;
-                            await sleep(5000);
-                        } else {
-                            ready = true;
+        if (code !== 0) {
+            if (result.includes('Is the docker daemon running?') || result.includes('docker: command not found')) {
+                const dockerOpenAppConfirmation = await task.prompt({
+                    type: 'Confirm',
+                    message: 'Looks like Docker is not running, would you like us to open a Docker for Mac application and wait for it to start up?'
+                });
+
+                if (dockerOpenAppConfirmation && await pathExists(pathToDockerApplication)) {
+                    await execAsyncSpawn(`open ${pathToDockerApplication}`);
+                    let ready = false;
+                    let attempts = 0;
+                    while (!ready) {
+                        if (attempts > 24 && !ready) {
+                            throw new KnownError('Docker haven\'t started in 2 mins, exiting...');
                         }
-                    } catch (e) {
+                        try {
+                            const { code: startupCode } = await getDockerVersion();
+                            if (startupCode !== 0) {
+                                task.output = `Waiting for Docker to startup for ${attempts * 5} seconds...`;
+                                attempts++;
+                                await sleep(5000);
+                            } else {
+                                ready = true;
+                            }
+                        } catch (e) {
                         //
+                        }
                     }
+
+                    return;
                 }
 
-                return;
+                task.skip('User skipped running Docker');
             }
-
-            task.skip('User skipped running Docker');
         }
     },
     options: {
@@ -67,7 +68,7 @@ const checkDockerStatusWSL = () => ({
         const { result, code } = await getDockerVersion();
 
         if (code !== 0 && result.includes('Is the docker daemon running?')) {
-            throw new Error(`Docker is not running!
+            throw new KnownError(`Docker is not running!
 
 Please open Docker Desktop application for Windows and make sure that Docker is running. Then you can try again!`);
         }
@@ -123,10 +124,10 @@ This action requires root privileges.`
 const checkDockerStatus = () => ({
     title: 'Checking Docker status',
     task: async (ctx, task) => {
-        if (os.platform() === 'darwin') {
+        if (ctx.platform === 'darwin') {
             return task.newListr(checkDockerStatusMacOS());
         }
-        if (!await getIsWsl()) {
+        if (!ctx.isWsl) {
             return task.newListr(checkDockerStatusLinux());
         }
 

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

@@ -1,3 +1,4 @@
+const UnknownError = require('../../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 
 /**
@@ -14,7 +15,7 @@ const getDockerVersion = () => ({
 
             ctx.dockerVersion = dockerVersion;
         } else {
-            throw new Error(`Got unexpected result during Docker version retrieval!\n\n${ result }`);
+            throw new UnknownError(`Got unexpected result during Docker version retrieval!\n\n${ result }`);
         }
     }
 });

package/lib/tasks/requirements/index.js

@@ -4,6 +4,7 @@ const checkComposer = require('./composer');
 const checkDocker = require('./docker');
 const checkNodeVersion = require('./node-version');
 const checkPHPVersion = require('./php-version');
+const checkRosetta = require('./rosetta');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -13,6 +14,8 @@ const checkRequirements = () => ({
     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(),
         // check the Docker installation
         checkDocker(),
         // check for Node.js version

package/lib/tasks/requirements/node-version.js

@@ -1,4 +1,5 @@
 const semver = require('semver');
+const KnownError = require('../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -9,7 +10,7 @@ const checkNodeVersion = () => ({
         const { node } = process.versions;
 
         if (!semver.gte(node, '12.0.0')) {
-            throw new Error(
+            throw new KnownError(
                 `Your Node.js version is out of date!
 You need to upgrade Node.js to at lease version 12 to work with this software!`
             );