@scandipwa/magento-scripts 2.3.7 → 2.4.0-alpha.1

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

@@ -68,69 +68,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
 
     const { isDockerDesktop } = ctx
 
-    if (isDockerDesktop) {
-        /**
-         * 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: 'none',
-                device: path.join(magentoDir),
-                o: 'bind'
-            }
-        }
-        volumes.nginx = {
-            name: `${prefix}_nginx-data`,
-            driver: 'local',
-            opt: {
-                type: 'none',
-                device: path.join(cacheDir, 'nginx', 'conf.d'),
-                o: 'bind'
-            }
-        }
-        volumes.appPub = {
-            name: `${prefix}_pub-data`,
-            driver: 'local',
-            opt: {
-                type: 'none',
-                device: path.join(magentoDir, 'pub'),
-                o: 'bind'
-            }
-        }
-        volumes.appSetup = {
-            name: `${prefix}_setup-data`,
-            driver: 'local',
-            opt: {
-                type: 'none',
-                device: path.join(magentoDir, 'setup'),
-                o: 'bind'
-            }
-        }
-        volumes.sslTerminator = {
-            name: `${prefix}_ssl-terminator-data`,
-            driver: 'local',
-            opt: {
-                type: 'none',
-                device: path.join(cacheDir, 'ssl-terminator', 'conf.d'),
-                o: 'bind'
-            }
-        }
-
-        if (varnish.enabled) {
-            volumes.varnish = {
-                name: `${prefix}_varnish-data`,
-                driver: 'local',
-                opt: {
-                    type: 'none',
-                    device: path.join(cacheDir, 'varnish'),
-                    o: 'bind'
-                }
-            }
-        }
-    }
+    const volumeDirective = isDockerDesktop ? ':cached' : ''
 
     /**
      * @param {Record<string, number>} ports
@@ -147,7 +85,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 }>}
          */
         const dockerConfig = {
             php: {
@@ -166,27 +104,15 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ],
                 network: isDockerDesktop ? network.name : 'host',
                 mountVolumes: [
-                    `${
-                        !isDockerDesktop ? magentoDir : volumes.php.name
-                    }:${containerMagentoDir}`,
+                    `${magentoDir}:${containerMagentoDir}${volumeDirective}`,
                     `${volumes.composer_cache.name}:/composer/home/cache`,
-                    `${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`
-                          ]
-                        : []
-                ),
+                    `${php.iniPath}:/usr/local/etc/php/php.ini${volumeDirective}`,
+                    `${php.fpmConfPath}:/usr/local/etc/php-fpm.d/zz-docker.conf${volumeDirective}`
+                ],
                 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'],
                 user:
@@ -195,6 +121,40 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                         ? `${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: [
+                    `${magentoDir}:${containerMagentoDir}${volumeDirective}`,
+                    `${volumes.composer_cache.name}:/composer/home/cache`,
+                    `${php.iniPath}:/usr/local/etc/php/php.ini${volumeDirective}`,
+                    `${php.debugFpmConfPath}:/usr/local/etc/php-fpm.d/zz-docker.conf${volumeDirective}`,
+                    `${php.debugIniPath}:/usr/local/etc/php/conf.d/00-xdebug.ini${volumeDirective}`
+                ],
+                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'],
+                user:
+                    (ctx.platform === 'linux' && isDockerDesktop) ||
+                    !isDockerDesktop
+                        ? `${os.userInfo().uid}:${os.userInfo().gid}`
+                        : ''
+            },
             sslTerminator: {
                 _: 'SSL Terminator (Nginx)',
                 ports: isDockerDesktop
@@ -216,16 +176,16 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                  * Mount volumes directly on linux
                  */
                 mountVolumes: [
-                    `${
-                        !isDockerDesktop
-                            ? path.join(cacheDir, 'ssl-terminator', 'conf.d')
-                            : volumes.sslTerminator.name
-                    }:/etc/nginx/conf.d`,
+                    `${path.join(
+                        cacheDir,
+                        'ssl-terminator',
+                        'conf.d'
+                    )}:/etc/nginx/conf.d${volumeDirective}`,
                     `${path.join(
                         cacheDir,
                         'ssl-terminator',
                         'fastcgi_params'
-                    )}:/etc/nginx/fastcgi_params`
+                    )}:/etc/nginx/fastcgi_params${volumeDirective}`
                 ],
                 restart: 'on-failure:5',
                 network: isDockerDesktop ? network.name : 'host',
@@ -255,39 +215,19 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 /**
                  * Mount volumes directly on linux
                  */
