@scandipwa/magento-scripts 1.14.1-alpha.1 → 1.14.1-alpha.12

package/lib/tasks/file-system/create-varnish-config.js

@@ -0,0 +1,53 @@
+const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
+const setConfigFile = require('../../util/set-config');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createVarnishConfig = () => ({
+    title: 'Setting Varnish config',
+    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    task: async (ctx) => {
+        const {
+            ports,
+            config: {
+                overridenConfiguration,
+                baseConfig: {
+                    cacheDir
+                }
+            },
+            isWsl,
+            platform
+        } = ctx;
+
+        const {
+            configuration: {
+                varnish
+            }
+        } = overridenConfiguration;
+
+        const isLinux = platform === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
+
+        try {
+            await setConfigFile({
+                configPathname: path.join(
+                    cacheDir,
+                    'varnish',
+                    'default.vcl'
+                ),
+                template: varnish.configTemplate,
+                overwrite: true,
+                templateArgs: {
+                    hostMachine: isNativeLinux ? '127.0.0.1' : 'host.docker.internal',
+                    nginxPort: ports.app
+                }
+            });
+        } catch (e) {
+            throw new UnknownError(`Unexpected error accrued during varnish config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createVarnishConfig;

package/lib/tasks/file-system/create-vscode-config.js

@@ -5,6 +5,7 @@ const os = require('os');
 const hjson = require('hjson');
 const pathExists = require('../../util/path-exists');
 const setConfigFile = require('../../util/set-config');
+const UnknownError = require('../../errors/unknown-error');
 
 const phpXDebug2port = 9111;
 const phpXDebug3port = 9003;
@@ -87,7 +88,7 @@ const createPhpFpmConfig = () => ({
             try {
                 await fs.promises.mkdir(path.join(process.cwd(), '.vscode'));
             } catch (e) {
-                throw new Error(`Unable to creade .vscode directory in your project!\n\n${e}`);
+                throw new UnknownError(`Unable to creade .vscode directory in your project!\n\n${e}`);
             }
         }
 
@@ -103,7 +104,7 @@ const createPhpFpmConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during launch.json config creation!\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during launch.json config creation!\n\n${e}`);
         }
     }
 });

package/lib/tasks/file-system/index.js

@@ -2,6 +2,8 @@ const createNginxConfig = require('./create-nginx-config');
 const createPhpConfig = require('./create-php-config');
 const createPhpFpmConfig = require('./create-php-fpm-config');
 const createPhpStormConfig = require('./create-phpstorm-config');
