@scandipwa/magento-scripts 1.14.1-alpha.0 → 1.14.1-alpha.11

package/lib/tasks/docker/volumes.js

@@ -20,10 +20,10 @@ const create = ({
 const createVolumes = () => ({
     title: 'Creating volumes',
     task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls -q')).split('\n');
+        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
 
         const missingVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => !volumeList.some((volume) => volume === name)
+            ({ name }) => !volumeList.includes(name)
         );
 
         if (missingVolumes.length === 0) {
@@ -41,10 +41,10 @@ const createVolumes = () => ({
 const removeVolumes = () => ({
     title: 'Removing volumes',
     task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls -q')).split('\n');
+        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
 
         const deployedVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => volumeList.some((volume) => volume === name)
+            ({ name }) => volumeList.includes(name)
         );
 
         if (deployedVolumes.length === 0) {

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

@@ -1,9 +1,7 @@
 const os = require('os');
 const path = require('path');
-const fs = require('fs');
 const setConfigFile = require('../../util/set-config');
-const pathExists = require('../../util/path-exists');
-const { isIpAddress } = require('../../util/ip');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -23,41 +21,13 @@ const createNginxConfig = () => ({
         const {
             configuration: {
                 nginx
-            },
-            ssl,
-            host
-        } = overridenConfiguration;
-
-        if (ssl.enabled) {
-            if (!(await pathExists(ssl.ssl_certificate))) {
-                throw new Error('ssl.ssl_certificate file does not exist!');
-            }
-            if (!(await pathExists(ssl.ssl_certificate_key))) {
-                throw new Error('ssl.ssl_certificate_key file does not exist!');
             }
+        } = overridenConfiguration;
 
-            await fs.promises.copyFile(
-                ssl.ssl_certificate,
-                path.join(
-                    baseConfig.cacheDir,
-                    'nginx',
-                    'conf.d',
-                    'ssl_certificate.pem'
-                )
-            );
-            await fs.promises.copyFile(
-                ssl.ssl_certificate_key,
-                path.join(
-                    baseConfig.cacheDir,
-                    'nginx',
-                    'conf.d',
-                    'ssl_certificate-key.pem'
-                )
-            );
-        }
-
-        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1';
         const isLinux = os.platform() === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
+        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = isNativeLinux ? ports.app : 80;
 
         try {
             await setConfigFile({
@@ -72,14 +42,13 @@ const createNginxConfig = () => ({
                 templateArgs: {
                     ports,
                     mageRoot: baseConfig.magentoDir,
-                    hostMachine: (isLinux && !isWsl) ? '127.0.0.1' : 'host.docker.internal',
-                    hostPort: (isLinux && !isWsl) ? ports.app : 80,
-                    config: overridenConfiguration,
-                    networkToBindTo
+                    hostMachine,
+                    hostPort,
+                    config: overridenConfiguration
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during nginx config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during nginx config creation\n\n${e}`);
         }
     }
 });

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

@@ -1,4 +1,5 @@
 const semver = require('semver');
+const UnknownError = require('../../errors/unknown-error');
 const setConfigFile = require('../../util/set-config');
 
 /**
@@ -21,7 +22,7 @@ const createPhpConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during php.ini config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during php.ini config creation\n\n${e}`);
         }
     }
 });

package/lib/tasks/file-system/create-php-fpm-config.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
 const setConfigFile = require('../../util/set-config');
 
 /**
@@ -17,7 +18,7 @@ const createPhpFpmConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during php-fpm config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during php-fpm config creation\n\n${e}`);
         }
     }
 });

package/lib/tasks/file-system/create-php-storm-config.js

@@ -2,6 +2,7 @@ const setConfigFile = require('../../util/set-config');
 const pathExists = require('../../util/path-exists');
 const path = require('path');
 const fs = require('fs');
+const UnknownError = require('../../errors/unknown-error');
 
 const createPhpStormConfig = () => ({
     title: 'Setting PHPStorm config',
@@ -19,7 +20,7 @@ const createPhpStormConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during workspace.xml config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during workspace.xml config creation\n\n${e}`);
         }
 
         try {
@@ -32,7 +33,7 @@ const createPhpStormConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during php.xml config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during php.xml config creation\n\n${e}`);
         }
 
         try {
@@ -45,7 +46,7 @@ const createPhpStormConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during dataSources.local.xml config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during dataSources.local.xml config creation\n\n${e}`);
         }
 
         try {
@@ -59,7 +60,7 @@ const createPhpStormConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during dataSources.xml config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during dataSources.xml config creation\n\n${e}`);
         }
 
         if (!await pathExists(path.resolve('./.idea/dataSources'))) {
@@ -74,7 +75,7 @@ const createPhpStormConfig = () => ({
                 templateArgs: {}
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during Project_Default.xml config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during Project_Default.xml config creation\n\n${e}`);
         }
     }
 });

package/lib/tasks/file-system/create-ssl-terminator-config.js

@@ -0,0 +1,96 @@
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+const setConfigFile = require('../../util/set-config');
+const pathExists = require('../../util/path-exists');
+const { isIpAddress } = require('../../util/ip');
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createSSLTerminatorConfig = () => ({
+    title: 'Setting ssl terminator config',
+    task: async (ctx) => {
+        const {
+            ports,
+            config: {
+                overridenConfiguration,
+                baseConfig
+            },
+            isWsl
+        } = ctx;
+
+        const {
+            configuration: {
+                sslTerminator
+            },
+            ssl,
+            host
+        } = overridenConfiguration;
+
+        if (ssl.enabled) {
+            if (!(await pathExists(ssl.ssl_certificate))) {
+                throw new KnownError('ssl.ssl_certificate file does not exist!');
+            }
+            if (!(await pathExists(ssl.ssl_certificate_key))) {
+                throw new KnownError('ssl.ssl_certificate_key file does not exist!');
+            }
+
+            const nginxCacheDir = path.join(baseConfig.cacheDir, 'nginx', 'conf.d');
+            if (!await pathExists(nginxCacheDir)) {
+                await fs.promises.mkdir(nginxCacheDir, { recursive: true });
+            }
+
+            await fs.promises.copyFile(
+                ssl.ssl_certificate,
+                path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'conf.d',
+                    'ssl_certificate.pem'
+                )
+            );
+            await fs.promises.copyFile(
+                ssl.ssl_certificate_key,
+                path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'conf.d',
+                    'ssl_certificate-key.pem'
+                )
+            );
+        }
+
+        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1';
+        const isLinux = os.platform() === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
+        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = isNativeLinux ? ports.sslTerminator : 80;
+
+        try {
+            await setConfigFile({
+                configPathname: path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'conf.d',
+                    'default.conf'
+                ),
+                template: sslTerminator.configTemplate,
+                overwrite: true,
+                templateArgs: {
+                    ports,
+                    hostMachine,
+                    hostPort,
+                    config: overridenConfiguration,
+                    networkToBindTo
+                }
+            });
+        } catch (e) {
+            throw new UnknownError(`Unexpected error accrued during ssl terminator config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createSSLTerminatorConfig;

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-php-storm-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/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/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/disable-full-page-cache.js

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

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: {