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

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

@@ -1,54 +0,0 @@
-/* eslint-disable max-len */
-const phpbrewConfig = require('../../../config/phpbrew');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const { getPHPForPHPBrewBin } = require('../../../util/get-php-for-phpbrew');
-
-/**
- * @param {String} extensionName
- * @param {import('../../../../typings/index').PHPExtension} extensionOptions
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const installExtension = (extensionName, extensionOptions) => ({
-    title: `Installing ${extensionName} extension`,
-    task: async (ctx, task) => {
-        const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-        const {
-            config,
-            config: { php }
-        } = ctx;
-        const { hooks } = extensionOptions;
-
-        if (extensionOptions.install) {
-            await Promise.resolve(extensionOptions.install(ctx, task));
-        } else {
-            const options = ctx.platform === 'darwin' ? extensionOptions.macosOptions : extensionOptions.linuxOptions;
-
-            if (hooks && hooks.preInstall) {
-                await Promise.resolve(hooks.preInstall(config));
-            }
-
-            await execAsyncSpawn(`source ${phpbrewConfig.bashrcPath} && \
-                phpbrew use ${ php.version } && \
-                phpbrew ext install ${ extensionName }${ extensionOptions.version ? ` ${extensionOptions.version}` : ''}${ options ? ` -- ${ options }` : ''}`,
-            {
-                callback: (t) => {
-                    task.output = t;
-                },
-                useRosetta2: true,
-                env: phpBinForPHPBrew ? {
-                    ...process.env,
-                    PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-                } : process.env
-            });
-
-            if (hooks && hooks.postInstall) {
-                await Promise.resolve(hooks.postInstall(config));
-            }
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = installExtension;

package/lib/tasks/php/index.js

@@ -1,79 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const pathExists = require('../../util/path-exists');
-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>}
- */
-const installPhp = () => ({
-    title: 'Installing PHP',
-    task: async (ctx, task) => {
-        const { config: { php }, recompilePhp } = ctx;
-        const phpBinExists = await pathExists(php.binPath);
-
-        if (phpBinExists && !recompilePhp) {
-            task.title = `Using PHP version ${php.version} in project`;
-
-            return;
-        }
-
-        task.title = `Installing PHP ${php.version}`;
-
-        try {
-            const hasPHPVersionDirectory = (
-                await Promise.all(
-                    (
-                        await fs.promises.readdir(phpbrewConfig.phpPath, {
-                            encoding: 'utf-8',
-                            withFileTypes: true
-                        })
-                    ).map(async (f) => {
-                        if (!f.isDirectory()) {
-                            return false;
-                        }
-
-                        if (f.name !== `php-${php.version}`) {
-                            return false;
-                        }
-
-                        return pathExists(path.join(phpbrewConfig.phpPath, f.name, 'bin', 'php'));
-                    })
-                ))
-                .includes(true);
-
-            if (hasPHPVersionDirectory && !recompilePhp) {
-                task.skip();
-                // eslint-disable-next-line consistent-return
-                return;
-            }
-        } catch (e) {
-            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') }
-                Otherwise, See error details in the output below.\n\n${e}`
-            );
-        }
-
-        // eslint-disable-next-line consistent-return
-        return task.newListr([
-            updatePhpBrew(),
-            compilePhp()
-        ], {
-            concurrent: false,
-            exitOnError: true
-        });
-    }
-});
-
-module.exports = {
-    installPhp,
-    compilePhp,
-    configurePhp
-};

package/lib/tasks/php/install-sodium.js

@@ -1,93 +0,0 @@
-const path = require('path');
-const os = require('os');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { cmaGlobalConfig } = require('../../config/cma-config');
-const downloadFile = require('../../util/download-file');
-const { execCommandTask } = require('../../util/exec-async-command');
-const { getEnabledExtensions } = require('./extensions');
-
-const libsodiumArchiveUrl = 'https://download.libsodium.org/libsodium/releases/libsodium-1.0.18-stable.tar.gz';
-
-const HAS_LIBSODIUM_BEEN_INSTALLED = 'hasLibsodiumBeenInstalled';
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const installSodiumExtension = () => ({
-    skip: async (ctx) => {
-        if (ctx.isArmMac) {
-            if (cmaGlobalConfig.has(HAS_LIBSODIUM_BEEN_INSTALLED)) {
-                const hasLibsodiumBeenInstalled = cmaGlobalConfig.get(HAS_LIBSODIUM_BEEN_INSTALLED);
-                return hasLibsodiumBeenInstalled;
-            }
-
-            return false;
-        }
-
-        return true;
-    },
-    task: async (ctx, task) => {
-        task.title = 'Preparing libsodium to installation';
-        const tempDir = os.tmpdir();
-        const destination = path.join(tempDir, path.parse(libsodiumArchiveUrl).base);
-        const extractedArchivePath = path.join(tempDir, 'libsodium-stable');
-        const enabledExtensions = await getEnabledExtensions(ctx.config);
-
-        if (enabledExtensions.sodium !== undefined) {
-            cmaGlobalConfig.set(HAS_LIBSODIUM_BEEN_INSTALLED, true);
-            task.skip();
-            return;
-        }
-
-        return task.newListr([
-            {
-                title: 'Downloading archive',
-                task: async () => {
-                    await downloadFile(libsodiumArchiveUrl, { destination });
-                }
-            },
-            {
-                ...execCommandTask(`tar -zxf ${destination}`, {
-                    cwd: tempDir
-                }),
-                title: 'Extracting archive'
-            },
-            execCommandTask('./configure', {
-                cwd: extractedArchivePath
-            }),
-            execCommandTask('make && make check', {
-                cwd: extractedArchivePath
-            }),
-            {
-                title: 'Installing...',
-                task: async (ctx, task) => {
-                    task.output = 'Enter your sudo password!';
-                    task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
-
-                    return task.newListr(
-                        execCommandTask('sudo make install', {
-                            callback: (t) => {
-                                task.output = t;
-                            },
-                            pipeInput: true,
-                            cwd: extractedArchivePath
-                        })
-                    );
-                },
-                options: {
-                    bottomBar: 10
-                }
-            },
-            {
-                task: () => {
-                    cmaGlobalConfig.set(HAS_LIBSODIUM_BEEN_INSTALLED, true);
-                }
-            }
-        ]);
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = installSodiumExtension;

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

@@ -1,45 +0,0 @@
-const UnknownError = require('../../errors/unknown-error');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const { getPHPForPHPBrewBin } = require('../../util/get-php-for-phpbrew');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const updatePhpBrew = () => ({
-    title: 'Updating PHPBrew PHP versions',
-    task: async ({ config: { php } }, task) => {
-        const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-        try {
-            const knownPhpVersions = await execAsyncSpawn('phpbrew known', {
-                useRosetta2: true,
-                env: phpBinForPHPBrew ? {
-                    ...process.env,
-                    PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-                } : process.env
-            });
-
-            if (knownPhpVersions.includes(`${php.version}`)) {
-                task.skip();
-                return;
-            }
-
-            await execAsyncSpawn('phpbrew known --update', {
-                callback: (t) => {
-                    task.output = t;
-                },
-                useRosetta2: true,
-                env: phpBinForPHPBrew ? {
-                    ...process.env,
-                    PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-                } : process.env
-            });
-        } catch (e) {
-            throw new UnknownError(`Unexpected error while updating phpbrew known php versions\n\n${e}`);
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = updatePhpBrew;

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

@@ -1,67 +0,0 @@
-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/get-process-id.js

@@ -1,14 +0,0 @@
-const fs = require('fs');
-const pathExists = require('../../util/path-exists');
-
-const getProcessId = async (fpmPidFilePath) => {
-    const pidExists = await pathExists(fpmPidFilePath);
-
-    if (pidExists) {
-        return fs.promises.readFile(fpmPidFilePath, 'utf-8');
-    }
-
-    return null;
-};
-
-module.exports = getProcessId;

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

@@ -1,4 +0,0 @@
-module.exports = {
-    startPhpFpm: require('./start-php-fpm'),
-    stopPhpFpm: require('./stop-php-fpm')
-};

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

@@ -1,49 +0,0 @@
-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>}
- */
-const startPhpFpm = () => ({
-    title: 'Starting PHP-FPM',
-    task: async ({ config: { overridenConfiguration }, projectPath }, task) => {
-        const php = getPhpConfig(overridenConfiguration.configuration, getBaseConfig(projectPath));
-        const processId = await getProcessId(php.fpmPidFilePath);
-        if (processId) {
-            task.skip();
-            return;
-        }
-        const phpIniPathArg = `--php-ini ${php.iniPath}`;
-        const phpFpmConfPathArg = `--fpm-config ${php.fpmConfPath}`;
-        const phpFpmPidFilePathArg = `--pid ${php.fpmPidFilePath}`;
-
-        const command = [
-            phpIniPathArg,
-            phpFpmConfPathArg,
-            phpFpmPidFilePathArg
-        ].filter(Boolean);
-
-        try {
-            await execAsyncSpawn(
-                `${php.fpmBinPath} ${command.join(' ')} "$@"`,
-                {
-                    callback: (t) => {
-                        task.output = t;
-                    },
-                    useRosetta2: true
-                }
-            );
-        } catch (e) {
-            throw new UnknownError(`Error during PHP-FPM start\n\n${e}`);
-        }
-    },
-    options: {
-        bottomBar: 5,
-        showTimer: false
-    }
-});
-
-module.exports = startPhpFpm;

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

@@ -1,48 +0,0 @@
-const fs = require('fs');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const pathExists = require('../../util/path-exists');
-const getPhpConfig = require('../../config/php-config');
-const { getBaseConfig } = require('../../config/index');
-const getProcessId = require('./get-process-id');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const stopPhpFpmTask = () => ({
-    title: 'Stopping PHP-FPM',
-    task: async ({ config: { overridenConfiguration }, projectPath }, task) => {
-        const php = getPhpConfig(overridenConfiguration.configuration, getBaseConfig(projectPath));
-        const processId = await getProcessId(php.fpmPidFilePath);
-        if (!processId) {
-            task.skip();
-            return;
-        }
-        try {
-            await execAsyncSpawn(`kill ${processId}`);
-        } catch (e) {
-            if (e.toLowerCase().includes('no such process')) {
-                try {
-                    await fs.promises.unlink(php.fpmPidFilePath);
-                } catch (e) {
-                    //
-                }
-
-                return;
-            }
-        }
-
-        if (await pathExists(php.fpmPidFilePath)) {
-            try {
-                await fs.promises.unlink(php.fpmPidFilePath);
-            } catch (e) {
-                //
-            }
-        }
-    },
-    options: {
-        bottomBar: 10,
-        showTimer: false
-    }
-});
-
-module.exports = stopPhpFpmTask;

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

@@ -1,61 +0,0 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const KnownError = require('../../../errors/known-error');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const { getPHPForPHPBrewBin } = require('../../../util/get-php-for-phpbrew');
-const installPHPBrew = require('./install');
-const getPHPBrewVersion = require('./version');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const checkPHPBrew = () => ({
-    title: 'Checking phpbrew',
-    task: async (ctx, task) => {
-        const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-        const { code } = await execAsyncSpawn('phpbrew --version', {
-            withCode: true,
-            env: phpBinForPHPBrew ? {
-                ...process.env,
-                PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-            } : process.env
-        });
-
-        if (code !== 0) {
-            const automaticallyInstallPHPBrew = await task.prompt({
-                type: 'Confirm',
-                message: `You don't have PHPBrew installed!
-Do you want to install it automatically?`
-            });
-
-            if (automaticallyInstallPHPBrew) {
-                return task.newListr([
-                    installPHPBrew(),
-                    getPHPBrewVersion(),
-                    {
-                        task: (ctx) => {
-                            task.title = `Using PHPBrew version ${ctx.PHPBrewVersion}`;
-                        }
-                    }
-                ]);
-            }
-
-            throw new KnownError(
-                `To install PHPBrew, you must first make sure the requirements are met.
-The requirements are available here: ${ logger.style.link('https://github.com/phpbrew/phpbrew/wiki/Requirement') }.
-Then, you can follow the installation instruction, here: ${ logger.style.link('https://phpbrew.github.io/phpbrew/#installation') }.
-When completed, try running this script again.`
-            );
-        }
-
-        return task.newListr([
-            getPHPBrewVersion(),
-            {
-                task: (ctx) => {
-                    task.title = `Using PHPBrew version ${ctx.PHPBrewVersion}`;
-                }
-            }
-        ]);
-    }
-});
-
-module.exports = checkPHPBrew;

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

@@ -1,159 +0,0 @@
-const os = require('os');
-const path = require('path');
-const fs = require('fs');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const KnownError = require('../../../errors/known-error');
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const installXcode = () => ({
-    title: 'Installing XCode',
-    task: async (ctx, task) => {
-        const { code: XCODEInstallCode } = await execAsyncSpawn('xcode-select -p 1>/dev/null;echo $?', {
-            throwNonZeroCode: false,
-            withCode: true
-        });
-
-        if (XCODEInstallCode !== 0) {
-            return task.newListr({
-                task: async (subCtx, subTask) => {
-                    await execAsyncSpawn('xcode-select --install', {
-                        pipeInput: true,
-                        callback: (t) => {
-                            subTask.output = t;
-                        }
-                    });
-                },
-                options: {
-                    bottomBar: 10
-                }
-            });
-        }
-
-        task.skip();
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const installPHPBrewBinary = () => ({
-    title: 'Installing PHPBrew binary',
-    task: async (ctx, task) => {
-        task.output = 'Downloading PHPbrew binary...';
-        await execAsyncSpawn('curl -L -O https://github.com/phpbrew/phpbrew/releases/latest/download/phpbrew.phar', {
-            throwNonZeroCode: true
-        });
-
-        task.output = 'Making PHPbrew binary executable...';
-        await execAsyncSpawn('chmod +x phpbrew.phar', {
-            throwNonZeroCode: true
-        });
-
-        task.output = 'Moving PHPbrew binary to /url/local/bin directory...';
-        task.output = 'Enter your sudo password:';
-        await execAsyncSpawn('sudo mv phpbrew.phar /usr/local/bin/phpbrew', {
-            throwNonZeroCode: true,
-            pipeInput: true
-        });
-
-        task.output = 'Initializing PHPbrew...';
-        await execAsyncSpawn('phpbrew init', {
-            throwNonZeroCode: true
-        });
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const addPHPBrewInitiatorLineToConfigFile = () => ({
-    task: async (ctx, task) => {
-        const shellName = process.env.SHELL.split('/').pop();
-
-        const shellConfigFileName = `.${shellName}rc`;
-
-        const addLineToShellConfigFIle = await task.prompt({
-            type: 'Select',
-            message: `To finish configuring PHPBrew we need to add ${logger.style.code('[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc')} line to your ${ shellConfigFileName } file.
-Do you want to do it now?`,
-            choices: [{
-                name: 'yes',
-                message: 'Yeah, thanks'
-            }, {
-                name: 'no',
-                message: 'No, I will deal with this myself'
-            }]
-        });
-
-        if (addLineToShellConfigFIle === 'no') {
-            task.skip();
-            return;
-        }
-
-        if (shellName === 'zsh') {
-            await fs.promises.appendFile(
-                path.join(os.homedir(), '.zshrc'),
-                '\n[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc\n'
-            );
-        } else if (shellName === 'bash') {
-            await fs.promises.appendFile(
-                path.join(os.homedir(), '.bashrc'),
-                '\n[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc\n'
-            );
-        } else {
-            const continueInstall = await task.prompt({
-                type: 'Select',
-                message: `Unfortunately we cannot automatically add necessary configuration for your shell ${process.env.SHELL}!
-You will need to that manually!
-
-Add following string to your shells configuration file: ${logger.style.code('[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc')}
-
-When you ready, press Enter and installation will continue.`,
-                choices: [
-                    {
-                        name: 'yes',
-                        message: 'YES'
-                    },
-                    {
-                        name: 'no',
-                        message: 'Exit installation'
-                    }
-                ]
-            });
-
-            if (continueInstall === 'no') {
-                throw new KnownError(`Add following string to your shells configuration file: ${logger.style.code('[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc')}
-
-Then you can continue installation.`);
-            }
-        }
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const installPHPBrew = () => ({
-    title: 'Installing PHPBrew',
-    task: async (ctx, task) => {
-        if (process.platform === 'darwin') {
-            return task.newListr([
-                installXcode(),
-                installPHPBrewBinary(),
-                addPHPBrewInitiatorLineToConfigFile()
-            ]);
-        }
-
-        return task.newListr([
-            installPHPBrewBinary(),
-            addPHPBrewInitiatorLineToConfigFile()
-        ]);
-    }
-});
-
-module.exports = installPHPBrew;