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

package/lib/config/docker.js

@@ -4,6 +4,9 @@ const getPhpConfig = require('./php-config');
 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');
 
 /**
  *
@@ -22,7 +25,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         varnish
     } = configuration;
 
-    const php = getPhpConfig(configuration, baseConfig);
+    const php = getPhpConfig(overridenConfiguration, baseConfig);
     const {
         prefix,
         magentoDir,
@@ -30,69 +33,75 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         cacheDir
     } = baseConfig;
 
-    const cpuSupportedFlags = await systeminformation.cpuFlags();
+    const cpuSupportedFlags = (await systeminformation.cpuFlags()).split(' ');
 
     const network = {
         name: `${ prefix }_network`
     };
 
     const volumes = {
-        mysql: {
-            name: `${ prefix }_mysql-data`
+        mariadb: {
+            name: `${ prefix }_mariadb-data`
         },
         redis: {
             name: `${ prefix }_redis-data`
         },
         elasticsearch: {
             name: `${ prefix }_elasticsearch-data`
+        },
+        composer_home: {
+            name: 'composer_home-data'
         }
     };
 
-    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`,
-            opts: {
-                type: 'nfs',
+            driver: 'local',
+            opt: {
+                type: 'none',
                 device: path.join(magentoDir),
                 o: 'bind'
             }
         };
         volumes.nginx = {
             name: `${ prefix }_nginx-data`,
-            opts: {
-                type: 'nfs',
+            driver: 'local',
+            opt: {
+                type: 'none',
                 device: path.join(cacheDir, 'nginx', 'conf.d'),
                 o: 'bind'
             }
         };
         volumes.appPub = {
             name: `${ prefix }_pub-data`,
-            opts: {
-                type: 'nfs',
+            driver: 'local',
+            opt: {
+                type: 'none',
                 device: path.join(magentoDir, 'pub'),
                 o: 'bind'
             }
         };
         volumes.appSetup = {
             name: `${ prefix }_setup-data`,
-            opts: {
-                type: 'nfs',
+            driver: 'local',
+            opt: {
+                type: 'none',
                 device: path.join(magentoDir, 'setup'),
                 o: 'bind'
             }
         };
         volumes.sslTerminator = {
             name: `${ prefix }_ssl-terminator-data`,
-            opts: {
-                type: 'nfs',
+            driver: 'local',
+            opt: {
+                type: 'none',
                 device: path.join(cacheDir, 'ssl-terminator', 'conf.d'),
                 o: 'bind'
             }
@@ -101,8 +110,9 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         if (varnish.enabled) {
             volumes.varnish = {
                 name: `${ prefix }_varnish-data`,
-                opts: {
-                    type: 'nfs',
+                driver: 'local',
+                opt: {
+                    type: 'none',
                     device: path.join(cacheDir, 'varnish'),
                     o: 'bind'
                 }
@@ -117,22 +127,24 @@ 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: process.env.COMPOSER_AUTH || ''
+                    COMPOSER_AUTH: JSON.stringify(JSON.parse(process.env.COMPOSER_AUTH), null, 0) || '',
+                    COMPOSER_HOME: '/composer/home'
                 },
                 restart: 'on-failure:5',
                 image: `local-cma-project:${ prefix }`,
@@ -143,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 }`
                 ],
@@ -162,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',
-                image: `nginx:${ nginx.version }`,
+                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 }`
                 ],
@@ -186,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')}`
@@ -196,9 +208,8 @@ 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',
-                image: `nginx:${ nginx.version }`,
+                network: isDockerDesktop ? network.name : 'host',
+                image: `${ nginx.version ? `nginx:${ nginx.version }` : nginx.image }`,
                 name: `${ prefix }_nginx`,
                 command: "nginx -g 'daemon off;'"
             },
@@ -210,50 +221,35 @@ 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:${ redis.version }`,
-                imageDetails: {
-                    name: 'redis',
-                    tag: redis.version
-                },
+                image: `${ redis.version ? `redis:${ redis.version }` : redis.image }`,
                 name: `${ prefix }_redis`,
                 connectCommand: ['redis-cli']
             },
-            mysql: {
+            mariadb: {
                 _: 'MariaDB',
                 healthCheck: {
                     cmd: 'mysqladmin ping --silent'
                 },
-                ports: [`127.0.0.1:${ ports.mysql }:3306`],
-                forwardedPorts: [`127.0.0.1:${ ports.mysql }:3306`],
-                mounts: [`source=${ volumes.mysql.name },target=/var/lib/mysql`],
+                ports: [`127.0.0.1:${ ports.mariadb }:3306`],
+                forwardedPorts: [`127.0.0.1:${ ports.mariadb }:3306`],
+                mountVolumes: [
+                    `${ volumes.mariadb.name }:/var/lib/mysql`,
+                    `${ path.join(baseConfig.cacheDir, 'mariadb.cnf') }:/etc/mysql/my.cnf`
+                ],
                 env: {
-                    MYSQL_PORT: 3306,
-                    MYSQL_ROOT_PASSWORD: 'scandipwa',
-                    MYSQL_USER: 'magento',
-                    MYSQL_PASSWORD: 'magento',
-                    MYSQL_DATABASE: 'magento'
+                    MARIADB_ROOT_PASSWORD: 'scandipwa'
                 },
-                /**
-                 * When database dump contains functions, MySQL can throw and error "access denied for those functions"
-                 * so to overcome this issue, we need to enable trust option for these functions to avoid errors during migrations.
-                 *
-                 * Documentation reference: https://dev.mysql.com/doc/refman/5.7/en/stored-programs-logging.html
-                 */
-                command: [
-                    '--log_bin_trust_function_creators=1',
-                    '--default-authentication-plugin=mysql_native_password',
-                    '--max_allowed_packet=1GB',
-                    '--bind-address=0.0.0.0'
-                ]
-                    .join(' '),
+                command: '--log_bin_trust_function_creators=1',
                 securityOptions: [
                     'seccomp=unconfined'
                 ],
                 network: network.name,
