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

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

@@ -1,14 +1,18 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const { cmaGlobalConfig } = require('../../../config/cma-config');
 const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const openBrowser = require('../../../util/open-browser');
-const installDocker = require('./install');
+const checkDockerDesktopContext = require('./context');
+const { installDockerEngine } = require('./install');
 const installDockerOnMac = require('./install-on-mac');
 const { checkDockerPerformance } = require('./performance');
 const { checkDockerSocketPermissions } = require('./permissions');
-const checkDockerStatus = require('./running-status');
+const { checkDockerStatus, getDockerEngineAndDesktopServiceStatus } = require('./running-status');
 const getDockerVersion = require('./version');
 
+const USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER = 'useDockerEngineWithDockerDesktop';
+
 const setVersionInContextTask = (task) => ({
     task: (ctx) => {
         if (ctx.platform === 'darwin' && ctx.dockerServerData && ctx.dockerServerData.Platform && ctx.dockerServerData.Platform.Name) {
@@ -19,32 +23,72 @@ const setVersionInContextTask = (task) => ({
     }
 });
 
-const dockerInstallPromptLinux = async (task) => {
-    const automaticallyInstallDocker = await task.prompt({
-        type: 'Confirm',
+const dockerInstallPromptLinux = async (task, { skipPrompt = false } = {}) => {
+    const automaticallyInstallDocker = skipPrompt ? 'yes' : await task.prompt({
+        type: 'Select',
         message: `You don't have Docker installed!
 Do you want to install it automatically?
-NOTE: After installation it's recommended to log out and log back in so your group membership is re-evaluated!`
+`,
+        choices: [
+            {
+                name: 'yes',
+                message: 'Yes, I to install Docker automatically'
+            },
+            {
+                name: 'no',
+                message: 'No, I want to install Docker myself'
+            },
+            {
+                name: 'skip',
+                message: 'Skip installing Docker'
+            }
+        ]
     });
 
-    if (automaticallyInstallDocker) {
+    if (automaticallyInstallDocker === 'yes') {
         return task.newListr([
-            installDocker(),
+            installDockerEngine(),
+            checkDockerSocketPermissions(),
             getDockerVersion(),
             {
-                task: (ctx) => {
+                task: async (ctx) => {
                     task.title = `Using docker version ${ctx.dockerVersion}`;
 
+                    const confirmLogOut = await task.prompt({
+                        type: 'Select',
+                        message: 'Docker installed successfully!\n',
+                        choices: [
+                            {
+                                name: 'log-out',
+                                message: `${logger.style.command('[Recommended]')} Now I will log out and log back it (or restart my system) to re-evaluate group membership`
+                            },
+                            {
+                                name: 'skip',
+                                message: 'Skip log out and proceed with installation'
+                            }
+                        ]
+                    });
+
+                    if (confirmLogOut === 'skip') {
+                        return;
+                    }
+
                     throw new KnownError(
                         `Docker is installed successfully!
-Please log out and log back to so your group membership is re-evaluated!
+Please log out and log back in (or restart your system) so your group membership is re-evaluated!
 Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/linux-postinstall/') }`
                     );
                 }
-            }
+            },
+            checkDockerStatus(),
+            checkDockerDesktopContext()
         ]);
     }
 
+    if (automaticallyInstallDocker === 'skip') {
+        return;
+    }
+
     throw new KnownError('Docker is not installed!');
 };
 
@@ -64,7 +108,8 @@ const dockerInstallPromptMacOS = async (task) => {
     const confirmationToInstallDocker = await task.prompt({
         type: 'Select',
         message: `You don't have Docker installed!
-Would you like to install it automatically using brew cask or you prefer to install it manually?`,
+Would you like to install it automatically using brew cask or you prefer to install it manually?
+`,
         choices: [
             {
                 name: 'automatic',
@@ -80,6 +125,7 @@ Would you like to install it automatically using brew cask or you prefer to inst
     if (confirmationToInstallDocker === 'automatic') {
         return task.newListr([
             installDockerOnMac(),
+            checkDockerSocketPermissions(),
             checkDockerStatus(),
             getDockerVersion(),
             setVersionInContextTask(task)
@@ -106,24 +152,70 @@ const checkDocker = () => ({
         });
 
         if (code !== 0) {
-            if (ctx.platform === 'linux' && !ctx.isWsl) {
-                const result = await dockerInstallPromptLinux(task);
-                if (result) {
-                    return result;
+            if (ctx.platform === 'linux') {
+                if (!ctx.isWsl) {
+                    const { engine } = await getDockerEngineAndDesktopServiceStatus();
+                    if (!engine.exists) {
+                        const result = await dockerInstallPromptLinux(task);
+                        if (result) {
+                            return result;
+                        }
+                    }
+                } else if (ctx.isWsl) {
+                    dockerInstallPromptWindows();
                 }
-            } else if (ctx.isWsl) {
-                dockerInstallPromptWindows();
             } else {
                 const result = await dockerInstallPromptMacOS(task);
                 if (result) {
                     return result;
                 }
             }
+        } else if (ctx.platform === 'linux') {
+            const { engine, desktop } = await getDockerEngineAndDesktopServiceStatus();
+            if (!engine.exists
+                && desktop.exists
+                && cmaGlobalConfig.get(USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER) !== false
+            ) {
+                const confirmInstallingDockerEngine = await task.prompt({
+                    type: 'Select',
+                    message: `Looks like you have Docker Desktop installed on Linux system, but Docker Engine is not installed.
+Do you want to install it and use it's context together with Docker Desktop?
+`,
+                    choices: [
+                        {
+                            name: 'yes',
+                            message: 'Sure, if it means I will have less issues with my setup!'
+                        },
+                        {
+                            name: 'no',
+                            message: 'No. But you can ask me again later.'
+                        },
+                        {
+                            name: 'skip',
+                            message: 'No. And don\'t ask me again.'
+                        }
+                    ]
+                });
+
+                if (confirmInstallingDockerEngine === 'skip') {
+                    cmaGlobalConfig.set(USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER, false);
+                } else if (confirmInstallingDockerEngine === 'yes') {
+                    const result = await dockerInstallPromptLinux(task, {
+                        skipPrompt: true
+                    });
+
+                    if (result) {
+                        return result;
+                    }
+                }
+            }
         }
 
         return task.newListr([
+            checkDockerSocketPermissions(),
             checkDockerStatus(),
             getDockerVersion(),
+            checkDockerDesktopContext(),
             setVersionInContextTask(task)
         ]);
     }
@@ -134,7 +226,6 @@ const checkDocker = () => ({
  */
 module.exports = () => ({
     task: (ctx, task) => task.newListr([
-        checkDockerSocketPermissions(),
         checkDocker(),
         checkDockerPerformance()
     ], {

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

@@ -17,8 +17,8 @@ const postInstallSteps = [
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
-const installDocker = () => ({
-    title: 'Installing Docker',
+const installDockerEngine = () => ({
+    title: 'Installing Docker Engine',
     task: async (ctx, task) => {
         const distro = await osPlatform();
         switch (distro) {
@@ -32,12 +32,21 @@ const installDocker = () => ({
                 ...postInstallSteps
             ]);
         }
-        case 'Fedora':
+        case 'Fedora': {
+            return task.newListr([
+                executeSudoCommand('sudo dnf -y install dnf-plugins-core'),
+                executeSudoCommand('sudo dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo'),
+                executeSudoCommand('sudo dnf -y install docker-ce docker-ce-cli containerd.io docker-compose-plugin'),
+                enableAndStartDockerCommand(),
+                ...postInstallSteps
+            ]);
+        }
         case 'CentOS': {
             return task.newListr([
-                downloadDockerInstallScriptCommand(),
-                runDockerInstallScriptCommand(),
-                enableAndStartDockerCommand()
+                executeSudoCommand('sudo yum install -y yum-utils'),
+                executeSudoCommand('sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo'),
+                executeSudoCommand('sudo yum install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin'),
+                ...postInstallSteps
             ]);
         }
         case 'Ubuntu': {
@@ -53,7 +62,12 @@ const installDocker = () => ({
 Your distro ${distro} is not supported by automatic installation.`);
         }
         }
+    },
+    options: {
+        bottomBar: 10
     }
 });
 
