@scandipwa/magento-scripts 2.4.0-alpha.4 → 2.4.1

package/lib/commands/cli.js

@@ -132,7 +132,7 @@ module.exports = (yargs) => {
                 .addLine('1. Start debugger in VSCode or PHPStorm')
                 .addLine(
                     `2. Go to PHP container: ${logger.style.command(
-                        'exec phpWithDebug'
+                        'exec phpWithXdebug'
                     )}`
                 )
                 .addLine(

package/lib/config/port-config.js

@@ -73,6 +73,8 @@ const defaultPorts = {
     sslTerminator: 80,
     fpm: 9000,
     fpmXdebug: 9001,
+    // for xdebug server running in the editor
+    xdebug: 9003,
     mariadb: 3306,
     redis: 6379,
     elasticsearch: 9200,
@@ -99,10 +101,12 @@ const getPortsConfig = async (ports, options = {}) => {
         p = p.concat(await getUsedByOtherCMAProjectsPorts())
     }
 
+    const { xdebug: _, ...portsWithoutXDebug } = mergedPorts
+
     /**
      * @type {Record<string, string>}
      */
-    const portsToCheck = Object.entries(mergedPorts).reduce(
+    const portsToCheck = Object.entries(portsWithoutXDebug).reduce(
         (acc, [name, port]) => {
             if (acc[port]) {
                 let i = 0
@@ -146,6 +150,21 @@ const getPortsConfig = async (ports, options = {}) => {
         }
     }
 
+    // XDebug port will be occupied by the editor
+    // so we can expect default port to be free
+    // if setup ran more than once
+    // first time: default port (9003) is free
+    // second time: default port (9003) is occupied by the editor, we choose 9004
+    // third time: default port (9004) is occupied by the editor, we choose 9003
+    // that way port number will not grow indefinitely
+    const xdebugPort = await getPort(defaultPorts.xdebug, {
+        portIgnoreList: Object.keys(availablePorts).map((item) =>
+            Number.parseInt(item)
+        )
+    })
+
+    availablePorts.xdebug = xdebugPort
+
     return availablePorts
 }
 

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

@@ -9,7 +9,7 @@ xdebug.remote_enable=1
 
 xdebug.remote_host=<%~ it.hostMachine %>
 
-xdebug.remote_port=9003
+xdebug.remote_port=<%~ it.xdebugPort %>
 
 xdebug.remote_log=<%~ it.mageRoot %>/var/log/xdebug.log
 
@@ -18,7 +18,7 @@ xdebug.remote_log=<%~ it.mageRoot %>/var/log/xdebug.log
 xdebug.mode=debug
 xdebug.client_host=<%~ it.hostMachine %>
 
-xdebug.client_port=9003
+xdebug.client_port=<%~ it.xdebugPort %>
 
 ; THIS THING WILL BREAK PHP
 ; xdebug.start_with_request=yes

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

@@ -175,6 +175,12 @@ const buildDockerFileInstructions = async (
             `addgroup -g ${gid} ${username} && adduser -u ${gid} -G ${username} -H -s /sbin/nologin -D ${username} && \
                 addgroup www-data ${username}`
         )
+
+        if (ctx.isDockerDesktop) {
+            dockerFileInstructions.run(
+                `chown -R ${username}:${username} /composer/home/cache`
+            )
+        }
     }
 
     dockerFileInstructions.workDir(ctx.config.baseConfig.containerMagentoDir)

package/lib/tasks/file-system/create-nginx-config.js

@@ -34,7 +34,7 @@ const createNginxConfig = () => ({
             networkSettings.phpWithXdebugNetwork = containers.phpWithXdebug.name
 
             networkSettings.fpmPort = 9000
-            networkSettings.fpmXdebugPort = 9001
+            networkSettings.fpmXdebugPort = 9000
 
             networkSettings.hostPort = 80
         }

package/lib/tasks/file-system/create-php-debug-config.js

@@ -26,6 +26,8 @@ const createPhpDebugConfig = () => ({
             ? '127.0.0.1'
             : 'host.docker.internal'
 
+        const { xdebug: xdebugPort } = ctx.ports
+
         try {
             await setConfigFile({
                 configPathname: php.debugIniPath,
@@ -35,7 +37,8 @@ const createPhpDebugConfig = () => ({
                     debug,
                     mageRoot: baseConfig.containerMagentoDir,
                     isXDebug2,
-                    hostMachine
+                    hostMachine,
+                    xdebugPort
                 }
             })
         } catch (e) {

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

@@ -36,7 +36,7 @@ const setupWorkspaceConfig = () => ({
                 setupPHPStanProjectConfiguration(workspaceConfigs),
                 setupPSalmProjectConfiguration(workspaceConfigs),
                 setupPHPWorkspaceProjectConfiguration(workspaceConfigs, ctx),
-                setupPHPDebugGeneral(workspaceConfigs),
+                setupPHPDebugGeneral(workspaceConfigs, ctx),
                 setupPHPServers(workspaceConfigs, workspaceConfig, ctx),
                 setupComposerSettings(workspaceConfigs, ctx),
                 setupRunManager(workspaceConfigs, workspaceConfig),
@@ -61,7 +61,7 @@ const setupWorkspaceConfig = () => ({
             setupPHPCodeSnifferProjectConfiguration(workspaceConfigs),
             setupPHPStanProjectConfiguration(workspaceConfigs),
             setupPSalmProjectConfiguration(workspaceConfigs),
-            setupPHPDebugGeneral(workspaceConfigs),
+            setupPHPDebugGeneral(workspaceConfigs, ctx),
             setupPHPServers(workspaceConfigs, workspaceConfig, ctx),
             setupPHPWorkspaceProjectConfiguration(workspaceConfigs, ctx),
             setupRunManager(workspaceConfigs, workspaceConfig),

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-debug-general-config.js

@@ -7,13 +7,16 @@ const xdebugDebugPortKey = '@_xdebug_debug_port'
 const ignoreConnectionsThroughUnregisteredServersKey =
     '@_ignore_connections_through_unregistered_servers'
 
-const xdebugPort = '9003'
-
 /**
  * @param {Array} workspaceConfigs
+ * @param {import('../../../../../typings/context').ListrContext} ctx
  * @returns {Promise<Boolean>}
  */
-const setupPHPDebugGeneral = async (workspaceConfigs) => {
+const setupPHPDebugGeneral = async (workspaceConfigs, ctx) => {
+    const { ports } = ctx
+
+    const xdebugPort = `${ports.xdebug}`
+
     let hasChanges = false
     const phpDebugGeneralComponent = workspaceConfigs.find(
         (workspaceConfig) =>

package/lib/tasks/file-system/create-vscode-config.js

@@ -7,8 +7,6 @@ const UnknownError = require('../../errors/unknown-error')
 
 const listenForXDebugConfigName = 'Listen for XDebug'
 
-const xdebugPort = 9003
-
 const vscodeLaunchConfigPath = path.join(
     process.cwd(),
     '.vscode',
@@ -19,6 +17,7 @@ const vscodeLaunchConfigPath = path.join(
  * @param {import('../../../typings/context').ListrContext} ctx
  */
 const addPHPDebugConfig = (vscodeLaunchConfig, ctx) => {
+    const { ports } = ctx
     const phpXDebugConfig = vscodeLaunchConfig.configurations.find(
         ({ name }) => name === listenForXDebugConfigName
     )
@@ -29,7 +28,8 @@ const addPHPDebugConfig = (vscodeLaunchConfig, ctx) => {
         name: listenForXDebugConfigName,
         type: 'php',
         request: 'launch',
-        port: xdebugPort,
+        // port: xdebugPort,
+        port: ports.xdebug,
         pathMappings: {
             // eslint-disable-next-line no-template-curly-in-string
             [ctx.config.baseConfig.containerMagentoDir]: '${workspaceFolder}'
@@ -52,8 +52,8 @@ const addPHPDebugConfig = (vscodeLaunchConfig, ctx) => {
         return true
     }
 
-    if (!phpXDebugConfig.port || phpXDebugConfig.port !== xdebugPort) {
-        phpXDebugConfig.port = xdebugPort
+    if (!phpXDebugConfig.port || phpXDebugConfig.port !== ports.xdebug) {
+        phpXDebugConfig.port = ports.xdebug
 
         hasChanges = true
     }
@@ -129,7 +129,7 @@ const createVSCodeConfig = () => ({
                 template: vscodeLaunchConfigTemplatePath,
                 configPathname: vscodeLaunchConfigPath,
                 templateArgs: {
-                    XDebugPort: xdebugPort,
+                    XDebugPort: ctx.ports.xdebug,
                     baseConfig: ctx.config.baseConfig
                 }
             })

package/lib/tasks/magento/install-magento-project.js

@@ -277,13 +277,17 @@ const installMagentoProject = () => ({
                 title: 'Installing Magento dependencies',
                 task: async () => {
                     try {
-                        await runComposerCommand(ctx, 'install', {
-                            callback: !ctx.verbose
-                                ? undefined
-                                : (t) => {
-                                      task.output = t
-                                  }
-                        })
+                        await runComposerCommand(
+                            ctx,
+                            `install${ctx.verbose ? ' -v' : ''}`,
+                            {
+                                callback: !ctx.verbose
+                                    ? undefined
+                                    : (t) => {
+                                          task.output = t
+                                      }
+                            }
+                        )
                     } catch (e) {
                         if (
                             e instanceof UnknownError &&

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.4.0-alpha.4",
+    "version": "2.4.1",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -59,5 +59,5 @@
         "@types/node": "^20.14.11",
         "@types/yargs": "^17.0.32"
     },
-    "gitHead": "44e76144f6979996e604a6a57088ac139ae88731"
+    "gitHead": "54272cb4f12f8684d032dd611027ec4fe3877cab"
 }