@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/tasks/magento/setup-magento/delete-orders.js

@@ -1,4 +1,4 @@
-const { orderTables } = require('../../database/magento-tables');
+const { orderTables } = require('../../database/magento-tables')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -6,21 +6,27 @@ const { orderTables } = require('../../database/magento-tables');
 const deleteOrders = () => ({
     title: 'Deleting orders',
     task: async (ctx, task) => {
-        const { databaseConnection, withCustomersData } = ctx;
+        const { databaseConnection, withCustomersData } = ctx
 
         if (withCustomersData) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        const [rows] = await databaseConnection.query('select TABLE_NAME from information_schema.TABLES;');
+        const [rows] = await databaseConnection.query(
+            'select TABLE_NAME from information_schema.TABLES;'
+        )
 
         await Promise.all(
             orderTables
-                .filter((tableName) => rows.some((row) => row.TABLE_NAME === tableName))
-                .map((tableName) => databaseConnection.query(`TRUNCATE TABLE \`${ tableName }\`;`))
-        );
+                .filter((tableName) =>
+                    rows.some((row) => row.TABLE_NAME === tableName)
+                )
+                .map((tableName) =>
+                    databaseConnection.query(`TRUNCATE TABLE \`${tableName}\`;`)
+                )
+        )
     }
-});
+})
 
-module.exports = deleteOrders;
+module.exports = deleteOrders

package/lib/tasks/magento/setup-magento/disable-2fa.js

@@ -1,5 +1,5 @@
-const configPhpToJson = require('../../../util/config-php-json');
-const runMagentoCommand = require('../../../util/run-magento');
+const configPhpToJson = require('../../../util/config-php-json')
+const runMagentoCommand = require('../../../util/run-magento')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -7,14 +7,17 @@ const runMagentoCommand = require('../../../util/run-magento');
 module.exports = () => ({
     title: 'Disabling 2fa for admin',
     task: async (ctx, task) => {
-        const { modules } = await configPhpToJson(ctx);
+        const { modules } = await configPhpToJson(ctx)
 
-        if (modules.Magento_TwoFactorAuth !== undefined && modules.Magento_TwoFactorAuth !== 0) {
-            await runMagentoCommand(ctx, 'module:disable Magento_TwoFactorAuth');
+        if (
+            modules.Magento_TwoFactorAuth !== undefined &&
+            modules.Magento_TwoFactorAuth !== 0
+        ) {
+            await runMagentoCommand(ctx, 'module:disable Magento_TwoFactorAuth')
 
-            return;
+            return
         }
 
-        task.skip();
+        task.skip()
     }
-});
+})

package/lib/tasks/magento/setup-magento/disable-maintenance-mode.js

@@ -1,4 +1,4 @@
-const runMagentoCommand = require('../../../util/run-magento');
+const runMagentoCommand = require('../../../util/run-magento')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -8,15 +8,15 @@ const disableMaintenanceMode = () => ({
     task: async (ctx, task) => {
         const { result } = await runMagentoCommand(ctx, 'maintenance:status', {
             throwNonZeroCode: false
-        });
+        })
 
         if (result.includes('maintenance mode is not active')) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        await runMagentoCommand(ctx, 'maintenance:disable');
+        await runMagentoCommand(ctx, 'maintenance:disable')
     }
-});
+})
 
-module.exports = disableMaintenanceMode;
+module.exports = disableMaintenanceMode

package/lib/tasks/magento/setup-magento/disable-page-builder.js

@@ -1,11 +1,12 @@
-const magentoTask = require('../../../util/magento-task');
+const magentoTask = require('../../../util/magento-task')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const disablePageBuilder = () => ({
     title: 'Disabling page builder in Magento',
-    task: (ctx, task) => task.newListr(magentoTask('config:set cms/pagebuilder/enabled 0'))
-});
+    task: (ctx, task) =>
+        task.newListr(magentoTask('config:set cms/pagebuilder/enabled 0'))
+})
 
-module.exports = disablePageBuilder;
+module.exports = disablePageBuilder

package/lib/tasks/magento/setup-magento/flush-redis-config.js

