@scandipwa/magento-scripts 2.4.0-alpha.0 → 2.4.0-alpha.2

package/exec.js

@@ -98,10 +98,10 @@ const newVersionIsAPatch = (latestVersion, currentVersion) => {
         logger.log() // add empty line
     }
 
-    const [containername, ...commands] = process.argv.slice(2)
+    const [containerName, ...commands] = process.argv.slice(2)
 
     return executeTask({
-        containername,
+        containerName,
         commands
     })
 })()

package/index.js

@@ -121,6 +121,7 @@ const newVersionIsAPatch = (latestVersion, currentVersion) => {
     }
 
     yargs.scriptName('magento-scripts')
+    yargs.version(false)
 
     // Initialize program commands
     commands.forEach((command) => command(yargs))

package/lib/commands/cli.js

@@ -98,7 +98,7 @@ module.exports = (yargs) => {
 
             block
                 .addLine(
-                    `Clear Magento cache: ${logger.style.command('m c:c')}`
+                    `Clear Magento cache: ${logger.style.command('m c:f')}`
                 )
                 .addLine(
                     `Magento setup upgrade: ${logger.style.command('m se:up')}`
@@ -127,24 +127,22 @@ module.exports = (yargs) => {
                 )
                 .addEmptyLine()
 
-            if (ctx.debug) {
-                block
-                    .addLine('Debug PHP in CLI:')
-                    .addLine('1. Start debugger in VSCode or PHPStorm')
-                    .addLine(
-                        `2. Go to PHP container: ${logger.style.command(
-                            'exec php'
-                        )}`
-                    )
-                    .addLine(
-                        `3. Run CLI command with ${logger.style.code(
-                            'XDEBUG_SESSION=phpstorm'
-                        )} environmental variable: ${logger.style.command(
-                            'XDEBUG_SESSION=phpstorm magento <command>'
-                        )}`
-                    )
-                    .addLine('4. Enjoy')
-            }
+            block
+                .addLine('Debug PHP in CLI:')
+                .addLine('1. Start debugger in VSCode or PHPStorm')
+                .addLine(
+                    `2. Go to PHP container: ${logger.style.command(
+                        'exec phpWithDebug'
+                    )}`
+                )
+                .addLine(
+                    `3. Run CLI command with ${logger.style.code(
+                        'XDEBUG_SESSION=PHPSTORM'
+                    )} environmental variable: ${logger.style.command(
+                        'XDEBUG_SESSION=PHPSTORM magento <command>'
+                    )}`
+                )
+                .addLine('4. Enjoy')
 
             block.log()
 

package/lib/commands/execute.js

@@ -5,10 +5,10 @@ const { executeTask } = require('../tasks/execute')
  */
 module.exports = (yargs) => {
     yargs.command(
-        'exec <container name> [commands...]',
+        'exec <container name> [command...]',
         'Execute command in docker container',
         (yargs) => {
-            yargs.usage(`Usage: npm run exec <container name> [commands...]
+            yargs.usage(`Usage: npm run exec <container name> [command...]
 
 Available containers:
 - mariadb
@@ -18,8 +18,12 @@ Available containers:
 - varnish (if enabled)
 - sslTerminator`)
         },
-        async (argv) => {
-            await executeTask(argv)
+        async () => {
+            const [containerName, ...commands] = process.argv.slice(3)
+            await executeTask({
+                containerName,
+                commands
+            })
         }
     )
 }

package/lib/commands/start.js

@@ -70,12 +70,6 @@ module.exports = (yargs) => {
                     type: 'boolean',
                     default: false
                 })
-                .option('debug', {
-                    alias: 'd',
-                    describe: 'Enable PHP xdebug.',
-                    type: 'boolean',
-                    default: false
-                })
                 .option('skip-setup', {
                     alias: 's',
                     describe: 'Skip Magento setup',

package/lib/config/docker.js

@@ -10,6 +10,27 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger')
 const defaultMagentoUser = require('../tasks/database/default-magento-user')
 const defaultOsEnv = require('./services/opensearch/default-os-env')
 
+/**
+ * @param {Partial<Record<'rw' | 'ro' | 'cached', boolean>>} directives
+ */
+const volumeDirectives = (directives) => {
+    const directivesResult = Object.entries(directives)
+        .filter(([name, value]) => value === true)
+        .map(([name]) => name)
+        .join(',')
+
+    return directivesResult ? `:${directivesResult}` : ''
+}
+
+/**
+ * @param {{source: string, target: string, rw?: boolean, ro?: boolean, cached?: boolean}} options
+ */
+const containerVolume = (options) => {
+    const { source, target, ...directives } = options
+
+    return `${source}:${target}${volumeDirectives(directives)}`
+}
+
 /**
  * @param {import('../../typings/context').ListrContext} ctx
  * @param {import('../../typings/context').ListrContext['config']['overridenConfiguration']} overridenConfiguration
@@ -68,6 +89,17 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
 
     const { isDockerDesktop } = ctx
 
+    if (isDockerDesktop) {
+        volumes.php = {
+            name: `${prefix}_project-data`,
+            driver: 'local',
+            opt: {
+                type: 'none',
+                device: path.join(magentoDir),
+                o: 'bind'
+            }
+        }
+    }
     /**
      * @param {Record<string, number>} ports
      */
@@ -83,7 +115,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             : {}
 
         /**
-         * @type {Record<string, import('../tasks/docker/containers/container-api').ContainerRunOptions & { _?: string, forwardedPorts?: string[], debugImage?: string, remoteImages?: string[], connectCommand?: string[], description?: string }>}
+         * @type {Record<string, import('../tasks/docker/containers/container-api').ContainerRunOptions & { _?: string, forwardedPorts?: string[], remoteImages?: string[], connectCommand?: string[], description?: string, pullImage?: boolean, dependsOn?: string[] }>}
          */
         const dockerConfig = {
             php: {
@@ -102,39 +134,96 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ],
                 network: isDockerDesktop ? network.name : 'host',
                 mountVolumes: [
-                    `${magentoDir}:${containerMagentoDir}${
-                        isDockerDesktop ? ':cached' : ''
-                    }`,
-                    `${volumes.composer_cache.name}:/composer/home/cache`,
-                    `${php.iniPath}:/usr/local/etc/php/php.ini${
-                        isDockerDesktop ? ':cached' : ''
-                    }`,
-                    `${
-                        php.fpmConfPath
-                    }:/usr/local/etc/php-fpm.d/zz-docker.conf${
-                        isDockerDesktop ? ':cached' : ''
-                    }`
-                ].concat(
-                    ctx.debug
-                        ? [
-                              `${
-                                  php.debugIniPath
-                              }:/usr/local/etc/php/conf.d/00-xdebug.ini${
-                                  isDockerDesktop ? ':cached' : ''
-                              }`
-                          ]
-                        : []
-                ),
+                    containerVolume({
+                        source: isDockerDesktop ? volumes.php.name : magentoDir,
+                        target: containerMagentoDir,
+                        rw: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: volumes.composer_cache.name,
+                        target: '/composer/home/cache',
+                        rw: true
+                    }),
+                    containerVolume({
+                        source: php.iniPath,
+                        target: '/usr/local/etc/php/php.ini',
+                        ro: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: php.fpmConfPath,
+                        target: '/usr/local/etc/php-fpm.d/zz-docker.conf',
+                        ro: true,
+                        cached: isDockerDesktop
+                    })
+                ],
                 env: deepmerge(composerAuthEnv, php.env || {}),
                 restart: 'on-failure:5',
                 image: `local-cma-project:${prefix}`,
-                debugImage: `local-cma-project:${prefix}.debug`,
-                remoteImages: [
-                    configuration.php.baseImage,
-                    configuration.php.debugImage
-                ],
+                remoteImages: [configuration.php.baseImage],
                 name: `${prefix}_php`,
                 connectCommand: ['/bin/sh'],
+                dependsOn: ['mariadb', 'redis', 'elasticsearch'],
+                user:
+                    (ctx.platform === 'linux' && isDockerDesktop) ||
+                    !isDockerDesktop
+                        ? `${os.userInfo().uid}:${os.userInfo().gid}`
+                        : ''
+            },
+            phpWithXdebug: {
+                _: 'PHP with Xdebug',
+                ports: isDockerDesktop
+                    ? [
+                          `${isIpAddress(host) ? host : '127.0.0.1'}:${
+                              ports.fpmXdebug
+                          }:9000`
+                      ]
+                    : [],
+                forwardedPorts: [
+                    isDockerDesktop
+                        ? `127.0.0.1:${ports.fpmXdebug}:9000`
+                        : `127.0.0.1:${ports.fpmXdebug}`
+                ],
+                network: isDockerDesktop ? network.name : 'host',
+                mountVolumes: [
+                    containerVolume({
+                        source: isDockerDesktop ? volumes.php.name : magentoDir,
+                        target: containerMagentoDir,
+                        rw: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: volumes.composer_cache.name,
+                        target: '/composer/home/cache',
+                        rw: true
+                    }),
+                    containerVolume({
+                        source: php.iniPath,
+                        target: '/usr/local/etc/php/php.ini',
+                        ro: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: php.debugFpmConfPath,
+                        target: '/usr/local/etc/php-fpm.d/zz-docker.conf',
+                        ro: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: php.debugIniPath,
+                        target: '/usr/local/etc/php/conf.d/00-xdebug.ini',
+                        ro: true,
+                        cached: isDockerDesktop
+                    })
+                ],
+                env: deepmerge(composerAuthEnv, php.env || {}),
+                restart: 'on-failure:5',
+                image: `local-cma-project:${prefix}.debug`,
+                pullImage: false,
+                name: `${prefix}_php_with_xdebug`,
+                connectCommand: ['/bin/sh'],
+                dependsOn: ['mariadb', 'redis', 'elasticsearch'],
                 user:
                     (ctx.platform === 'linux' && isDockerDesktop) ||
                     !isDockerDesktop
@@ -158,22 +247,23 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 healthCheck: {
                     cmd: 'service nginx status'
                 },
-                /**
-                 * Mount volumes directly on linux
-                 */
                 mountVolumes: [
-                    `${path.join(
-                        cacheDir,
-                        'ssl-terminator',
-                        'conf.d'
-                    )}:/etc/nginx/conf.d${isDockerDesktop ? ':cached' : ''}`,
-                    `${path.join(
-                        cacheDir,
-                        'ssl-terminator',
-                        'fastcgi_params'
-                    )}:/etc/nginx/fastcgi_params${
-                        isDockerDesktop ? ':cached' : ''
-                    }`
+                    containerVolume({
+                        source: path.join(cacheDir, 'ssl-terminator', 'conf.d'),
+                        target: '/etc/nginx/conf.d',
+                        ro: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: path.join(
+                            cacheDir,
+                            'ssl-terminator',
+                            'fastcgi_params'
+                        ),
+                        target: '/etc/nginx/fastcgi_params',
+                        ro: true,
+                        cached: isDockerDesktop
+                    })
                 ],
                 restart: 'on-failure:5',
                 network: isDockerDesktop ? network.name : 'host',
@@ -181,7 +271,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     nginx.version ? `nginx:${nginx.version}` : nginx.image
                 }`,
                 name: `${prefix}_ssl-terminator`,
-                command: "nginx -g 'daemon off;'"
+                command: "nginx -g 'daemon off;'",
+                dependsOn: ['nginx']
             },
             nginx: {
                 _: 'Nginx',
@@ -200,25 +291,29 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 healthCheck: {
                     cmd: 'service nginx status'
                 },
-                /**
-                 * Mount volumes directly on linux
-                 */
                 mountVolumes: [
-                    `${path.join(
-                        cacheDir,
-                        'nginx',
-                        'conf.d'
-                    )}:/etc/nginx/conf.d${isDockerDesktop ? ':cached' : ''}`,
-                    `${magentoDir}:${containerMagentoDir}${
-                        isDockerDesktop ? ':cached' : ''
-                    }`,
-                    `${path.join(
-                        cacheDir,
-                        'ssl-terminator',
-                        'fastcgi_params'
-                    )}:/etc/nginx/fastcgi_params${
-                        isDockerDesktop ? ':cached' : ''
-                    }`
+                    containerVolume({
+                        source: path.join(cacheDir, 'nginx', 'conf.d'),
+                        target: '/etc/nginx/conf.d',
+                        ro: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: isDockerDesktop ? volumes.php.name : magentoDir,
+                        target: containerMagentoDir,
+                        rw: true,
+                        cached: isDockerDesktop
+                    }),
+                    containerVolume({
+                        source: path.join(
+                            cacheDir,
+                            'ssl-terminator',
+                            'fastcgi_params'
+                        ),
+                        target: '/etc/nginx/fastcgi_params',
+                        ro: true,
+                        cached: isDockerDesktop
+                    })
                 ],
                 restart: 'on-failure:5',
                 network: isDockerDesktop ? network.name : 'host',
@@ -226,7 +321,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     nginx.version ? `nginx:${nginx.version}` : nginx.image
                 }`,
                 name: `${prefix}_nginx`,
-                command: "nginx -g 'daemon off;'"
+                command: "nginx -g 'daemon off;'",
+                dependsOn: ['php', 'phpWithXdebug']
             },
             redis: {
                 _: 'Redis',
@@ -246,16 +342,21 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             mariadb: {
                 _: 'MariaDB',
                 healthCheck: {
-                    cmd: 'mysqladmin ping --silent'
+                    cmd: `${mariadb.binAdminFileName} ping --silent`
                 },
                 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${isDockerDesktop ? ':cached' : ''}`
+                    containerVolume({
+                        source: volumes.mariadb.name,
+                        target: '/var/lib/mysql'
+                    }),
+                    containerVolume({
+                        source: path.join(baseConfig.cacheDir, 'mariadb.cnf'),
+                        target: '/etc/mysql/my.cnf',
+                        ro: true,
+                        cached: isDockerDesktop
+                    })
                 ],
                 env: {
                     MARIADB_ROOT_PASSWORD: 'scandipwa'
@@ -289,10 +390,16 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 },
                 ports: [`127.0.0.1:${ports.elasticsearch}:9200`],
                 forwardedPorts: [`127.0.0.1:${ports.elasticsearch}:9200`],
-                mounts: [
+                mountVolumes: [
                     searchengine === 'elasticsearch'
-                        ? `source=${volumes.elasticsearch.name},target=/usr/share/elasticsearch/data`
-                        : `source=${volumes.opensearch.name},target=/usr/share/opensearch/data`
+                        ? containerVolume({
+                              source: volumes.elasticsearch.name,
+                              target: '/usr/share/elasticsearch/data'
+                          })
+                        : containerVolume({
+                              source: volumes.opensearch.name,
+                              target: '/usr/share/opensearch/data'
+                          })
                 ],
                 env:
                     searchengine === 'elasticsearch'
@@ -335,7 +442,12 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                           `127.0.0.1:${ports.maildevWeb}`,
                           `127.0.0.1:${ports.maildevSMTP}`
                       ],
-                mountVolumes: [`${volumes.maildev.name}:/tmp/maildev`],
+                mountVolumes: [
+                    containerVolume({
+                        source: volumes.maildev.name,
+                        target: '/tmp/maildev'
+                    })
+                ],
                 env: {
                     MAILDEV_SMTP_PORT: isDockerDesktop
                         ? '1025'
@@ -366,7 +478,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             )
         }
 
-        if (!ctx.debug && varnish.enabled) {
+        if (varnish.enabled) {
             dockerConfig.varnish = {
                 _: 'Varnish',
                 image: `${
@@ -376,9 +488,11 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 }`,
                 name: `${prefix}_varnish`,
                 mountVolumes: [
-                    `${path.join(cacheDir, 'varnish')}:/etc/varnish${
-                        isDockerDesktop ? ':cached' : ''
-                    }`
+                    containerVolume({
+                        source: path.join(cacheDir, 'varnish'),
+                        target: '/etc/varnish',
+                        ro: true
+                    })
                 ],
                 ports: isDockerDesktop
                     ? [
@@ -404,8 +518,11 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 tmpfs: ['/var/lib/varnish/varnishd:exec'],
                 description: `Varnish HealthCheck status: ${logger.style.command(
                     varnish.healthCheck ? 'enabled' : 'disabled'
-                )}`
+                )}`,
+                dependsOn: ['nginx']
             }
+
+            dockerConfig.sslTerminator.dependsOn.push('varnish')
         }
 
         if (newRelic.enabled) {

package/lib/config/get-project-configuration.js

@@ -1,4 +1,3 @@
-const { getProjectConfig } = require('./config')
 const { getConfigFromMagentoVersion } = require('./index')
 
 /**
@@ -9,10 +8,6 @@ const getProjectConfiguration = () => ({
     task: async (ctx) => {
         const { magentoVersion } = ctx
 
-        if (typeof ctx.debug !== 'boolean') {
-            ctx.debug = getProjectConfig().debug
-        }
-
         ctx.config = await getConfigFromMagentoVersion(ctx, {
             magentoVersion
         })

package/lib/config/php-config.js

@@ -11,6 +11,9 @@ module.exports = (overridenConfiguration, baseConfig) => {
 
     const { cacheDir } = baseConfig
 
+    /**
+     * @type {import('../../typings/context').ListrContext['config']['php']}
+     */
     const phpConfiguration = {
         iniPath: path.join(cacheDir, 'php.ini'),
         iniTemplatePath: php.configTemplate,
@@ -18,6 +21,7 @@ module.exports = (overridenConfiguration, baseConfig) => {
         debugTemplatePath: php.debugTemplate,
         fpmTemplatePath: php.fpmConfigTemplate,
         fpmConfPath: path.join(cacheDir, 'php-fpm.conf'),
+        debugFpmConfPath: path.join(cacheDir, 'php-fpm-debug.conf'),
         extensions: php.extensions,
         env: php.env
     }

package/lib/config/port-config.js

@@ -72,6 +72,7 @@ const defaultPorts = {
     varnish: 8080,
     sslTerminator: 80,
     fpm: 9000,
+    fpmXdebug: 9001,
     mariadb: 3306,
     redis: 6379,
     elasticsearch: 9200,
@@ -97,18 +98,54 @@ const getPortsConfig = async (ports, options = {}) => {
     if (useNonOverlappingPorts) {
         p = p.concat(await getUsedByOtherCMAProjectsPorts())
     }
-    const availablePorts = Object.fromEntries(
-        await Promise.all(
-            Object.entries(mergedPorts).map(async ([name, port]) => {
-                const availablePort = await getPort(port, {
-                    portIgnoreList: p
-                })
-
-                return [name, availablePort]
-            })
-        )
+
+    /**
+     * @type {Record<string, string>}
+     */
+    const portsToCheck = Object.entries(mergedPorts).reduce(
+        (acc, [name, port]) => {
+            if (acc[port]) {
+                let i = 0
+                while (acc[port + i]) {
+                    i++
+                }
+
+                return {
+                    ...acc,
+                    [port + i]: name
+                }
+            } else {
+                return {
+                    ...acc,
+                    [port]: name
+                }
+            }
+        },
+        {}
     )
 
+    /**
+     * @type {Record<string, number>}
+     */
+    const availablePorts = {}
+
+    for (const [port, name] of Object.entries(portsToCheck)) {
+        const portInt = Number.parseInt(port)
+        const portIgnoreList = p.concat(
+            Object.keys(availablePorts).map((item) => Number.parseInt(item))
+        )
+
+        const getPortResult = await getPort(portInt, {
+            portIgnoreList
+        })
+
+        if (typeof getPortResult === 'number') {
+            availablePorts[name] = getPortResult
+        } else {
+            throw new Error(`No available port found for ${name} (${portInt})`)
+        }
+    }
+
     return availablePorts
 }
 

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

@@ -2,7 +2,7 @@
  * @returns {import('../../../../../typings/index').ComposerConfiguration}
  */
 const composer28 = () => ({
-    version: '2.8.5'
+    version: '2.8.8'
 })
 
 module.exports = composer28

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

@@ -5,5 +5,5 @@ module.exports = {
     'bootstrap.memory_lock': true,
     'xpack.security.enabled': false,
     'discovery.type': 'single-node',
-    ES_JAVA_OPTS: '-Xms512m -Xmx512m'
+    ES_JAVA_OPTS: '-Xms2g -Xmx2g'
 }

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

@@ -0,0 +1,14 @@
+const defaultEnv = require('../default-es-env')
+
+/**
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
+ */
+const elasticsearch817 = () => ({
+    image: 'elasticsearch:8.17.4',
+    env: {
+        ...defaultEnv,
+        'indices.id_field_data.enabled': true
+    }
+})
+
+module.exports = elasticsearch817

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

@@ -11,6 +11,7 @@ const elasticsearch85 = require('./elasticsearch-8.5')
 const elasticsearch87 = require('./elasticsearch-8.7')
 const elasticsearch811 = require('./elasticsearch-8.11')
 const elasticsearch816 = require('./elasticsearch-8.16')
+const elasticsearch817 = require('./elasticsearch-8.17')
 
 module.exports = {
     elasticsearch68,
@@ -25,5 +26,6 @@ module.exports = {
     elasticsearch85,
     elasticsearch87,
     elasticsearch811,
-    elasticsearch816
+    elasticsearch816,
+    elasticsearch817
 }

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

@@ -2,5 +2,7 @@ module.exports = {
     mariadb102: require('./mariadb-10.2'),
     mariadb103: require('./mariadb-10.3'),
     mariadb104: require('./mariadb-10.4'),
-    mariadb106: require('./mariadb-10.6')
+    mariadb106: require('./mariadb-10.6'),
+    mariadb114: require('./mariadb-11.4'),
+    mariadb116: require('./mariadb-11.6')
 }