@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/tasks/magento/setup-magento/migrate-database.js

@@ -1,128 +1,147 @@
-const path = require('path');
-const installMagentoProject = require('../install-magento-project');
-const magentoTask = require('../../../util/magento-task');
-const runMagentoCommand = require('../../../util/run-magento');
-const configureElasticsearch = require('./configure-elasticsearch');
-const installMagento = require('./install-magento');
-const upgradeMagento = require('./upgrade-magento');
-const varnishConfigSetup = require('./varnish-config');
-const pathExists = require('../../../util/path-exists');
-const updateEnvPHP = require('../../php/update-env-php');
-const UnknownError = require('../../../errors/unknown-error');
+const path = require('path')
+const installMagentoProject = require('../install-magento-project')
+const magentoTask = require('../../../util/magento-task')
+const runMagentoCommand = require('../../../util/run-magento')
+const configureElasticsearch = require('./configure-elasticsearch')
+const installMagento = require('./install-magento')
+const upgradeMagento = require('./upgrade-magento')
+const varnishConfigSetup = require('./varnish-config')
+const pathExists = require('../../../util/path-exists')
+const updateEnvPHP = require('../../php/update-env-php')
+const UnknownError = require('../../../errors/unknown-error')
 
 /**
  * @param {Object} [options]
- * @param {Boolean} options.onlyInstallMagento
+ * @param {Boolean} [options.onlyInstallMagento]
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const migrateDatabase = (options = {}) => ({
     title: 'Migrating database',
     task: async (ctx, task) => {
-        const { databaseConnection } = ctx;
+        const { databaseConnection } = ctx
 
         const [[{ tableCount }]] = await databaseConnection.query(`
             SELECT count(*) AS tableCount
             FROM INFORMATION_SCHEMA.TABLES
             WHERE TABLE_SCHEMA = 'magento';
-        `);
+        `)
 
         if (
-            tableCount === 0
-            || !(await pathExists(path.join(process.cwd(), 'app', 'etc', 'env.php'))
-            || (!await pathExists(path.join(process.cwd(), 'app', 'etc', 'config.php'))))
+            tableCount === 0 ||
+            !(
+                (await pathExists(
+                    path.join(process.cwd(), 'app', 'etc', 'env.php')
+                )) ||
+                !(await pathExists(
+                    path.join(process.cwd(), 'app', 'etc', 'config.php')
+                ))
+            )
         ) {
             if (options.onlyInstallMagento) {
-                ctx.isSetupUpgradeNeeded = false;
-                return task.newListr([
-                    installMagento({ isDbEmpty: true })
-                ]);
+                ctx.isSetupUpgradeNeeded = false
+                return task.newListr([installMagento({ isDbEmpty: true })])
             }
 
-            return task.newListr([
-                installMagento({ isDbEmpty: true }),
-                updateEnvPHP(),
-                varnishConfigSetup(),
-                configureElasticsearch(),
-                upgradeMagento(),
-                magentoTask('cache:enable')
-            ], {
-                concurrent: false,
-                exitOnError: true,
-                ctx,
-                rendererOptions: {
-                    collapse: false
+            return task.newListr(
+                [
+                    installMagento({ isDbEmpty: true }),
+                    updateEnvPHP(),
+                    varnishConfigSetup(),
+                    configureElasticsearch(),
+                    upgradeMagento(),
+                    magentoTask('cache:enable')
+                ],
+                {
+                    concurrent: false,
+                    exitOnError: true,
+                    ctx,
+                    rendererOptions: {
+                        collapse: false
+                    }
                 }
-            });
+            )
         }
 
-        const { code, result } = await runMagentoCommand(ctx, 'setup:db:status', {
-            throwNonZeroCode: false
-        });
+        const { code, result } = await runMagentoCommand(
+            ctx,
+            'setup:db:status',
+            {
+                throwNonZeroCode: false
+            }
+        )
 
         switch (code) {
-        case 0: {
-            ctx.isSetupUpgradeNeeded = false;
-            // no setup is needed, but still to be sure configure ES
-            return task.newListr([
-                varnishConfigSetup(),
-                configureElasticsearch()
-            ], {
-                concurrent: false,
-                exitOnError: true,
-                ctx,
-                rendererOptions: {
-                    collapse: false
-                }
-            });
-        }
-        case 1: {
-            if (options.onlyInstallMagento) {
-                ctx.isSetupUpgradeNeeded = false;
-                return task.newListr([
-                    installMagentoProject(),
-                    installMagento()
-                ]);
+            case 0: {
+                ctx.isSetupUpgradeNeeded = false
+                // no setup is needed, but still to be sure configure ES
+                return task.newListr(
+                    [varnishConfigSetup(), configureElasticsearch()],
+                    {
+                        concurrent: false,
+                        exitOnError: true,
+                        ctx,
+                        rendererOptions: {
+                            collapse: false
+                        }
+                    }
+                )
             }
-
-            return task.newListr([
-                installMagentoProject(),
-                installMagento(),
-                updateEnvPHP(),
-                varnishConfigSetup(),
-                configureElasticsearch(),
-                upgradeMagento(),
-                magentoTask('cache:enable')
-            ], {
-                concurrent: false,
-                exitOnError: true,
-                ctx,
-                rendererOptions: {
-                    collapse: false
-                }
-            });
-        }
-        case 2: {
-            return task.newListr([
-                varnishConfigSetup(),
-                configureElasticsearch(),
-                upgradeMagento()
-            ], {
-                concurrent: false,
-                exitOnError: true,
-                ctx,
-                rendererOptions: {
-                    collapse: false
+            case 1: {
+                if (options.onlyInstallMagento) {
+                    ctx.isSetupUpgradeNeeded = false
+                    return task.newListr([
+                        installMagentoProject(),
+                        installMagento()
+                    ])
                 }
-            });
-        }
-        default: {
-            throw new UnknownError(`Migrating database failed: manual action is required!\n\n${result}`);
-        }
+
+                return task.newListr(
+                    [
+                        installMagentoProject(),
+                        installMagento(),
+                        updateEnvPHP(),
+                        varnishConfigSetup(),
+                        configureElasticsearch(),
+                        upgradeMagento(),
+                        magentoTask('cache:enable')
+                    ],
+                    {
+                        concurrent: false,
+                        exitOnError: true,
+                        ctx,
+                        rendererOptions: {
+                            collapse: false
+                        }
+                    }
+                )
+            }
+            case 2: {
+                return task.newListr(
+                    [
+                        varnishConfigSetup(),
+                        configureElasticsearch(),
+                        upgradeMagento()
+                    ],
+                    {
+                        concurrent: false,
+                        exitOnError: true,
+                        ctx,
+                        rendererOptions: {
+                            collapse: false
+                        }
+                    }
+                )
+            }
+            default: {
+                throw new UnknownError(
+                    `Migrating database failed: manual action is required!\n\n${result}`
+                )
+            }
         }
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = migrateDatabase;
+module.exports = migrateDatabase

package/lib/tasks/magento/setup-magento/set-base-url.js

@@ -1,4 +1,4 @@
-const { updateTableValues } = require('../../../util/database');
+const { updateTableValues } = require('../../../util/database')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -9,27 +9,41 @@ module.exports = () => ({
         const {
             ports,
             config: {
-                overridenConfiguration: {
-                    host,
-                    ssl
-                }
+                overridenConfiguration: { host, ssl }
             },
             databaseConnection
-        } = ctx;
-        const isNgrok = host.endsWith('ngrok.io');
-        const enableSecureFrontend = (isNgrok || ssl.enabled) ? '1' : '0';
-        const location = `${host}${ !isNgrok && ports.sslTerminator !== 80 ? `:${ports.sslTerminator }` : '' }/`;
-        const secureLocation = `${host}/`; // SSL will work only on port 443, so you cannot run multiple projects with SSL at the same time.
-        const httpUrl = `http://${location}`;
-        const httpsUrl = `https://${secureLocation}`;
+        } = ctx
+        const isNgrok = host.endsWith('ngrok.io')
+        const enableSecureFrontend = isNgrok || ssl.enabled ? '1' : '0'
+        const location = `${host}${
+            !isNgrok && ports.sslTerminator !== 80
+                ? `:${ports.sslTerminator}`
+                : ''
+        }/`
+        const secureLocation = `${host}/` // SSL will work only on port 443, so you cannot run multiple projects with SSL at the same time.
+        const httpUrl = `http://${location}`
+        const httpsUrl = `https://${secureLocation}`
 
-        await updateTableValues('core_config_data', [
-            { path: 'web/unsecure/base_url', value: httpUrl },
-            { path: 'web/secure/base_url', value: httpsUrl },
-            { path: 'web/secure/use_in_frontend', value: enableSecureFrontend },
-            { path: 'web/secure/use_in_adminhtml', value: enableSecureFrontend },
-            { path: 'web/secure/enable_upgrade_insecure', value: enableSecureFrontend },
-            { path: 'web/cookie/cookie_domain', value: null }
-        ], { databaseConnection, task });
+        await updateTableValues(
+            'core_config_data',
+            [
+                { path: 'web/unsecure/base_url', value: httpUrl },
+                { path: 'web/secure/base_url', value: httpsUrl },
+                {
+                    path: 'web/secure/use_in_frontend',
+                    value: enableSecureFrontend
+                },
+                {
+                    path: 'web/secure/use_in_adminhtml',
+                    value: enableSecureFrontend
+                },
+                {
+                    path: 'web/secure/enable_upgrade_insecure',
+                    value: enableSecureFrontend
+                },
+                { path: 'web/cookie/cookie_domain', value: null }
+            ],
+            { databaseConnection, task }
+        )
     }
-});
+})

package/lib/tasks/magento/setup-magento/set-deployment-mode.js

@@ -1,5 +1,5 @@
-const magentoTask = require('../../../util/magento-task');
-const runMagentoCommand = require('../../../util/run-magento');
+const magentoTask = require('../../../util/magento-task')
+const runMagentoCommand = require('../../../util/run-magento')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -7,29 +7,31 @@ const runMagentoCommand = require('../../../util/run-magento');
 module.exports = () => ({
     title: 'Switching Magento mode',
     task: async (ctx, task) => {
-        const { config: { magentoConfiguration: { mode } } } = ctx;
+        const {
+            config: {
+                magentoConfiguration: { mode }
+            }
+        } = ctx
         const { result } = await runMagentoCommand(ctx, 'deploy:mode:show', {
             throwNonZeroCode: false
-        });
+        })
 
         if (result.includes(mode)) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
         const magentoModeSwitchTasks = [
-            magentoTask(`deploy:mode:set ${ mode } --skip-compilation`)
-        ];
+            magentoTask(`deploy:mode:set ${mode} --skip-compilation`)
+        ]
 
         if (mode === 'production') {
             magentoModeSwitchTasks.push(
                 magentoTask('setup:di:compile'),
                 magentoTask('setup:static-content:deploy')
-            );
+            )
         }
 
-        return task.newListr(
-            magentoModeSwitchTasks
-        );
+        return task.newListr(magentoModeSwitchTasks)
     }
-});
+})

package/lib/tasks/magento/setup-magento/set-mail-config.js

@@ -1,22 +1,28 @@
-const { updateTableValues } = require('../../../util/database');
+const { updateTableValues } = require('../../../util/database')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const setMailConfig = () => ({
     title: 'Setting up mail configuration',
     task: async ({ databaseConnection, ports, isDockerDesktop }, task) => {
-        await updateTableValues('core_config_data', [
-            {
-                path: 'smtp/configuration_option/port',
-                value: `${ ports.maildevSMTP }`
-            },
-            {
-                path: 'smtp/configuration_option/host',
-                value: isDockerDesktop ? 'host.docker.internal' : 'localhost'
-            }
-        ], { databaseConnection, task });
+        await updateTableValues(
+            'core_config_data',
+            [
+                {
+                    path: 'smtp/configuration_option/port',
+                    value: `${ports.maildevSMTP}`
+                },
+                {
+                    path: 'smtp/configuration_option/host',
+                    value: isDockerDesktop
+                        ? 'host.docker.internal'
+                        : 'localhost'
+                }
+            ],
+            { databaseConnection, task }
+        )
     }
-});
+})
 
-module.exports = setMailConfig;
+module.exports = setMailConfig

package/lib/tasks/magento/setup-magento/set-url-rewrite.js

@@ -1,4 +1,4 @@
-const { updateTableValues } = require('../../../util/database');
+const { updateTableValues } = require('../../../util/database')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -6,13 +6,17 @@ const { updateTableValues } = require('../../../util/database');
 const setUrlRewrite = () => ({
     title: 'Setting up url-rewrites',
     task: async ({ databaseConnection }, task) => {
-        await updateTableValues('core_config_data', [
-            {
-                path: 'web/seo/use_rewrites',
-                value: '1'
-            }
-        ], { databaseConnection, task });
+        await updateTableValues(
+            'core_config_data',
+            [
+                {
+                    path: 'web/seo/use_rewrites',
+                    value: '1'
+                }
+            ],
+            { databaseConnection, task }
+        )
     }
-});
+})
 
-module.exports = setUrlRewrite;
+module.exports = setUrlRewrite

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

@@ -1,6 +1,6 @@
-const magentoTask = require('../../../util/magento-task');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const KnownError = require('../../../errors/known-error');
+const magentoTask = require('../../../util/magento-task')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const KnownError = require('../../../errors/known-error')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -8,29 +8,37 @@ const KnownError = require('../../../errors/known-error');
 const upgradeMagento = () => ({
     skip: (ctx) => {
         if (ctx.isSetupUpgradeNeeded !== undefined) {
-            return !ctx.isSetupUpgradeNeeded;
+            return !ctx.isSetupUpgradeNeeded
         }
 
-        return false;
+        return false
     },
-    task: (_ctx, task) => task.newListr([
-        magentoTask('setup:upgrade --no-interaction', {
-            onError: (e) => {
-                throw new KnownError(`Magento setup:upgrade command failed!
+    task: (_ctx, task) =>
+        task.newListr(
+            [
+                magentoTask('setup:upgrade --no-interaction', {
+                    onError: (e) => {
+                        throw new KnownError(`Magento setup:upgrade command failed!
 You can try disabling failed module and try again.
-To disable module, open ${logger.style.misc('cli')} and type the following command: ${logger.style.command('m module:disable <module-name>')}
+To disable module, open ${logger.style.misc(
+                            'cli'
+                        )} and type the following command: ${logger.style.command(
+                            'm module:disable <module-name>'
+                        )}
 
-Error: ${e}`);
+Error: ${e}`)
+                    }
+                }),
+                {
+                    task: (ctx) => {
+                        ctx.isSetupUpgradeNeeded = false
+                    }
+                }
+            ],
+            {
+                concurrent: false
             }
-        }),
-        {
-            task: (ctx) => {
-                ctx.isSetupUpgradeNeeded = false;
-            }
-        }
-    ], {
-        concurrent: false
-    })
-});
+        )
+})
 
-module.exports = upgradeMagento;
+module.exports = upgradeMagento

package/lib/tasks/magento/setup-magento/urn-highlighter.js

@@ -1,7 +1,7 @@
-const fs = require('fs');
-const path = require('path');
-const magentoTask = require('../../../util/magento-task');
-const pathExists = require('../../../util/path-exists');
+const fs = require('fs')
+const path = require('path')
+const magentoTask = require('../../../util/magento-task')
+const pathExists = require('../../../util/path-exists')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -11,19 +11,19 @@ const pathExists = require('../../../util/path-exists');
 const urnHighlighter = () => ({
     title: 'Generating URN highlighter',
     task: async (ctx, task) => {
-        if (!await pathExists(path.join(process.cwd(), './.idea'))) {
-            await fs.promises.mkdir(path.join(process.cwd(), './.idea'));
+        if (!(await pathExists(path.join(process.cwd(), './.idea')))) {
+            await fs.promises.mkdir(path.join(process.cwd(), './.idea'))
         }
 
         if (await pathExists(path.join(process.cwd(), './.idea/misc.xml'))) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
         return task.newListr(
             magentoTask('dev:urn-catalog:generate -- ./.idea/misc.xml')
-        );
+        )
     }
-});
+})
 
-module.exports = urnHighlighter;
+module.exports = urnHighlighter

package/lib/tasks/magento/setup-magento/varnish-config.js

@@ -1,4 +1,4 @@
-const { updateTableValues } = require('../../../util/database');
+const { updateTableValues } = require('../../../util/database')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -10,9 +10,7 @@ const varnishConfigSetup = () => ({
             config: {
                 overridenConfiguration: {
                     configuration: {
-                        varnish: {
-                            enabled: varnishEnabled
-                        }
+                        varnish: { enabled: varnishEnabled }
                     }
                 }
             },
@@ -20,46 +18,58 @@ const varnishConfigSetup = () => ({
             ports,
             debug,
             isDockerDesktop
-        } = ctx;
+        } = ctx
 
         if (!debug && varnishEnabled) {
-            await updateTableValues('core_config_data', [
-                {
-                    path: 'system/full_page_cache/varnish/backend_host',
-                    value: isDockerDesktop ? 'host.docker.internal' : 'localhost'
-                },
-                {
-                    path: 'system/full_page_cache/varnish/backend_port',
-                    value: ports.varnish
-                },
-                {
-                    path: 'system/full_page_cache/varnish/access_list',
-                    value: isDockerDesktop ? 'host.docker.internal,localhost' : 'localhost'
-                },
-                {
-                    path: 'system/full_page_cache/caching_application',
-                    value: '2'
-                }
-            ], { databaseConnection, task });
+            await updateTableValues(
+                'core_config_data',
+                [
+                    {
+                        path: 'system/full_page_cache/varnish/backend_host',
+                        value: isDockerDesktop
+                            ? 'host.docker.internal'
+                            : 'localhost'
+                    },
+                    {
+                        path: 'system/full_page_cache/varnish/backend_port',
+                        value: ports.varnish
+                    },
+                    {
+                        path: 'system/full_page_cache/varnish/access_list',
+                        value: isDockerDesktop
+                            ? 'host.docker.internal,localhost'
+                            : 'localhost'
+                    },
+                    {
+                        path: 'system/full_page_cache/caching_application',
+                        value: '2'
+                    }
+                ],
+                { databaseConnection, task }
+            )
         } else {
             // delete varnish configuration if exists
             await databaseConnection.query(`
                 DELETE FROM core_config_data WHERE path LIKE '%varnish%';
-            `);
+            `)
 
             // update cache policy to not use varnish
             // 1 - magento cache, 2 - varnish cache
-            await updateTableValues('core_config_data', [
-                {
-                    path: 'system/full_page_cache/caching_application',
-                    value: '1'
-                }
-            ], { databaseConnection, task });
+            await updateTableValues(
+                'core_config_data',
+                [
+                    {
+                        path: 'system/full_page_cache/caching_application',
+                        value: '1'
+                    }
+                ],
+                { databaseConnection, task }
+            )
         }
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = varnishConfigSetup;
+module.exports = varnishConfigSetup