@scandipwa/magento-scripts 2.0.0-alpha.9 → 2.0.0

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

@@ -0,0 +1,88 @@
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const os = require('os');
+const { cmaGlobalConfig } = require('../../../config/cma-config');
+const { getCachedPorts } = require('../../../config/get-port-config');
+const { getSystemConfigTask } = require('../../../config/system-config');
+const UnknownError = require('../../../errors/unknown-error');
+const { execCommandTask } = require('../../../util/exec-async-command');
+const createCacheFolder = require('../../cache/create-cache-folder');
+const { dockerApi } = require('../../docker');
+const { stopContainers } = require('../../docker/containers');
+const { getDockerEngineAndDesktopServiceStatus } = require('./running-status');
+const getMagentoVersionConfig = require('../../../config/get-magento-version-config');
+const checkConfigurationFile = require('../../../config/check-configuration-file');
+const getProjectConfiguration = require('../../../config/get-project-configuration');
+const getDockerVersion = require('./version');
+
+const USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER = 'useDefaultDockerDesktopContext';
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const checkDockerDesktopContext = () => ({
+    task: async (ctx, task) => {
+        if (os.platform() !== 'linux' || !ctx.isDockerDesktop) {
+            task.skip();
+            return;
+        }
+
+        task.title = 'Checking contexts for Docker Desktop';
+
+        const contexts = await dockerApi.context({ formatToJSON: true });
+        const currentlyUsedContext = contexts.find((c) => c.Current);
+
+        if (!currentlyUsedContext) {
+            throw new UnknownError('We haven\'t found contexts in Docker...');
+        }
+
+        const { engine } = await getDockerEngineAndDesktopServiceStatus();
+
+        if (currentlyUsedContext.Name !== 'default' && engine.exists) {
+            if (cmaGlobalConfig.get(USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER) === false) {
+                task.skip();
+                return;
+            }
+
+            const confirmContextChange = await task.prompt({
+                type: 'Select',
+                message: `Do you want to change current Docker Desktop context (${logger.style.code(currentlyUsedContext.Name)}) to ${logger.style.code('default')}?`,
+                choices: [
+                    {
+                        name: 'yes',
+                        message: 'Yes'
+                    },
+                    {
+                        name: 'no',
+                        message: 'No, I don\'t know what this means, but you can ask again on next start.'
+                    },
+                    {
+                        name: 'skip',
+                        // eslint-disable-next-line max-len
+                        message: 'I do know what this means and I DON\'T want to change context for Docker. Also, save this answer to never ask again.'
+                    }
+                ]
+            });
+
+            if (confirmContextChange === 'skip') {
+                cmaGlobalConfig.set(USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER, false);
+                task.skip();
+            }
+
+            if (confirmContextChange === 'yes') {
+                return task.newListr([
+                    getMagentoVersionConfig(),
+                    checkConfigurationFile(),
+                    getProjectConfiguration(),
+                    createCacheFolder(),
+                    getSystemConfigTask(),
+                    getCachedPorts(),
+                    stopContainers(),
+                    execCommandTask('docker context use default'),
+                    getDockerVersion()
+                ]);
+            }
+        }
+    }
+});
+
+module.exports = checkDockerDesktopContext;

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

@@ -1,17 +1,23 @@
+const os = require('os');
 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 getIsWsl = require('../../../util/is-wsl');
+
+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) {
+        if (os.platform() === 'darwin' && ctx.dockerServerData && ctx.dockerServerData.Platform && ctx.dockerServerData.Platform.Name) {
             task.title = `Using ${ctx.dockerServerData.Platform.Name} for Mac`;
         } else {
             task.title = `Using Docker version ${ctx.dockerVersion}`;
@@ -19,33 +25,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!');
 };
 
@@ -65,7 +110,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',
@@ -108,25 +154,71 @@ const checkDocker = () => ({
         });
 
         if (code !== 0) {
-            if (ctx.platform === 'linux' && !ctx.isWsl) {
-                const result = await dockerInstallPromptLinux(task);
-                if (result) {
-                    return result;
+            if (os.platform() === 'linux') {
+                const isWsl = await getIsWsl();
+                if (!isWsl) {
+                    const { engine } = await getDockerEngineAndDesktopServiceStatus();
+                    if (!engine.exists) {
+                        const result = await dockerInstallPromptLinux(task);
+                        if (result) {
+                            return result;
+                        }
+                    }
+                } else if (isWsl) {
+                    dockerInstallPromptWindows();
                 }
-            } else if (ctx.isWsl) {
-                dockerInstallPromptWindows();
             } else {
                 const result = await dockerInstallPromptMacOS(task);
                 if (result) {
                     return result;
                 }
             }
+        } else if (os.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)
         ]);
     }

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

@@ -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(),