@scandipwa/magento-scripts 2.0.0-alpha.9 → 2.0.0

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

@@ -0,0 +1,45 @@
+const semver = require('semver');
+const UnknownError = require('../../errors/unknown-error');
+const setConfigFile = require('../../util/set-config');
+const { getEnabledExtensionsFromImage } = require('../docker/project-image-builder');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createPhpDebugConfig = () => ({
+    title: 'Setting PHP XDebug config',
+    skip: (ctx) => !ctx.debug,
+    task: async (ctx) => {
+        const {
+            config: {
+                php,
+                baseConfig
+            },
+            debug,
+            isDockerDesktop
+        } = ctx;
+        const containers = ctx.config.docker.getContainers(ctx.ports);
+        const phpExtensions = await getEnabledExtensionsFromImage(containers.php.debugImage);
+        const isXDebug2 = semver.satisfies(phpExtensions.xdebug, '2');
+
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+
+        try {
+            await setConfigFile({
+                configPathname: php.debugIniPath,
+                template: php.debugTemplatePath,
+                overwrite: true,
+                templateArgs: {
+                    debug,
+                    mageRoot: baseConfig.containerMagentoDir,
+                    isXDebug2,
+                    hostMachine
+                }
+            });
+        } catch (e) {
+            throw new UnknownError(`Unexpected error accrued during xdebug.ini config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createPhpDebugConfig;

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

@@ -7,10 +7,8 @@ const setConfigFile = require('../../util/set-config');
 const createPhpFpmConfig = () => ({
     title: 'Setting php-fpm config',
     task: async (ctx) => {
-        const { config: { php } } = ctx;
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !ctx.isWsl;
-        const port = isNativeLinux ? ctx.ports.fpm : 9000;
+        const { config: { php }, isDockerDesktop } = ctx;
+        const port = !isDockerDesktop ? ctx.ports.fpm : 9000;
 
         try {
             await setConfigFile({

package/lib/tasks/file-system/create-phpstorm-config/exclude-folder-config.js

@@ -26,11 +26,21 @@ const mustBeIncludedPaths = [
 /**
  * Will retrieve project config file path from module.xml
  *
- * @returns {Promise<String>}
+ * @returns {Promise<String | null>}
  */
 const getProjectConfigFilePath = async () => {
     const modulesConfigData = await loadXmlFile(pathToModulesConfig);
-    return modulesConfigData.project.component.modules.module['@_filepath'].replace('$PROJECT_DIR$', process.cwd());
+    const {
+        project: {
+            component: {
+                modules: {
+                    module
+                } = {}
+            } = {}
+        } = {}
+    } = modulesConfigData || {};
+    const filePath = module && module['@_filepath'];
+    return filePath ? filePath.replace('$PROJECT_DIR$', process.cwd()) : null;
 };
 
 const setupDefaultsForExcludedFoldersConfig = (projectConfigData) => {
@@ -138,7 +148,7 @@ const setupExcludedFoldersConfig = () => ({
     task: async (ctx, task) => {
         if (await pathExists(pathToModulesConfig)) {
             const projectFilePath = await getProjectConfigFilePath();
-            if (await pathExists(projectFilePath)) {
+            if (projectFilePath && await pathExists(projectFilePath)) {
                 const projectConfigData = await loadXmlFile(projectFilePath);
                 setupDefaultsForExcludedFoldersConfig(projectConfigData);
                 const hasChanges = setupExcludedFolders(projectConfigData);

package/lib/tasks/file-system/create-phpstorm-config/index.js

@@ -22,7 +22,8 @@ const createPhpStormConfig = () => ({
         setupStylelintConfig(),
         setupESLintConfig()
     ], {
-        concurrent: true
+        concurrent: true,
+        exitOnError: false
     })
 });
 

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

@@ -1,4 +1,3 @@
-const os = require('os');
 const path = require('path');
 const fs = require('fs');
 const setConfigFile = require('../../util/set-config');
@@ -19,8 +18,8 @@ const createSSLTerminatorConfig = () => ({
                 overridenConfiguration,
                 baseConfig
             },
-            isWsl,
-            debug
+            debug,
+            isDockerDesktop
         } = ctx;
 
         const {
@@ -65,10 +64,8 @@ const createSSLTerminatorConfig = () => ({
         }
 
         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;
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = !isDockerDesktop ? ports.sslTerminator : 80;
 
         try {
             await setConfigFile({
@@ -90,7 +87,25 @@ const createSSLTerminatorConfig = () => ({
                 }
             });
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during ssl terminator config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error appeared during ssl terminator config creation\n\n${e}`);
+        }
+
+        // fixes ngrok error "ngrok.io redirected you too many times"
+        try {
+            await setConfigFile({
+                configPathname: path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'fastcgi_params'
+                ),
+                template: path.join(baseConfig.templateDir, 'nginx.fastcgi_params.template'),
+                overwrite: true,
+                templateArgs: {
+                    isNgrok: host.endsWith('ngrok.io')
+                }
+            });
+        } catch (e) {
+            throw new UnknownError(`Unexpected error appeared during ssl terminator fastcgi_params config creation\n\n${e}`);
         }
     }
 });

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

