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

package/lib/config/docker.js

@@ -115,7 +115,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             : {}
 
         /**
-         * @type {Record<string, import('../tasks/docker/containers/container-api').ContainerRunOptions & { _?: string, forwardedPorts?: string[], remoteImages?: string[], connectCommand?: string[], description?: string, pullImage?: boolean, dependsOn?: string[] }>}
+         * @type {Record<string, import('../tasks/docker/containers/container-api').ContainerRunOptions & { _?: string, forwardedPorts?: string[], remoteImages?: string[], connectCommand?: string[], description?: string, pullImage?: boolean, dependsOn?: string[], serviceReadyLog?: string }>}
          */
         const dockerConfig = {
             php: {
@@ -169,7 +169,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     (ctx.platform === 'linux' && isDockerDesktop) ||
                     !isDockerDesktop
                         ? `${os.userInfo().uid}:${os.userInfo().gid}`
-                        : ''
+                        : '',
+                serviceReadyLog: 'ready to handle connections'
             },
             phpWithXdebug: {
                 _: 'PHP with Xdebug',
@@ -228,7 +229,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     (ctx.platform === 'linux' && isDockerDesktop) ||
                     !isDockerDesktop
                         ? `${os.userInfo().uid}:${os.userInfo().gid}`
-                        : ''
+                        : '',
+                serviceReadyLog: 'ready to handle connections'
             },
             sslTerminator: {
                 _: 'SSL Terminator (Nginx)',
@@ -337,7 +339,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     redis.version ? `redis:${redis.version}` : redis.image
                 }`,
                 name: `${prefix}_redis`,
-                connectCommand: ['redis-cli']
+                connectCommand: ['redis-cli'],
+                serviceReadyLog: 'Ready to accept connections'
             },
             mariadb: {
                 _: 'MariaDB',
@@ -423,7 +426,9 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                             : elasticsearch.image
                         : opensearch.image
                 }`,
-                name: `${prefix}_${searchengine}`
+                name: `${prefix}_${searchengine}`,
+                serviceReadyLog:
+                    searchengine === 'elasticsearch' ? '"started"' : '] started'
             },
             maildev: {
                 _: 'MailDev',

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/containers/tasks.js

@@ -5,6 +5,7 @@ const KnownError = require('../../../errors/known-error')
 const containerApi = require('./container-api')
 const { imageApi } = require('../image')
 const { execAsyncSpawn } = require('../../../util/exec-async-command')
+const waitForLogs = require('../../../util/wait-for-logs')
 
 /**
  * @param {string[]} containers
@@ -154,7 +155,9 @@ const startContainers = () => ({
             all: true
         })
 
-        const missingContainers = Object.entries(docker.getContainers(ports))
+        const containers = docker.getContainers(ports)
+
+        const missingContainers = Object.entries(containers)
             .filter(
                 ([nameWithoutPrefix, { name }]) =>
                     !containerList.some((c) => c.Names === name)
@@ -189,7 +192,9 @@ const startContainers = () => ({
                         const startedContainers = []
                         subTask.title = `Container ${
                             container._
-                        } is waiting for ${dependsOn.join(', ')} to start...`
+                        } is waiting for ${dependsOn
+                            .map((a) => containers[a]._)
+                            .join(', ')} to start...`
                         await Promise.all(
                             dependsOn.map(
                                 async (name) =>
@@ -217,6 +222,7 @@ const startContainers = () => ({
                                                                 d
                                                             )
                                                     )
+                                                    .map((d) => containers[d]._)
                                                     .join(', ')} to start...`
                                                 clearTimeout(timeout)
                                                 resolve()
@@ -231,6 +237,13 @@ const startContainers = () => ({
 
                     await containerApi.run(container)
 
+                    if (container.serviceReadyLog) {
+                        await waitForLogs({
+                            containerName: container.name,
+                            matchText: container.serviceReadyLog
+                        })
+                    }
+
                     containerStatuses[
                         container.nameWithoutPrefix
                     ].started = true
@@ -240,7 +253,7 @@ const startContainers = () => ({
                         cb()
                     })
 
-                    subTask.output = `${container._} container started`
+                    subTask.title = `${container._} container started`
                 }
             })),
             {

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/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",
+    "version": "2.4.2-alpha.0",
     "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": "2260d8d8945d830bb552aa910af847ce7fe8ab6b"
+    "gitHead": "77f33d97f83963ba52d9cf493a9a6cb86029a76e"
 }

package/typings/context.d.ts

@@ -118,6 +118,7 @@ export interface ListrContext {
                     command: string
                     connectCommand: string[]
                     dependsOn?: string[]
+                    serviceReadyLog?: string
                 }
             >
         }
@@ -154,4 +155,5 @@ export interface ListrContext {
     dockerServerData?: DockerVersionResult['Server']
     dockerClientData?: DockerVersionResult['Client']
     dockerVersion?: DockerVersionResult['Server']['Version']
+    dockerMemoryLimit: number
 }