@scandipwa/magento-scripts 2.0.0-alpha.0 → 2.0.0-alpha.11

package/typings/index.d.ts

@@ -1,14 +1,21 @@
 import { ListrContext } from './context';
 
 /* eslint-disable no-use-before-define */
-export interface ServiceWithVersion {
+export interface ServiceWithImage {
     /**
      * Service version
+     *
+     * @deprecated
      */
     version: string
+
+    /**
+     * Service Docker image
+     */
+    image: string
 }
 
-export interface SSLTerminatorConfiguration extends ServiceWithVersion {
+export interface SSLTerminatorConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
      *
@@ -17,7 +24,7 @@ export interface SSLTerminatorConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface NginxConfiguration extends ServiceWithVersion {
+export interface NginxConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
      *
@@ -26,7 +33,14 @@ export interface NginxConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface VarnishConfiguration extends ServiceWithVersion {
+export interface ElasticSearchConfiguration extends ServiceWithImage {
+    /**
+     * Environmental variables used for Elasticsearch container
+     */
+    env: Record<string, unknown>
+}
+
+export interface VarnishConfiguration extends ServiceWithImage {
     /**
      * Enable or disable Varnish in the project
      */
@@ -38,6 +52,42 @@ export interface VarnishConfiguration extends ServiceWithVersion {
      * @example ./my-varnish-config.vcl
      */
     configTemplate: string
+
+    /**
+     * Enable or disable healthcheck in the project
+     */
+    healthCheck: boolean
+}
+
+export interface ComposerConfiguration {
+    /**
+     * Composer version
+     *
+     * This will become part of the url (`https://getcomposer.org/download/<version>/composer.phar`) so you can use the following variants as well:
+     * ```
+     * 'latest-stable'
+     * 'latest-preview'
+     * 'latest-1.x'
+     * 'latest-2.x'
+     * 'latest-2.2.x'
+     *
+     * '2.4.1'
+     * '2.3.10'
+     * '2.2.18'
+     * '2.1.14'
+     * ```
+     *
+     * @url https://getcomposer.org/download/
+     */
+    version: string
+
+    /**
+     *  Composer global plugins that will be added to Docker image
+     */
+    plugins: Record<string, {
+        version?: string
+        options?: string
+    }>
 }
 
 export interface PHPExtensionInstallationInstruction {
@@ -59,7 +109,9 @@ export interface PHPExtensionInstallationInstruction {
      * pecl install xdebug && docker-php-ext-enable xdebug
      * ```
      */
-    command: (arg0: (Omit<PHPExtensionInstallationInstruction, 'command'> & { ctx: ListrContext})) => string | string
+    command: string |
+        ((arg0: (Omit<PHPExtensionInstallationInstruction, 'command'> & { ctx: ListrContext})) => string) |
+        ((arg0: (Omit<PHPExtensionInstallationInstruction, 'command'> & { ctx: ListrContext})) => Promise<string>)
 
     /**
      * System dependencies required by the extension
@@ -97,6 +149,12 @@ export interface PHPConfiguration {
      * @example ./my-php-template.ini
      */
     configTemplate: string
+    /**
+     * PHP XDebug file template location
+     *
+     * @example ./my-php-debug-template.ini
+     */
+    debugTemplate: string
 
     /**
      * PHP-FPM configuration file template location
@@ -109,11 +167,6 @@ export interface PHPConfiguration {
      * Extensions for PHP
      */
     extensions: PHPExtensions
-
-    /**
-     * Disabled extension list
-     */
-    disabledExtensions?: string[]
 }
 export interface SSLConfiguration {
     /**
@@ -153,30 +206,25 @@ export interface CMAConfiguration {
          */
         nginx: NginxConfiguration
 
-        /**
-         * MySQL configuration
-         */
-        mysql: ServiceWithVersion
-
         /**
          * MariaDB configuration
          */
-        mariadb: ServiceWithVersion
+        mariadb: ServiceWithImage
 
         /**
          * ElasticSearch configuration
          */
-        elasticsearch: ServiceWithVersion
+        elasticsearch: ElasticSearchConfiguration
 
         /**
          * Redis configuration
          */
-        redis: ServiceWithVersion
+        redis: ServiceWithImage
 
         /**
          * Composer configuration
          */
-        composer: ServiceWithVersion
+        composer: ComposerConfiguration
 
         /**
          * Varnish configuration
@@ -222,8 +270,8 @@ export interface CMAConfiguration {
     }
     /**
      *  Custom host for website base url
-     * @default 'localhost'
-     * */
+     *  @default 'localhost'
+     */
     host: string
 
     /**
@@ -242,14 +290,4 @@ export interface CMAConfiguration {
      * If prefix is set to `false` docker container and volume names will only include folder name **which is not safe and not recommended**.
      */
     prefix: boolean
-
-    /**
-     * Non-overlapping ports config
-     * @default false
-     *
-     * @deprecated Use global configuration file.
-     * @description If set to `true` CMA will try retrieving others CMA projects port configuration
-     * and will not use their ports for itself.
-     */
-    useNonOverlappingPorts: boolean
 }

package/lib/tasks/docker/volumes.js

@@ -1,63 +0,0 @@
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-
-const create = ({
-    driver,
-    opts = {},
-    name
-}) => {
-    let command = `docker volume create ${ Object.entries(opts).map(([name, value]) => `--opt ${name}='${value}'`).join(' ') } `;
-
-    if (driver) {
-        command += `--driver ${ driver }`;
-    }
-
-    return execAsyncSpawn(`${ command } ${ name }`);
-};
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const createVolumes = () => ({
-    title: 'Creating volumes',
-    task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
-
-        const missingVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => !volumeList.includes(name)
-        );
-
-        if (missingVolumes.length === 0) {
-            task.skip();
-            return;
-        }
-
-        await Promise.all(missingVolumes.map((volume) => create(volume)));
-    }
-});
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const removeVolumes = () => ({
-    title: 'Removing volumes',
-    task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
-
-        const deployedVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => volumeList.includes(name)
-        );
-
-        if (deployedVolumes.length === 0) {
-            task.skip();
-            return;
-        }
-
-        await execAsyncSpawn(`docker volume rm ${deployedVolumes.map(({ name }) => name).join(' ')}`);
-    }
-});
-
-module.exports = {
-    createVolumes,
-    removeVolumes,
-    createVolume: create
-};

package/lib/tasks/execute/index.js

@@ -1,23 +0,0 @@
-// const path = require('path');
-const { spawn } = require('child_process');
-
-const executeInContainer = ({ containerName, commands }) => {
-    if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode');
-        process.exit(1);
-    }
-
-    spawn('docker', [
-        'exec',
-        '-it',
-        containerName
-    ].concat(...commands.map((command) => command.split(' '))), {
-        stdio: [0, 1, 2]
-    });
-
-    return new Promise((_resolve) => {
-        // never resolve
-    });
-};
-
-module.exports = executeInContainer;

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

@@ -1,127 +0,0 @@
-const mysql2 = 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 } = ctx.config.docker.getContainers();
-
-        task.title = `Waiting for ${mysql._} to initialize`;
-
-        let mysqlReadyForConnections = false;
-
-        while (!mysqlReadyForConnections) {
-            const mysqlOutput = await execAsyncSpawn(`docker logs ${mysql.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 ${mysql.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 } = docker.getContainers(ctx.ports);
-        let tries = 0;
-        const maxTries = 20;
-        const errors = [];
-
-        task.title = `Getting ${mysql._} connection`;
-
-        while (tries < maxTries) {
-            tries++;
-            try {
-                const connection = await mysql2.createConnection({
-                    host: '127.0.0.1',
-                    port: ports.mysql,
-                    user: mysql.env.MYSQL_USER,
-                    password: mysql.env.MYSQL_PASSWORD,
-                    database: mysql.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 Database 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) => {
-        const { mysql } = ctx.config.docker.getContainers();
-
-        task.title = `Connecting to ${mysql._} server`;
-
-        return 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/requirements/dependency/arch.js

@@ -1,50 +0,0 @@
-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');
-
-const pkgRegex = /(\S+)\s(\S+)/i;
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const archDependenciesCheck = () => ({
-    title: 'Checking Arch Linux dependencies',
-    task: async (ctx, task) => {
-        const installedDependencies = (await execAsyncSpawn('pacman -Q')).split('\n')
-            .map((pkg) => {
-                const result = pkg.match(pkgRegex);
-
-                if (!result) {
-                    throw new UnknownError(`Package without a version!\n\n${pkg}\n\nHOW?`);
-                }
-
-                return result[1];
-            });
-
-        const dependenciesToInstall = dependenciesForPlatforms['Arch Linux']
-            .dependencies
-            .filter((dep) => {
-                if (Array.isArray(dep)) {
-                    return !dep.some((dp) => installedDependencies.includes(dp));
-                }
-
-                return !installedDependencies.includes(dep);
-            })
-            .map((dep) => (Array.isArray(dep) ? dep[0] : dep));
-
-        if (dependenciesToInstall.length > 0) {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'Arch Linux',
-                    dependenciesToInstall
-                })
-            );
-        }
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = archDependenciesCheck;

package/lib/tasks/requirements/dependency/centos.js

@@ -1,36 +0,0 @@
-const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const installDependenciesTask = require('../../../util/install-dependencies-task');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const centosDependenciesCheck = () => ({
-    title: 'Checking CentOS dependencies',
-    task: async (ctx, task) => {
-        const installedDependencies = (await execAsyncSpawn('yum list installed')).split('\n')
-            .filter((pkg) => !pkg.toLowerCase().includes('installed packages'))
-            .map((pkg) => pkg.match(/^(\S+)/i))
-            .filter(Boolean)
-            .map((pkg) => pkg[1])
-            .map((pkg) => pkg.match(/^(\S+)\.\S+/i))
-            .filter(Boolean)
-            .map((pkg) => pkg[1]);
-
-        const dependenciesToInstall = dependenciesForPlatforms
-            .CentOS
-            .dependencies
-            .filter((dep) => !installedDependencies.includes(dep));
-
-        if (dependenciesToInstall.length > 0) {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'CentOS',
-                    dependenciesToInstall
-                })
-            );
-        }
-    }
-});
-
-module.exports = centosDependenciesCheck;

package/lib/tasks/requirements/dependency/fedora.js

@@ -1,36 +0,0 @@
-const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const installDependenciesTask = require('../../../util/install-dependencies-task');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const fedoraDependenciesCheck = () => ({
-    title: 'Checking Fedora Linux dependencies',
-    task: async (ctx, task) => {
-        const installedDependencies = (await execAsyncSpawn('yum list installed')).split('\n')
-            .filter((pkg) => !pkg.toLowerCase().includes('installed packages'))
-            .map((pkg) => pkg.match(/^(\S+)/i))
-            .filter(Boolean)
-            .map((pkg) => pkg[1])
-            .map((pkg) => pkg.match(/^(\S+)\.\S+/i))
-            .filter(Boolean)
-            .map((pkg) => pkg[1]);
-
-        const dependenciesToInstall = dependenciesForPlatforms
-            .Fedora
-            .dependencies
-            .filter((dep) => !installedDependencies.includes(dep));
-
-        if (dependenciesToInstall.length > 0) {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'Fedora',
-                    dependenciesToInstall
-                })
-            );
-        }
-    }
-});
-
-module.exports = fedoraDependenciesCheck;

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

@@ -1,33 +0,0 @@
-const archDependenciesCheck = require('./arch');
-const fedoraDependenciesCheck = require('./fedora');
-const centosDependenciesCheck = require('./centos');
-const ubuntuDependenciesCheck = require('./ubuntu');
-const macDependenciesCheck = require('./mac');
-const osPlatform = require('../../../util/os-platform');
-
-const dependencyCheck = async () => {
-    if (process.platform === 'darwin') {
-        return macDependenciesCheck();
-    }
-
-    const distro = await osPlatform();
-    switch (distro) {
-    case 'Arch Linux': {
-        return archDependenciesCheck();
-    }
-    case 'Fedora': {
-        return fedoraDependenciesCheck();
-    }
-    case 'CentOS': {
-        return centosDependenciesCheck();
-    }
-    case 'Ubuntu': {
-        return ubuntuDependenciesCheck();
-    }
-    default: {
-        // skip check
-    }
-    }
-};
-
-module.exports = dependencyCheck;