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

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/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
-};

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

@@ -1,56 +0,0 @@
-/* eslint-disable max-len */
-const { getBrewCommandSync, getBrewBinPathSync } = require('../../util/get-brew-bin-path');
-const { bundledExtensions } = require('./bundled-extensions');
-
-const darwinVariants = [
-    `openssl=$(${getBrewCommandSync()} --prefix openssl@1.1)`, // ="$(brew --prefix openssl@1.1)"
-    `curl=$(${getBrewCommandSync()} --prefix curl)`,
-    `intl=$(${getBrewCommandSync()} --prefix icu4c)`,
-    `bz2="$(${getBrewCommandSync()} --prefix bzip2)"`
-];
-
-const compileOptions = {
-    linux: {
-        cpuCount: '$(nproc)',
-        variants: bundledExtensions.map((ext) => `+${ext}`),
-        extraOptions: [
-            '--with-freetype-dir=/usr/include/freetype2',
-            '--with-openssl=/usr/',
-            '--with-gd=shared',
-            '--with-jpeg-dir=/usr/',
-            '--with-png-dir=/usr/'
-        ],
-        env: {
-            CXX: 'g++ -DTRUE=1 -DFALSE=0',
-            CC: 'gcc -DTRUE=1 -DFALSE=0'
-        }
-    },
-    darwin: {
-        cpuCount: '$(sysctl -n hw.ncpu)',
-        variants: bundledExtensions.map((ext) => {
-            const darwinVariant = darwinVariants.find((dv) => dv.startsWith(ext));
-            if (darwinVariant) {
-                return `+${darwinVariant}`;
-            }
-
-            return `+${ext}`;
-        }),
-        extraOptions: [
-            `--with-zlib-dir=$(${getBrewCommandSync()} --prefix zlib)`,
-            `--with-iconv=$(${getBrewCommandSync()} --prefix libiconv)`,
-            '--with-gd=shared'
-        ],
-        env: {
-            // eslint-disable-next-line max-len
-            PKG_CONFIG_PATH: `$PKG_CONFIG_PATH:$(${getBrewCommandSync()} --prefix libxml2)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix icu4c)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix openssl@1.1)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix curl)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix zlib)/lib/pkgconfig`,
-            CPATH: `$CPATH:$(${getBrewCommandSync()} --prefix openssl@1.1)/include`,
-            CXX: 'g++ -DTRUE=1 -DFALSE=0',
-            CC: 'gcc -DTRUE=1 -DFALSE=0',
-            LDFLAGS: `$(${getBrewCommandSync()} --prefix openssl@1.1)/lib/libssl.dylib $(${getBrewCommandSync()} --prefix openssl@1.1)/lib/libcrypto.dylib`,
-            CFLAGS: '-Wno-implicit-function-declaration', // https://github.com/phpbrew/phpbrew/issues/1222
-            PATH: `${getBrewBinPathSync().replace('/brew', '')}:${process.env.PATH}`
-        }
-    }
-};
-
-module.exports = compileOptions;

package/lib/tasks/php/compile.js