-                image: `mariadb:${ mariadb.version }`,
-                name: `${ prefix }_mariadb`
+                image: `${ mariadb.version ? `mariadb:${ mariadb.version }` : mariadb.image }`,
+                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',
@@ -263,22 +259,20 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ports: [`127.0.0.1:${ ports.elasticsearch }:9200`],
                 forwardedPorts: [`127.0.0.1:${ ports.elasticsearch }:9200`],
                 mounts: [`source=${ volumes.elasticsearch.name },target=/usr/share/elasticsearch/data`],
-                env: {
-                    'bootstrap.memory_lock': true,
-                    'xpack.security.enabled': false,
-                    'discovery.type': 'single-node',
-                    ES_JAVA_OPTS: '-Xms512m -Xmx512m',
+                env: deepmerge(
+                    {
                     // https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-settings.html
-                    'xpack.ml.enabled': ['sse4.2', 'sse4_2'].some((sse42Flag) => cpuSupportedFlags.includes(sse42Flag))
-                },
+                        'xpack.ml.enabled': ['sse4.2', 'sse4_2'].some((sse42Flag) => cpuSupportedFlags.includes(sse42Flag))
+                    }, elasticsearch.env || defaultEsEnv
+                ),
                 network: network.name,
-                image: `elasticsearch:${ elasticsearch.version }`,
+                image: `${ elasticsearch.version ? `elasticsearch:${ elasticsearch.version }` : elasticsearch.image }`,
                 name: `${ prefix }_elasticsearch`
             }
         };
 
         if (ssl.enabled) {
-            dockerConfig.nginx.ports.push(
+            dockerConfig.sslTerminator.ports.push(
                 `${isIpAddress(host) ? host : '127.0.0.1'}:443:443`
             );
         }
@@ -286,16 +280,16 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         if (!ctx.debug && varnish.enabled) {
             dockerConfig.varnish = {
                 _: 'Varnish',
-                image: `varnish:${ varnish.version }`,
+                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 }`
                 ],
@@ -303,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

@@ -19,7 +19,7 @@ const darwinMinimalVersion = '10.5';
 const getBaseConfig = (projectPath = process.cwd(), prefix = folderName) => ({
     prefix: getPrefix(prefix),
     magentoDir: projectPath,
-    containerMagentoDir: '/var/www/html',
+    containerMagentoDir: projectPath,
     templateDir: path.join(__dirname, 'templates'),
     cacheDir: path.join(projectPath, 'node_modules', '.create-magento-app-cache')
 });
@@ -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/port-config.js

@@ -58,7 +58,7 @@ const defaultPorts = {
     varnish: 8080,
     sslTerminator: 80,
     fpm: 9000,
-    mysql: 3306,
+    mariadb: 3306,
     redis: 6379,
     elasticsearch: 9200
 };

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/elasticsearch/base-repo.js

@@ -0,0 +1,3 @@
+module.exports = {
+    repo: 'ghcr.io/scandipwa/create-magento-app'
+};

package/lib/config/services/elasticsearch/default-es-env.js

@@ -0,0 +1,6 @@
+module.exports = {
+    'bootstrap.memory_lock': true,
+    'xpack.security.enabled': false,
+    'discovery.type': 'single-node',
+    ES_JAVA_OPTS: '-Xms512m -Xmx512m'
+};

package/lib/config/services/elasticsearch/versions/elasticsearch-6.8.js

@@ -0,0 +1,19 @@
+const os = require('os');
+const { getArchSync } = require('../../../../util/arch');
+const { deepmerge } = require('../../../../util/deepmerge');
+const { repo } = require('../base-repo');
+const defaultEnv = require('../default-es-env');
+
+/**
+ * @returns {import('../../../../../typings/index').ServiceWithImage}
+ */
+const elasticsearch68 = ({
+    image = `${ repo }:elasticsearch-6.8`
+} = {}) => ({
+    image,
+    env: deepmerge(defaultEnv, os.platform() === 'darwin' && getArchSync() === 'arm64' ? {
+        'xpack.ml.enabled': false
+    } : {})
+});
+
+module.exports = elasticsearch68;

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

@@ -0,0 +1,5 @@
+const elasticsearch68 = require('./elasticsearch-6.8');
+
+module.exports = {
+    elasticsearch68
+};

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="npm run 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="npm run exec php composer"
+alias composer="exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
-alias cvc="npm run exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+alias cvc="exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mysql="npm run exec mysql 'mysql -umagento -pmagento'"
-alias mysqlroot="npm run exec mysql 'mysql -uroot -pscandipwa'"
+alias mariadb="exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="exec mariadb 'mysql -uroot -pscandipwa'"
 
 export BASH_SILENCE_DEPRECATION_WARNING=1