@@ -1,5 +1,5 @@
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const UnknownError = require('../../../errors/unknown-error');
+const { execAsyncSpawn } = require('../../../util/exec-async-command')
+const UnknownError = require('../../../errors/unknown-error')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -7,13 +7,19 @@ const UnknownError = require('../../../errors/unknown-error');
 module.exports = () => ({
     title: 'Flushing Magento Redis cache',
     task: async ({ ports, config: { docker }, isDockerDesktop }) => {
-        const { redis: { name } } = docker.getContainers(ports);
-        const host = !isDockerDesktop ? 'localhost' : 'host.docker.internal';
-        const port = !isDockerDesktop ? '6379' : ports.redis;
-        const result = await execAsyncSpawn(`docker exec ${ name } redis-cli -h ${ host } -p ${ port } -n 0 flushdb`);
+        const {
+            redis: { name }
+        } = docker.getContainers(ports)
+        const host = !isDockerDesktop ? 'localhost' : 'host.docker.internal'
+        const port = !isDockerDesktop ? '6379' : ports.redis
+        const result = await execAsyncSpawn(
+            `docker exec ${name} redis-cli -h ${host} -p ${port} -n 0 flushdb`
+        )
 
         if (!result.trim().includes('OK')) {
-            throw new UnknownError(`Unexpected output from redis flush command: ${result}`);
+            throw new UnknownError(
+                `Unexpected output from redis flush command: ${result}`
+            )
         }
     }
-});
+})

package/lib/tasks/magento/setup-magento/increase-admin-session-lifetime.js

@@ -1,24 +1,28 @@
-const { updateTableValues } = require('../../../util/database');
+const { updateTableValues } = require('../../../util/database')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const increaseAdminSessionLifetime = () => ({
     title: 'Increase admin session lifetime to 1 month',
-    task: async ({ databaseConnection }, task) => updateTableValues('core_config_data', [
-        {
-            path: 'admin/security/session_lifetime',
-            value: '2800000'
-        },
-        {
-            path: 'admin/security/password_lifetime',
-            value: null
-        }
-    ], {
-        databaseConnection,
-        task
-    })
+    task: async ({ databaseConnection }, task) =>
+        updateTableValues(
+            'core_config_data',
+            [
+                {
+                    path: 'admin/security/session_lifetime',
+                    value: '2800000'
+                },
+                {
+                    path: 'admin/security/password_lifetime',
+                    value: null
+                }
+            ],
+            {
+                databaseConnection,
+                task
+            }
+        )
+})
 
-});
-
-module.exports = increaseAdminSessionLifetime;
+module.exports = increaseAdminSessionLifetime

package/lib/tasks/magento/setup-magento/index-products.js

@@ -1,13 +1,11 @@
-const magentoTask = require('../../../util/magento-task');
+const magentoTask = require('../../../util/magento-task')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const indexProducts = () => ({
-    task: (ctx, task) => task.newListr(
-        magentoTask('index:reindex')
-    ),
+    task: (ctx, task) => task.newListr(magentoTask('index:reindex')),
     retry: 2
-});
+})
 
-module.exports = indexProducts;
+module.exports = indexProducts

package/lib/tasks/magento/setup-magento/index.js

