@scandipwa/magento-scripts 2.0.0 → 2.0.2

package/lib/config/versions/magento-2.4.5-p1.js

@@ -0,0 +1,41 @@
+const { defaultMagentoConfig } = require('../magento-config');
+const sodium = require('../services/php/extensions/sodium');
+const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
+const { php81 } = require('../services/php/versions');
+const { sslTerminator } = require('../services/ssl-terminator');
+const { varnish70 } = require('../services/varnish');
+const { repo } = require('../services/php/base-repo');
+const { nginx118 } = require('../services/nginx/versions');
+const { composer2 } = require('../services/composer/versions');
+const { maildev } = require('../services/maildev');
+const { redis62 } = require('../services/redis');
+const { mariadb104 } = require('../services/mariadb/versions');
+const { elasticsearch717 } = require('../services/elasticsearch/versions');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.5-p1',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${ repo }:php-8.1-magento-2.4`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: redis62(),
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: mariadb104(),
+        elasticsearch: elasticsearch717(),
+        composer: composer2(),
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/config/versions/magento-2.4.5.js

@@ -1,13 +1,16 @@
 const { defaultMagentoConfig } = require('../magento-config');
-const sodium = require('../php/extensions/sodium');
+const sodium = require('../services/php/extensions/sodium');
 const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
-const { php81 } = require('../php/versions');
+const { php81 } = require('../services/php/versions');
 const { sslTerminator } = require('../services/ssl-terminator');
-const { varnish70 } = require('../varnish/varnish-7-0');
-const { repo } = require('../php/base-repo');
+const { varnish70 } = require('../services/varnish');
+const { repo } = require('../services/php/base-repo');
 const { nginx118 } = require('../services/nginx/versions');
 const { composer2 } = require('../services/composer/versions');
 const { maildev } = require('../services/maildev');
+const { redis62 } = require('../services/redis');
+const { mariadb104 } = require('../services/mariadb/versions');
+const { elasticsearch717 } = require('../services/elasticsearch/versions');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.5',
@@ -19,18 +22,12 @@ module.exports = ({ templateDir } = {}) => ({
             baseImage: `${ repo }:php-8.1-magento-2.4`
         }),
         nginx: nginx118({ templateDir }),
-        redis: {
-            version: '6.0'
-        },
+        redis: redis62(),
         mysql: {
             version: '8.0'
         },