+const createSSLTerminatorConfig = require('./create-ssl-terminator-config');
+const createVarnishConfig = require('./create-varnish-config');
 const createVSCodeConfig = require('./create-vscode-config');
 
 /**
@@ -10,11 +12,13 @@ const createVSCodeConfig = require('./create-vscode-config');
 const prepareFileSystem = () => ({
     title: 'Preparing file system',
     task: (ctx, task) => task.newListr([
+        createSSLTerminatorConfig(),
         createNginxConfig(),
         createPhpFpmConfig(),
         createPhpConfig(),
         createPhpStormConfig(),
-        createVSCodeConfig()
+        createVSCodeConfig(),
+        createVarnishConfig()
     ], {
         concurrent: true
     })

package/lib/tasks/magento/enable-magento-composer-plugins.js

@@ -4,6 +4,7 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const semver = require('semver');
 const pathExists = require('../../util/path-exists');
 const getJsonfileData = require('../../util/get-jsonfile-data');
+const KnownError = require('../../errors/known-error');
 
 const vendorPath = path.join(process.cwd(), 'vendor');
 const composerJsonPath = path.join(process.cwd(), 'composer.json');
@@ -121,7 +122,7 @@ Do you want to enable them all or disable some of them?`,
                         encoding: 'utf-8'
                     });
                 } else {
-                    throw new Error('Please confirm your choice or choose other option.');
+                    throw new KnownError('Please confirm your choice or choose other option.');
                 }
                 break;
             }
@@ -153,7 +154,7 @@ Do you want to enable them all or disable some of them?`,
                         encoding: 'utf-8'
                     });
                 } else {
-                    throw new Error('Please confirm your choice or choose other option.');
+                    throw new KnownError('Please confirm your choice or choose other option.');
                 }
 
                 break;

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

@@ -6,6 +6,8 @@ const moveFile = require('../../util/move-file');
 const pathExists = require('../../util/path-exists');
 const getJsonFileData = require('../../util/get-jsonfile-data');
 const rmdirSafe = require('../../util/rmdir-safe');
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
 
 const magentoProductEnterpriseEdition = 'magento/product-enterprise-edition';
 const magentoProductCommunityEdition = 'magento/product-community-edition';
@@ -58,7 +60,7 @@ const adjustComposerJson = async ({
         composerData.require[magentoProductCommunityEdition]
         && composerData.require[magentoProductEnterpriseEdition]
     ) {
-        throw new Error('Somehow, both Magento editions are installed!\nPlease choose only one edition an modify your composer.json manually!');
+        throw new KnownError('Somehow, both Magento editions are installed!\nPlease choose only one edition an modify your composer.json manually!');
     }
 
     const oppositeEdition = [magentoProductCommunityEdition, magentoProductEnterpriseEdition]
@@ -66,7 +68,7 @@ const adjustComposerJson = async ({
 
     // if opposite edition is installed than selected in config file, throw an error
     if (composerData.require[oppositeEdition]) {
-        throw new Error(`You have installed ${oppositeEdition} but selected magento.edition as ${magentoEdition} in config file!
+        throw new KnownError(`You have installed ${oppositeEdition} but selected magento.edition as ${magentoEdition} in config file!
 
 Change magento edition in config file or manually reinstall correct magento edition!`);
     }
@@ -187,11 +189,11 @@ const installMagento = () => ({
                 });
         } catch (e) {
             if (e.message.includes('man-in-the-middle attack')) {
-                throw new Error(`Probably you haven't setup pubkeys in composer.
-                Please run composer diagnose in cli to get mode.\n\n${e}`);
+                throw new KnownError(`Probably you haven't setup pubkeys in composer.
+Please run composer diagnose in cli to get mode.\n\n${e}`);
             }
 
-            throw new Error(`Unexpected error during composer install.\n\n${e}`);
+            throw new UnknownError(`Unexpected error during composer install.\n\n${e}`);
         }
         ctx.magentoFirstInstall = true;
     },

package/lib/tasks/magento/setup-magento/adjust-full-page-cache.js

@@ -0,0 +1,26 @@
+const envPhpToJson = require('../../../util/env-php-json');
+const magentoTask = require('../../../util/magento-task');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const disableFullPageCache = () => ({
+    title: 'Adjusting full_page cache setting',
+    task: async ({ magentoVersion, config }, task) => {
+        const { cache_types } = await envPhpToJson(process.cwd(), { magentoVersion });
+
+        if (cache_types.full_page !== 0 && !config.overridenConfiguration.configuration.varnish.enabled) {
+            task.title = 'Disabling full_page cache in Magento';
+            return task.newListr(magentoTask('cache:disable full_page'));
+        }
+
+        if (config.overridenConfiguration.configuration.varnish.enabled && cache_types.full_page !== 1) {
+            task.title = 'Enabling full_page cache in Magento (Varnish is enabled)';
+            return task.newListr(magentoTask('cache:enable full_page'));
+        }
+
+        task.skip();
+    }
+});
+
+module.exports = disableFullPageCache;

package/lib/tasks/magento/setup-magento/configure-elasticsearch.js

@@ -4,7 +4,7 @@ const { updateTableValues, isTableExists } = require('../../../util/database');
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
-    title: 'Configuring elasticsearch',
+    title: 'Configuring Elasticsearch',
     skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
     task: async ({ ports, mysqlConnection }, task) => {
         await updateTableValues('core_config_data', [

package/lib/tasks/magento/setup-magento/delete-admin-users.js

@@ -1,7 +1,7 @@
 const { isTableExists } = require('../../../util/database');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const deleteAdminUsers = () => ({
     title: 'Deleting old admin users',

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

@@ -1,7 +1,7 @@
 const { customerTables } = require('../../mysql/magento-tables');
 
 /**
- * @type {() => import(listr2).ListrTask<import(../../../../typings/context).ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const deleteCustomers = () => ({
     title: 'Deleting customers',
@@ -12,10 +12,13 @@ const deleteCustomers = () => ({
             task.skip();
             return;
         }
+
+        const [rows] = await mysqlConnection.query('select TABLE_NAME from information_schema.TABLES;');
+
         await Promise.all(
-            customerTables.map(
-                (tableName) => mysqlConnection.query(`TRUNCATE TABLE \`${ tableName }\`;`)
-            )
+            customerTables
+                .filter((tableName) => rows.some((row) => row.TABLE_NAME === tableName))
+                .map((tableName) => mysqlConnection.query(`TRUNCATE TABLE \`${ tableName }\`;`))
         );
     }
 });

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

@@ -1,7 +1,7 @@
 const { orderTables } = require('../../mysql/magento-tables');
 
 /**
- * @type {import(listr2).ListrTask<import(../../../../typings/context).ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const deleteOrders = () => ({
     title: 'Deleting orders',
@@ -13,10 +13,12 @@ const deleteOrders = () => ({
             return;
         }
 
+        const [rows] = await mysqlConnection.query('select TABLE_NAME from information_schema.TABLES;');
+
         await Promise.all(
-            orderTables.map(
-                (tableName) => mysqlConnection.query(`TRUNCATE TABLE \`${ tableName }\`;`)
-            )
+            orderTables
+                .filter((tableName) => rows.some((row) => row.TABLE_NAME === tableName))
+                .map((tableName) => mysqlConnection.query(`TRUNCATE TABLE \`${ tableName }\`;`))
         );
     }
 });

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

@@ -1,23 +1,15 @@
+const configPhpToJson = require('../../../util/config-php-json');
 const runMagentoCommand = require('../../../util/run-magento');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
-    title: 'Disabling 2fa for admin.',
+    title: 'Disabling 2fa for admin',
     task: async ({ magentoVersion }, task) => {
-        const { result } = await runMagentoCommand('module:status Magento_TwoFactorAuth', {
-            magentoVersion,
-            throwNonZeroCode: false
-        });
+        const { modules } = await configPhpToJson(process.cwd(), { magentoVersion });
 
-        if (result.includes('Module is disabled')) {
-            task.skip();
-            return;
-        }
-
-        // Disable 2FA due admin login issue
-        if (result.includes('Module is enabled')) {
+        if (modules.Magento_TwoFactorAuth !== 0) {
             await runMagentoCommand('module:disable Magento_TwoFactorAuth', {
                 magentoVersion
             });

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

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const os = require('os');
+const UnknownError = require('../../../errors/unknown-error');
 
 const isLinux = os.platform() === 'linux';
 
@@ -15,7 +16,7 @@ module.exports = () => ({
         const result = await execAsyncSpawn(`docker exec ${ name } redis-cli -h ${ host } -p ${ port } -n 0 flushdb`);
 
         if (!result.trim().includes('OK')) {
-            throw new Error(`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

@@ -5,22 +5,20 @@ const { updateTableValues } = require('../../../util/database');
  */
 const increaseAdminSessionLifetime = () => ({
     title: 'Increase admin session lifetime to 1 month',
-    task: async (ctx, task) => {
-        const { mysqlConnection } = ctx;
-        await updateTableValues('core_config_data', [
-            {
-                path: 'admin/security/session_lifetime',
-                value: '2800000'
-            },
-            {
-                path: 'admin/security/password_lifetime',
-                value: null
-            }
-        ], {
-            mysqlConnection,
-            task
-        });
-    }
+    task: async ({ mysqlConnection }, task) => updateTableValues('core_config_data', [
+        {
+            path: 'admin/security/session_lifetime',
+            value: '2800000'
+        },
+        {
+            path: 'admin/security/password_lifetime',
+            value: null
+        }
+    ], {
+        mysqlConnection,
+        task
+    })
+
 });
 
 module.exports = increaseAdminSessionLifetime;

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