@@ -1,65 +1,72 @@
-const flushRedisConfig = require('./flush-redis-config');
-const waitingForRedis = require('./waiting-for-redis');
-const migrateDatabase = require('./migrate-database');
-const createAdmin = require('./create-admin');
-const setDeploymentMode = require('./set-deployment-mode');
-const setBaseUrl = require('./set-base-url');
-const disableMaintenanceMode = require('./disable-maintenance-mode');
-const disable2fa = require('./disable-2fa');
-const setUrlRewrite = require('./set-url-rewrite');
-const increaseAdminSessionLifetime = require('./increase-admin-session-lifetime');
-const magentoTask = require('../../../util/magento-task');
-const urnHighlighter = require('./urn-highlighter');
-const adjustFullPageCache = require('./adjust-full-page-cache');
-const updateEnvPHP = require('../../php/update-env-php');
-const setMailConfig = require('./set-mail-config');
+const flushRedisConfig = require('./flush-redis-config')
+const waitingForRedis = require('./waiting-for-redis')
+const migrateDatabase = require('./migrate-database')
+const createAdmin = require('./create-admin')
+const setDeploymentMode = require('./set-deployment-mode')
+const setBaseUrl = require('./set-base-url')
+const disableMaintenanceMode = require('./disable-maintenance-mode')
+const disable2fa = require('./disable-2fa')
+const setUrlRewrite = require('./set-url-rewrite')
+const increaseAdminSessionLifetime = require('./increase-admin-session-lifetime')
+const magentoTask = require('../../../util/magento-task')
+const urnHighlighter = require('./urn-highlighter')
+const adjustFullPageCache = require('./adjust-full-page-cache')
+const updateEnvPHP = require('../../php/update-env-php')
+const setMailConfig = require('./set-mail-config')
 
 /**
  * @param {Object} [options]
- * @param {Boolean} options.onlyInstallMagento
+ * @param {Boolean} [options.onlyInstallMagento]
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const setupMagento = (options = {}) => ({
     title: 'Setting up Magento',
-    skip: ({ skipSetup }) => skipSetup,
+    skip: ({ skipSetup }) => Boolean(skipSetup),
     task: (ctx, task) => {
         if (options.onlyInstallMagento) {
             return task.newListr([
                 flushRedisConfig(),
                 waitingForRedis(),
                 migrateDatabase({ onlyInstallMagento: true })
-            ]);
+            ])
         }
 
-        return task.newListr([
-            waitingForRedis(),
-            updateEnvPHP(),
-            migrateDatabase(),
-            flushRedisConfig(),
+        return task.newListr(
+            [
+                waitingForRedis(),
+                updateEnvPHP(),
+                migrateDatabase(),
+                flushRedisConfig(),
+                {
+                    title: 'Configuring Magento settings',
+                    task: (ctx, task) =>
+                        task.newListr(
+                            [
+                                setBaseUrl(),
+                                setUrlRewrite(),
+                                setMailConfig(),
+                                increaseAdminSessionLifetime()
+                            ],
+                            {
+                                concurrent: true
+                            }
+                        )
+                },
+                createAdmin(),
+                setDeploymentMode(),
+                disableMaintenanceMode(),
+                disable2fa(),
+                urnHighlighter(),
+                adjustFullPageCache(),
+                magentoTask('cache:flush')
+            ],
             {
-                title: 'Configuring Magento settings',
-                task: (ctx, task) => task.newListr([
-                    setBaseUrl(),
-                    setUrlRewrite(),
-                    setMailConfig(),
-                    increaseAdminSessionLifetime()
-                ], {
-                    concurrent: true
-                })
-            },
-            createAdmin(),
-            setDeploymentMode(),
-            disableMaintenanceMode(),
-            disable2fa(),
-            urnHighlighter(),
-            adjustFullPageCache(),
-            magentoTask('cache:flush')
-        ], {
-            concurrent: false,
-            exitOnError: true,
-            ctx
-        });
+                concurrent: false,
+                exitOnError: true,
+                ctx
+            }
+        )
     }
-});
+})
 
-module.exports = setupMagento;
+module.exports = setupMagento

package/lib/tasks/magento/setup-magento/install-magento.js

@@ -1,189 +1,222 @@
-const fs = require('fs');
-const path = require('path');
-const semver = require('semver');
-const UnknownError = require('../../../errors/unknown-error');
-const runMagentoCommand = require('../../../util/run-magento');
-const envPhpToJson = require('../../../util/env-php-json');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { defaultMagentoDatabase } = require('../../database/default-magento-database');
-const defaultMagentoUser = require('../../database/default-magento-user');
+const fs = require('fs')
+const path = require('path')
+const semver = require('semver')
+const UnknownError = require('../../../errors/unknown-error')
+const runMagentoCommand = require('../../../util/run-magento')
+const envPhpToJson = require('../../../util/env-php-json')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const {
+    defaultMagentoDatabase
+} = require('../../database/default-magento-database')
+const defaultMagentoUser = require('../../database/default-magento-user')
 
 /**
- * @param {Object} [param0]
- * @param {Boolean} param0.isDbEmpty
+ * @param {Object} param0
+ * @param {Boolean} [param0.isDbEmpty]
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const installMagento = ({ isDbEmpty = false } = {}) => ({
     title: 'Installing Magento in Database',
     task: async (ctx, task) => {
         if (isDbEmpty) {
-            task.output = 'No Magento is installed in DB!\nInstalling...';
+            task.output = 'No Magento is installed in DB!\nInstalling...'
         }
         const {
             magentoVersion,
-            config: {
-                magentoConfiguration
-            },
+            config: { magentoConfiguration },
             ports,
             databaseConnection,
             isDockerDesktop
-        } = ctx;
+        } = ctx
 
-        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+        const hostMachine = !isDockerDesktop
+            ? '127.0.0.1'
+            : 'host.docker.internal'
 
         const [tableResponse] = await databaseConnection.query(
-            'SELECT * FROM information_schema.tables WHERE table_schema = \'magento\' AND table_name = \'admin_user\' LIMIT 1;'
-        );
+            "SELECT * FROM information_schema.tables WHERE table_schema = 'magento' AND table_name = 'admin_user' LIMIT 1;"
+        )
 
         if (tableResponse.length > 0) {
             const response = await databaseConnection.query(
-                'select * from admin_user where username=\'admin\';'
-            );
+                "select * from admin_user where username='admin';"
+            )
 
-            const usersWithUsernameAdmin = response && response.length > 0 && response[0];
+            const usersWithUsernameAdmin =
+                response && response.length > 0 && response[0]
 
             if (usersWithUsernameAdmin && usersWithUsernameAdmin.length > 0) {
                 const confirmDeleteAdminUsers = await task.prompt({
                     type: 'Select',
-                    message: `In order to install Magento in database you will need to delete admin user with username ${logger.style.command('admin')}`,
+                    message: `In order to install Magento in database you will need to delete admin user with username ${logger.style.command(
+                        'admin'
+                    )}`,
                     choices: [
                         {
                             name: 'delete-all',
-                            message: `Delete all admin users (${logger.style.code('Recommended')})`
+                            message: `Delete all admin users (${logger.style.code(
+                                'Recommended'
+                            )})`
                         },
                         {
                             name: 'delete-only-admin',
-                            message: `Delete only admin user with ${logger.style.command('admin')} username`
+                            message: `Delete only admin user with ${logger.style.command(
+                                'admin'
+                            )} username`
                         }
                     ]
-                });
+                })
 
-                await databaseConnection.query('SET FOREIGN_KEY_CHECKS = 0;');
+                await databaseConnection.query('SET FOREIGN_KEY_CHECKS = 0;')
 
                 if (confirmDeleteAdminUsers === 'delete-all') {
                     await databaseConnection.query(`
                     TRUNCATE TABLE admin_user;
-                `);
+                `)
                 } else {
                     await databaseConnection.query(`
                     DELETE FROM admin_user WHERE username='admin';
-                `);
+                `)
                 }
 
-                await databaseConnection.query('SET FOREIGN_KEY_CHECKS = 1;');
+                await databaseConnection.query('SET FOREIGN_KEY_CHECKS = 1;')
             }
         }
-        const envPhpData = await envPhpToJson(ctx);
+        const envPhpData = await envPhpToJson(ctx)
 
-        const envPhpHaveEncryptionKey = envPhpData && envPhpData.crypt && envPhpData.crypt.key && envPhpData.crypt.key;
+        const envPhpHaveEncryptionKey =
+            envPhpData &&
+            envPhpData.crypt &&
+            envPhpData.crypt.key &&
+            envPhpData.crypt.key
 
-        let encryptionKeyOption = null;
+        let encryptionKeyOption = null
 
         if (ctx.encryptionKey) {
-            encryptionKeyOption = `--key='${ctx.encryptionKey}'`;
+            encryptionKeyOption = `--key='${ctx.encryptionKey}'`
         }
 
         if (envPhpHaveEncryptionKey && !encryptionKeyOption) {
-            encryptionKeyOption = `--key='${envPhpData.crypt.key}'`;
+            encryptionKeyOption = `--key='${envPhpData.crypt.key}'`
         }
 
-        let installed = false;
+        let installed = false
 
-        const pureMagentoVersion = magentoVersion.match(/^([0-9]+\.[0-9]+\.[0-9]+)/)[1];
+        const pureMagentoVersion = magentoVersion.match(
+            /^([0-9]+\.[0-9]+\.[0-9]+)/
+        )[1]
 
-        const isMagento23 = semver.satisfies(pureMagentoVersion, '<2.4');
+        const isMagento23 = semver.satisfies(pureMagentoVersion, '<2.4')
 
         const elasticsearchConfiguration = ` \
 --search-engine='elasticsearch7' \
---elasticsearch-host='${ hostMachine }' \
---elasticsearch-port='${ ports.elasticsearch }'`;
+--elasticsearch-host='${hostMachine}' \
+--elasticsearch-port='${ports.elasticsearch}'`
 
         /**
          * @type {Array<Error>}
          */