@@ -1,55 +0,0 @@
-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');
-const { getPHPForPHPBrewBin } = require('../../util/get-php-for-phpbrew');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const compilePHP = () => ({
-    title: 'Compiling PHP',
-    task: async ({ config: { php } }, task) => {
-        const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-        const platformCompileOptions = compileOptions[process.platform];
-        if (process.platform === 'linux') {
-            const { distro } = await systeminformation.osInfo();
-            if (['Fedora', 'Manjaro'].some((d) => distro.includes(d))) {
-                platformCompileOptions.extraOptions.push('--with-libdir=lib64');
-            }
-        }
-        const commandEnv = Object.entries(platformCompileOptions.env || {}).map(([key, value]) => `export ${key}="${value}"`).join(' && ');
-        const phpCompileCommand = `${commandEnv ? `${commandEnv} && ` : ''} \
-        phpbrew install -j ${platformCompileOptions.cpuCount} ${php.version} ${platformCompileOptions.variants.join(' ')} \
-        -- ${platformCompileOptions.extraOptions.join(' ')}`;
-
-        try {
-            await execAsyncSpawn(
-                phpCompileCommand,
-                {
-                    callback: (t) => {
-                        task.output = t;
-                    },
-                    useRosetta2: true,
-                    env: phpBinForPHPBrew ? {
-                        ...process.env,
-                        PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-                    } : process.env
-                }
-            );
-        } catch (e) {
-            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.
-                See error details in the output below.\n\n${e}`
-            );
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = compilePHP;

package/lib/tasks/php/configure.js

@@ -1,89 +0,0 @@
-/* eslint-disable max-len */
-const enableExtension = require('./extensions/enable');
-const installExtension = require('./extensions/install');
-const disableExtension = require('./extensions/disable');
-const {
-    getEnabledExtensions,
-    getInstalledExtensions,
-    getDisabledExtensions
-} = require('./extensions');
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const configurePHP = () => ({
-    title: 'Configuring PHP extensions',
-    task: async ({ config, debug }, task) => {
-        const { php, php: { disabledExtensions = [] } } = config;
-        const enabledExtensions = await getEnabledExtensions(config);
-        const installedExtensions = await getInstalledExtensions(config);
-        const disabledExtensionsInPHP = await getDisabledExtensions(config);
-
-        if (!debug && enabledExtensions.xdebug && !disabledExtensions.includes('xdebug')) {
-            disabledExtensions.push('xdebug');
-        }
-
-        /** @type {[string, import('../../../typings/index').PHPExtension][]} */
-        const missingExtensions = Object.entries(php.extensions)
-            .filter(([name, options]) => {
-                const extensionName = options.extensionName || name;
-
-                return !disabledExtensions.includes(extensionName);
-            })
-            // check if module is not loaded and if it is loaded check installed version
-            .filter(([name, options]) => {
-                const extensionName = options.extensionName || name;
-                if (extensionName === 'xdebug' && !debug) {
-                    return false;
-                }
-                if (!enabledExtensions[extensionName]) {
-                    return true;
-                }
-
-                if (options && options.version && enabledExtensions[extensionName] !== options.version) {
-                    return true;
-                }
-
-                return false;
-            });
-
-        /** @type {import('listr2').ListrTask[]} */
-        const extensionTasks = [];
-
-        if (missingExtensions.length > 0) {
-            missingExtensions.forEach(([extensionName, extensionOptions]) => {
-                if (installedExtensions.includes(extensionName) && disabledExtensionsInPHP.includes(extensionName)) {
-                    extensionTasks.push(enableExtension(extensionName, extensionOptions));
-                } else {
-                    extensionTasks.push(installExtension(extensionName, extensionOptions));
-                }
-            });
-        }
-
-        if (disabledExtensions.length > 0) {
-            disabledExtensions.forEach((extensionName) => {
-                extensionTasks.push(disableExtension(extensionName));
-            });
-        }
-
-        if (extensionTasks.length === 0) {
-            task.skip();
-            return;
-        }
-
-        return task.newListr(
-            extensionTasks,
-            {
-                concurrent: false,
-                rendererOptions: {
-                    collapse: false
-                }
-            }
-        );
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = configurePHP;

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

@@ -1,49 +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
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const disableExtension = (extensionName) => ({
-    title: `Disabling ${extensionName} extension`,
-    task: async (ctx, task) => {
-        const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-        const {
-            config,
-            config: { php }
-        } = ctx;
-        const extensionOptions = php.extensions[extensionName] || {};
-        const { hooks } = extensionOptions;
-        if (extensionOptions.disable) {
-            await Promise.resolve(extensionOptions.disable(ctx, task));
-        } else {
-            if (hooks && hooks.preDisable) {
-                await Promise.resolve(hooks.preDisable(config));
-            }
-            await execAsyncSpawn(`source ${phpbrewConfig.bashrcPath} && \
-            phpbrew use ${ php.version } && \
-            phpbrew ext disable ${ extensionName }`,
-            {
-                callback: (t) => {
-                    task.output = t;
-                },
-                useRosetta2: true,
-                env: phpBinForPHPBrew ? {
-                    ...process.env,
-                    PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-                } : process.env
-            });
-            if (hooks && hooks.postDisable) {
-                await Promise.resolve(hooks.postDisable(config));
-            }
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = disableExtension;

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

@@ -1,52 +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 enableExtension = (extensionName, extensionOptions) => ({
-    title: `Enabling ${extensionName} extension`,
-    task: async (ctx, task) => {
-        const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-        const {
-            config,
-            config: { php }
-        } = ctx;
-        const { hooks } = extensionOptions;
-
-        if (extensionOptions.enable) {
-            await Promise.resolve(extensionOptions.enable(ctx, task));
-        } else {
-            if (hooks && hooks.postEnable) {
-                await Promise.resolve(hooks.postEnable(config));
-            }
-
-            await execAsyncSpawn(`source ${phpbrewConfig.bashrcPath} && \
-            phpbrew use ${ php.version } && \
-            phpbrew ext enable ${ extensionName }`,
-            {
-                callback: (t) => {
-                    task.output = t;
-                },
-                useRosetta2: true,
-                env: phpBinForPHPBrew ? {
-                    ...process.env,
-                    PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-                } : process.env
-            });
-
-            if (hooks && hooks.postEnable) {
-                await Promise.resolve(hooks.postEnable(config));
-            }
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = enableExtension;

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

@@ -1,80 +0,0 @@
-/* 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');
-const { getPHPForPHPBrewBin } = require('../../../util/get-php-for-phpbrew');
-
-/**
- * Get enabled extensions list with versions
- * @param {import('../../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<{[key: string]: string}}>}
- */
-const getEnabledExtensions = async ({ php }) => {
-    const phpBinForPHPBrew = await getPHPForPHPBrewBin();
-    const output = await execAsyncSpawn(
-        `${ php.binPath } -c ${php.iniPath} -r 'foreach (get_loaded_extensions() as $extension) echo "$extension:" . phpversion($extension) . "\n";'`,
-        {
-            useRosetta2: true,
-            env: phpBinForPHPBrew ? {
-                ...process.env,
-                PATH: `${phpBinForPHPBrew}:${process.env.PATH}`
-            } : process.env
-        }
-    );
-
-    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('.ini.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
-};