@@ -17,8 +17,7 @@ const createVarnishConfig = () => ({
                     cacheDir
                 }
             },
-            isWsl,
-            platform
+            isDockerDesktop
         } = ctx;
 
         const {
@@ -27,9 +26,6 @@ const createVarnishConfig = () => ({
             }
         } = overridenConfiguration;
 
-        const isLinux = platform === 'linux';
-        const isNativeLinux = isLinux && !isWsl;
-
         try {
             await setConfigFile({
                 configPathname: path.join(
@@ -40,8 +36,9 @@ const createVarnishConfig = () => ({
                 template: varnish.configTemplate,
                 overwrite: true,
                 templateArgs: {
-                    hostMachine: isNativeLinux ? '127.0.0.1' : 'host.docker.internal',
-                    nginxPort: ports.app
+                    hostMachine: !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal',
+                    nginxPort: ports.app,
+                    healthCheck: varnish.healthCheck
                 }
             });
         } catch (e) {

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

@@ -121,7 +121,8 @@ const createVSCodeConfig = () => ({
         } catch (e) {
             throw new UnknownError(`Unexpected error accrued during launch.json config creation!\n\n${e}`);
         }
-    }
+    },
+    exitOnError: false
 });
 
 module.exports = createVSCodeConfig;

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

@@ -1,6 +1,7 @@
 const createMariaDBConfig = require('./create-mariadb-config');
 const createNginxConfig = require('./create-nginx-config');
 const createPhpConfig = require('./create-php-config');
+const createPhpDebugConfig = require('./create-php-debug-config');
 const createPhpFpmConfig = require('./create-php-fpm-config');
 const createPhpStormConfig = require('./create-phpstorm-config');
 const createSSLTerminatorConfig = require('./create-ssl-terminator-config');
@@ -17,13 +18,13 @@ const prepareFileSystem = () => ({
         createNginxConfig(),
         createPhpFpmConfig(),
         createPhpConfig(),
+        createPhpDebugConfig(),
         createPhpStormConfig(),
         createVSCodeConfig(),
         createVarnishConfig(),
         createMariaDBConfig()
     ], {
-        concurrent: true,
-        exitOnError: false
+        concurrent: true
     })
 });
 

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

