@scandipwa/magento-scripts 2.0.0-alpha.10 → 2.0.0-alpha.13

package/lib/tasks/status/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 const path = require('path');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const { getProjectCreatedAt, getPrefix } = require('../../util/prefix');
@@ -5,7 +6,6 @@ const { getProjectCreatedAt, getPrefix } = require('../../util/prefix');
 const { version: packageVersion } = require('../../../package.json');
 const { getArchSync } = require('../../util/arch');
 const ConsoleBlock = require('../../util/console-block');
-const { getComposerVersion } = require('../composer');
 const { getInstanceMetadata } = require('../../util/instance-metadata');
 
 /**
@@ -22,6 +22,9 @@ const parsePort = (port) => {
     };
 };
 
+/**
+ * @param {import('../../../typings/context').ListrContext & { containers: ReturnType<Awaited<ReturnType<import('../../config/docker')>>['getContainers']> }} ctx
+ */
 const prettyStatus = async (ctx) => {
     const {
         config: {
@@ -31,10 +34,10 @@ const prettyStatus = async (ctx) => {
         dockerVersion,
         platform,
         platformVersion,
-        containers
+        containers,
+        composerVersion
     } = ctx;
     const projectCreatedAt = getProjectCreatedAt();
-    const composerVersion = await getComposerVersion(ctx);
 
     const prefix = getPrefix();
 
@@ -103,6 +106,13 @@ const prettyStatus = async (ctx) => {
                 block.addLine(`${' '.repeat(3)} ${logger.style.misc(envName)}=${logger.style.file(envValue)}`);
             }
         }
+
+        if (container.description) {
+            block.addLine('Description:');
+            container.description.split('\n').forEach((line) => {
+                block.addLine(line);
+            });
+        }
     });
 
     const instanceMetadata = getInstanceMetadata(ctx);
@@ -123,14 +133,6 @@ const prettyStatus = async (ctx) => {
     instanceMetadata.admin.forEach(({ title, text }) => {
         block.addLine(`  ${title}: ${text}`);
     });
-    // block
-    //     .addEmptyLine()
-    //     .addSeparator('Magento status')
-    //     .addEmptyLine()
-    //     .addLine(`Web location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/`)}`)
-    //     .addLine(`Magento Admin panel location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/${magentoConfiguration.adminuri}`)}`)
-    //     .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`)
-    //     .addEmptyLine();
 
     block.log();
 };

package/lib/tasks/stop.js

@@ -2,6 +2,7 @@ const { stopServices } = require('./docker');
 const getMagentoVersionConfig = require('../config/get-magento-version-config');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const checkConfigurationFile = require('../config/check-configuration-file');
