@scandipwa/magento-scripts 1.16.0 → 2.0.0-alpha.1

package/lib/config/composer.js

@@ -1,11 +0,0 @@
-const path = require('path');
-
-module.exports = ({ composer }, config) => {
-    const { cacheDir } = config;
-
-    return {
-        dirPath: path.join(cacheDir, 'composer'),
-        binPath: path.join(cacheDir, 'composer', 'composer.phar'),
-        version: composer.version
-    };
-};

package/lib/config/php/extensions/libsodium.js

@@ -1,36 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-const pathExists = require('../../../util/path-exists');
-const UnknownError = require('../../../errors/unknown-error');
-const phpbrewConfig = require('../../phpbrew');
-
-/**
- * @type {import('../../../../typings/index').PHPExtension}
- */
-module.exports = {
-    extensionName: 'sodium',
-    hooks: {
-        postInstall: async ({ php }) => {
-            const sodiumDynamicLibraryPath = path.join(
-                phpbrewConfig.phpPath,
-                `php-${php.version}`,
-                'var',
-                'db',
-                'libsodium.ini'
-            );
-
-            if (!await pathExists(sodiumDynamicLibraryPath)) {
-                throw new UnknownError(`libsodium dynamic library file configuration not found: ${sodiumDynamicLibraryPath}`);
-            }
-            const fileContent = await fs.promises.readFile(sodiumDynamicLibraryPath, 'utf-8');
-
-            if (/^extension=libsodium\.so$/.test(fileContent.trim())) {
-                await fs.promises.writeFile(
-                    sodiumDynamicLibraryPath,
-                    'extension=sodium.so\n',
-                    'utf-8'
-                );
-            }
-        }
-    }
-};

package/lib/config/php/releases/php-7.2.js

