@scandipwa/magento-scripts 2.0.0-alpha.2 → 2.0.0-alpha.20

package/lib/tasks/requirements/docker/permissions.js

@@ -2,7 +2,7 @@ const os = require('os');
 const fs = require('fs');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const pathExists = require('../../../util/path-exists');
-const { execCommandTask } = require('../../../util/exec-async-command');
+const executeSudoCommand = require('../../../util/execute-sudo-command');
 
 const dockerSocketPath = '/var/run/docker.sock';
 
@@ -33,16 +33,7 @@ Otherwise installation will likely fail.`
                 });
 
                 if (confirmPrompt) {
-                    task.output = 'Enter your sudo password!';
-                    task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
-                    return task.newListr(
-                        execCommandTask(fixCommand, {
-                            callback: (t) => {
-                                task.output = t;
-                            },
-                            pipeInput: true
-                        })
-                    );
+                    return task.newListr(executeSudoCommand(fixCommand));
                 }
                 task.skip(`Permission issue detected in ${ logger.style.file(dockerSocketPath) } but user decided not to fix it.`);
             }

package/lib/tasks/requirements/docker/running-status.js

@@ -10,6 +10,41 @@ const getDockerVersion = () => execAsyncSpawn('docker version --format {{.Server
     withCode: true
 });
 
+const getDockerEngineAndDesktopServiceStatus = async () => {
+    const dockerEngineService = systemctlControl('docker');
+    const dockerDesktopService = systemctlControl('docker-desktop', { user: true });
+    const [
+        dockerEngineServiceExists,
+        dockerDesktopServiceExists,
+        dockerEngineServiceIsRunning,
+        dockerDesktopServiceIsRunning,
+        dockerEngineServiceIsEnabled,
+        dockerDesktopServiceIsEnabled
+    ] = await Promise.all([
+        dockerEngineService.exists(),
+        dockerDesktopService.exists(),
+        dockerEngineService.isRunning(),
+        dockerDesktopService.isRunning(),
+        dockerEngineService.isEnabled(),
+        dockerDesktopService.isEnabled()
+    ]);
+
+    return {
+        engine: {
+            service: dockerEngineService,
+            exists: dockerEngineServiceExists,
+            isRunning: dockerEngineServiceIsRunning,
+            isEnabled: dockerEngineServiceIsEnabled
+        },
+        desktop: {
+            service: dockerDesktopService,
+            exists: dockerDesktopServiceExists,
+            isRunning: dockerDesktopServiceIsRunning,
+            isEnabled: dockerDesktopServiceIsEnabled
+        }
+    };
+};
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -81,39 +116,71 @@ Please open Docker Desktop application for Windows and make sure that Docker is
 const checkDockerStatusLinux = () => ({
     title: 'Checking Docker status on Linux',
     task: async (ctx, task) => {
-        const dockerService = systemctlControl('docker');
+        const {
+            engine,
+            desktop
+        } = await getDockerEngineAndDesktopServiceStatus();
+
+        if (engine.exists) {
+            if (!engine.isEnabled && !engine.isRunning) {
+                const dockerStartConfirmation = await task.prompt({
+                    type: 'Confirm',
+                    message: `Looks like Docker Engine is not enabled and not running, would you like to enable and run it?
 