+const getDockerVersion = require('./requirements/docker/version');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -9,6 +10,7 @@ const checkConfigurationFile = require('../config/check-configuration-file');
 const stop = () => ({
     title: 'Stopping project',
     task: async (ctx, task) => task.newListr([
+        getDockerVersion(),
         getMagentoVersionConfig(),
         checkConfigurationFile(),
         getProjectConfiguration(),

package/lib/util/config-file-validator.js

@@ -69,6 +69,7 @@ const phpConfigurationSchema = Joi.object({
     debugImage: Joi.string().optional(),
     fpmConfigTemplate: Joi.string().optional(),
     configTemplate: Joi.string().optional().custom(fileExistsValidator),
+    debugTemplate: Joi.string().optional().custom(fileExistsValidator),
     extensions: phpExtensionConfiguration.optional()
 });
 
@@ -85,6 +86,7 @@ const nginxConfigurationSchema = Joi.object({
  */
 const varnishConfigurationSchema = Joi.object({
     enabled: Joi.boolean().optional(),
+    healthCheck: Joi.boolean().optional(),
     image: Joi.string().optional(),
     configTemplate: Joi.string().optional().custom(fileExistsValidator)
 });

package/lib/util/execute-in-container.js

@@ -3,15 +3,15 @@ const { spawn } = require('child_process');
 const { runCommand } = require('../tasks/docker/containers/container-api');
 
 /**
- * @param {{ containerName: string, commands: string[] }} param0
+ * @param {{ containerName: string, commands: string[], isDockerDesktop: boolean }} param0
  */
-const executeInContainer = ({ containerName, commands }) => {
+const executeInContainer = ({ containerName, commands, isDockerDesktop }) => {
     if (!process.stdin.isTTY) {
         process.stderr.write('This app works only in TTY mode');
         process.exit(1);
     }
 
-    const userArg = os.platform() === 'linux' && `--user=${os.userInfo().uid}:${os.userInfo().gid}`;
+    const userArg = ((os.platform() === 'linux' && isDockerDesktop) || !isDockerDesktop) && `--user=${os.userInfo().uid}:${os.userInfo().gid}`;
 
     spawn('docker', [
         'exec',

package/lib/util/systemctl.js

@@ -3,10 +3,10 @@ const { execAsyncSpawn } = require('./exec-async-command');
 /**
  * @param {String} cmd
  * @param {String} serviceName
- * @param {{ now: boolean }} options
+ * @param {{ now: boolean, user: boolean }} options
  */
 const run = (cmd, serviceName, options = {}) => execAsyncSpawn(
-    `systemctl ${ cmd }${ serviceName ? ` ${ serviceName }` : '' }${ options.now ? ' --now' : ''}`,
+    `systemctl ${ options.user ? '--user ' : '' }${ cmd }${ serviceName ? ` ${ serviceName }` : '' }${ options.now ? ' --now' : ''}`,
     {
         withCode: true
     }
@@ -14,29 +14,78 @@ const run = (cmd, serviceName, options = {}) => execAsyncSpawn(
 
 const daemonReload = () => run('daemon-reload');
 
-const systemctlControl = (serviceName) => ({
-    disable: () => run('disable', serviceName),
-    enable: () => run('enable', serviceName),
-    enableAndStart: () => run('enable', serviceName, { now: true }),
-    restart: () => run('restart', serviceName),
-    start: () => run('start', serviceName),
-    stop: () => run('stop', serviceName),
-    isEnabled: async () => {
+/**
+ * @param {String} serviceName
+ * @param {{ now: boolean, user: boolean }} defaultOptions
+ */
+const systemctlControl = (serviceName, defaultOptions = {}) => ({
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    disable: (options = {}) => run('disable', serviceName, { ...defaultOptions, ...options }),
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    enable: (options = {}) => run('enable', serviceName, { ...defaultOptions, ...options }),
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    enableAndStart: (options = {}) => run('enable', serviceName, { now: true, ...defaultOptions, ...options }),
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    restart: (options = {}) => run('restart', serviceName, { ...defaultOptions, ...options }),
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    start: (options = {}) => run('start', serviceName, { ...defaultOptions, ...options }),
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    stop: (options = {}) => run('stop', serviceName, { ...defaultOptions, ...options }),
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    isEnabled: async (options = {}) => {
         try {
-            const { result } = await run('is-enabled', serviceName);
+            const { result } = await run('is-enabled', serviceName, { ...defaultOptions, ...options });
             return result.includes('enabled');
         } catch (e) {
             return false;
         }
     },
-    isRunning: async () => {
+    /**
+     * @param {{ now: boolean, user: boolean }} options
+     */
+    isRunning: async (options = {}) => {
         try {
-            const { result } = await run('status', serviceName);
+            const { result } = await run('status', serviceName, { ...defaultOptions, ...options });
 
             return result.includes('active (running)');
         } catch (e) {
             return false;
         }
+    },
+    /**
+     * @param {{ user: boolean }} options
+     */
+    exists: async (options = {}) => {
+        const optionsToUse = { ...defaultOptions, ...options };
+        try {
+            // eslint-disable-next-line max-len, no-useless-escape
+            const command = `if [[ $(systemctl ${ optionsToUse.user ? '--user ' : ''}list-units --all -t service --full --no-legend "${ serviceName }.service" | sed 's/^\\s*//g' | cut -f1 -d' ') == ${ serviceName }.service ]]; then
+                echo "1"
+            else
+                echo "0"
+            fi`;
+            const result = await execAsyncSpawn(
+                command
+            );
+
+            return result === '1';
+        } catch (e) {
+            return false;
+        }
     }
 });
 

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.0.0-alpha.10",
+    "version": "2.0.0-alpha.13",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -54,5 +54,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "8b34ad44642dc8b4decf57df42f45ab2cdd18e16"
+    "gitHead": "92a6255dbb6fb46334c0677be8f1ff2c7adab56f"
 }

package/typings/context.d.ts

@@ -1,11 +1,13 @@
 import mysql2 from 'mysql2';
 
+import { DockerVersionResult } from '../lib/tasks/docker/api';
 import { CMAConfiguration, PHPExtensions } from './index';
 import { PHPStormConfig } from './phpstorm';
 
 export interface ListrContext {
     magentoVersion: string
     composerVersion: string
+    phpVersion: string
     port?: number
     ports?: {
         app: number
@@ -67,6 +69,7 @@ export interface ListrContext {
                 network: string
                 image: string
                 debugImage?: string
+                remoteImages?: string[]
                 name: string
                 command: string
                 connectCommand: string[]
@@ -90,4 +93,8 @@ export interface ListrContext {
     }
     databaseConnection: mysql2.Connection
     isSetupUpgradeNeeded?: boolean
+    isDockerDesktop?: boolean
+    dockerServerData?: DockerVersionResult['Server']
+    dockerClientData?: DockerVersionResult['Client']
+    dockerVersion?: DockerVersionResult['Server']['Version']
 }

package/typings/index.d.ts

@@ -52,13 +52,42 @@ export interface VarnishConfiguration extends ServiceWithImage {
      * @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 {
@@ -80,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
@@ -118,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

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;

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

@@ -1,124 +0,0 @@
-const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
-const { execAsyncSpawn, execCommandTask } = require('../../../util/exec-async-command');
-const {
-    BREW_BIN_PATH_ARM_NATIVE,
-    BREW_BIN_PATH_ARM_ROSETTA,
-    BREW_BIN_PATH_INTEL,
-    getBrewCommand
-} = require('../../../util/get-brew-bin-path');
-const installDependenciesTask = require('../../../util/install-dependencies-task');
-const pathExists = require('../../../util/path-exists');
-
-const brewInstallCommand = '$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)';
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const installBrewRosettaTask = () => ({
-    title: 'Installing Brew using Rosetta 2',
-    task: async (ctx, task) => {
-        if (await pathExists(BREW_BIN_PATH_ARM_ROSETTA)) {
-            task.skip('Brew in Rosetta is already installed');
-            return;
-        }
-
-        return task.newListr(
-            execCommandTask(brewInstallCommand, {
-                useRosetta2: true
-            })
-        );
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const installBrewNativeTask = () => ({
-    title: 'Installing Brew',
-    task: async (ctx, task) => {
-        if (
-            (ctx.arch === 'arm64' && await pathExists(BREW_BIN_PATH_ARM_NATIVE))
-            || (ctx.arch === 'x64' && await pathExists(BREW_BIN_PATH_INTEL))
-        ) {
-            task.skip('Brew in native path is already installed');
-            return;
-        }
-
-        return task.newListr(
-            execCommandTask(brewInstallCommand, {
-                useRosetta2: false
-            })
-        );
-    }
-});
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const macDependenciesCheck = () => ({
-    title: 'Checking MacOS dependencies',
-    task: async (ctx, task) => {
-        const tasks = [installBrewNativeTask()];
-
-        if (ctx.arch === 'arm64') {
-            tasks.push(installBrewRosettaTask());
-        }
-
-        return task.newListr(
-            tasks.concat([
-                {
-                    task: async () => {
-                        const installDependenciesTasks = [];
-                        if (ctx.arch === 'arm64') {
-                            const installedNativeDependencies = (
-                                await execAsyncSpawn(`${await getBrewCommand({ native: true })} list`, { useRosetta2: false })
-                            ).split('\n');
-                            const dependenciesToInstallOnArm = dependenciesForPlatforms['darwin-arm']
-                                .dependencies
-                                .filter((dep) => !installedNativeDependencies.includes(dep));
-
-                            if (dependenciesToInstallOnArm.length > 0) {
-                                installDependenciesTasks.push(
-                                    installDependenciesTask({
-                                        platform: 'darwin-arm',
-                                        dependenciesToInstall: dependenciesToInstallOnArm,
-                                        useMacNativeEnvironment: true
-                                    })
-                                );
-                            }
-                        }
-
-                        const installedDependencies = (
-                            await execAsyncSpawn(`${await getBrewCommand({ native: false })} list`, { useRosetta2: true })
-                        ).split('\n');
-                        const dependenciesToInstall = dependenciesForPlatforms
-                            .darwin
-                            .dependencies
-                            .filter((dep) => !installedDependencies.includes(dep));
-
-                        if (dependenciesToInstall.length > 0) {
-                            installDependenciesTasks.push(
-                                installDependenciesTask({
-                                    platform: 'darwin',
-                                    dependenciesToInstall,
-                                    useMacNativeEnvironment: false
-                                })
-                            );
-                        }
-
-                        if (installDependenciesTasks.length > 0) {
-                            return task.newListr(installDependenciesTasks);
-                        }
-
-                        task.skip();
-                    }
-                }
-            ])
-        );
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = macDependenciesCheck;