-        mariadb: {
-            version: '10.4'
-        },
-        elasticsearch: {
-            version: '7.17.5'
-        },
+        mariadb: mariadb104(),
+        elasticsearch: elasticsearch717(),
         composer: composer2(),
         varnish: varnish70({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),

package/lib/tasks/docker/containers/container-api.js

@@ -35,8 +35,8 @@ const runCommand = (options) => {
     const restartArg = !rm && restart && `--restart=${ restart }`;
     const networkArg = network && `--network=${ network }`;
     const portsArgs = ports && ports.length > 0 && ports.map((port) => `-p=${ port }`);
-    const mountsArgs = mounts && mounts.map((mount) => `--mount=${ mount }`);
-    const mountVolumesArgs = mountVolumes && mountVolumes.map((mount) => `-v=${mount}`);
+    const mountsArgs = mounts && mounts.map((mount) => `--mount="${ mount }"`);
+    const mountVolumesArgs = mountVolumes && mountVolumes.map((mount) => `-v="${mount}"`);
     const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env=${ key }='${ value }'`);
     const nameArg = name && `--name=${name}`;
     const entrypointArg = entrypoint && `--entrypoint="${entrypoint}"`;

package/lib/tasks/docker/network/tasks.js

@@ -4,6 +4,14 @@ const UnknownError = require('../../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const networkApi = require('./network-api');
 
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const pruneNetworks = () => ({
+    title: 'Removing custom networks not used by at least one container',
+    task: () => execAsyncSpawn('docker network prune -f')
+});
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -22,17 +30,22 @@ const createNetwork = () => ({
                 driver: 'bridge'
             });
         } catch (e) {
-            if (e.includes('could not find an available, non-overlapping IPv4 address pool')) {
-                const pruneNetworks = await task.prompt({
+            if (e.message.includes('could not find an available, non-overlapping IPv4 address pool')) {
+                const doPruneNetworks = await task.prompt({
                     type: 'Confirm',
                     message: `You don't have available, non-overlapping IPv4 address pool on you system.
 Do you want remove all custom networks not used by at least one container?`
                 });
 
-                if (pruneNetworks) {
-                    return task.newListr(
-                        pruneNetworks()
-                    );
+                if (doPruneNetworks) {
+                    return task.newListr([
+                        pruneNetworks(),
+                        {
+                            task: () => networkApi.create({
+                                network: docker.network.name,
+                                driver: 'bridge'
+                            })
+                        }]);
                 }
 
                 throw new KnownError(`Unable to create network for your project.
@@ -62,14 +75,6 @@ const removeNetwork = () => ({
     }
 });
 
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const pruneNetworks = () => ({
-    title: 'Removing custom networks not used by at least one container',
-    task: () => execAsyncSpawn('docker network prune -f')
-});
-
 module.exports = {
     createNetwork,
     removeNetwork,

package/lib/tasks/docker/project-image-builder.js

@@ -120,10 +120,12 @@ const buildDockerFileInstructions = async (ctx, { image, tag }) => {
         .workDir(ctx.config.baseConfig.containerMagentoDir);
 
     const imagePathEnv = imageDetails.Config.Env.find((env) => env.startsWith('PATH'));
+    const magentoBinDir = path.join(ctx.config.baseConfig.containerMagentoDir, 'bin');
+    const vendorBinDir = path.join(ctx.config.baseConfig.containerMagentoDir, 'vendor', 'bin');
 
     dockerFileInstructions
         .env({
-            PATH: `${ imagePathEnv.split('=').pop() }:${ path.join(ctx.config.baseConfig.containerMagentoDir, 'bin') }`
+            PATH: `${ imagePathEnv.split('=').pop() }:${ magentoBinDir }:${vendorBinDir }`
         });
 
     return dockerFileInstructions;

package/lib/tasks/docker/system/system-api.js

@@ -21,6 +21,12 @@ const df = async (options, execOptions = {}) => {
         verboseArg
     ].filter(Boolean).join(' ');
 
+    if (formatToJSON) {
+        const result = await execAsyncSpawn(`docker system df ${args}`, execOptions);
+
+        return JSON.parse(result);
+    }
+
     return execAsyncSpawn(`docker system df ${args}`, execOptions);
 };
 

package/lib/tasks/docker/volume/volume-api.js

@@ -14,7 +14,7 @@ const create = async (options, execOptions = {}) => {
 
     const driverArg = driver && `--driver=${driver}`;
     const labelArg = label && `--label=${label}`;
-    const optArg = opt && Object.entries(opt).map(([name, value]) => `--opt ${name}='${value}'`).join(' ');
+    const optArg = opt && Object.entries(opt).map(([name, value]) => `--opt ${name}="${value}"`).join(' ');
 
     const args = [
         driverArg,

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

@@ -3,6 +3,7 @@ const path = require('path');
 const { baseConfig } = require('../../../config');
 const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser');
 const UnknownError = require('../../../errors/unknown-error');
+const { connectionStringParser, connectionStringBuilder } = require('../../../util/connection-string');
 const pathExists = require('../../../util/path-exists');
 const setConfigFile = require('../../../util/set-config');
 
@@ -40,7 +41,7 @@ const getToDataSource = (data, defaultData) => {
 
     return data.project.component['data-source'];
 };
-
+// const mariadbVersion = await ctx.databaseConnection.query('SHOW VARIABLES LIKE "%version%";');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -153,8 +154,6 @@ const setupDataSourceLocalConfig = () => ({
  */
 const setupDataSourceConfig = () => ({
     task: async (ctx, task) => {
-        const jdbcUrl = `jdbc:mysql://localhost:${ctx.ports.mysql}/magento`;
-
         if (await pathExists(databaseConfiguration.dataSources.path)) {
             let hasChanges = false;
             const dataSourcesData = await loadXmlFile(databaseConfiguration.dataSources.path);
@@ -176,6 +175,26 @@ const setupDataSourceConfig = () => ({
                 }
             );
 
+            if (dataSource['jdbc-url']) {
+                const parsedJDBC = dataSource['jdbc-url'].match(/jdbc:(\S+)/i);
+                if (parsedJDBC && parsedJDBC.length > 0) {
+                    const url = parsedJDBC[1];
+                    const parsedJDBCUrl = connectionStringParser(url);
+
+                    if (/\S+:undefined/.test(parsedJDBCUrl.host)) {
+                        hasChanges = true;
+                        parsedJDBCUrl.host = parsedJDBCUrl.host.split(':').shift();
+                    }
+
+                    if (parsedJDBCUrl.port !== `${ctx.ports.mariadb}`) {
+                        hasChanges = true;
+                        parsedJDBCUrl.port = `${ctx.ports.mariadb}`;
+
+                        dataSource['jdbc-url'] = `jdbc:${connectionStringBuilder(parsedJDBCUrl)}`;
+                    }
+                }
+            }
+
             if (dataSource['@_uuid'] === undefined) {
                 hasChanges = true;
                 dataSource['@_uuid'] = 'a2eadb3c-6fc9-4d85-b5f4-d8114906ce2f';
@@ -186,7 +205,7 @@ const setupDataSourceConfig = () => ({
                 'driver-ref': 'mysql.8',
                 synchronize: true,
                 'jdbc-driver': 'com.mysql.cj.jdbc.Driver',
-                'jdbc-url': jdbcUrl,
+                'jdbc-url': `jdbc:mysql://localhost:${ctx.ports.mariadb}/magento`,
                 'working-dir': '$ProjectFileDir$',
                 '@_source': 'LOCAL'
             };
@@ -222,7 +241,7 @@ const setupDataSourceConfig = () => ({
                     overwrite: true,
                     templateArgs: {
                         databaseConfiguration,
-                        jdbcUrl
+                        jdbcUrl: `jdbc:mysql://localhost:${ctx.ports.mariadb}/magento`
                     }
                 });
             } catch (e) {

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

@@ -17,6 +17,17 @@ const defaultESLintComponentConfiguration = {
     }
 };
 
+const esLintDefaultConfigurationData = {
+    '?xml': {
+        '@_version': '1.0',
+        '@_encoding': 'UTF-8'
+    },
+    project: {
+        '@_version': '4',
+        component: defaultESLintComponentConfiguration
+    }
+};
+
 const setupESlintConfig = async (esLintConfigurationData) => {
     let hasChanges = false;
     const themes = await getCSAThemes();
@@ -56,6 +67,18 @@ const setupESLintConfigTask = () => ({
             let hasChanges = false;
             const esLintConfigurationData = await loadXmlFile(pathToESLintConfig);
 
+            if (!esLintConfigurationData.project) {
+                esLintConfigurationData.project = {
+                    ...esLintDefaultConfigurationData.project
+                };
+            }
+
+            if (!esLintConfigurationData['?xml']) {
+                esLintConfigurationData['?xml'] = {
+                    ...esLintDefaultConfigurationData['?xml']
+                };
+            }
+
             if (esLintConfigurationData.project.component && !Array.isArray(esLintConfigurationData.project.component)) {
                 hasChanges = true;
                 esLintConfigurationData.project.component = [esLintConfigurationData.project.component];
@@ -84,20 +107,9 @@ const setupESLintConfigTask = () => ({
             return;
         }
 
-        const esLintConfigurationData = {
-            '?xml': {
-                '@_version': '1.0',
-                '@_encoding': 'UTF-8'
-            },
-            project: {
-                '@_version': '4',
-                component: defaultESLintComponentConfiguration
-            }
-        };
-
-        await setupESlintConfig(esLintConfigurationData);
+        await setupESlintConfig(esLintDefaultConfigurationData);
 
-        await buildXmlFile(pathToESLintConfig, esLintConfigurationData);
+        await buildXmlFile(pathToESLintConfig, esLintDefaultConfigurationData);
     }
 });
 

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/custom-ruleset-path-config.js

@@ -1,5 +1,7 @@
 const pathExists = require('../../../../util/path-exists');
-const { phpCSConfigurationPath, phpCSConfigFormattedPath } = require('./paths');
+const {
+    phpCSConfigurationPath, phpCSConfigFormattedPath, phpCSFixerConfigurationPath, phpCSFixerConfigurationFormattedPath
+} = require('./paths');
 const { nameKey, valueKey } = require('../keys');
 const {
     options: {
@@ -13,13 +15,22 @@ const setupCustomRuleSetPathOption = async (config) => {
         (option) => option[nameKey] === CUSTOM_RULE_SET_PATH_OPTION_NAME
     );
     const phpCSConfigExists = await pathExists(phpCSConfigurationPath);
+    const phpCSFixerConfigPathExists = await pathExists(phpCSFixerConfigurationPath);
 
-    if (!customRuleSetPathOption && phpCSConfigExists) {
-        hasChanges = true;
-        config.option.push({
-            [nameKey]: CUSTOM_RULE_SET_PATH_OPTION_NAME,
-            [valueKey]: phpCSConfigFormattedPath
-        });
+    if (!customRuleSetPathOption) {
+        if (phpCSConfigExists) {
+            hasChanges = true;
+            config.option.push({
+                [nameKey]: CUSTOM_RULE_SET_PATH_OPTION_NAME,
+                [valueKey]: phpCSConfigFormattedPath
+            });
+        } else if (phpCSFixerConfigPathExists) {
+            hasChanges = true;
+            config.option.push({
+                [nameKey]: CUSTOM_RULE_SET_PATH_OPTION_NAME,
+                [valueKey]: phpCSFixerConfigurationFormattedPath
+            });
+        }
     }
 
     return hasChanges;

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/paths.js

@@ -6,6 +6,8 @@ const phpCompatibilityRuleSetPath = path.join(phpCompatibilityPath, 'ruleset.xml
 const phpCompatibilityFormattedPath = formatPathForPHPStormConfig(phpCompatibilityPath);
 const phpCSConfigurationPath = path.join(process.cwd(), '.php_cs.dist');
 const phpCSConfigFormattedPath = formatPathForPHPStormConfig(phpCSConfigurationPath);
+const phpCSFixerConfigurationPath = path.join(process.cwd(), '.php-cs-fixer.dist.php');
+const phpCSFixerConfigurationFormattedPath = formatPathForPHPStormConfig(phpCSFixerConfigurationPath);
 const phpMDRuleSetPath = path.join(process.cwd(), 'dev', 'tests', 'static', 'testsuite', 'Magento', 'Test', 'Php', '_files', 'phpmd', 'ruleset.xml');
 const phpMDRuleSetFormattedPath = formatPathForPHPStormConfig(phpMDRuleSetPath);
 
@@ -15,6 +17,8 @@ module.exports = {
     phpCompatibilityFormattedPath,
     phpCSConfigurationPath,
     phpCSConfigFormattedPath,
+    phpCSFixerConfigurationPath,
+    phpCSFixerConfigurationFormattedPath,
     phpMDRuleSetPath,
     phpMDRuleSetFormattedPath
 };

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

@@ -5,7 +5,7 @@ const UnknownError = require('../../../errors/unknown-error');
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
-    title: 'Flushing Magento redis cache',
+    title: 'Flushing Magento Redis cache',
     task: async ({ ports, config: { docker }, isDockerDesktop }) => {
         const { redis: { name } } = docker.getContainers(ports);
         const host = !isDockerDesktop ? 'localhost' : 'host.docker.internal';

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

@@ -32,10 +32,10 @@ const setupMagento = (options = {}) => ({
         }
 
         return task.newListr([
-            flushRedisConfig(),
             waitingForRedis(),
             updateEnvPHP(),
             migrateDatabase(),
+            flushRedisConfig(),
             {
                 title: 'Configuring Magento settings',
                 task: (ctx, task) => task.newListr([

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

@@ -48,11 +48,11 @@ const varnishConfigSetup = () => ({
             `);
 
             // update cache policy to not use varnish
-            // 0 - magento cache, 2 - varnish cache
+            // 1 - magento cache, 2 - varnish cache
             await updateTableValues('core_config_data', [
                 {
                     path: 'system/full_page_cache/caching_application',
-                    value: '0'
+                    value: '1'
                 }
             ], { databaseConnection, task });
         }

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

@@ -19,7 +19,7 @@ const updateEnvPHP = () => ({
             return;
         }
 
-        const { isDockerDesktop, platform } = ctx;
+        const { isDockerDesktop } = ctx;
         const { php } = ctx.config.docker.getContainers(ctx.ports);
 
         const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
@@ -71,12 +71,12 @@ const updateEnvPHP = () => ({
             command: 'php ./update-env-php.php',
             mountVolumes: [
                 `${path.join(__dirname, 'update-env.php')}:${ctx.config.baseConfig.containerMagentoDir}/update-env-php.php`,
-                `${envPhpPath}:/${ctx.config.baseConfig.containerMagentoDir}/env.php`
+                `${envPhpPath}:${ctx.config.baseConfig.containerMagentoDir}/env.php`
             ],
             image: php.image,
             detach: false,
             rm: true,
-            user: platform === 'linux' ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
+            user: ((ctx.platform === 'linux' && isDockerDesktop) || !isDockerDesktop) ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
         });
 
         task.output = result;

package/lib/tasks/status/index.js

@@ -49,7 +49,8 @@ const prettyStatus = async (ctx) => {
         platform,
         platformVersion,
         containers,
-        composerVersion
+        composerVersion,
+        systemDFData
     } = ctx;
     const projectCreatedAt = getProjectCreatedAt();
 
@@ -152,6 +153,31 @@ const prettyStatus = async (ctx) => {
         }
     });
 
+    block
+        .addSeparator('Docker volume data')
+        .addEmptyLine();
+
+    const { volumes } = ctx.config.docker;
+
+    Object.values(volumes)
+        .map((volume) => {
+            volume.volumeData = systemDFData.Volumes
+                .find((v) => v.Name === volume.name);
+
+            return volume;
+        })
+        .forEach((v) => {
+            block
+                .addLine(`> ${logger.style.misc(v.name)}`);
+            if (v.volumeData) {
+                block.addLine(`Size: ${logger.style.code(v.volumeData.Size)}`);
+            }
+
+            if (ctx.isDockerDesktop && v.opt && v.opt.device) {
+                block.addLine(`Mountpoint: ${logger.style.file(v.opt.device.replace(process.cwd(), '<project location>'))}`);
+            }
+        });
+
     const instanceMetadata = getInstanceMetadata(ctx);
 
     block

package/lib/util/connection-string.js

@@ -0,0 +1,62 @@
+/**
+ * @typedef ParsedConnection
+ * @prop {String} protocol
+ * @prop {String} [user]
+ * @prop {String} [port]
+ * @prop {String} host
+ * @prop {String} [hostname]
+ * @prop {String[]} [segments]
+ * @prop {Record<string, string} params
+ */
+
+/**
+ * @param {String} url
+ * @returns {ParsedConnection}
+ */
+const connectionStringParser = (url) => {
+    // eslint-disable-next-line no-useless-escape
+    const pattern = /^(?:([^:\/?#\s]+):\/{2})?(?:([^@\/?#\s]+)@)?([^\/?#\s]+)?(?:\/([^?#\s]*))?(?:[?]([^#\s]+))?\S*$/;
+    const matches = url.match(pattern);
+    const params = {};
+    if (matches[5] !== undefined) {
+        matches[5].split('&').forEach((x) => {
+            const a = x.split('=');
+            params[a[0]] = a[1];
+        });
+    }
+
+    return {
+        protocol: matches[1],
+        user: matches[2] !== undefined ? matches[2].split(':')[0] : undefined,
+        password: matches[2] !== undefined ? matches[2].split(':')[1] : undefined,
+        host: matches[3],
+        hostname: matches[3] !== undefined ? matches[3].split(/:(?=\d+$)/)[0] : undefined,
+        port: matches[3] !== undefined ? matches[3].split(/:(?=\d+$)/)[1] : undefined,
+        segments: matches[4] !== undefined ? matches[4].split('/') : undefined,
+        params
+    };
+};
+
+/**
+ * @param {ParsedConnection} options
+ * @returns {String}
+ */
+const connectionStringBuilder = (options) => {
+    const {
+        protocol,
+        user,
+        password,
+        host,
+        port,
+        segments,
+        params
+    } = options;
+
+    // eslint-disable-next-line max-len
+    return `${protocol}://${(user && password) ? `${user}:${password}@` : ''}${host}${port ? `:${port}` : ''}/${(segments && segments.length > 0) ? segments.join('/') : ''}${new URLSearchParams(params).toString()}`;
+};
+
+module.exports = {
+    connectionStringParser,
+    connectionStringBuilder
+};

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.0.0",
+    "version": "2.0.2",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -54,5 +54,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "7df62ec60329e7e554b7d68a8ddb9c8a73510135"
+    "gitHead": "676d083e666a985e1942a7b1d216ca6d6b6151f8"
 }