@@ -11,6 +11,7 @@ const updateEnvPHP = require('../../php/update-env-php');
 const increaseAdminSessionLifetime = require('./increase-admin-session-lifetime');
 const magentoTask = require('../../../util/magento-task');
 const urnHighlighter = require('./urn-highlighter');
+const waitingForVarnish = require('./waiting-for-varnish');
 
 /**
  * @type {({ onlyInstallMagento: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -48,7 +49,8 @@ const setupMagento = (options = {}) => ({
             disableMaintenanceMode(),
             disable2fa(),
             urnHighlighter(),
-            magentoTask('cache:flush')
+            magentoTask('cache:flush'),
+            waitingForVarnish()
         ], {
             concurrent: false,
             exitOnError: true,

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

@@ -1,4 +1,5 @@
 const semver = require('semver');
+const UnknownError = require('../../../errors/unknown-error');
 const runMagentoCommand = require('../../../util/run-magento');
 
 /**
@@ -86,7 +87,7 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
 
         if (!installed) {
             const errorMessages = errors.map((e) => e.message).join('\n\n');
-            throw new Error(`Unable to install Magento!\n${errorMessages}`);
+            throw new UnknownError(`Unable to install Magento!\n${errorMessages}`);
         }
     },
     options: {

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

@@ -1,10 +1,9 @@
 const magentoTask = require('../../../util/magento-task');
 const runMagentoCommand = require('../../../util/run-magento');
-const adjustMagentoConfiguration = require('./adjust-magento-configuration');
 const configureElasticsearch = require('./configure-elasticsearch');
 const installMagento = require('./install-magento');
 const upgradeMagento = require('./upgrade-magento');
-const setupPersistedQuery = require('../../theme/setup-persisted-query');
+const varnishConfigSetup = require('./varnish-config');
 
 /**
  * @type {({ onlyInstallMagento: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -25,6 +24,7 @@ const migrateDatabase = (options = {}) => ({
 
         if (tableCount === 0) {
             if (options.onlyInstallMagento) {
+                ctx.isSetupUpgradeNeeded = false;
                 return task.newListr(
                     installMagento({ isDbEmpty: true })
                 );
@@ -32,14 +32,17 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento({ isDbEmpty: true }),
-                setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         const { code } = await runMagentoCommand('setup:db:status', {
@@ -49,18 +52,23 @@ const migrateDatabase = (options = {}) => ({
 
         switch (code) {
         case 0: {
+            ctx.isSetupUpgradeNeeded = false;
             // no setup is needed, but still to be sure configure ES
             return task.newListr([
-                setupPersistedQuery(),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         case 1: {
             if (options.onlyInstallMagento) {
+                ctx.isSetupUpgradeNeeded = false;
                 return task.newListr(
                     installMagento()
                 );
@@ -68,26 +76,31 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento(),
-                setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         case 2: {
             return task.newListr([
-                setupPersistedQuery(),
-                adjustMagentoConfiguration(),
+                varnishConfigSetup(),
                 configureElasticsearch(),
                 upgradeMagento()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         default: {

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

@@ -8,12 +8,17 @@ module.exports = () => ({
     task: async (ctx, task) => {
         const {
             ports,
-            config: { overridenConfiguration: { host, ssl } },
+            config: {
+                overridenConfiguration: {
+                    host,
+                    ssl
+                }
+            },
             mysqlConnection
         } = ctx;
         const isNgrok = host.endsWith('ngrok.io');
         const enableSecureFrontend = ssl.enabled ? '1' : '0';
-        const location = `${host}${ !isNgrok && ports.app !== 80 ? `:${ports.app}` : '' }/`;
+        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}`;

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

@@ -1,12 +1,36 @@
 const magentoTask = require('../../../util/magento-task');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const KnownError = require('../../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const upgradeMagento = () => ({
-    task: (ctx, task) => task.newListr(
-        magentoTask('setup:upgrade --no-interaction')
-    )
+    skip: (ctx) => {
+        if ('isSetupUpgradeNeeded' in ctx) {
+            return !ctx.isSetupUpgradeNeeded;
+        }
+
+        return false;
+    },
+    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>')}
+
+Error: ${e}`);
+            }
+        }),
+        {
+            task: (ctx) => {
+                ctx.isSetupUpgradeNeeded = false;
+            }
+        }
+    ], {
+        concurrent: false
+    })
 });
 
 module.exports = upgradeMagento;

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

@@ -0,0 +1,69 @@
+const os = require('os');
+const { updateTableValues } = require('../../../util/database');
+const getIsWsl = require('../../../util/is-wsl');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const varnishConfigSetup = () => ({
+    title: 'Varnish setup',
+    task: async (ctx, task) => {
+        const {
+            config: {
+                overridenConfiguration: {
+                    configuration: {
+                        varnish: {
+                            enabled: varnishEnabled
+                        }
+                    }
+                }
+            },
+            mysqlConnection,
+            ports
+        } = ctx;
+
+        const isLinux = os.platform() === 'linux';
+        const isWsl = await getIsWsl();
+        // const host = (isLinux && !isWsl) ? 'localhost' : 'host.docker.internal';
+
+        if (varnishEnabled) {
+            await updateTableValues('core_config_data', [
+                {
+                    path: 'system/full_page_cache/varnish/backend_host',
+                    value: 'localhost'
+                },
+                {
+                    path: 'system/full_page_cache/varnish/backend_port',
+                    value: ports.varnish
+                },
+                {
+                    path: 'system/full_page_cache/varnish/access_list',
+                    value: (!isLinux || isWsl) ? 'host.docker.internal,localhost' : 'localhost'
+                },
+                {
+                    path: 'system/full_page_cache/caching_application',
+                    value: '2'
+                }
+            ], { mysqlConnection, task });
+        } else {
+            // delete varnish configuration if exists
+            await mysqlConnection.query(`
+                DELETE FROM core_config_data WHERE path LIKE '%varnish%';
+            `);
+
+            // update cache policy to not use varnish
+            // 0 - magento cache, 2 - varnish cache
+            await updateTableValues('core_config_data', [
+                {
+                    path: 'system/full_page_cache/caching_application',
+                    value: '0'
+                }
+            ], { mysqlConnection, task });
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = varnishConfigSetup;

package/lib/tasks/magento/setup-magento/waiting-for-varnish.js

@@ -0,0 +1,41 @@
+const { request } = require('smol-request');
+const KnownError = require('../../../errors/known-error');
+const sleep = require('../../../util/sleep');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const waitingForVarnish = () => ({
+    title: 'Waiting for Varnish to return code 200',
+    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    task: async (ctx) => {
+        let tries = 0;
+        while (tries < 10) {
+            try {
+                const response = await request(`http://localhost:${ctx.ports.sslTerminator}/`, {
+                    responseType: 'headers'
+                });
+
+                if (response.status !== 200) {
+                    tries++;
+                    await sleep(2000);
+                } else {
+                    break;
+                }
+            } catch (e) {
+                tries++;
+                await sleep(200);
+            }
+        }
+
+        if (tries === 10) {
+            throw new KnownError(`After 20 seconds website is still responding with non-200 code, which might indicate issue with setup.
+Or Varnish is still loading...
+
+Please check the logs!`);
+        }
+    },
+    exitOnError: false
+});
+
+module.exports = waitingForVarnish;