@@ -1,25 +0,0 @@
-const path = require('path');
-const { xdebug } = require('../extensions');
-
-const php72 = ({ templateDir, additionalExtensions = {} }) => ({
-    version: '7.2.34',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {
-            macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
-        },
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php72;

package/lib/config/php/releases/php-7.3.js

@@ -1,25 +0,0 @@
-const path = require('path');
-const { xdebug } = require('../extensions');
-
-const php73 = ({ templateDir, additionalExtensions = {} }) => ({
-    version: '7.3.33',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {
-            macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
-        },
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php73;

package/lib/config/php/releases/php-7.4.js

@@ -1,23 +0,0 @@
-const path = require('path');
-const { xdebug } = require('../extensions');
-
-const php74 = ({ templateDir, additionalExtensions = {} } = {}) => ({
-    version: '7.4.30',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {},
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php74;

package/lib/config/php/releases/php-8.1.js

@@ -1,25 +0,0 @@
-const path = require('path');
-const { libsodium, xdebug } = require('../extensions');
-
-const php81 = ({ templateDir, additionalExtensions = {} } = {}) => ({
-    version: '8.1.7',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {},
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        libsodium,
-        fileinfo: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php81;

package/lib/config/phpbrew.js

@@ -1,12 +0,0 @@
-const os = require('os');
-const path = require('path');
-
-const homePath = process.env.PHPBREW_HOME || path.join(os.homedir(), '.phpbrew');
-const phpbrewConfig = {
-    homePath,
-    buildPath: path.join(homePath, 'build'),
-    phpPath: path.join(homePath, 'php'),
-    bashrcPath: path.join(homePath, 'bashrc')
-};
-
-module.exports = phpbrewConfig;

package/lib/tasks/composer/install-prestissimo.js

@@ -1,103 +0,0 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const os = require('os');
-const path = require('path');
-const fs = require('fs');
-const semver = require('semver');
-const { baseConfig } = require('../../config');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const pathExists = require('../../util/path-exists');
-const runComposerCommand = require('../../util/run-composer');
-
-const globalComposerJsonPath = path.join(os.homedir(), '.config', 'composer', 'composer.json');
-const localComposerJsonPath = path.join(baseConfig.magentoDir, 'composer.json');
-const prestissimoPluginName = 'hirak/prestissimo';
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const prestissimoInstall = () => ({
-    title: 'Installing Prestissimo',
-    task: async (ctx, task) => {
-        const { magentoVersion, composerVersion } = ctx;
-
-        if (semver.satisfies(composerVersion, '^2')) {
-            if (await pathExists(globalComposerJsonPath) && semver.satisfies(composerVersion, '^2.2.0')) {
-                const globalComposerJsonData = await getJsonfileData(globalComposerJsonPath);
-                const hasPrestissimoInstalled = globalComposerJsonData
-                    && globalComposerJsonData.require
-                    && !!globalComposerJsonData.require[prestissimoPluginName];
-
-                if (await pathExists(localComposerJsonPath)) {
-                    const localComposerJsonData = await getJsonfileData(localComposerJsonPath);
-
-                    if (
-                        hasPrestissimoInstalled
-                            && localComposerJsonData
-                            && localComposerJsonData.config
-                            && localComposerJsonData.config['allow-plugins']
-                            && typeof localComposerJsonData.config['allow-plugins'][prestissimoPluginName] !== 'boolean'
-                    ) {
-                        const disableConfirmation = await task.prompt({
-                            type: 'Select',
-                            message: `We noticed that you have Composer ${ctx.composerVersion}, but you have ${logger.style.code(prestissimoPluginName)} installed, which is used only in Composer 1.
-Would you like to disable it in your project?`,
-                            choices: [
-                                {
-                                    name: 'disable',
-                                    message: 'Disable it, thanks'
-                                },
-                                {
-                                    name: 'remove',
-                                    message: `Remove ${prestissimoPluginName} from your system`
-                                },
-                                {
-                                    name: 'skip',
-                                    message: 'Skip this step'
-                                }
-                            ]
-                        });
-
-                        if (disableConfirmation === 'disable') {
-                            localComposerJsonData.config['allow-plugins'][prestissimoPluginName] = false;
-                            await fs.promises.writeFile(localComposerJsonPath, JSON.stringify(localComposerJsonData, null, 4), 'utf-8');
-
-                            return;
-                        }
-
-                        if (disableConfirmation === 'remove') {
-                            await runComposerCommand(`global remove ${prestissimoPluginName}`, {
-                                throwNonZeroCode: false,
-                                magentoVersion
-                            });
-
-                            return;
-                        }
-                    }
-                }
-            }
-            task.skip();
-            return;
-        }
-        const { code } = await runComposerCommand(`global show ${prestissimoPluginName}`, {
-            throwNonZeroCode: false,
-            magentoVersion
-        });
-
-        if (code === 0) {
-            task.skip();
-            return;
-        }
-
-        await runComposerCommand(`global require ${prestissimoPluginName}`, {
-            magentoVersion,
-            callback: (t) => {
-                task.output = t;
-            }
-        });
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = prestissimoInstall;

package/lib/tasks/docker/containers.js

@@ -1,231 +0,0 @@
-/* eslint-disable max-len */
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const sleep = require('../../util/sleep');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const KnownError = require('../../errors/known-error');
-
-/**
- * @param {Object} options
- * @param {number[]} [options.ports] Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
- * @param {number[]} [options.mounts] Add bind mounts or volumes using the --mount flag [docs](https://docs.docker.com/engine/reference/commandline/run/#add-bind-mounts-or-volumes-using-the---mount-flag)
- * @param {number[]} [options.mountVolumes] Mount volume [docs](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only)
- * @param {Record<string, string>} [options.env] Set environment variables [docs](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
- * @param {string} [options.image]
- * @param {string} [options.restart] Restart policies [docs](https://docs.docker.com/engine/reference/commandline/run/#restart-policies---restart)
- * @param {string} [options.name] Container name
- * @param {string} [options.entrypoint] Container entrypoint
- * @param {string} [options.command] Container command
- * @param {Record<"cmd" | "interval" | "retries" | "start-period" | "timeout", string>} [options.healthCheck] Container heathcheck properties
- * @param {string[]} [options.securityOptions] Security options [docs](https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt)
- * @param {string[]} [options.tmpfs]
- */
-const run = (options) => {
-    const {
-        ports = [],
-        mounts = [],
-        mountVolumes = [],
-        env = {},
-        image,
-        restart,
-        network,
-        name,
-        entrypoint,
-        command = '',
-        healthCheck,
-        securityOptions = [],
-        tmpfs = [],
-        expose = []
-    } = options;
-
-    const exposeArg = expose && expose.map((e) => `--expose=${ e }`);
-    const restartArg = restart && `--restart ${ restart }`;
-    const networkArg = network && `--network ${ network }`;
-    const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
-    const mountsArgs = mounts.map((mount) => `--mount ${ mount }`).join(' ');
-    const mountVolumesArgs = mountVolumes.map((mount) => `-v ${mount}`).join(' ');
-    const envArgs = Object.entries(env).map(([key, value]) => `--env ${ key }=${ value }`).join(' ');
-    const nameArg = name && `--name ${name}`;
-    const entrypointArg = entrypoint && `--entrypoint "${entrypoint}"`;
-    const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key} '${value}'`).join(' ');
-    const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt ${opt}`).join(' ');
-    const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs ${t}`).join(' ');
-
-    const dockerCommand = [
-        'docker',
-        'run',
-        '-d',
-        nameArg,
-        networkArg,
-        restartArg,
-        portsArgs,
-        exposeArg,
-        mountsArgs,
-        mountVolumesArgs,
-        envArgs,
-        entrypointArg,
-        healthCheckArg,
-        securityArg,
-        tmpfsArg,
-        image,
-        command
-    ].filter(Boolean).join(' ');
-
-    return execAsyncSpawn(dockerCommand);
-};
-
-const stop = async (containers) => {
-    await execAsyncSpawn(`docker container stop ${containers.join(' ')}`);
-    await execAsyncSpawn(`docker container rm ${containers.join(' ')}`);
-};
-
-const pull = async (image) => execAsyncSpawn(`docker pull ${image}`);
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const pullContainers = () => ({
-    title: 'Pulling container images',
-    task: async ({ config: { docker } }, task) => {
-        const containers = Object.values(docker.getContainers());
-        const containerFilters = containers
-            .map((container) => `-f=reference='${container.imageDetails.name}:${container.imageDetails.tag}'`)
-            .join(' ');
-        const existingImages = await execAsyncSpawn(`docker images ${containerFilters}`);
-        const missingContainerImages = containers.filter((container) => !existingImages.split('\n')
-            .some((line) => line.includes(container.imageDetails.name) && line.includes(container.imageDetails.tag)))
-            .reduce((acc, val) => acc.concat(acc.some((c) => c.imageDetails.name === val.imageDetails.name && c.imageDetails.tag === val.imageDetails.tag) ? [] : val), []);
-
-        if (missingContainerImages.length === 0) {
-            task.skip();
-            return;
-        }
-
-        return task.newListr(
-            missingContainerImages.map((container) => ({
-                title: `Pulling ${ logger.style.file(`${container.imageDetails.name}:${container.imageDetails.tag}`) } image`,
-                task: () => pull(`${container.imageDetails.name}:${container.imageDetails.tag}`)
-            })), {
-                concurrent: true,
-                exitOnError: true
-            }
-        );
-    }
-});
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const startContainers = () => ({
-    title: 'Starting containers',
-    task: async ({ ports, config: { docker } }, task) => {
-        const containerList = (await execAsyncSpawn('docker container ls --all --format="{{.Names}}"')).split('\n');
-
-        const missingContainers = Object.values(docker.getContainers(ports)).filter(
-            ({ name }) => !containerList.includes(name)
-        );
-
-        if (missingContainers.length === 0) {
-            task.skip();
-            return;
-        }
-
-        // TODO: we might stop containers here ?
-        await Promise.all(missingContainers.map((container) => run(container).then((out) => {
-            task.output = `From ${container._}: ${out}`;
-        })));
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const stopContainers = () => ({
-    title: 'Stopping Docker containers',
-    task: async ({ config: { baseConfig: { prefix } } }, task) => {
-        const containerList = (await execAsyncSpawn('docker container ls --all --format="{{.Names}}"')).split('\n');
-
-        const runningContainers = containerList.filter((containerName) => containerName.startsWith(prefix));
-
-        if (runningContainers.length === 0) {
-            task.skip();
-            return;
-        }
-
-        await stop(runningContainers);
-    }
-});
-
-const getContainerStatus = async (containerName) => {
-    try {
-        return JSON.parse(await execAsyncSpawn(`docker inspect --format='{{json .State}}' ${containerName}`));
-    } catch {
-        return null;
-    }
-};
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const checkContainersAreRunning = () => ({
-    title: 'Checking container statuses',
-    task: async (ctx, task) => {
-        const { config: { docker }, ports } = ctx;
-        const containers = Object.values(docker.getContainers(ports));
-        let tries = 0;
-        while (tries < 3) {
-            const containersWithStatus = await Promise.all(
-                containers.map(async (container) => ({
-                    ...container,
-                    status: await getContainerStatus(container.name)
-                }))
-            );
-
-            if (containersWithStatus.some((c) => c.status.Status !== 'running')) {
-                if (tries === 2) {
-                    throw new KnownError(`${containersWithStatus.filter((c) => c.status.Status !== 'running').map((c) => c._).join(', ')} containers are not running! Please check container logs for more details!`);
-                } else {
-                    task.output = `${containersWithStatus.filter((c) => c.status.Status !== 'running').map((c) => c._).join(', ')} are not running, waiting if something will change...`;
-                    await sleep(2000);
-                    tries++;
-                }
-            } else {
-                break;
-            }
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const statusContainers = () => ({
-    task: async (ctx) => {
-        const { config: { docker }, ports } = ctx;
-        const containers = Object.values(docker.getContainers(ports));
-
-        ctx.containers = await Promise.all(
-            containers.map(async (container) => ({
-                ...container,
-                status: await getContainerStatus(container.name)
-            }))
-        );
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = {
-    startContainers,
-    stopContainers,
-    pullContainers,
-    statusContainers,
-    checkContainersAreRunning,
-    getContainerStatus
-};

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

@@ -1,114 +0,0 @@
-const mysql = require('mysql2/promise');
-const UnknownError = require('../../errors/unknown-error');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const sleep = require('../../util/sleep');
-const { createMagentoDatabase } = require('./create-magento-database');
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const waitForMySQLInitialization = () => ({
-    title: 'Waiting for MySQL to initialize',
-    task: async (ctx, task) => {
-        const { mysql: { name } } = ctx.config.docker.getContainers();
-        let mysqlReadyForConnections = false;
-        while (!mysqlReadyForConnections) {
-            const mysqlOutput = await execAsyncSpawn(`docker logs ${name}`);
-            if (mysqlOutput.includes('ready for connections')) {
-                mysqlReadyForConnections = true;
-                break;
-            } else if (mysqlOutput.includes('Initializing database files')) {
-                task.output = `MySQL is initializing database files!
-Please wait, this will take some time and do not restart the MySQL container until initialization is finished!`;
-
-                let mysqlFinishedInitialization = false;
-                while (!mysqlFinishedInitialization) {
-                    const mysqlOutput = await execAsyncSpawn(`docker logs ${name}`);
-                    if (mysqlOutput.includes('init process done.') && !mysqlFinishedInitialization) {
-                        mysqlFinishedInitialization = true;
-                        break;
-                    }
-                    await sleep(2000);
-                }
-            }
-
-            await sleep(2000);
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const gettingMySQLConnection = () => ({
-    title: 'Getting MySQL connection',
-    task: async (ctx, task) => {
-        const { config: { docker }, ports } = ctx;
-        const { mysql: { env } } = docker.getContainers();
-        let tries = 0;
-        const maxTries = 20;
-        const errors = [];
-        while (tries < maxTries) {
-            tries++;
-            try {
-                const connection = await mysql.createConnection({
-                    host: '127.0.0.1',
-                    port: ports.mysql,
-                    user: env.MYSQL_USER,
-                    password: env.MYSQL_PASSWORD,
-                    database: env.MYSQL_DATABASE
-                });
-
-                ctx.mysqlConnection = connection;
-                break;
-            } catch (e) {
-                errors.push(e);
-            }
-            await sleep(1000);
-        }
-
-        if (tries === maxTries) {
-            throw new UnknownError(`Unable to connect to MySQL server. Check your server configuration!\n\n${ errors.join(' ') }`);
-        }
-
-        task.title = 'MySQL server connected!';
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const terminatingExistingConnection = () => ({
-    title: 'Terminating existing MySQL connection',
-    skip: (ctx) => !ctx.mysqlConnection,
-    task: (ctx) => {
-        ctx.mysqlConnection.destroy();
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const connectToMySQL = () => ({
-    title: 'Connecting to MySQL server',
-    skip: (ctx) => ctx.skipSetup,
-    task: (ctx, task) => task.newListr([
-        waitForMySQLInitialization(),
-        createMagentoDatabase(),
-        terminatingExistingConnection(),
-        gettingMySQLConnection()
-    ], {
-        concurrent: false,
-        rendererOptions: {
-            collapse: true
-        }
-    }),
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = connectToMySQL;

package/lib/tasks/mysql/create-magento-database.js

@@ -1,18 +0,0 @@
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-
-/**
- * Will create database 'magento' in MySQL if it does not exist for some reason
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const createMagentoDatabase = () => ({
-    title: 'Creating Magento database in MySQL',
-    task: async (ctx) => {
-        const { mysql } = ctx.config.docker.getContainers();
-
-        await execAsyncSpawn(`docker exec ${mysql.name} mysql -umagento -pmagento -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`);
-    }
-});
-
-module.exports = {
-    createMagentoDatabase
-};

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

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