-        const isRunning = await dockerService.isRunning();
-        const isEnabled = await dockerService.isEnabled();
+    This action requires root privileges.`
+                });
+
+                if (dockerStartConfirmation) {
+                    await engine.service.enableAndStart();
 
-        if (!isEnabled && !isRunning) {
-            const dockerStartConfirmation = await task.prompt({
-                type: 'Confirm',
-                message: `Looks like Docker is not enabled and not running, would you like to enable and run it?
+                    return;
+                }
+                task.skip('User skipped running Docker');
+            } else if (!engine.isRunning) {
+                const dockerStartConfirmation = await task.prompt({
+                    type: 'Confirm',
+                    message: `Looks like Docker Engine is not running, would you like to run it?
 
-This action requires root privileges.`
-            });
+    This action requires root privileges.`
+                });
 
-            if (dockerStartConfirmation) {
-                await dockerService.enableAndStart();
+                if (dockerStartConfirmation) {
+                    await engine.service.start();
 
-                return;
+                    return;
+                }
+                task.skip('User skipped running Docker Engine');
             }
-            task.skip('User skipped running Docker');
-        } else if (!isRunning) {
-            const dockerStartConfirmation = await task.prompt({
-                type: 'Confirm',
-                message: `Looks like Docker is not running, would you like to run it?
+        } else if (desktop.exists) {
+            if (!desktop.isEnabled && !desktop.isRunning) {
+                const dockerStartConfirmation = await task.prompt({
+                    type: 'Confirm',
+                    message: `Looks like Docker Desktop is not enabled and not running, would you like to enable and run it?
+
+    This action requires root privileges.`
+                });
+
+                if (dockerStartConfirmation) {
+                    await desktop.service.enableAndStart();
+
+                    return;
+                }
+                task.skip('User skipped running Docker');
+            } else if (!desktop.isRunning) {
+                const dockerStartConfirmation = await task.prompt({
+                    type: 'Confirm',
+                    message: `Looks like Docker Desktop is not running, would you like to run it?
 
-This action requires root privileges.`
-            });
+    This action requires root privileges.`
+                });
 
-            if (dockerStartConfirmation) {
-                await dockerService.start();
+                if (dockerStartConfirmation) {
+                    await desktop.service.start();
 
-                return;
+                    return;
+                }
+                task.skip('User skipped running Docker Desktop');
             }
-            task.skip('User skipped running Docker');
         }
     }
 });
@@ -135,4 +202,7 @@ const checkDockerStatus = () => ({
     }
 });
 
-module.exports = checkDockerStatus;
+module.exports = {
+    checkDockerStatus,
+    getDockerEngineAndDesktopServiceStatus
+};

package/lib/tasks/requirements/docker/version.js

@@ -14,6 +14,7 @@ const getDockerVersion = () => ({
             ctx.dockerServerData = dockerVersion.Server;
             ctx.dockerClientData = dockerVersion.Client;
             ctx.dockerVersion = dockerVersion.Server.Version;
+            ctx.isDockerDesktop = dockerVersion.Server.Platform.Name.includes('Desktop');
         } else {
             throw new UnknownError(`Got unexpected result during Docker version retrieval!\n\n${ dockerVersion }`);
         }

package/lib/tasks/requirements/index.js

@@ -19,8 +19,6 @@ const checkRequirements = () => ({
         checkDocker(),
         // check for Node.js version
         checkNodeVersion(),
-        // check installed PHP version
-        // checkPHPVersion(),
         // check for COMPOSER_AUTH or auth.json
         localAuthJson(),
         checkComposerCredentials()

package/lib/tasks/requirements/php-version.js

@@ -7,8 +7,10 @@ const { runContainerImage } = require('../../util/run-container-image');
 const checkPHPVersion = () => ({
     title: 'Checking container PHP version',
     task: async (ctx, task) => {
-        const { php } = ctx.config.docker.getContainers(ctx.ports);
-        const phpVersionResponse = await runContainerImage(php.image, 'php --version');
+        const phpVersionResponse = await runContainerImage(
+            ctx.config.overridenConfiguration.configuration.php.baseImage,
+            'php --version'
+        );
 
         const phpVersionResponseResult = phpVersionResponse.match(/PHP\s(\d+\.\d+\.\d+)/i);
 

package/lib/tasks/start.js

@@ -11,7 +11,6 @@ const { prepareFileSystem } = require('./file-system');
 const { installMagentoProject, setupMagento } = require('./magento');
 const { pullImages, stopContainers } = require('./docker/containers');
 const dockerNetwork = require('./docker/network');
-const { setPrefix } = require('./prefix');
 const { connectToDatabase } = require('./database');
 const { buildProjectImage, buildDebugProjectImage } = require('./docker/project-image-builder');
 const getProjectConfiguration = require('../config/get-project-configuration');
@@ -28,6 +27,19 @@ const waitingForVarnish = require('./magento/setup-magento/waiting-for-varnish')
 const checkPHPVersion = require('./requirements/php-version');
 const volumes = require('./docker/volume/tasks');
 const convertMySQLDatabaseToMariaDB = require('./docker/convert-mysql-to-mariadb');
+const { cmaGlobalConfig } = require('../config/cma-config');
+const { setProjectConfigTask } = require('./project-config');
+const { convertComposerHomeToComposerCacheVolume } = require('./docker/convert-composer-home-to-composer-cache-volume');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ */
+const resetCmaGlobalConfig = () => ({
+    skip: (ctx) => !ctx.resetGlobalConfig,
+    task: () => {
+        cmaGlobalConfig.clear();
+    }
+});
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -39,7 +51,6 @@ const retrieveProjectConfiguration = () => ({
         checkConfigurationFile(),
         getProjectConfiguration(),
         convertLegacyVolumes(),
-        convertMySQLDatabaseToMariaDB(),
         createCacheFolder(),
         getSystemConfigTask(),
         getCachedPorts()
@@ -59,7 +70,8 @@ const retrieveProjectConfiguration = () => ({
 const stopProject = () => ({
     title: 'Stopping project',
     task: (ctx, task) => task.newListr([
-        stopContainers()
+        stopContainers(),
+        volumes.removeLocalVolumes()
     ]),
     options: {
         showTimer: false
@@ -72,7 +84,7 @@ const stopProject = () => ({
 const retrieveFreshProjectConfiguration = () => ({
     title: 'Retrieving fresh project configuration',
     task: (ctx, task) => task.newListr([
-        setPrefix(),
+        setProjectConfigTask(),
         getProjectConfiguration(),
         // get fresh ports
         getAvailablePorts(),
@@ -93,9 +105,14 @@ const retrieveFreshProjectConfiguration = () => ({
 const configureProject = () => ({
     title: 'Configuring project',
     task: (ctx, task) => task.newListr([
-        pullImages(),
-        dockerNetwork.tasks.createNetwork(),
-        volumes.createVolumes(),
+        convertMySQLDatabaseToMariaDB(),
+        {
+            task: (ctx, task) => task.newListr([
+                pullImages(),
+                dockerNetwork.tasks.createNetwork()
+            ], { concurrent: true })
+        },
+        checkPHPVersion(),
         {
             task: (ctx, task) => task.newListr([
                 buildProjectImage(),
@@ -104,9 +121,10 @@ const configureProject = () => ({
                 concurrent: true
             })
         },
-        checkPHPVersion(),
         getComposerVersionTask(),
         prepareFileSystem(),
+        volumes.createVolumes(),
+        convertComposerHomeToComposerCacheVolume(),
         installMagentoProject(),
         enableMagentoComposerPlugins(),
         startServices(),
@@ -138,6 +156,7 @@ const start = () => ({
     task: (ctx, task) => {
         task.title = `Starting project (magento-scripts@${pkg.version})`;
         return task.newListr([
+            resetCmaGlobalConfig(),
             checkRequirements(),
             retrieveProjectConfiguration(),
             stopProject(),

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,19 +22,23 @@ const parsePort = (port) => {
     };
 };
 
+/**
+ * @param {import('../../../typings/context').ListrContext & { containers: ReturnType<Awaited<ReturnType<import('../../config/docker')>>['getContainers']> }} ctx
+ */
 const prettyStatus = async (ctx) => {
     const {
         config: {
-            baseConfig
+            baseConfig,
+            projectConfig
         },
         magentoVersion,
         dockerVersion,
         platform,
         platformVersion,
-        containers
+        containers,
+        composerVersion
     } = ctx;
     const projectCreatedAt = getProjectCreatedAt();
-    const composerVersion = await getComposerVersion(ctx);
 
     const prefix = getPrefix();
 
@@ -45,7 +49,7 @@ const prettyStatus = async (ctx) => {
     block
         .addHeader(`magento-scripts version: ${ logger.style.link(packageVersion) }`)
         .addEmptyLine()
-        .addLine(`Project: ${logger.style.file(baseConfig.prefix)} ${prefix === folderName ? '(without prefix)' : '(with prefix)'} (with php container)`)
+        .addLine(`Project: ${logger.style.file(baseConfig.prefix)} ${prefix === folderName ? '(without prefix)' : '(with prefix)'} (with php container)${ projectConfig.debug ? ' (with debugging)' : '' }`)
         .addLine(`Project location: ${logger.style.link(process.cwd())}`);
 
     if (projectCreatedAt) {
@@ -71,19 +75,25 @@ const prettyStatus = async (ctx) => {
 
         let containerStatus;
 
-        if (container.status && container.status.Health) {
-            containerStatus = `✓ ${ logger.style.file(container.status.Health.Status) } and ${ logger.style.file('running') }`;
-        } else if (container.status) {
-            containerStatus = logger.style.file(container.status.Status);
+        if (container.status && container.status.State && container.status.State.Health) {
+            containerStatus = `✓ ${ logger.style.file(container.status.State.Health.Status) } and ${ logger.style.file('running') }`;
+        } else if (container.status && container.status.State) {
+            containerStatus = logger.style.file(container.status.State.Status);
         } else {
             containerStatus = '✖ Not running';
         }
 
         block
             .addLine(`Status: ${containerStatus}`)
-            .addLine(`Name: ${logger.style.misc(container.name)}`)
-            .addLine(`Image: ${logger.style.file(container.image)}`)
-            .addLine(`Network: ${logger.style.link(container.network)}`);
+            .addLine(`Name: ${logger.style.misc(container.name)}`);
+
+        if (container.status && container.status.Config && container.status.Config.Image) {
+            block.addLine(`Image: ${logger.style.file(container.status.Config.Image)}`);
+        } else {
+            block.addLine(`Image: ${logger.style.file(container.image)}`);
+        }
+
+        block.addLine(`Network: ${logger.style.link(container.network)}`);
 
         if (!containerStatus.includes('Not running') && container.forwardedPorts && container.forwardedPorts.length > 0) {
             block.addLine('Port forwarding:');
@@ -103,6 +113,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 +140,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/tasks/theme/retrieve-theme-data.js

@@ -1,3 +1,4 @@
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const path = require('path');
 const KnownError = require('../../errors/known-error');
 const getJsonfileData = require('../../util/get-jsonfile-data');
@@ -11,10 +12,19 @@ const retrieveThemeData = (themePath) => ({
     task: async (ctx) => {
         let absoluteThemePath = path.join(process.cwd(), themePath);
 
+        // validate if theme is located inside magento directory
+        if (!absoluteThemePath.includes(process.cwd())) {
+            throw new KnownError(`You are trying to link the theme from outside of your Magento project!
+
+This is not supported in ${ logger.style.command('magento-scripts') } version 2.
+
+Move your theme inside Magento project!`);
+        }
+
         // check if path not relative
         if (!(await pathExists(path.join(absoluteThemePath, 'composer.json')))) {
             // if composer.json is not found, then it's not correct path
-            // and we need to test if it's alsolute one
+            // and we need to test if it's absolute one
             if (await pathExists(path.join(themePath, 'composer.json'))) {
                 // if so, use it as absolute path
                 absoluteThemePath = themePath;

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)
 });
@@ -114,7 +116,17 @@ const composerConfigurationSchema = Joi.object({
         }
 
         return versionValidator(value);
-    })
+    }),
+    plugins: Joi.object()
+        .pattern(
+            Joi.string(),
+            Joi.object({
+                version: Joi.string().optional(),
+                options: Joi.string().optional(),
+                enabled: Joi.boolean().optional()
+            })
+                .unknown()
+        )
 });
 
 /**
@@ -128,7 +140,8 @@ const configurationSchema = Joi.object({
     redis: serviceConfigurationSchema.optional(),
     composer: composerConfigurationSchema.optional(),
     varnish: varnishConfigurationSchema.optional(),
-    sslTerminator: nginxConfigurationSchema.optional()
+    sslTerminator: nginxConfigurationSchema.optional(),
+    maildev: serviceConfigurationSchema.optional()
 });
 
 /**

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

@@ -0,0 +1,62 @@
+const { spawn } = require('child_process');
+const { runCommand } = require('../tasks/docker/containers/container-api');
+
+/**
+ * @param {{ containerName: string, commands: string[], user?: string }} param0
+ */
+const executeInContainer = ({
+    containerName, commands, user
+}) => {
+    if (!process.stdin.isTTY) {
+        process.stderr.write('This app works only in TTY mode');
+        process.exit(1);
+    }
+
+    const userArg = user && `--user=${user}`;
+
+    spawn('docker', [
+        'exec',
+        '-it',
+        userArg,
+        containerName
+    ]
+        .filter(Boolean)
+        .concat(...commands.map((command) => command.split(' ')).flat()),
+    {
+        stdio: [0, 1, 2]
+    });
+
+    return new Promise((_resolve) => {
+        // never resolve
+    });
+};
+
+/**
+ * @param {import('../tasks/docker/containers/container-api').ContainerRunOptions} options
+ * @param {string[]} commands
+ */
+const runInContainer = (options, commands) => {
+    if (!process.stdin.isTTY) {
+        process.stderr.write('This app works only in TTY mode');
+        process.exit(1);
+    }
+
+    const runArgs = runCommand({
+        ...options,
+        tty: true,
+        detach: false,
+        rm: true,
+        command: commands.join(' ')
+    });
+
+    spawn('bash', ['-c', runArgs.join(' ')], { stdio: [0, 1, 2] });
+
+    return new Promise((_resolve) => {
+        // never resolve
+    });
+};
+
+module.exports = {
+    executeInContainer,
+    runInContainer
+};

package/lib/util/instance-metadata.js

@@ -4,6 +4,7 @@ const WEB_LOCAL_LOCATION_TITLE = `Location on ${ logger.style.misc('localhost')
 const WEB_LOCATION_TITLE = 'Location on the Web';
 const WEB_ADMIN_LOCATION_TITLE = 'Panel location';
 const WEB_ADMIN_CREDENTIALS_TITLE = 'Panel credentials';
+const WEB_MAILDEV_LOCATION_TITLE = 'Panel location';
 
 const mapDataStyle = ({ title, text }) => ({
     title,
@@ -13,7 +14,7 @@ const mapDataStyle = ({ title, text }) => ({
 
 /**
  * @param {import("../../typings/context").ListrContext} ctx
- * @return {{ frontend: { title: string, text: string }[], admin: { title: string, url: string }[]}}
+ * @return {{ frontend: { title: string, text: string }[], admin: { title: string, url: string }[], maildev: { title: string, text: string }[] }}
  */
 const getInstanceMetadata = (ctx) => {
     const {
@@ -34,6 +35,11 @@ const getInstanceMetadata = (ctx) => {
      */
     const admin = [];
 
+    /**
+     * @type {{ title: string, text: string }[]}
+     */
+    const maildev = [];
+
     const isNgrok = host.endsWith('ngrok.io');
 
     if (isNgrok) {
@@ -64,9 +70,15 @@ const getInstanceMetadata = (ctx) => {
         text: `${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`
     });
 
+    maildev.push({
+        title: WEB_MAILDEV_LOCATION_TITLE,
+        text: `http://${host}:${ports.maildevWeb}/`
+    });
+
     return {
         admin,
-        frontend: frontend.map(mapDataStyle)
+        frontend: frontend.map(mapDataStyle),
+        maildev: maildev.map(mapDataStyle)
     };
 };