@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/tasks/docker/convert-legacy-volumes.js

@@ -1,90 +1,126 @@
 /* eslint-disable no-param-reassign */
 /* eslint-disable max-len */
-const { stopServices } = require('./index');
-const { getBaseConfig, getConfigFromMagentoVersion } = require('../../config');
-const getDockerConfig = require('../../config/docker');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const { folderName, legacyFolderName } = require('../../util/prefix');
-const { volumeApi } = require('./volume');
+const { stopServices } = require('./index')
+const { getBaseConfig, getConfigFromMagentoVersion } = require('../../config')
+const getDockerConfig = require('../../config/docker')
+const { execAsyncSpawn } = require('../../util/exec-async-command')
+const { folderName, legacyFolderName } = require('../../util/prefix')
+const { volumeApi } = require('./volume')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const convertLegacyVolumes = () => ({
     task: async (ctx, task) => {
-        const { config: { overridenConfiguration } } = ctx;
-        const newDockerConfig = await getDockerConfig(ctx, overridenConfiguration, getBaseConfig(process.cwd(), folderName));
+        const {
+            config: { overridenConfiguration }
+        } = ctx
+        const newDockerConfig = await getDockerConfig(
+            ctx,
+            overridenConfiguration,
+            getBaseConfig(process.cwd(), folderName)
+        )
 
-        const newVolumeNames = Object.values(newDockerConfig.volumes).filter((v) => !v.opt).map(({ name }) => name);
+        const newVolumeNames = Object.values(newDockerConfig.volumes)
+            .filter((v) => !v.opt)
+            .map(({ name }) => name)
 
-        const existingVolumes = await volumeApi.ls({ formatToJSON: true });
+        const existingVolumes = await volumeApi.ls({ formatToJSON: true })
 
         if (newVolumeNames.every((v) => existingVolumes.includes(v))) {
-            return;
+            return
         }
 
-        const legacyDockerConfig = await getDockerConfig(ctx, overridenConfiguration, getBaseConfig(process.cwd(), legacyFolderName));
-        const legacyVolumeNames = Object.values(legacyDockerConfig.volumes).filter((v) => !v.opt).map(({ name }) => name);
+        const legacyDockerConfig = await getDockerConfig(
+            ctx,
+            overridenConfiguration,
+            getBaseConfig(process.cwd(), legacyFolderName)
+        )
+        const legacyVolumeNames = Object.values(legacyDockerConfig.volumes)
+            .filter((v) => !v.opt)
+            .map(({ name }) => name)
 
         if (
-            newVolumeNames.every((name) => !existingVolumes.some((v) => v.Name === name))
-            && legacyVolumeNames.every((name) => existingVolumes.some((v) => v.Name === name))
+            newVolumeNames.every(
+                (name) => !existingVolumes.some((v) => v.Name === name)
+            ) &&
+            legacyVolumeNames.every((name) =>
+                existingVolumes.some((v) => v.Name === name)
+            )
         ) {
             ctx.config = await getConfigFromMagentoVersion(ctx, {
                 magentoVersion: ctx.magentoVersion,
                 projectPath: process.cwd(),
                 prefix: legacyFolderName
-            });
+            })
 
-            return task.newListr([
-                stopServices(),
-                {
-                    title: 'Migrating data from legacy volumes to new ones',
-                    task: async (subCtx, subTask) => {
-                        task.title = 'Converting old volumes to new ones, this will take some time...';
+            return task.newListr(
+                [
+                    stopServices(),
+                    {
+                        title: 'Migrating data from legacy volumes to new ones',
+                        task: async (subCtx, subTask) => {
+                            task.title =
+                                'Converting old volumes to new ones, this will take some time...'
 
-                        for (const [volumeName, volumeConfig] of Object.entries(newDockerConfig.volumes)) {
-                            const legacyVolumeConfig = legacyDockerConfig.volumes[volumeName];
+                            for (const [
+                                volumeName,
+                                volumeConfig
+                            ] of Object.entries(newDockerConfig.volumes)) {
+                                const legacyVolumeConfig =
+                                    legacyDockerConfig.volumes[volumeName]
 
-                            subTask.output = `Creating volume ${volumeConfig.name}...`;
-                            await volumeApi.create(volumeConfig);
-                            subTask.output = `Copying data from ${legacyVolumeConfig.name} to ${volumeConfig.name}...`;
-                            await execAsyncSpawn(
-                                `docker run --rm -v ${legacyVolumeConfig.name}:/from:ro -v ${volumeConfig.name}:/to alpine ash -c "cd /from; cp -av . /to"`, {
-                                    callback: (t) => {
-                                        task.output = t;
+                                subTask.output = `Creating volume ${volumeConfig.name}...`
+                                await volumeApi.create(volumeConfig)
+                                subTask.output = `Copying data from ${legacyVolumeConfig.name} to ${volumeConfig.name}...`
+                                await execAsyncSpawn(
+                                    `docker run --rm -v ${legacyVolumeConfig.name}:/from:ro -v ${volumeConfig.name}:/to alpine ash -c "cd /from; cp -av . /to"`,
+                                    {
+                                        callback: (t) => {
+                                            task.output = t
+                                        }
                                     }
-                                }
-                            );
-                        }
+                                )
+                            }
 
-                        subCtx.config = await getConfigFromMagentoVersion(ctx.magentoVersion, process.cwd());
+                            subCtx.config = await getConfigFromMagentoVersion(
+                                ctx.magentoVersion,
+                                process.cwd()
+                            )
 
-                        const doDelete = await subTask.prompt({
-                            type: 'Toggle',
-                            message: `Good news! We successfully moved your data from legacy volumes ${legacyVolumeNames.join(', ')} to new ones!
+                            const doDelete = await subTask.prompt({
+                                type: 'Toggle',
+                                message: `Good news! We successfully moved your data from legacy volumes ${legacyVolumeNames.join(
+                                    ', '
+                                )} to new ones!
             But we have one last thing to do.
-            To free some space and avoid possible interference between docker volumes we strongly recommend you to delete legacy volumes ${legacyVolumeNames.join(', ')} now or when you are ready.
+            To free some space and avoid possible interference between docker volumes we strongly recommend you to delete legacy volumes ${legacyVolumeNames.join(
+                ', '
+            )} now or when you are ready.
             `,
-                            disabled: 'Delete later myself',
-                            enabled: 'Delete automatically now'
-                        });
+                                disabled: 'Delete later myself',
+                                enabled: 'Delete automatically now'
+                            })
 
-                        if (doDelete) {
-                            await execAsyncSpawn(
-                                `docker volume rm ${legacyVolumeNames.join(' ')}`
-                            );
+                            if (doDelete) {
+                                await execAsyncSpawn(
+                                    `docker volume rm ${legacyVolumeNames.join(
+                                        ' '
+                                    )}`
+                                )
+                            }
+                        },
+                        options: {
+                            bottomBar: 10
                         }
-                    },
-                    options: {
-                        bottomBar: 10
                     }
+                ],
+                {
+                    concurrent: false
                 }
-            ], {
-                concurrent: false
-            });
+            )
         }
     }
-});
+})
 
-module.exports = convertLegacyVolumes;
+module.exports = convertLegacyVolumes

package/lib/tasks/docker/convert-mysql-to-mariadb.js

@@ -1,168 +1,192 @@
-const path = require('path');
-const fs = require('fs');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { volumeApi, createVolumes } = require('./volume');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const { containerApi, stopContainers, pullImages } = require('./containers');
-const { importDumpToDatabase, connectToDatabase } = require('../database');
-const getProjectConfiguration = require('../../config/get-project-configuration');
-const { getAvailablePorts, getCachedPorts } = require('../../config/get-port-config');
-const { saveConfiguration } = require('../../config/save-config');
-const { buildProjectImage, buildDebugProjectImage } = require('./project-image-builder');
-const checkPHPVersion = require('../requirements/php-version');
-const { getComposerVersionTask } = require('../composer');
-const { prepareFileSystem } = require('../file-system');
-const { installMagentoProject } = require('../magento');
-const enableMagentoComposerPlugins = require('../magento/enable-magento-composer-plugins');
-const { startServices } = require('./index');
-const dockerNetwork = require('./network');
-const KnownError = require('../../errors/known-error');
-const { createCacheFolder } = require('../cache');
-const { getSystemConfigTask } = require('../../config/system-config');
-const sleep = require('../../util/sleep');
-const { setProjectConfigTask } = require('../project-config');
+const path = require('path')
+const fs = require('fs')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { volumeApi, createVolumes } = require('./volume')
+const { execAsyncSpawn } = require('../../util/exec-async-command')
+const { containerApi, stopContainers, pullImages } = require('./containers')
+const { importDumpToDatabase, connectToDatabase } = require('../database')
+const getProjectConfiguration = require('../../config/get-project-configuration')
+const {
+    getAvailablePorts,
+    getCachedPorts
+} = require('../../config/get-port-config')
+const { saveConfiguration } = require('../../config/save-config')
+const {
+    buildProjectImage,
+    buildDebugProjectImage
+} = require('./project-image-builder')
+const checkPHPVersion = require('../requirements/php-version')
+const { getComposerVersionTask } = require('../composer')
+const { prepareFileSystem } = require('../file-system')
+const { installMagentoProject } = require('../magento')
+const enableMagentoComposerPlugins = require('../magento/enable-magento-composer-plugins')
+const { startServices } = require('./index')
+const dockerNetwork = require('./network')
+const KnownError = require('../../errors/known-error')
+const { createCacheFolder } = require('../cache')
+const { getSystemConfigTask } = require('../../config/system-config')
+const sleep = require('../../util/sleep')
+const { setProjectConfigTask } = require('../project-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const convertMySQLDatabaseToMariaDB = () => ({
     task: async (ctx, task) => {
-        const mysqlVolumeName = `${ ctx.config.baseConfig.prefix }_mysql-data`;
-        const volumes = await volumeApi.ls({ formatToJSON: true });
+        const mysqlVolumeName = `${ctx.config.baseConfig.prefix}_mysql-data`
+        const volumes = await volumeApi.ls({ formatToJSON: true })
         if (ctx.isArmMac) {
-            if (volumes.some(
-                (volume) => volume.Name === mysqlVolumeName
-            ) && !volumes.some(
-                (volume) => volume.Name === ctx.config.docker.volumes.mariadb.name
-            )
+            if (
+                volumes.some((volume) => volume.Name === mysqlVolumeName) &&
+                !volumes.some(
+                    (volume) =>
+                        volume.Name === ctx.config.docker.volumes.mariadb.name
+                )
             ) {
-                task.title = 'Converting MySQL database to MariaDB';
+                task.title = 'Converting MySQL database to MariaDB'
                 return task.newListr([
                     stopContainers(),
                     {
                         title: 'Converting MySQL volume to MariaDB',
                         task: async (subCtx, subTask) => {
-                            subTask.output = `Creating volume ${subCtx.config.docker.volumes.mariadb.name}...`;
-                            await volumeApi.create(subCtx.config.docker.volumes.mariadb);
-                            subTask.output = `Copying data from ${mysqlVolumeName} to ${subCtx.config.docker.volumes.mariadb.name}...`;
+                            subTask.output = `Creating volume ${subCtx.config.docker.volumes.mariadb.name}...`
+                            await volumeApi.create(
+                                subCtx.config.docker.volumes.mariadb
+                            )
+                            subTask.output = `Copying data from ${mysqlVolumeName} to ${subCtx.config.docker.volumes.mariadb.name}...`
                             await execAsyncSpawn(
-                            // eslint-disable-next-line max-len
-                                `docker run --rm -v ${mysqlVolumeName}:/from:ro -v ${subCtx.config.docker.volumes.mariadb.name}:/to alpine ash -c "cd /from; cp -av . /to"`, {
+                                `docker run --rm -v ${mysqlVolumeName}:/from:ro -v ${subCtx.config.docker.volumes.mariadb.name}:/to alpine ash -c "cd /from; cp -av . /to"`,
+                                {
                                     callback: (t) => {
-                                        subTask.output = t;
+                                        subTask.output = t
                                     }
                                 }
-                            );
-                            subTask.output = 'Deleting old volume...';
-                            await execAsyncSpawn(`docker volume rm ${mysqlVolumeName}`);
+                            )
+                            subTask.output = 'Deleting old volume...'
+                            await execAsyncSpawn(
+                                `docker volume rm ${mysqlVolumeName}`
+                            )
                         },
                         options: {
                             bottomBar: 10
                         }
                     }
-                ]);
+                ])
             }
 
-            return;
+            return
         }
 
-        if (volumes.some(
-            (volume) => volume.Name === mysqlVolumeName
-        ) && !volumes.some(
-            (volume) => volume.Name === ctx.config.docker.volumes.mariadb.name
-        )
+        if (
+            volumes.some((volume) => volume.Name === mysqlVolumeName) &&
+            !volumes.some(
+                (volume) =>
+                    volume.Name === ctx.config.docker.volumes.mariadb.name
+            )
         ) {
-            task.title = 'Converting MySQL database to MariaDB';
+            task.title = 'Converting MySQL database to MariaDB'
             const confirmConvert = await task.prompt({
                 type: 'Select',
                 message: `We see that you have old mysql-data volume in the project!
-Since ${logger.style.code('magento-scripts@2.0.0')} ${logger.style.misc('MariaDB')} is used as database instead of MySQL.
+Since ${logger.style.code('magento-scripts@2.0.0')} ${logger.style.misc(
+                    'MariaDB'
+                )} is used as database instead of MySQL.
 
 To use MariaDB with data from MySQL we need to convert your database.
 `,
                 choices: [
                     {
                         name: 'yes',
-                        message: 'Okay, let\'s do that!'
+                        message: "Okay, let's do that!"
                     },
                     {
                         name: 'no',
                         message: 'ABORT ABORT ABORT'
                     }
                 ]
-            });
+            })
 
             if (confirmConvert === 'yes') {
-                const pathToMySQLDumpFile = path.join(process.cwd(), 'mysql-database.sql');
-                const containerName = 'mysql-database';
-                task.output = 'Creating dump file from MySQL database...';
+                const pathToMySQLDumpFile = path.join(
+                    process.cwd(),
+                    'mysql-database.sql'
+                )
+                const containerName = 'mysql-database'
+                task.output = 'Creating dump file from MySQL database...'
 
-                const existingContainers = await containerApi.ls({ formatToJSON: true, all: true });
+                const existingContainers = await containerApi.ls({
+                    formatToJSON: true,
+                    all: true
+                })
 
                 if (existingContainers.some((c) => c.Names === containerName)) {
-                    await execAsyncSpawn(`docker container stop ${containerName}`);
-                    await execAsyncSpawn(`docker container rm ${containerName}`);
+                    await execAsyncSpawn(
+                        `docker container stop ${containerName}`
+                    )
+                    await execAsyncSpawn(`docker container rm ${containerName}`)
                 }
 
-                task.output = 'Starting MySQL server...';
+                task.output = 'Starting MySQL server...'
 
-                await containerApi.run(
-                    {
-                        mounts: [
-                            `source=${ mysqlVolumeName },target=/var/lib/mysql`
-                        ],
-                        env: {
-                            MYSQL_PORT: 3306,
-                            MYSQL_ROOT_PASSWORD: 'scandipwa',
-                            MYSQL_USER: 'magento',
-                            MYSQL_PASSWORD: 'magento',
-                            MYSQL_DATABASE: 'magento'
-                        },
-                        command: [
-                            '--log_bin_trust_function_creators=1',
-                            '--default-authentication-plugin=mysql_native_password',
-                            '--max_allowed_packet=1GB',
-                            '--bind-address=0.0.0.0'
-                        ]
-                            .join(' '),
-                        securityOptions: [
-                            'seccomp=unconfined'
-                        ],
-                        name: containerName,
-                        image: `mysql:${ ctx.config.overridenConfiguration.configuration.mysql.version }`
-                    }
-                );
+                await containerApi.run({
+                    mounts: [`source=${mysqlVolumeName},target=/var/lib/mysql`],
+                    env: {
+                        MYSQL_PORT: 3306,
+                        MYSQL_ROOT_PASSWORD: 'scandipwa',
+                        MYSQL_USER: 'magento',
+                        MYSQL_PASSWORD: 'magento',
+                        MYSQL_DATABASE: 'magento'
+                    },
+                    command: [
+                        '--log_bin_trust_function_creators=1',
+                        '--default-authentication-plugin=mysql_native_password',
+                        '--max_allowed_packet=1GB',
+                        '--bind-address=0.0.0.0'
+                    ].join(' '),
+                    securityOptions: ['seccomp=unconfined'],
+                    name: containerName,
+                    image: `mysql:${ctx.config.overridenConfiguration.configuration.mysql.version}`
+                })
 
-                task.output = 'Waiting for MySQL to initialize...';
+                task.output = 'Waiting for MySQL to initialize...'
 
-                let mysqlReadyForConnections = false;
+                let mysqlReadyForConnections = false
 
                 while (!mysqlReadyForConnections) {
-                    const mysqlOutput = await execAsyncSpawn(`docker logs ${containerName}`);
+                    const mysqlOutput = await execAsyncSpawn(
+                        `docker logs ${containerName}`
+                    )
                     if (mysqlOutput.includes('ready for connections')) {
-                        mysqlReadyForConnections = true;
-                        task.output = 'MySQL is ready!';
-                        break;
-                    } else if (mysqlOutput.includes('Initializing database files')) {
+                        mysqlReadyForConnections = true
+                        task.output = 'MySQL is ready!'
+                        break
+                    } else if (
+                        mysqlOutput.includes('Initializing database files')
+                    ) {
                         task.output = `MySQL is initializing database files!
-Please wait, this will take some time and do not restart the MySQL container until initialization is finished!`;
+Please wait, this will take some time and do not restart the MySQL container until initialization is finished!`
 
-                        let mysqlFinishedInitialization = false;
+                        let mysqlFinishedInitialization = false
                         while (!mysqlFinishedInitialization) {
-                            const mysqlOutput = await execAsyncSpawn(`docker logs ${containerName}`);
-                            if (mysqlOutput.includes('init process done.') && !mysqlFinishedInitialization) {
-                                mysqlFinishedInitialization = true;
-                                task.output = 'MySQL is initialized!';
-                                break;
+                            const mysqlOutput = await execAsyncSpawn(
+                                `docker logs ${containerName}`
+                            )
+                            if (
+                                mysqlOutput.includes('init process done.') &&
+                                !mysqlFinishedInitialization
+                            ) {
+                                mysqlFinishedInitialization = true
+                                task.output = 'MySQL is initialized!'
+                                break
                             }
-                            await sleep(2000);
+                            await sleep(2000)
                         }
                     }
 
-                    await sleep(2000);
+                    await sleep(2000)
                 }
 
-                task.output = 'Dumping MySQL database to dump file...';
+                task.output = 'Dumping MySQL database to dump file...'
 
                 await containerApi.exec(
                     [
@@ -170,33 +194,31 @@ Please wait, this will take some time and do not restart the MySQL container unt
                         '--user=root',
                         '--password=scandipwa',
                         'magento',
-                        `--result-file=${ path.parse(pathToMySQLDumpFile).base }`
+                        `--result-file=${path.parse(pathToMySQLDumpFile).base}`
                     ].join(' '),
                     containerName,
                     {},
                     {
                         callback: (t) => {
-                            task.output = t;
+                            task.output = t
                         }
                     }
-                );
+                )
 
-                task.output = 'Copying dump file from container to system...';
+                task.output = 'Copying dump file from container to system...'
 
                 await execAsyncSpawn(
-                    `docker cp ${containerName}:/${ path.parse(pathToMySQLDumpFile).base } ${ pathToMySQLDumpFile }`
-                );
+                    `docker cp ${containerName}:/${
+                        path.parse(pathToMySQLDumpFile).base
+                    } ${pathToMySQLDumpFile}`
+                )
 
-                task.output = 'Removing migration container...';
+                task.output = 'Removing migration container...'
 
-                await execAsyncSpawn(
-                    `docker container stop ${containerName}`
-                );
-                await execAsyncSpawn(
-                    `docker container rm ${containerName}`
-                );
+                await execAsyncSpawn(`docker container stop ${containerName}`)
+                await execAsyncSpawn(`docker container rm ${containerName}`)
 
-                ctx.importDb = pathToMySQLDumpFile;
+                ctx.importDb = pathToMySQLDumpFile
 
                 return task.newListr([
                     createCacheFolder(),
@@ -212,12 +234,13 @@ Please wait, this will take some time and do not restart the MySQL container unt
                     dockerNetwork.tasks.createNetwork(),
                     createVolumes(),
                     {
-                        task: (ctx, task) => task.newListr([
-                            buildProjectImage(),
-                            buildDebugProjectImage()
-                        ], {
-                            concurrent: true
-                        })
+                        task: (ctx, task) =>
+                            task.newListr(
+                                [buildProjectImage(), buildDebugProjectImage()],
+                                {
+                                    concurrent: true
+                                }
+                            )
                     },
                     checkPHPVersion(),
                     getComposerVersionTask(),
@@ -229,56 +252,64 @@ Please wait, this will take some time and do not restart the MySQL container unt
                     importDumpToDatabase(),
                     {
                         task: async (subCtx, subTask) => {
-                            const confirmDeleteOldVolume = await subTask.prompt({
-                                type: 'Select',
-                                message: 'Okay, looks like conversion went well, do you want to delete old mysql-data volume?',
-                                choices: [
-                                    {
-                                        name: 'yes',
-                                        message: 'Sure'
-                                    },
-                                    {
-                                        name: 'no',
-                                        message: 'No, I want to keep it'
-                                    }
-                                ]
-                            });
+                            const confirmDeleteOldVolume = await subTask.prompt(
+                                {
+                                    type: 'Select',
+                                    message:
+                                        'Okay, looks like conversion went well, do you want to delete old mysql-data volume?',
+                                    choices: [
+                                        {
+                                            name: 'yes',
+                                            message: 'Sure'
+                                        },
+                                        {
+                                            name: 'no',
+                                            message: 'No, I want to keep it'
+                                        }
+                                    ]
+                                }
+                            )
 
                             if (confirmDeleteOldVolume === 'yes') {
-                                await execAsyncSpawn(`docker volume rm ${ mysqlVolumeName }`);
+                                await execAsyncSpawn(
+                                    `docker volume rm ${mysqlVolumeName}`
+                                )
 
                                 const confirmDeleteDump = await subTask.prompt({
                                     type: 'Select',
                                     message: `Last question for today.
-Do you want to keep database dump created during conversion process? (${logger.style.file(pathToMySQLDumpFile)})`,
+Do you want to keep database dump created during conversion process? (${logger.style.file(
+                                        pathToMySQLDumpFile
+                                    )})`,
                                     choices: [
                                         {
                                             name: 'yes',
-                                            message: 'I don\'t need it, thanks'
+                                            message: "I don't need it, thanks"
                                         },
                                         {
                                             name: 'no',
-                                            message: 'I would like to keep it, thanks'
+                                            message:
+                                                'I would like to keep it, thanks'
                                         }
                                     ]
-                                });
+                                })
 
                                 if (confirmDeleteDump === 'yes') {
-                                    await fs.promises.rm(pathToMySQLDumpFile);
+                                    await fs.promises.rm(pathToMySQLDumpFile)
                                 }
                             }
                         }
                     }
-                ]);
+                ])
             }
-            throw new KnownError('ABORTING');
+            throw new KnownError('ABORTING')
         }
 
-        task.skip();
+        task.skip()
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = convertMySQLDatabaseToMariaDB;
+module.exports = convertMySQLDatabaseToMariaDB