-                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'
-                          )}`,
-                          `${path.join(
-                              cacheDir,
-                              'ssl-terminator',
-                              'fastcgi_params'
-                          )}:/etc/nginx/fastcgi_params`
-                      ]
-                    : [
-                          `${volumes.nginx.name}:/etc/nginx/conf.d`,
-                          `${volumes.appPub.name}:${path.join(
-                              containerMagentoDir,
-                              'pub'
-                          )}`,
-                          `${volumes.appSetup.name}:${path.join(
-                              containerMagentoDir,
-                              'setup'
-                          )}`,
-                          `${path.join(
-                              cacheDir,
-                              'ssl-terminator',
-                              'fastcgi_params'
-                          )}:/etc/nginx/fastcgi_params`
-                      ],
+                mountVolumes: [
+                    `${path.join(
+                        cacheDir,
+                        'nginx',
+                        'conf.d'
+                    )}:/etc/nginx/conf.d${volumeDirective}`,
+                    `${magentoDir}:${containerMagentoDir}${volumeDirective}`,
+                    `${path.join(
+                        cacheDir,
+                        'ssl-terminator',
+                        'fastcgi_params'
+                    )}:/etc/nginx/fastcgi_params${volumeDirective}`
+                ],
                 restart: 'on-failure:5',
                 network: isDockerDesktop ? network.name : 'host',
                 image: `${
@@ -314,7 +254,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             mariadb: {
                 _: 'MariaDB',
                 healthCheck: {
-                    cmd: 'mysqladmin ping --silent'
+                    cmd: 'mariadb-admin ping --silent'
                 },
                 ports: [`127.0.0.1:${ports.mariadb}:3306`],
                 forwardedPorts: [`127.0.0.1:${ports.mariadb}:3306`],
@@ -323,7 +263,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     `${path.join(
                         baseConfig.cacheDir,
                         'mariadb.cnf'
-                    )}:/etc/mysql/my.cnf`
+                    )}:/etc/mysql/my.cnf${volumeDirective}`
                 ],
                 env: {
                     MARIADB_ROOT_PASSWORD: 'scandipwa'
@@ -434,7 +374,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             )
         }
 
-        if (!ctx.debug && varnish.enabled) {
+        if (varnish.enabled) {
             dockerConfig.varnish = {
                 _: 'Varnish',
                 image: `${
@@ -444,11 +384,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 }`,
                 name: `${prefix}_varnish`,
                 mountVolumes: [
-                    `${
-                        !isDockerDesktop
-                            ? path.join(cacheDir, 'varnish')
-                            : volumes.varnish.name
-                    }:/etc/varnish`
+                    `${path.join(
+                        cacheDir,
+                        'varnish'
+                    )}:/etc/varnish${volumeDirective}`
                 ],
                 ports: isDockerDesktop
                     ? [

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,

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/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')
 }

package/lib/config/services/mariadb/versions/mariadb-11.4.js

@@ -0,0 +1,9 @@
+/**
+ * @returns {import('../../../../../typings/index').MariaDBConfiguration}
+ */
+const mariadb114 = () => ({
+    image: 'mariadb:11.4',
+    useOptimizerSwitch: true
+})
+
+module.exports = mariadb114

package/lib/config/services/mariadb/versions/mariadb-11.6.js

@@ -0,0 +1,9 @@
+/**
+ * @returns {import('../../../../../typings/index').MariaDBConfiguration}
+ */
+const mariadb116 = () => ({
+    image: 'mariadb:11.6',
+    useOptimizerSwitch: true
+})
+
+module.exports = mariadb116

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

@@ -2,10 +2,12 @@ const opensearch12 = require('./opensearch-1.2')
 const opensearch13 = require('./opensearch-1.3')
 const opensearch25 = require('./opensearch-2.5')
 const opensearch212 = require('./opensearch-2.12')
+const opensearch219 = require('./opensearch-2.19')
 
 module.exports = {
     opensearch12,
     opensearch13,
     opensearch25,
-    opensearch212
+    opensearch212,
+    opensearch219
 }

package/lib/config/services/opensearch/versions/opensearch-2.19.js

@@ -0,0 +1,14 @@
+const defaultEnv = require('../default-os-env')
+
+/**
+ * @returns {import('../../../../../typings/index').OpenSearchSearchConfiguration}
+ */
+const opensearch219 = () => ({
+    image: 'opensearchproject/opensearch:2.19.1',
+    env: {
+        ...defaultEnv,
+        'indices.id_field_data.enabled': true
+    }
+})
+
+module.exports = opensearch219

package/lib/config/services/php/extensions/ftp.js

@@ -0,0 +1,7 @@
+/**
+ * @type {import('../../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'ftp',
+    command: 'docker-php-ext-install ftp'
+}

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

@@ -3,5 +3,6 @@ module.exports = {
     php73: require('./php-7.3'),
     php74: require('./php-7.4'),
     php81: require('./php-8.1'),
-    php82: require('./php-8.2')
+    php82: require('./php-8.2'),
+    php83: require('./php-8.3')
 }

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

@@ -16,7 +16,6 @@ const php72 = ({
     baseImage = `${repo}:php-7.2`
 }) => ({
     baseImage,
-    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'),

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

@@ -16,7 +16,6 @@ const php73 = ({
     baseImage = `${repo}:php-7.3`
 }) => ({
     baseImage,
-    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'),

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

@@ -16,7 +16,6 @@ const php74 = ({
     baseImage = `${repo}:php-7.4`
 }) => ({
     baseImage,
-    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'),

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

@@ -16,12 +16,14 @@ const php81 = ({
     baseImage = `${repo}:php-8.1`
 }) => ({
     baseImage,
-    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,
+        xdebug: {
+            ...xdebug,
+            version: '3.4.2'
+        },
         ...extensions
     },
     env: defaultPhpEnv

package/lib/config/services/php/versions/php-8.2.js

@@ -16,14 +16,13 @@ const php82 = ({
     baseImage = `${repo}:php-8.2`
 }) => ({
     baseImage,
-    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: {
             ...xdebug,
-            version: '3.2.1'
+            version: '3.4.2'
         },
         ...extensions
     },

package/lib/config/services/php/versions/php-8.3.js

@@ -0,0 +1,32 @@
+const path = require('path')
+const { repo } = require('../base-repo')
+const xdebug = require('../extensions/xdebug')
+const defaultPhpEnv = require('../default-php-env')
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @param {import('../../../../../typings/index').PHPExtensions} [param0.extensions]
+ * @param {string} [param0.baseImage]
+ * @returns {import('../../../../../typings/index').PHPConfiguration}
+ */
+const php83 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${repo}:php-8.3`
+}) => ({
+    baseImage,
+    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: {
+            ...xdebug,
+            version: '3.4.2'
+        },
+        ...extensions
+    },
+    env: defaultPhpEnv
+})
+
+module.exports = php83