@@ -7,10 +7,8 @@ module.exports = () => ({
     title: 'Configuring Elasticsearch',
     skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
     task: async (ctx, task) => {
-        const { ports, databaseConnection } = ctx;
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !ctx.isWsl;
-        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const { ports, databaseConnection, isDockerDesktop } = ctx;
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
         await updateTableValues('core_config_data', [
             { path: 'catalog/search/engine', value: 'elasticsearch7' },
             { path: 'catalog/search/elasticsearch7_server_hostname', value: hostMachine },

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

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

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

@@ -12,6 +12,7 @@ const magentoTask = require('../../../util/magento-task');
 const urnHighlighter = require('./urn-highlighter');
 const adjustFullPageCache = require('./adjust-full-page-cache');
 const updateEnvPHP = require('../../php/update-env-php');
+const setMailConfig = require('./set-mail-config');
 
 /**
  * @param {Object} [options]
@@ -40,6 +41,7 @@ const setupMagento = (options = {}) => ({
                 task: (ctx, task) => task.newListr([
                     setBaseUrl(),
                     setUrlRewrite(),
+                    setMailConfig(),
                     increaseAdminSessionLifetime()
                 ], {
                     concurrent: true

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

@@ -5,6 +5,8 @@ const UnknownError = require('../../../errors/unknown-error');
 const runMagentoCommand = require('../../../util/run-magento');
 const envPhpToJson = require('../../../util/env-php-json');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const { defaultMagentoDatabase } = require('../../database/default-magento-database');
+const defaultMagentoUser = require('../../database/default-magento-user');
 
 /**
  * @param {Object} [param0]
@@ -20,16 +22,14 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
         const {
             magentoVersion,
             config: {
-                docker,
                 magentoConfiguration
             },
             ports,
-            databaseConnection
+            databaseConnection,
+            isDockerDesktop
         } = ctx;
 
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !ctx.isWsl;
-        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
 
         const [tableResponse] = await databaseConnection.query(
             'SELECT * FROM information_schema.tables WHERE table_schema = \'magento\' AND table_name = \'admin_user\' LIMIT 1;'
@@ -73,8 +73,6 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                 await databaseConnection.query('SET FOREIGN_KEY_CHECKS = 1;');
             }
         }
-
-        const { mariadb: { env } } = docker.getContainers(ports);
         const envPhpData = await envPhpToJson(ctx);
 
         const envPhpHaveEncryptionKey = envPhpData && envPhpData.crypt && envPhpData.crypt.key && envPhpData.crypt.key;
@@ -127,9 +125,9 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                 --cache-backend-redis-port='${ ports.redis }' \
                 --cache-backend-redis-db='0't \
                 --db-host='${ hostMachine }:${ ports.mariadb }' \
-                --db-name='${ env.MARIADB_DATABASE }' \
-                --db-user='${ env.MARIADB_USER }' \
-                --db-password='${ env.MARIADB_PASSWORD }' \
+                --db-name='${ defaultMagentoDatabase }' \
+                --db-user='${ defaultMagentoUser.user }' \
+                --db-password='${ defaultMagentoUser.password }' \
                 --backend-frontname='${ magentoConfiguration.adminuri }' \
                 --no-interaction`;
 
@@ -143,9 +141,6 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                 installed = true;
             } catch (e) {
                 errors.push(e);
-                if (tries === 2) {
-                    throw e;
-                }
             }
 
             if (installed) {

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

@@ -17,7 +17,7 @@ module.exports = () => ({
             databaseConnection
         } = ctx;
         const isNgrok = host.endsWith('ngrok.io');
-        const enableSecureFrontend = (ctx.config.overridenConfiguration.configuration.varnish.enabled && ssl.enabled) ? '1' : '0';
+        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}`;
@@ -28,6 +28,7 @@ module.exports = () => ({
             { 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-mail-config.js

@@ -0,0 +1,22 @@
+const { updateTableValues } = require('../../../util/database');
+
+/**
+ * @type {() => 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 });
+    }
+});
+
+module.exports = setMailConfig;

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

@@ -1,6 +1,4 @@
-const os = require('os');
 const { updateTableValues } = require('../../../util/database');
-const getIsWsl = require('../../../util/is-wsl');
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -20,18 +18,15 @@ const varnishConfigSetup = () => ({
             },
             databaseConnection,
             ports,
-            debug
+            debug,
+            isDockerDesktop
         } = ctx;
 
-        const isLinux = os.platform() === 'linux';
-        const isWsl = await getIsWsl();
-        const isNativeLinux = isLinux && !isWsl;
-
         if (!debug && varnishEnabled) {
             await updateTableValues('core_config_data', [
                 {
                     path: 'system/full_page_cache/varnish/backend_host',
-                    value: !isNativeLinux ? 'host.docker.internal' : 'localhost'
+                    value: isDockerDesktop ? 'host.docker.internal' : 'localhost'
                 },
                 {
                     path: 'system/full_page_cache/varnish/backend_port',
@@ -39,7 +34,7 @@ const varnishConfigSetup = () => ({
                 },
                 {
                     path: 'system/full_page_cache/varnish/access_list',
-                    value: !isNativeLinux ? 'host.docker.internal,localhost' : 'localhost'
+                    value: isDockerDesktop ? 'host.docker.internal,localhost' : 'localhost'
                 },
                 {
                     path: 'system/full_page_cache/caching_application',

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

@@ -4,9 +4,9 @@ const fs = require('fs');
 const path = require('path');
 const { request } = require('smol-request');
 const KnownError = require('../../../errors/known-error');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const { NginxParser } = require('../../../util/nginx-logs-parser');
 const sleep = require('../../../util/sleep');
+const { containerApi } = require('../../docker/containers');
 
 const pathToWorkingHealthCheckPhp = path.join(__dirname, '..', '..', 'php', 'working_health_check.php');
 const pathToProjectsHealthCheckPhp = path.join(process.cwd(), 'pub', 'health_check.php');
@@ -17,19 +17,18 @@ const pathToHealthCheckBackupPhp = path.join(process.cwd(), 'pub', 'health_check
  */
 const getIsHealthCheckRequestBroken = async (ctx) => {
     const { nginx } = ctx.config.docker.getContainers(ctx.ports);
-
-    const nginxLogs = await execAsyncSpawn(`docker logs ${nginx.name}`);
-
-    const healthCheckRequests = nginxLogs
-        .split('\n')
-        .filter((line) => line.includes('"GET /health_check.php HTTP/1.1"'));
-
-    // eslint-disable-next-line max-len
-    const parser = new NginxParser('$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"');
-
-    const parsedRequests = healthCheckRequests.map((line) => parser.parseLine(line));
-
-    return parsedRequests.every((parsedRequest) => parsedRequest.status !== '200');
+    const parser = new NginxParser(
+        '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"'
+    );
+    const parsedLogs = await containerApi.logs({
+        name: nginx.name,
+        parser: (line) => parser.parseLine(line)
+    });
+
+    const healthCheckRequests = parsedLogs
+        .filter((line) => line.request.includes('/health_check.php'));
+
+    return healthCheckRequests.every((parsedRequest) => parsedRequest.status !== '200');
 };
 
 /**
@@ -39,12 +38,12 @@ const waitingForVarnish = () => ({
     title: 'Waiting for Varnish to return code 200',
     skip: (ctx) => ctx.debug
         || !ctx.config.overridenConfiguration.configuration.varnish.enabled
-        || ctx.config.overridenConfiguration.ssl.enabled,
+        || ctx.config.overridenConfiguration.ssl.enabled
+        || !ctx.config.overridenConfiguration.configuration.varnish.healthCheck,
     task: async (ctx, task) => {
         const pureMagentoVersion = ctx.magentoVersion.match(/^([0-9]+\.[0-9]+\.[0-9]+)/)[1];
 
         const isMagento23 = semver.satisfies(pureMagentoVersion, '<2.4');
-
         let tries = 0;
         while (tries < 10) {
             try {

package/lib/tasks/php/php-container.js

@@ -29,7 +29,7 @@ const runPHPContainerCommand = async (ctx, command, options = {}) => {
             },
             options.useXDebugContainer
                 ? {
-                    image: `${ php.image }.xdebug`
+                    image: php.debugImage
                 }
                 : {},
             {

package/lib/tasks/php/update-env-php.js

@@ -19,11 +19,10 @@ const updateEnvPHP = () => ({
             return;
         }
 
+        const { isDockerDesktop, platform } = ctx;
         const { php } = ctx.config.docker.getContainers(ctx.ports);
 
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !ctx.isWsl;
-        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
 
         const useVarnish = (!ctx.debug && ctx.config.overridenConfiguration.configuration.varnish.enabled) ? '1' : '';
         const varnishHost = hostMachine;
@@ -53,7 +52,6 @@ const updateEnvPHP = () => ({
                     || persistedQueryConfig.redis.host === hostMachine)
                 ) {
                     SETUP_PQ = '';
-                    return;
                 }
             }
         }
@@ -78,7 +76,7 @@ const updateEnvPHP = () => ({
             image: php.image,
             detach: false,
             rm: true,
-            user: isLinux ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
+            user: platform === 'linux' ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
         });
 
         task.output = result;

package/lib/tasks/{prefix → project-config}/index.js

@@ -1,21 +1,21 @@
+const { setProjectConfig } = require('../../config/config');
 const { setPrefix: setPrefixUtil } = require('../../util/prefix');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const setPrefix = () => ({
-    // if project is missing prefix, set one
-    title: 'Settings project prefix',
+const setProjectConfigTask = () => ({
+    title: 'Settings project config',
     task: (ctx) => {
         const { config: { overridenConfiguration: { prefix } } } = ctx;
 
         setPrefixUtil(prefix);
+
+        setProjectConfig('debug', ctx.debug);
     },
     options: {
         showTimer: false
     }
 });
 
-module.exports = {
-    setPrefix
-};
+module.exports = { setProjectConfigTask };

package/lib/tasks/requirements/composer-credentials.js

@@ -96,9 +96,9 @@ ${ logger.style.misc('Password') } (${ logger.style.misc('Private key') }):`,
         };
 
         const authJsonContent = JSON.stringify(authContent, null, 4);
-        const authEnvContent = `export COMPOSER_AUTH='${JSON.stringify(authContent)}'`;
+        const authEnvContent = `export COMPOSER_AUTH='${JSON.stringify(authContent, null, 0)}'`;
 
-        process.env.COMPOSER_AUTH = authJsonContent;
+        process.env.COMPOSER_AUTH = JSON.stringify(JSON.parse(authJsonContent), null, 0);
 
         if (configureLocation === 'auth.json') {
             await fs.promises.writeFile(authJsonPath, authJsonContent, 'utf-8');
@@ -175,7 +175,11 @@ Would you like to load them now?`
 
                     if (loadCredentialsFrom) {
                         const credentialsLine = lines.find((line) => line.startsWith('export COMPOSER_AUTH='));
-                        process.env.COMPOSER_AUTH = credentialsLine.replace('export COMPOSER_AUTH=', '').replace(/'/ig, '').trim();
+                        process.env.COMPOSER_AUTH = JSON.stringify(
+                            JSON.parse(credentialsLine.replace('export COMPOSER_AUTH=', '').replace(/'/ig, '').trim()),
+                            null,
+                            0
+                        );
                         problems.delete(MISSING_COMPOSER_AUTH_ENV);
                     }
                 }