@scandipwa/magento-scripts 2.0.0-alpha.10 → 2.0.0-alpha.13

package/lib/commands/cli.js

@@ -46,6 +46,11 @@ module.exports = (yargs) => {
             .addLine(`Available shortcuts: magento -> ${logger.style.command('m')}, composer -> ${logger.style.command('c')}`)
             .addEmptyLine();
 
+        block
+            .addLine(`Execute into any service: ${logger.style.command('exec <service name>')}`)
+            .addLine(`Execute into PHP container: ${logger.style.command('exec php')}`)
+            .addEmptyLine();
+
         if (ctx.config.overridenConfiguration.configuration.varnish.enabled) {
             block.addLine(`Clear Varnish cache: ${logger.style.command('cvc')}`);
         }

package/lib/commands/start.js

@@ -22,6 +22,7 @@ const reportErrors = async (errors) => {
         const path = (error.path && ` Error path: ${error.path} `) || '';
         if (error instanceof UnknownError || error instanceof KnownError) {
             logger.error(error.message);
+            logger.error(error.stack);
             if (error instanceof UnknownError) {
                 await googleAnalytics.trackError(`Unknown Error:${path}${error.stack}`);
             } else {
@@ -29,9 +30,11 @@ const reportErrors = async (errors) => {
             }
         } else if (error instanceof Error) {
             logger.error(error.message);
+            logger.error(error.stack);
             await googleAnalytics.trackError(`Regular Error:${path}${error.message}`);
         } else {
             logger.error(error);
+            logger.error(error.stack);
             await googleAnalytics.trackError(`Non Error:${path}${error}`); // track non-errors throws
         }
     }
@@ -83,6 +86,16 @@ module.exports = (yargs) => {
                 describe: 'Enable verbose logging',
                 type: 'boolean',
                 default: false
+            })
+            .option('pull-images', {
+                describe: 'Pull Docker images',
+                type: 'boolean',
+                default: false
+            })
+            .option('reset-global-config', {
+                describe: 'Reset global magento-scripts configuration',
+                type: 'boolean',
+                default: false
             }),
         async (args = {}) => {
             /**
@@ -170,10 +183,11 @@ module.exports = (yargs) => {
                 );
                 logger.log('');
 
-                if (!analytics && tasks.err && tasks.err.length > 0) {
-                    logger.warn('You have disabled analytics, but we\'ve encountered errors during startup!');
+                if (tasks.err && tasks.err.length > 0) {
+                    logger.warn('During the start, we encountered some errors that have not impacted the start-up process!');
+                    logger.log('');
                     for (const err of tasks.err) {
-                        logger.error(`${err.path}\n${err.message}\n\n${err.stack}`);
+                        logger.error(`Error path: ${err.path}\nError message: ${err.message}\n\nError stack: ${err.stack}`);
                     }
                 }
 

package/lib/commands/status.js

@@ -9,6 +9,7 @@ const { statusContainers } = require('../tasks/docker/containers');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const checkConfigurationFile = require('../config/check-configuration-file');
 const checkPHPVersion = require('../tasks/requirements/php-version');
+const { getComposerVersionTask } = require('../tasks/composer');
 
 /**
  * @param {import('yargs')} yargs
@@ -21,7 +22,14 @@ module.exports = (yargs) => {
             checkConfigurationFile(),
             getProjectConfiguration(),
             getCachedPorts(),
-            checkPHPVersion(),
+            {
+                task: (ctx, task) => task.newListr([
+                    checkPHPVersion(),
+                    getComposerVersionTask()
+                ], {
+                    concurrent: true
+                })
+            },
             statusContainers()
         ], {
             concurrent: false,

package/lib/config/config.js

@@ -2,6 +2,16 @@ const Conf = require('conf');
 
 const pkg = require('../../package.json');
 
+/**
+ * @typedef ProjectConfig
+ * @prop {String} [createdAt]
+ * @prop {String} [prefix]
+ * @prop {Boolean} debug
+ */
+
+/**
+ * @type {import('conf').default<Record<string, ProjectConfig>>}
+ */
 const projectsConfig = new Conf({
     configName: 'projects',
     projectName: 'create-magento-app',
@@ -10,6 +20,12 @@ const projectsConfig = new Conf({
 });
 const projectKey = process.cwd();
 
+const setProjectConfig = (key, value) => {
+    projectsConfig.set(`${projectKey}.${key}`, value);
+};
+
+const getProjectConfig = () => projectsConfig.get(projectKey);
+
 const getProjectsFromProjectKeys = (path, project) => {
     if (project.createdAt) {
         return { [path]: project };
@@ -21,7 +37,7 @@ const getProjectsFromProjectKeys = (path, project) => {
 };
 /**
  *
- * @returns {Record<string, { createdAt?: string, prefix?: string}>}
+ * @returns {Record<string, ProjectConfig>}
  */
 const getProjects = () => {
     const projects = {};
@@ -45,5 +61,7 @@ const getProjects = () => {
 module.exports = {
     projectsConfig,
     projectKey,
-    getProjects
+    getProjects,
+    setProjectConfig,
+    getProjectConfig
 };

package/lib/config/docker.js

@@ -6,6 +6,7 @@ const { isIpAddress } = require('../util/ip');
 const systeminformation = require('systeminformation');
 const { deepmerge } = require('../util/deepmerge');
 const defaultEsEnv = require('./services/elasticsearch/default-es-env');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 
 /**
  *
@@ -24,7 +25,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         varnish
     } = configuration;
 
-    const php = getPhpConfig(configuration, baseConfig);
+    const php = getPhpConfig(overridenConfiguration, baseConfig);
     const {
         prefix,
         magentoDir,
@@ -53,51 +54,54 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         }
     };
 
-    const isLinux = ctx.platform === 'linux';
-    const { isWsl } = ctx;
-    const isNotNativeLinux = (!isLinux || isWsl);
+    const { isDockerDesktop } = ctx;
 
-    if (!isLinux) {
+    if (isDockerDesktop) {
         /**
-         * When CMA is running in non-native linux environment,
-         * we need also create named volumes for nginx to avoid performance penalty
+         * When CMA is running with Docker Desktop,
+         * we need create named volumes to avoid performance penalty
          */
         volumes.php = {
             name: `${ prefix }_project-data`,
+            driver: 'local',
             opt: {
-                type: 'nfs',
+                type: 'none',
                 device: path.join(magentoDir),
                 o: 'bind'
             }
         };
         volumes.nginx = {
             name: `${ prefix }_nginx-data`,
+            driver: 'local',
             opt: {
-                type: 'nfs',
+                type: 'none',
                 device: path.join(cacheDir, 'nginx', 'conf.d'),
                 o: 'bind'
             }
         };
         volumes.appPub = {
             name: `${ prefix }_pub-data`,
+            driver: 'local',
             opt: {
-                type: 'nfs',
+                type: 'none',
                 device: path.join(magentoDir, 'pub'),
                 o: 'bind'
             }
         };
         volumes.appSetup = {
             name: `${ prefix }_setup-data`,
+            driver: 'local',
             opt: {
-                type: 'nfs',
+                type: 'none',
                 device: path.join(magentoDir, 'setup'),
                 o: 'bind'
             }
         };
         volumes.sslTerminator = {
             name: `${ prefix }_ssl-terminator-data`,
+            driver: 'local',
             opt: {
-                type: 'nfs',
+                type: 'none',
                 device: path.join(cacheDir, 'ssl-terminator', 'conf.d'),
                 o: 'bind'
             }
@@ -106,8 +110,9 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         if (varnish.enabled) {
             volumes.varnish = {
                 name: `${ prefix }_varnish-data`,
+                driver: 'local',
                 opt: {
-                    type: 'nfs',
+                    type: 'none',
                     device: path.join(cacheDir, 'varnish'),
                     o: 'bind'
                 }
@@ -122,21 +127,21 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         const dockerConfig = {
             php: {
                 _: 'PHP',
-                ports: isNotNativeLinux ? [
+                ports: isDockerDesktop ? [
                     `${ isIpAddress(host) ? host : '127.0.0.1' }:${ ports.fpm }:9000`
                 ] : [],
                 forwardedPorts: [
-                    isNotNativeLinux
+                    isDockerDesktop
                         ? `127.0.0.1:${ ports.fpm }:9000`
                         : `127.0.0.1:${ ports.fpm }`
                 ],
-                network: isNotNativeLinux ? network.name : 'host',
+                network: isDockerDesktop ? network.name : 'host',
                 mountVolumes: [
-                    `${ isLinux ? magentoDir : volumes.php.name }:${containerMagentoDir}`,
+                    `${ !isDockerDesktop ? magentoDir : volumes.php.name }:${containerMagentoDir}`,
                     `${ volumes.composer_home.name }:/composer/home`,
                     `${ php.iniPath }:/usr/local/etc/php/php.ini`,
                     `${ php.fpmConfPath }:/usr/local/etc/php-fpm.d/zz-docker.conf`
-                ],
+                ].concat(ctx.debug ? [`${ php.debugIniPath }:/usr/local/etc/php/conf.d/00-xdebug.ini`] : []),
                 env: {
                     COMPOSER_AUTH: JSON.stringify(JSON.parse(process.env.COMPOSER_AUTH), null, 0) || '',
                     COMPOSER_HOME: '/composer/home'
@@ -150,15 +155,15 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ],
                 name: `${ prefix }_php`,
                 connectCommand: ['/bin/sh'],
-                user: isLinux ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
+                user: ((ctx.platform === 'linux' && isDockerDesktop) || !isDockerDesktop) ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
             },
             sslTerminator: {
                 _: 'SSL Terminator (Nginx)',
-                ports: isNotNativeLinux ? [
+                ports: isDockerDesktop ? [
                     `${ isIpAddress(host) ? host : '127.0.0.1' }:${ ports.sslTerminator }:80`
                 ] : [],
                 forwardedPorts: [
-                    isNotNativeLinux
+                    isDockerDesktop
                         ? `127.0.0.1:${ ports.sslTerminator }:80`
                         : `127.0.0.1:${ ports.sslTerminator }`
                 ],
@@ -169,21 +174,21 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                  * Mount volumes directly on linux
                  */
                 mountVolumes: [
-                    `${ isLinux ? path.join(cacheDir, 'ssl-terminator', 'conf.d') : volumes.sslTerminator.name }:/etc/nginx/conf.d`
+                    `${ !isDockerDesktop ? path.join(cacheDir, 'ssl-terminator', 'conf.d') : volumes.sslTerminator.name }:/etc/nginx/conf.d`
                 ],
                 restart: 'on-failure:5',
-                network: isNotNativeLinux ? network.name : 'host',
+                network: isDockerDesktop ? network.name : 'host',
                 image: `${ nginx.version ? `nginx:${ nginx.version }` : nginx.image }`,
                 name: `${ prefix }_ssl-terminator`,
                 command: "nginx -g 'daemon off;'"
             },
             nginx: {
                 _: 'Nginx',
-                ports: isNotNativeLinux ? [
+                ports: isDockerDesktop ? [
                     `${ isIpAddress(host) ? host : '127.0.0.1' }:${ ports.app }:80`
                 ] : [],
                 forwardedPorts: [
-                    isNotNativeLinux
+                    isDockerDesktop
                         ? `127.0.0.1:${ ports.app }:80`
                         : `127.0.0.1:${ ports.app }`
                 ],
@@ -193,7 +198,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 /**
                  * Mount volumes directly on linux
                  */
-                mountVolumes: isLinux ? [
+                mountVolumes: !isDockerDesktop ? [
                     `${ cacheDir }/nginx/conf.d:/etc/nginx/conf.d`,
                     `${ path.join(magentoDir, 'pub') }:${path.join(containerMagentoDir, 'pub')}`,
                     `${ path.join(magentoDir, 'setup') }:${path.join(containerMagentoDir, 'setup')}`
@@ -203,8 +208,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     `${ volumes.appSetup.name }:${path.join(containerMagentoDir, 'setup')}`
                 ],
                 restart: 'on-failure:5',
-                // TODO: use connect instead
-                network: isNotNativeLinux ? network.name : 'host',
+                network: isDockerDesktop ? network.name : 'host',
                 image: `${ nginx.version ? `nginx:${ nginx.version }` : nginx.image }`,
                 name: `${ prefix }_nginx`,
                 command: "nginx -g 'daemon off;'"
@@ -217,7 +221,6 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ports: [`127.0.0.1:${ ports.redis }:6379`],
                 forwardedPorts: [`127.0.0.1:${ ports.redis }:6379`],
                 mounts: [`source=${ volumes.redis.name },target=/data`],
-                // TODO: use connect instead
                 network: network.name,
                 image: `${ redis.version ? `redis:${ redis.version }` : redis.image }`,
                 name: `${ prefix }_redis`,
@@ -235,22 +238,18 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     `${ path.join(baseConfig.cacheDir, 'mariadb.cnf') }:/etc/mysql/my.cnf`
                 ],
                 env: {
-                    MARIADB_PORT: 3306,
-                    MARIADB_ROOT_PASSWORD: 'scandipwa',
-                    MARIADB_USER: 'magento',
-                    MARIADB_PASSWORD: 'magento',
-                    MARIADB_DATABASE: 'magento'
+                    MARIADB_ROOT_PASSWORD: 'scandipwa'
                 },
-                command: [
-                    '--log_bin_trust_function_creators=1'
-                ]
-                    .join(' '),
+                command: '--log_bin_trust_function_creators=1',
                 securityOptions: [
                     'seccomp=unconfined'
                 ],
                 network: network.name,
                 image: `${ mariadb.version ? `mariadb:${ mariadb.version }` : mariadb.image }`,
-                name: `${ prefix }_mariadb`
+                name: `${ prefix }_mariadb`,
+                description: `To connect to MariaDB you can use the following users:
+- ${ logger.style.command('root') }@${ logger.style.command('scandipwa') }
+- ${ logger.style.command('magento') }@${ logger.style.command('magento') }`
             },
             elasticsearch: {
                 _: 'ElasticSearch',
@@ -284,13 +283,13 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 image: `${ varnish.version ? `varnish:${ varnish.version }` : varnish.image }`,
                 name: `${ prefix }_varnish`,
                 mountVolumes: [
-                    `${ isLinux ? path.join(cacheDir, 'varnish') : volumes.varnish.name }:/etc/varnish`
+                    `${ !isDockerDesktop ? path.join(cacheDir, 'varnish') : volumes.varnish.name }:/etc/varnish`
                 ],
-                ports: isNotNativeLinux ? [
+                ports: isDockerDesktop ? [
                     `${ isIpAddress(host) ? host : '127.0.0.1' }:${ ports.varnish }:80`
                 ] : [],
                 forwardedPorts: [
-                    isNotNativeLinux
+                    isDockerDesktop
                         ? `127.0.0.1:${ ports.varnish }:80`
                         : `127.0.0.1:${ ports.varnish }`
                 ],
@@ -298,9 +297,9 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     VARNISH_SIZE: '2G'
                 },
                 restart: 'on-failure:30',
-                network: isNotNativeLinux ? network.name : 'host',
+                network: isDockerDesktop ? network.name : 'host',
                 // eslint-disable-next-line max-len
-                command: `/bin/bash -c "varnishd -a :${ isNotNativeLinux ? 80 : ports.varnish } -t 600 -f /etc/varnish/default.vcl -s malloc,512m -p http_resp_hdr_len=70000 -p http_resp_size=100000 && varnishlog"`,
+                command: `/bin/bash -c "varnishd -a :${ isDockerDesktop ? 80 : ports.varnish } -t 600 -f /etc/varnish/default.vcl -s Cache=malloc,2048m -s Transient=malloc,512m -p http_resp_hdr_len=70000 -p http_resp_size=100000 && varnishlog"`,
                 tmpfs: [
                     '/var/lib/varnish:exec'
                 ]

package/lib/config/index.js

@@ -56,7 +56,7 @@ module.exports = {
         );
 
         return {
-            php: getPhpConfig(overridenConfiguration.configuration, newBaseConfig),
+            php: getPhpConfig(overridenConfiguration, newBaseConfig),
             docker: await getDockerConfig(ctx, overridenConfiguration, newBaseConfig),
             magentoConfiguration: getMagentoConfig(overridenConfiguration.magento),
             baseConfig: newBaseConfig,

package/lib/config/php/versions/php-7.2.js

@@ -14,6 +14,7 @@ const php72 = ({
     debugImage: `${ baseImage }-debug`,
     configTemplate: path.join(templateDir || '', 'php.template.ini'),
     fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    debugTemplate: path.join(templateDir || '', 'php-debug.template.ini'),
     extensions: {
         xdebug,
         ...extensions

package/lib/config/php/versions/php-7.3.js

@@ -14,6 +14,7 @@ const php73 = ({
     debugImage: `${ baseImage }-debug`,
     configTemplate: path.join(templateDir || '', 'php.template.ini'),
     fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    debugTemplate: path.join(templateDir || '', 'php-debug.template.ini'),
     extensions: {
         xdebug,
         ...extensions

package/lib/config/php/versions/php-7.4.js

@@ -14,6 +14,7 @@ const php74 = ({
     debugImage: `${ baseImage }-debug`,
     configTemplate: path.join(templateDir || '', 'php.template.ini'),
     fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    debugTemplate: path.join(templateDir || '', 'php-debug.template.ini'),
     extensions: {
         xdebug,
         ...extensions

package/lib/config/php/versions/php-8.1.js

@@ -14,6 +14,7 @@ const php81 = ({
     debugImage: `${ baseImage }-debug`,
     configTemplate: path.join(templateDir || '', 'php.template.ini'),
     fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    debugTemplate: path.join(templateDir || '', 'php-debug.template.ini'),
     extensions: {
         xdebug,
         ...extensions

package/lib/config/php-config.js

@@ -5,17 +5,18 @@ const path = require('path');
  * @param {import('../../typings/context').ListrContext['config']['baseConfig']} baseConfig
  */
 module.exports = (overridenConfiguration, baseConfig) => {
-    const { php } = overridenConfiguration;
+    const { configuration: { php } } = overridenConfiguration;
 
     const { cacheDir } = baseConfig;
 
     const phpConfiguration = {
         iniPath: path.join(cacheDir, 'php.ini'),
         iniTemplatePath: php.configTemplate,
+        debugIniPath: path.join(cacheDir, 'xdebug.ini'),
+        debugTemplatePath: php.debugTemplate,
         fpmTemplatePath: php.fpmConfigTemplate,
         fpmConfPath: path.join(cacheDir, 'php-fpm.conf'),
-        extensions: php.extensions,
-        version: php.version
+        extensions: php.extensions
     };
 
     return phpConfiguration;

package/lib/config/services/composer/versions/composer-1.js

@@ -0,0 +1,8 @@
+/**
+ * @returns {import('../../../../../typings/index').ComposerConfiguration}
+ */
+const composer1 = () => ({
+    version: '1'
+});
+
+module.exports = composer1;

package/lib/config/services/composer/versions/composer-2.js

@@ -0,0 +1,8 @@
+/**
+ * @returns {import('../../../../../typings/index').ComposerConfiguration}
+ */
+const composer2 = () => ({
+    version: '2'
+});
+
+module.exports = composer2;

package/lib/config/services/composer/versions/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+    composer1: require('./composer-1'),
+    composer2: require('./composer-2')
+};

package/lib/config/services/nginx/versions/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+    nginx118: require('./nginx-1.18')
+};

package/lib/config/services/nginx/versions/nginx-1.18.js

@@ -0,0 +1,11 @@
+const path = require('path');
+
+/**
+ * @returns {import('../../../../../typings/index').NginxConfiguration}
+ */
+const nginx118 = ({ templateDir }) => ({
+    version: '1.18.0',
+    configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+});
+
+module.exports = nginx118;

package/lib/config/{ssl-terminator → services/ssl-terminator}/index.js

@@ -1,5 +1,8 @@
 const path = require('path');
 
+/**
+ * @returns {import('../../../../typings/index').SSLTerminatorConfiguration}
+ */
 const sslTerminator = ({ templateDir }) => ({
     version: '1.18.0',
     configTemplate: path.join(templateDir || '', 'ssl-terminator.template.conf')

package/lib/config/templates/magentorc.template

@@ -2,16 +2,17 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 
-alias php="node ./node_modules/.bin/magento-scripts-exec php php"
+alias exec="node ./node_modules/.bin/magento-scripts-exec"
+alias php="exec php php"
 alias magento="php bin/magento"
 alias magneto="echo -e 'Not ${RED}magneto${NC} but ${GREEN}magento${NC} please! or at least ${GREEN}m${NC}!' && magento"
 alias m="magento"
-alias composer="node ./node_modules/.bin/magento-scripts-exec php composer"
+alias composer="exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
-alias cvc="node ./node_modules/.bin/magento-scripts-exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+alias cvc="exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mariadb="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -umagento -pmagento'"
-alias mariadbroot="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -uroot -pscandipwa'"
+alias mariadb="exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="exec mariadb 'mysql -uroot -pscandipwa'"
 
 export BASH_SILENCE_DEPRECATION_WARNING=1

package/lib/config/templates/php-debug.template.ini

@@ -0,0 +1,31 @@
+[xdebug]
+error_reporting=E_ALL
+
+xdebug.idekey=PHPSTORM
+
+<% if (it.isXDebug2) { %>
+xdebug.remote_autostart=1
+xdebug.remote_enable=1
+
+xdebug.remote_host=<%~ it.hostMachine %>
+
+xdebug.remote_port=9003
+
+xdebug.remote_log=<%~ it.mageRoot %>/var/log/xdebug.log
+
+<% } else { %>
+
+xdebug.mode=debug
+xdebug.client_host=<%~ it.hostMachine %>
+
+xdebug.client_port=9003
+
+; THIS THING WILL BREAK PHP
+; xdebug.start_with_request=yes
+
+xdebug.discover_client_host=false
+xdebug.start_upon_error=yes
+
+xdebug.log=<%~ it.mageRoot %>/var/log/xdebug.log
+
+<% } %>

package/lib/config/templates/php-fpm.template.conf

@@ -3,6 +3,7 @@ daemonize = no
 log_level = debug
 
 [www]
+clear_env = no
 user = nobody
 ;; Commented because if it is not set, php-fpm will use default group.
 ;; https://www.php.net/manual/en/install.fpm.configuration.php#group
@@ -17,5 +18,3 @@ pm.max_requests = 5000
 pm.process_idle_timeout = 10s
 pm.status_path = /fpmstatus
 listen = <%~ it.port %>
-
-env[PATH] = $PATH