-        const errors = [];
+        const errors = []
 
         for (let tries = 0; tries < 2; tries++) {
             try {
                 const command = `setup:install \
-                --admin-firstname='${ magentoConfiguration.first_name }' \
-                --admin-lastname='${ magentoConfiguration.last_name }' \
-                --admin-email='${ magentoConfiguration.email }' \
-                --admin-user='${ magentoConfiguration.user }' \
-                --admin-password='${ magentoConfiguration.password }' \
-                ${ !isMagento23 ? elasticsearchConfiguration : '' } \
+                --admin-firstname='${magentoConfiguration.first_name}' \
+                --admin-lastname='${magentoConfiguration.last_name}' \
+                --admin-email='${magentoConfiguration.email}' \
+                --admin-user='${magentoConfiguration.user}' \
+                --admin-password='${magentoConfiguration.password}' \
+                ${!isMagento23 ? elasticsearchConfiguration : ''} \
                 ${encryptionKeyOption || ''} \
                 --session-save=redis \
-                --session-save-redis-host='${ hostMachine }' \
-                --session-save-redis-port='${ ports.redis }' \
+                --session-save-redis-host='${hostMachine}' \
+                --session-save-redis-port='${ports.redis}' \
                 --session-save-redis-log-level='3' \
                 --session-save-redis-max-concurrency='30' \
                 --session-save-redis-db='1' \
                 --session-save-redis-disable-locking='1' \
                 --cache-backend='redis' \
-                --cache-backend-redis-server='${ hostMachine }' \
-                --cache-backend-redis-port='${ ports.redis }' \
+                --cache-backend-redis-server='${hostMachine}' \
+                --cache-backend-redis-port='${ports.redis}' \
                 --cache-backend-redis-db='0't \
-                --db-host='${ hostMachine }:${ ports.mariadb }' \
-                --db-name='${ defaultMagentoDatabase }' \
-                --db-user='${ defaultMagentoUser.user }' \
-                --db-password='${ defaultMagentoUser.password }' \
-                --backend-frontname='${ magentoConfiguration.adminuri }' \
-                --no-interaction`;
+                --db-host='${hostMachine}:${ports.mariadb}' \
+                --db-name='${defaultMagentoDatabase}' \
+                --db-user='${defaultMagentoUser.user}' \
+                --db-password='${defaultMagentoUser.password}' \
+                --backend-frontname='${magentoConfiguration.adminuri}' \
+                --no-interaction`
 
                 await runMagentoCommand(ctx, command, {
                     throwNonZeroCode: true,
-                    callback: !ctx.verbose ? undefined : (t) => {
-                        task.output = t;
-                    }
-                });
-
-                installed = true;
+                    callback: !ctx.verbose
+                        ? undefined
+                        : (t) => {
+                              task.output = t
+                          }
+                })
+
+                installed = true
             } catch (e) {
-                errors.push(e);
+                errors.push(e)
             }
 
             if (installed) {
-                break;
+                break
             }
         }
 
         if (errors.length > 0) {
-            if (envPhpHaveEncryptionKey && errors.some(
-                (e) => e.message.includes('The default website isn\'t defined. Set the website and try again.')
-            )
+            if (
+                envPhpHaveEncryptionKey &&
+                errors.some((e) =>
+                    e.message.includes(
+                        "The default website isn't defined. Set the website and try again."
+                    )
+                )
             ) {
                 const confirmToWipeEnvPhp = await task.prompt({
                     type: 'Confirm',
-                    message: `We detected that your encryption key in ${logger.style.file('app/etc/env.php')} file is not accepted by Magento installer.
-To fix this issue we will need to ${logger.style.misc('DELETE')} ${logger.style.file('app/etc/env.php')} file. It will be recreated but existing encryption key but if you any custom configuration in it will be lost.
+                    message: `We detected that your encryption key in ${logger.style.file(
+                        'app/etc/env.php'
+                    )} file is not accepted by Magento installer.
+To fix this issue we will need to ${logger.style.misc(
+                        'DELETE'
+                    )} ${logger.style.file(
+                        'app/etc/env.php'
+                    )} file. It will be recreated but existing encryption key but if you any custom configuration in it will be lost.
 
 Without this you will not be able to install Magento at this moment.
 
 Do you want to continue?`
-                });
+                })
 
                 if (confirmToWipeEnvPhp) {
                     try {
-                        await fs.promises.unlink(path.join(process.cwd(), 'app', 'etc', 'env.php'));
+                        await fs.promises.unlink(
+                            path.join(process.cwd(), 'app', 'etc', 'env.php')
+                        )
                     } catch (e) {
-                        throw new UnknownError(`Unexpected error occurred during deleting of app/etc/env.php file!\n\n${e}`);
+                        throw new UnknownError(
+                            `Unexpected error occurred during deleting of app/etc/env.php file!\n\n${e}`
+                        )
                     }
-                    ctx.encryptionKey = envPhpData.crypt.key;
+                    ctx.encryptionKey = envPhpData.crypt.key
 
-                    return task.run(ctx);
+                    return task.run(ctx)
                 }
             }
         }
 
         if (!installed) {
-            const errorMessages = errors.map((e) => e.message).join('\n\n');
-            throw new UnknownError(`Unable to install Magento!\n${errorMessages}`);
+            const errorMessages = errors.map((e) => e.message).join('\n\n')
+            throw new UnknownError(
+                `Unable to install Magento!\n${errorMessages}`
+            )
         }
     },
     options: {
         bottomBar: 15
     }
-});
+})
 
-module.exports = installMagento;
+module.exports = installMagento