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

package/lib/tasks/requirements/elasticsearch-version.js

@@ -1,4 +1,5 @@
 const { getPort } = require('../../config/port-config')
+const KnownError = require('../../errors/known-error')
 const UnknownError = require('../../errors/unknown-error')
 const { containerApi } = require('../docker/containers')
 
@@ -26,10 +27,10 @@ const checkElasticSearchVersion = () => ({
             elasticSearchContainerRunning.length !== 0 &&
             elasticSearchContainerRunning[0].State === 'running'
         ) {
-            elasticSearchVersionResponse = await containerApi.exec(
-                'elasticsearch --version',
-                elasticSearchContainer.name
-            )
+            elasticSearchVersionResponse = await containerApi.exec({
+                command: 'elasticsearch --version',
+                container: elasticSearchContainer.name
+            })
         } else {
             try {
                 const availableElasticSearchPort = await getPort(
@@ -41,13 +42,29 @@ const checkElasticSearchVersion = () => ({
                     detach: false,
                     rm: true,
                     ports: [`127.0.0.1:${availableElasticSearchPort}:9200`],
-                    memory: '512mb'
+                    memory: '2gb'
                 })
             } catch (e) {
                 elasticSearchVersionResponse = e.message
             }
         }
 
+        if (
+            ctx.cgroupVersion === 'v2' &&
+            elasticSearchVersionResponse.includes(
+                'Cannot invoke "jdk.internal.platform.CgroupInfo.getMountPoint()" because "anyController" is null'
+            )
+        ) {
+            throw new KnownError(`ElasticSearch failed to start up due to a JVM bug with CGroup version 2.
+Similar issue on StackOverflow: https://stackoverflow.com/q/71532170.
+
+Right now is check if OpenSearch works with your version of Magento.
+Follow the documentation: https://docs.create-magento-app.com/getting-started/config-file#searchengine-opensearch-elasticsearch
+
+If it will not help, try updating ElasticSearch image version: https://docs.create-magento-app.com/getting-started/config-file#elasticsearch
+`)
+        }
+
         const elasticSearchVersionResponseResult =
             elasticSearchVersionResponse.match(/Version:\s(\d+\.\d+\.\d+)/i)
 
@@ -64,8 +81,7 @@ const checkElasticSearchVersion = () => ({
                 `Cannot retrieve ElasticSearch Version!\n\n${elasticSearchVersionResponse}`
             )
         }
-    },
-    exitOnError: false
+    }
 })
 
 module.exports = checkElasticSearchVersion

package/lib/tasks/requirements/index.js

@@ -4,6 +4,7 @@ const localAuthJson = require('../composer/local-auth-json')
 const checkDocker = require('./docker')
 const checkNodeVersion = require('./node-version')
 const checkRosetta = require('./rosetta')
