@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/tasks/database/connect-to-database.js

@@ -1,10 +1,10 @@
-const mysql2 = require('mysql2/promise');
-const UnknownError = require('../../errors/unknown-error');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const sleep = require('../../util/sleep');
-const { createMagentoDatabase } = require('./create-magento-database');
-const { createMagentoUser } = require('./create-magento-user');
-const defaultMagentoUser = require('./default-magento-user');
+const mysql2 = require('mysql2/promise')
+const UnknownError = require('../../errors/unknown-error')
+const { execAsyncSpawn } = require('../../util/exec-async-command')
+const sleep = require('../../util/sleep')
+const { createMagentoDatabase } = require('./create-magento-database')
+const { createMagentoUser } = require('./create-magento-user')
+const defaultMagentoUser = require('./default-magento-user')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -12,37 +12,44 @@ const defaultMagentoUser = require('./default-magento-user');
 const waitForDatabaseInitialization = () => ({
     title: 'Waiting for Database to initialize',
     task: async (ctx, task) => {
-        const { mariadb } = ctx.config.docker.getContainers();
+        const { mariadb } = ctx.config.docker.getContainers()
 
-        let databaseReadyForConnections = false;
+        let databaseReadyForConnections = false
 
         while (!databaseReadyForConnections) {
-            const databaseOutput = await execAsyncSpawn(`docker logs ${mariadb.name}`);
+            const databaseOutput = await execAsyncSpawn(
+                `docker logs ${mariadb.name}`
+            )
             if (databaseOutput.includes('ready for connections')) {
-                databaseReadyForConnections = true;
-                break;
+                databaseReadyForConnections = true
+                break
             } else if (databaseOutput.includes('Initializing database files')) {
                 task.output = `${mariadb._} is initializing database files!
-Please wait, this will take some time and do not restart the ${mariadb._} container until initialization is finished!`;
+Please wait, this will take some time and do not restart the ${mariadb._} container until initialization is finished!`
 
-                let databaseFinishedInitialization = false;
+                let databaseFinishedInitialization = false
                 while (!databaseFinishedInitialization) {
-                    const databaseOutput2 = await execAsyncSpawn(`docker logs ${mariadb.name}`);
-                    if (databaseOutput2.includes('init process done.') && !databaseFinishedInitialization) {
-                        databaseFinishedInitialization = true;
-                        break;
+                    const databaseOutput2 = await execAsyncSpawn(
+                        `docker logs ${mariadb.name}`
+                    )
+                    if (
+                        databaseOutput2.includes('init process done.') &&
+                        !databaseFinishedInitialization
+                    ) {
+                        databaseFinishedInitialization = true
+                        break
                     }
-                    await sleep(2000);
+                    await sleep(2000)
                 }
             }
 
-            await sleep(2000);
+            await sleep(2000)
         }
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -50,14 +57,17 @@ Please wait, this will take some time and do not restart the ${mariadb._} contai
 const gettingDatabaseConnection = () => ({
     title: 'Getting Database connection',
     task: async (ctx, task) => {
-        const { config: { docker }, ports } = ctx;
-        const { mariadb } = docker.getContainers(ctx.ports);
-        let tries = 0;
-        const maxTries = 20;
-        const errors = [];
+        const {
+            config: { docker },
+            ports
+        } = ctx
+        const { mariadb } = docker.getContainers(ctx.ports)
+        let tries = 0
+        const maxTries = 20
+        const errors = []
 
         while (tries < maxTries) {
-            tries++;
+            tries++
             try {
                 const connection = await mysql2.createConnection({
                     host: '127.0.0.1',
@@ -65,23 +75,29 @@ const gettingDatabaseConnection = () => ({
                     user: defaultMagentoUser.user,
                     password: defaultMagentoUser.password,
                     database: 'magento'
-                });
+                })
 
-                ctx.databaseConnection = connection;
-                break;
+                ctx.databaseConnection = connection
+                break
             } catch (e) {
-                errors.push(e);
+                errors.push(e)
             }
-            await sleep(1000);
+            await sleep(1000)
         }
 
         if (tries === maxTries) {
-            throw new UnknownError(`Unable to connect to ${ mariadb._ } server. Check your server configuration!\n\n${ errors.join(' ') }`);
+            throw new UnknownError(
+                `Unable to connect to ${
+                    mariadb._
+                } server. Check your server configuration!\n\n${errors.join(
+                    ' '
+                )}`
+            )
         }
 
-        task.title = `${ mariadb._ } server connected!`;
+        task.title = `${mariadb._} server connected!`
     }
-});
+})
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -90,9 +106,9 @@ const terminatingExistingConnection = () => ({
     title: 'Terminating existing Database connection',
     skip: (ctx) => !ctx.databaseConnection,
     task: (ctx) => {
-        ctx.databaseConnection.destroy();
+        ctx.databaseConnection.destroy()
     }
-});
+})
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -100,21 +116,25 @@ const terminatingExistingConnection = () => ({
 const connectToDatabase = () => ({
     title: 'Connecting to Database server',
     skip: (ctx) => ctx.skipSetup,
-    task: (ctx, task) => task.newListr([
-        waitForDatabaseInitialization(),
-        createMagentoDatabase(),
-        createMagentoUser(),
-        terminatingExistingConnection(),
-        gettingDatabaseConnection()
-    ], {
-        concurrent: false,
-        rendererOptions: {
-            collapse: true
-        }
-    }),
+    task: (ctx, task) =>
+        task.newListr(
+            [
+                waitForDatabaseInitialization(),
+                createMagentoDatabase(),
+                createMagentoUser(),
+                terminatingExistingConnection(),
+                gettingDatabaseConnection()
+            ],
+            {
+                concurrent: false,
+                rendererOptions: {
+                    collapse: true
+                }
+            }
+        ),
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = connectToDatabase;
+module.exports = connectToDatabase

package/lib/tasks/database/create-magento-database.js

@@ -1,4 +1,4 @@
-const { containerApi } = require('../docker/containers');
+const { containerApi } = require('../docker/containers')
 
 /**
  * Will create database 'magento' in MariaDB if it does not exist for some reason
@@ -7,15 +7,15 @@ const { containerApi } = require('../docker/containers');
 const createMagentoDatabase = () => ({
     title: 'Creating Magento database',
     task: async (ctx, task) => {
-        const { mariadb } = ctx.config.docker.getContainers();
-        task.title = `Creating Magento database in ${ mariadb._ }`;
+        const { mariadb } = ctx.config.docker.getContainers()
+        task.title = `Creating Magento database in ${mariadb._}`
         await containerApi.exec(
-            `mysql -uroot -p${ mariadb.env.MARIADB_ROOT_PASSWORD } -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`,
+            `mysql -uroot -p${mariadb.env.MARIADB_ROOT_PASSWORD} -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`,
             mariadb.name
-        );
+        )
     }
-});
+})
 
 module.exports = {
     createMagentoDatabase
-};
+}

package/lib/tasks/database/create-magento-user.js

@@ -1,5 +1,5 @@
-const mysql2 = require('mysql2/promise');
-const defaultMagentoUser = require('./default-magento-user');
+const mysql2 = require('mysql2/promise')
+const defaultMagentoUser = require('./default-magento-user')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -7,44 +7,57 @@ const defaultMagentoUser = require('./default-magento-user');
 const createMagentoUser = () => ({
     title: 'Creating Magento user',
     task: async (ctx, task) => {
-        const { mariadb } = ctx.config.docker.getContainers();
+        const { mariadb } = ctx.config.docker.getContainers()
         const connection = await mysql2.createConnection({
             host: '127.0.0.1',
             port: ctx.ports.mariadb,
             user: 'root',
             password: mariadb.env.MARIADB_ROOT_PASSWORD
-        });
+        })
 
-        const result = await connection.query('select Host, User from mysql.user;');
+        const result = await connection.query(
+            'select Host, User from mysql.user;'
+        )
 
         if (result.length === 0) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        const [users] = result;
+        const [users] = result
 
-        if (users.some((user) => user.User === defaultMagentoUser.user && user.Host === '%')) {
-            task.skip();
-            return;
+        if (
+            users.some(
+                (user) =>
+                    user.User === defaultMagentoUser.user && user.Host === '%'
+            )
+        ) {
+            task.skip()
+            return
         }
 
         if (users.some((user) => user.User === defaultMagentoUser.user)) {
-            const magentoUser = users.find((user) => user.User === defaultMagentoUser.user);
+            const magentoUser = users.find(
+                (user) => user.User === defaultMagentoUser.user
+            )
 
-            await connection.query(`DROP USER '${ magentoUser.User }'@'${ magentoUser.Host }'`);
+            await connection.query(
+                `DROP USER '${magentoUser.User}'@'${magentoUser.Host}'`
+            )
         }
 
         await connection.query(
-            `CREATE USER '${ defaultMagentoUser.user }'@'${ defaultMagentoUser.host }' IDENTIFIED BY '${ defaultMagentoUser.password }';`
-        );
-        await connection.query(`GRANT ALL PRIVILEGES ON *.* TO '${ defaultMagentoUser.user }'@'${ defaultMagentoUser.host }' WITH GRANT OPTION;`);
-        await connection.query('FLUSH PRIVILEGES;');
+            `CREATE USER '${defaultMagentoUser.user}'@'${defaultMagentoUser.host}' IDENTIFIED BY '${defaultMagentoUser.password}';`
+        )
+        await connection.query(
+            `GRANT ALL PRIVILEGES ON *.* TO '${defaultMagentoUser.user}'@'${defaultMagentoUser.host}' WITH GRANT OPTION;`
+        )
+        await connection.query('FLUSH PRIVILEGES;')
 
-        await connection.destroy();
+        await connection.destroy()
     }
-});
+})
 
 module.exports = {
     createMagentoUser
-};
+}

package/lib/tasks/database/default-magento-database.js

@@ -1,3 +1,3 @@
 module.exports = {
     defaultMagentoDatabase: 'magento'
-};
+}

package/lib/tasks/database/default-magento-user.js

@@ -2,6 +2,6 @@ const defaultMagentoUser = {
     user: 'magento',
     password: 'magento',
     host: '%'
-};
+}
 
-module.exports = defaultMagentoUser;
+module.exports = defaultMagentoUser

package/lib/tasks/database/dump-theme-config.js

@@ -1,41 +1,45 @@
-const { isTableExists } = require('../../util/database');
+const { isTableExists } = require('../../util/database')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const dumpThemeConfig = () => ({
     title: 'Dumping themes and theme configuration',
     task: async (ctx, task) => {
-        const { databaseConnection } = ctx;
+        const { databaseConnection } = ctx
         if (await isTableExists('magento', 'theme', ctx)) {
-            const [themes] = await databaseConnection.query('select * from theme;');
+            const [themes] = await databaseConnection.query(
+                'select * from theme;'
+            )
             if (themes.length === 0) {
                 ctx.themeDump = {
                     themes: [],
                     themeIdConfig: undefined // we don't have a config saved
-                };
+                }
             }
 
             if (await isTableExists('magento', 'core_config_data', ctx)) {
-                const [themeIdConfig] = await databaseConnection.query('select * from core_config_data where path = \'design/theme/theme_id\';');
+                const [themeIdConfig] = await databaseConnection.query(
+                    "select * from core_config_data where path = 'design/theme/theme_id';"
+                )
                 if (themeIdConfig.length !== 0) {
                     ctx.themeDump = {
                         themes,
                         themeIdConfig: themeIdConfig[0]
-                    };
+                    }
 
-                    return;
+                    return
                 }
             }
         } else {
-            task.skip();
+            task.skip()
         }
 
         ctx.themeDump = {
             themes: [],
             themeIdConfig: undefined // we don't have a config saved
-        };
+        }
     }
-});
+})
 
-module.exports = dumpThemeConfig;
+module.exports = dumpThemeConfig

package/lib/tasks/database/fix-db.js

@@ -1,72 +1,82 @@
-const configureElasticsearch = require('../magento/setup-magento/configure-elasticsearch');
-const deleteAdminUsers = require('../magento/setup-magento/delete-admin-users');
-const deleteCustomers = require('../magento/setup-magento/delete-customers');
-const deleteOrders = require('../magento/setup-magento/delete-orders');
-const varnishConfigSetup = require('../magento/setup-magento/varnish-config');
+const configureElasticsearch = require('../magento/setup-magento/configure-elasticsearch')
+const deleteAdminUsers = require('../magento/setup-magento/delete-admin-users')
+const deleteCustomers = require('../magento/setup-magento/delete-customers')
+const deleteOrders = require('../magento/setup-magento/delete-orders')
+const varnishConfigSetup = require('../magento/setup-magento/varnish-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const enableForeignKeyCheck = () => ({
-    task: ({ databaseConnection }) => databaseConnection.query('SET FOREIGN_KEY_CHECKS = 0;')
-});
+    task: ({ databaseConnection }) =>
+        databaseConnection.query('SET FOREIGN_KEY_CHECKS = 0;')
+})
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const disableForeignKeyCheck = () => ({
-    task: ({ databaseConnection }) => databaseConnection.query('SET FOREIGN_KEY_CHECKS = 1;')
-});
+    task: ({ databaseConnection }) =>
+        databaseConnection.query('SET FOREIGN_KEY_CHECKS = 1;')
+})
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const fixDB = () => ({
     title: 'Fixing database',
-    task: async (ctx, task) => task.newListr([
-        varnishConfigSetup(),
-        configureElasticsearch(),
-        {
-            title: 'Deleting customers data',
-            skip: ({ withCustomersData }) => withCustomersData,
-            task: async (ctx, subTask) => {
-                const deleteCustomerData = await subTask.prompt({
-                    type: 'Confirm',
-                    message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
+    task: async (ctx, task) =>
+        task.newListr(
+            [
+                varnishConfigSetup(),
+                configureElasticsearch(),
+                {
+                    title: 'Deleting customers data',
+                    skip: ({ withCustomersData }) => withCustomersData,
+                    task: async (ctx, subTask) => {
+                        const deleteCustomerData = await subTask.prompt({
+                            type: 'Confirm',
+                            message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
 This will reduce database size and remove possible interference for your setup.`
-                });
+                        })
 
-                if (!deleteCustomerData) {
-                    subTask.skip();
-                    return;
-                }
+                        if (!deleteCustomerData) {
+                            subTask.skip()
+                            return
+                        }
 
-                return subTask.newListr([
-                    enableForeignKeyCheck(),
-                    {
-                        title: 'Deleting admin users, orders and customers...',
-                        task: (ctx, subSubTask) => subSubTask.newListr([
-                            deleteAdminUsers(),
-                            deleteOrders(),
-                            deleteCustomers()
-                        ], {
-                            concurrent: true
-                        }),
-                        rollback: disableForeignKeyCheck()
+                        return subTask.newListr([
+                            enableForeignKeyCheck(),
+                            {
+                                title: 'Deleting admin users, orders and customers...',
+                                task: (ctx, subSubTask) =>
+                                    subSubTask.newListr(
+                                        [
+                                            deleteAdminUsers(),
+                                            deleteOrders(),
+                                            deleteCustomers()
+                                        ],
+                                        {
+                                            concurrent: true
+                                        }
+                                    ),
+                                rollback: disableForeignKeyCheck()
+                            },
+                            disableForeignKeyCheck()
+                        ])
                     },
-                    disableForeignKeyCheck()
-                ]);
-            },
-            options: {
+                    options: {
+                        rendererOptions: { collapse: false }
+                    }
+                }
+            ],
+            {
+                concurrent: false,
+                exitOnError: true,
+                ctx,
                 rendererOptions: { collapse: false }
             }
-        }
-    ], {
-        concurrent: false,
-        exitOnError: true,
-        ctx,
-        rendererOptions: { collapse: false }
-    })
-});
+        )
+})
 
-module.exports = fixDB;
+module.exports = fixDB