-module.exports = installDocker;
+module.exports = {
+    installDockerEngine
+};

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

@@ -28,6 +28,17 @@ 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');
+
+/**
+ * @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 +50,6 @@ const retrieveProjectConfiguration = () => ({
         checkConfigurationFile(),
         getProjectConfiguration(),
         convertLegacyVolumes(),
-        convertMySQLDatabaseToMariaDB(),
         createCacheFolder(),
         getSystemConfigTask(),
         getCachedPorts()
@@ -59,7 +69,8 @@ const retrieveProjectConfiguration = () => ({
 const stopProject = () => ({
     title: 'Stopping project',
     task: (ctx, task) => task.newListr([
-        stopContainers()
+        stopContainers(),
+        volumes.removeLocalVolumes()
     ]),
     options: {
         showTimer: false
@@ -93,9 +104,19 @@ 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 })
+        },
+        {
+            task: (ctx, task) => task.newListr([
+                checkPHPVersion(),
+                getComposerVersionTask()
+            ], { concurrent: true })
+        },
         {
             task: (ctx, task) => task.newListr([
                 buildProjectImage(),
@@ -104,9 +125,8 @@ const configureProject = () => ({
                 concurrent: true
             })
         },
-        checkPHPVersion(),
-        getComposerVersionTask(),
         prepareFileSystem(),
+        volumes.createVolumes(),
         installMagentoProject(),
         enableMagentoComposerPlugins(),
         startServices(),
@@ -138,6 +158,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,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)
 });