+const checkCGroupVersion = require('./cgroup-version')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -19,6 +20,8 @@ const checkRequirements = () => ({
                 checkPlatform(),
                 // check the Docker installation
                 checkDocker(),
+                // check if cgroup v2 is used
+                checkCGroupVersion(),
                 // check for Node.js version
                 checkNodeVersion(),
                 // check for COMPOSER_AUTH or auth.json

package/lib/tasks/requirements/opensearch-version.js

@@ -25,10 +25,10 @@ const checkOpenSearchVersion = () => ({
             openSearchContainerRunning.length !== 0 &&
             openSearchContainerRunning[0].State === 'running'
         ) {
-            openSearchVersionResponse = await containerApi.exec(
-                'opensearch --version',
-                openSearchContainer.name
-            )
+            openSearchVersionResponse = await containerApi.exec({
+                command: 'opensearch --version',
+                container: openSearchContainer.name
+            })
         } else {
             try {
                 const availableOpenSearchPort = await getPort(
@@ -40,7 +40,7 @@ const checkOpenSearchVersion = () => ({
                     detach: false,
                     rm: true,
                     ports: [`127.0.0.1:${availableOpenSearchPort}:9200`],
-                    memory: '512mb'
+                    memory: '2gb'
                 })
             } catch (e) {
                 openSearchVersionResponse = e.message

package/lib/tasks/requirements/searchengine-version.js

@@ -13,8 +13,7 @@ const checkSearchEngineVersion = () => ({
         }
 
         return task.newListr(checkElasticSearchVersion())
-    },
-    exitOnError: false
+    }
 })
 
 module.exports = checkSearchEngineVersion

package/lib/tasks/start.js

@@ -15,10 +15,7 @@ const { installMagentoProject, setupMagento } = require('./magento')
 const { pullImages, stopContainers } = require('./docker/containers')
 const dockerNetwork = require('./docker/network')
 const { connectToDatabase } = require('./database')
-const {
-    buildProjectImage,
-    buildDebugProjectImage
-} = require('./docker/project-image-builder')
+const { buildProjectImage } = require('./docker/project-image-builder')
 const getProjectConfiguration = require('../config/get-project-configuration')
 const { getSystemConfigTask } = require('../config/system-config')
 const setupThemes = require('./theme/setup-themes')
@@ -141,15 +138,7 @@ const configureProject = () => ({
                         }
                     )
             },
-            {
-                task: (ctx, subTask) =>
-                    subTask.newListr(
-                        [buildProjectImage(), buildDebugProjectImage()],
-                        {
-                            concurrent: true
-                        }
-                    )
-            },
+            buildProjectImage(),
             getComposerVersionTask(),
             prepareFileSystem(),
             volumes.createVolumes(),

package/lib/util/dockerfile-builder/build-instructions.js

@@ -22,7 +22,11 @@ const buildInstructions = (instructions) => {
                     addInstruction += ` --chown=${instruction.chown}`
                 }
 
-                addInstruction += ` ${instruction.src.join(' ')}`
+                addInstruction += ` ${
+                    Array.isArray(instruction.src)
+                        ? instruction.src.join(' ')
+                        : instruction.src
+                }`
                 addInstruction += ` ${instruction.dest}`
 
                 dockerFileInstructions.push(addInstruction)

package/lib/util/dockerfile-builder/types.d.ts

@@ -42,7 +42,7 @@ export interface AddInstruction {
 
 export interface CopyInstruction {
     type: 'COPY'
-    src: string[]
+    src:  string | string[]
     dest: string
     chown?: string
     from?: string

package/lib/util/execute-in-container.js

@@ -1,22 +1,28 @@
 const { spawn } = require('child_process')
-const { runCommand } = require('../tasks/docker/containers/container-api')
+const {
+    runCommand,
+    execCommand
+} = require('../tasks/docker/containers/container-api')
 
 /**
- * @param {{ containerName: string, commands: string[], user?: string }} param0
+ * @param {{ containerName: string, command: string, user?: string }} param0
  * @returns {Promise<never>}
  */
-const executeInContainer = ({ containerName, commands, user }) => {
+const executeInContainer = ({ containerName, command, user }) => {
     if (!process.stdin.isTTY) {
         process.stderr.write('This app works only in TTY mode')
         process.exit(1)
     }
 
-    const userArg = (user && `--user=${user}`) || ''
-    const args = ['exec', '-it', userArg, containerName]
-        .filter(Boolean)
-        .concat(...commands.map((command) => command.split(' ')).flat())
+    const execArgs = execCommand({
+        container: containerName,
+        command,
+        user,
+        tty: true,
+        interactive: true
+    })
 
-    spawn('docker', args, {
+    spawn('bash', ['-c', execArgs.join(' ')], {
         stdio: [0, 1, 2]
     })
 

package/lib/util/get-installed-magento-version.js

@@ -17,6 +17,49 @@ const getComposerData = async (composerPath) => {
     return JSON.parse(await fs.promises.readFile(composerPath, 'utf-8'))
 }
 
+/**
+ * @param {string} composerLockPath
+ * @returns {Promise<{ packages: Array<{ name: string, version: string }> } | null>}
+ */
+const getComposerLockData = async (composerLockPath) => {
+    const composerExists = await pathExists(composerLockPath)
+
+    if (!composerExists) {
+        return null
+    }
+
+    return JSON.parse(await fs.promises.readFile(composerLockPath, 'utf-8'))
+}
+
+const getInstalledMagentoVersionFromLock = async (
+    projectPath = process.cwd()
+) => {
+    const composerLockData = await getComposerLockData(
+        path.join(projectPath, 'composer.lock')
+    )
+
+    if (!composerLockData) {
+        throw new KnownError('composer.lock not found')
+    }
+
+    const magentoDependency = composerLockData.packages.find(
+        (composerLockPackage) => {
+            return [
+                'magento/product-community-edition',
+                'magento/product-enterprise-edition'
+            ].some(
+                (magentoEdition) => composerLockPackage.name === magentoEdition
+            )
+        }
+    )
+
+    if (!magentoDependency) {
+        return null
+    }
+
+    return magentoDependency.version
+}
+
 const getInstalledMagentoVersion = async (projectPath = process.cwd()) => {
     const composerData = await getComposerData(
         path.join(projectPath, 'composer.json')
@@ -30,11 +73,26 @@ const getInstalledMagentoVersion = async (projectPath = process.cwd()) => {
         'magento/product-enterprise-edition'
     ].find((magentoEdition) => composerData.require[magentoEdition])
 
+    let foundMagentoVersion = ''
+
     if (!magentoDependency) {
-        throw new KnownError('No Magento dependency found in composer.json')
+        const magentoLockVersion = await getInstalledMagentoVersionFromLock(
+            projectPath
+        )
+        if (!magentoLockVersion) {
+            if (!magentoDependency) {
+                throw new KnownError(
+                    'No Magento dependency found in composer.json or composer.lock'
+                )
+            }
+        } else {
+            foundMagentoVersion = magentoLockVersion
+        }
+    } else {
+        foundMagentoVersion = composerData.require[magentoDependency]
     }
 
-    return composerData.require[magentoDependency].replace(/\^/i, '')
+    return foundMagentoVersion.replace(/\^/i, '')
 }
 
 module.exports = getInstalledMagentoVersion

package/lib/util/portscanner.js

@@ -13,7 +13,7 @@ const { Socket } = net
  * @param {Object} [options] - Options object.
  * @param {String} [options.host] - Host of where to scan.
  * @param {Number} [options.timeout] - Connection timeout in ms.
- * @returns {Promise<string>}
+ * @returns {Promise<'open' | 'closed'>}
  */
 const checkPortStatus = (port, options = {}) =>
     new Promise((resolve, reject) => {
@@ -23,7 +23,7 @@ const checkPortStatus = (port, options = {}) =>
 
         const socket = new Socket()
         /**
-         * @type {string}
+         * @type {'open' | 'closed'}
          */
         let status
 
@@ -80,7 +80,7 @@ const checkPortStatus = (port, options = {}) =>
 /**
  * Internal helper function used by {@link findAPortInUse} and {@link findAPortNotInUse}
  * to find a port from a range or a list with a specific status.
- * @param {String} status - Status to check.
+ * @param {'open' | 'closed'} status - Status to check.
  * @param {Object} options
  * @param {Number} options.startPort Port to begin status check on (inclusive).
  * @param {Number} options.endPort Last port to check status on (inclusive).

package/lib/util/run-composer.js

@@ -4,7 +4,7 @@ const { runPHPContainerCommand } = require('../tasks/php/php-container')
  * Execute composer command
  * @param {import('../../typings/context').ListrContext} ctx
  * @param {String} command composer command
- * @param {Parameters<import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean }} [options]
+ * @param {Parameters<import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean, user?: string, useAutomaticUser?: boolean }} [options]
  */
 const runComposerCommand = async (ctx, command, options = {}) => {
     const { throwNonZeroCode = true } = options

package/lib/util/run-magento.js

@@ -5,7 +5,7 @@ const { runPHPContainerCommand } = require('../tasks/php/php-container')
  *
  * @param {import('../../typings/context').ListrContext} ctx
  * @param {String} command magento command
- * @param {Parameters<typeof import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean }} options
+ * @param {Parameters<typeof import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean, useAutomaticUser?: boolean }} options
  * @returns {Promise<{ code: number, result: string }>}
  */
 const runMagentoCommand = async (ctx, command, options = {}) => {
@@ -15,6 +15,7 @@ const runMagentoCommand = async (ctx, command, options = {}) => {
         `bin/magento ${command}`,
         {
             ...options,
+            useAutomaticUser: true,
             withCode: true
         }
     )

package/lib/util/run-php.js

@@ -4,7 +4,7 @@ const { runPHPContainerCommand } = require('../tasks/php/php-container')
  * Execute PHP code
  * @param {import('../../typings/context').ListrContext} ctx
  * @param {String} command php command
- * @param {Parameters<typeof import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean }} [options]
+ * @param {Parameters<typeof import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean, useAutomaticUser?: boolean }} [options]
  */
 const runPhpCode = async (ctx, command, options = {}) => {
     const { throwNonZeroCode = true } = options
@@ -13,6 +13,7 @@ const runPhpCode = async (ctx, command, options = {}) => {
         `php ${command}`,
         {
             ...options,
+            useAutomaticUser: true,
             withCode: true
         }
     )

package/lib/util/set-config.js

@@ -1,8 +1,10 @@
-const eta = require('eta')
+const { Eta } = require('eta')
 const fs = require('fs')
 const path = require('path')
 const pathExists = require('./path-exists')
 
+const eta = new Eta()
+
 /**
  * @param {{ configPathname: string, template: string, overwrite?: boolean, templateArgs?: Record<string, unknown> }} param0
  */
@@ -19,7 +21,7 @@ const setConfigFile = async ({
     }
 
     const configTemplate = await fs.promises.readFile(template, 'utf-8')
-    const compliedConfig = await eta.render(configTemplate, {
+    const compliedConfig = await eta.renderStringAsync(configTemplate, {
         date: new Date().toUTCString(),
         ...templateArgs
     })

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.0",
+    "version": "2.4.0-alpha.2",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -23,24 +23,24 @@
         "arm64"
     ],
     "dependencies": {
-        "@scandipwa/scandipwa-dev-utils": "0.1.16",
-        "@tilework/mosaic-dev-utils": "^0.2.3",
-        "conf": "10.1.2",
-        "enquirer": "2.3.6",
-        "eta": "1.12.3",
-        "fast-xml-parser": "^4.0.9",
+        "@scandipwa/scandipwa-dev-utils": "0.1.17",
+        "@tilework/mosaic-dev-utils": "^0.2.4",
+        "conf": "10.2.0",
+        "enquirer": "2.4.1",
+        "eta": "3.4.0",
+        "fast-xml-parser": "^4.4.0",
         "hjson": "^3.2.2",
         "is-installed-globally": "0.4.0",
-        "joi": "17.6.0",
+        "joi": "17.13.3",
         "listr2": "4.0.5",
         "macos-version": "5.2.1",
         "merge-files": "0.1.2",
-        "mysql2": "2.3.3",
-        "node-ssh": "12.0.5",
-        "semver": "7.3.7",
+        "mysql2": "3.10.3",
+        "node-ssh-no-cpu-features": "^2.0.0",
+        "semver": "7.6.3",
         "smol-request": "^2.1.2",
-        "systeminformation": "5.12.1",
-        "yargs": "17.5.1"
+        "systeminformation": "5.22.11",
+        "yargs": "17.7.2"
     },
     "publishConfig": {
         "access": "public"
@@ -56,8 +56,8 @@
         "scandipwa"
     ],
     "devDependencies": {
-        "@types/node": "^20.10.4",
-        "@types/yargs": "^17.0.13"
+        "@types/node": "^20.14.11",
+        "@types/yargs": "^17.0.32"
     },
-    "gitHead": "684832cd42a2a9b37bcb4a03a4196221e3802a74"
+    "gitHead": "ec855efd799e10f263e82b3bf610d400892db6dc"
 }

package/typings/context.d.ts

@@ -18,17 +18,18 @@ export interface ListrContext {
     throwMagentoVersionMissing: boolean
     projectPath: string
     systemDFData?: systemApi.SystemDFResult
-    debug: boolean
     verbose: boolean
     magentoVersion: string
     composerVersion: string
     phpVersion: string
     elasticSearchVersion: string
     openSearchVersion: string
+    cgroupVersion: 'v1' | 'v2'
     port?: number
     ports: {
         app: number
         fpm: number
+        fpmXdebug: number
         xdebug: number
         mariadb: number
         redis: number
@@ -42,6 +43,7 @@ export interface ListrContext {
     cachedPorts?: {
         app: number
         fpm: number
+        fpmXdebug: number
         xdebug: number
         mariadb: number
         redis: number
@@ -55,8 +57,8 @@ export interface ListrContext {
     isArm: boolean
     isWsl: boolean
     isArmMac: boolean
-    platform?: NodeJS.Platform
-    platformVersion?: string
+    platform: NodeJS.Platform
+    platformVersion: string
     /**
      * Magento Edition
      *
@@ -67,6 +69,11 @@ export interface ListrContext {
         php: {
             iniTemplatePath: string
             fpmConfPath: string
+            fpmTemplatePath: string
+            debugIniPath: string
+            debugTemplatePath: string
+            debugFpmConfPath: string
+            debugFpmTemplatePath: string
             extensions: PHPExtensions
             version: string
         }
@@ -91,7 +98,7 @@ export interface ListrContext {
                     }
                 }
             >
-            getContainers(ports?: ListrContext['ports']): Record<'php' | 'sslTerminator' | 'nginx' | 'redis' | 'mariadb' | 'elasticsearch' | 'maildev' | 'varnish',
+            getContainers(ports?: ListrContext['ports']): Record<'php' | 'phpWithXdebug' | 'sslTerminator' | 'nginx' | 'redis' | 'mariadb' | 'elasticsearch' | 'maildev' | 'varnish',
                 {
                     _: string
                     ports: string[]
@@ -100,16 +107,17 @@ export interface ListrContext {
                     }
                     env: Record<string, string>
                     mountVolumes: string[]
+                    pullImage?: boolean
                     mounts: string[]
                     restart: string
                     securityOptions: string[]
                     network: string
                     image: string
-                    debugImage?: string
                     remoteImages?: string[]
                     name: string
                     command: string
                     connectCommand: string[]
+                    dependsOn?: string[]
                 }
             >
         }

package/typings/index.d.ts

@@ -30,6 +30,16 @@ export interface MariaDBConfiguration extends ServiceWithImage {
      * Allows to be boolean or custom value that will be set in the template
      */
     useOptimizerSwitch?: boolean | string
+
+    /**
+     * `mariadb` file name to be used in the shell
+     */
+    binFileName?: string
+
+    /**
+     * `mariadb-admin` file name to be used in the shell, for heathcheck
+     */
+    binAdminFileName?: string
 }
 
 export interface SSLTerminatorConfiguration extends ServiceWithImage {
@@ -189,11 +199,6 @@ export interface PHPConfiguration {
      */
     baseImage: string
 
-    /**
-     * Image with XDebug enabled
-     */
-    debugImage: string
-
     /**
      * Configuration file template location
      *