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

package/lib/tasks/magento/setup-magento/setup-file-permissions.js

@@ -0,0 +1,160 @@
+const os = require('os')
+const fs = require('fs')
+const path = require('path')
+const {
+    runPHPContainerCommandTask,
+    runPHPContainerCommand
+} = require('../../php/php-container')
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const makeNewFilesCreatedInFolderUseDirectoryGroup = () => ({
+    title: 'Make new files created in folder use directory group',
+    task: (ctx, task) =>
+        task.newListr([
+            runPHPContainerCommandTask(
+                'find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +',
+                {
+                    // should prevent command from failing the task
+                    // if the folder does not exist
+                    withCode: true
+                }
+            )
+        ])
+})
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const makeFilesWritableForGroupMembers = () => ({
+    title: 'Make files writable for group members',
+    task: (ctx, task) =>
+        task.newListr([
+            runPHPContainerCommandTask(
+                'find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +',
+                {
+                    // should prevent command from failing the task
+                    // if the folder does not exist
+                    withCode: true
+                }
+            )
+        ])
+})
+
+/**
+ * @param {string} folder
+ * @param {string | number} user
+ * @param {string | number} [group]
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const makeFolderOwnedByUser = (folder, user, group) => ({
+    title: `Make folder ${folder} owned by ${user} user${
+        group ? ` and ${group} group` : ''
+    }`,
+    task: (ctx, task) =>
+        task.newListr([
+            runPHPContainerCommandTask(
+                `chown -R ${user}${group ? `:${group}` : ''} ${folder}`,
+                {
+                    user: 'root:root'
+                }
+            )
+        ])
+})
+
+/**
+ * @param {import('../../../../typings/context').ListrContext} ctx
+ */
+const doesFileSystemNeedsPermissionsSetup = async (ctx) => {
+    const checkPHPPermissionsFileName = 'check-file-permissions.php'
+    const cacheDirFilePath = path.join(
+        ctx.config.baseConfig.cacheDir,
+        checkPHPPermissionsFileName
+    )
+    await fs.promises.copyFile(
+        path.join(__dirname, checkPHPPermissionsFileName),
+        cacheDirFilePath
+    )
+
+    const result = await runPHPContainerCommand(
+        ctx,
+        `php ${path.relative(process.cwd(), cacheDirFilePath)}`,
+        {
+            user: 'www-data:www-data',
+            cwd: ctx.config.baseConfig.containerMagentoDir
+        }
+    )
+
+    await fs.promises.unlink(cacheDirFilePath)
+
+    /**
+     * @type {{directory: string, exists: boolean, writable: boolean, permissions: string, directory_owner: {name: string, passwd: string, uid: number, gid: number, gecos: string, dir: string, shell: string} | boolean, directory_group: boolean, current_user: {name: string, passwd: string, uid: number, gid: number, gecos: string, dir: string, shell: string} | boolean, is_current_user_directory_owner: boolean}[]}
+     */
+    const parsedResult = JSON.parse(result)
+
+    if (parsedResult.some(({ exists, writable }) => exists && !writable)) {
+        return true
+    }
+
+    return false
+}
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setupMagentoFilePermissions = () => ({
+    title: 'Setting Magento file permissions',
+    // skip: true,
+    skip: async (ctx) =>
+        ctx.magentoFirstInstall ||
+        !(await doesFileSystemNeedsPermissionsSetup(ctx)),
+    task: (ctx, task) =>
+        task.newListr(
+            [
+                makeNewFilesCreatedInFolderUseDirectoryGroup(),
+                makeFilesWritableForGroupMembers()
+            ].concat(
+                ctx.isDockerDesktop
+                    ? [
+                          makeFolderOwnedByUser(
+                              ctx.config.baseConfig.containerMagentoDir,
+                              'www-data',
+                              'www-data'
+                          )
+                      ]
+                    : []
+            )
+        )
+})
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setupComposerCachePermissions = () => ({
+    title: 'Setting Composer Cache permissions',
+    task: (ctx, task) =>
+        task.newListr([
+            ctx.isDockerDesktop
+                ? makeFolderOwnedByUser(
+                      '/composer/home',
+                      'www-data',
+                      'www-data'
+                  )
+                : makeFolderOwnedByUser(
+                      '/composer/home',
+                      os.userInfo().uid,
+                      os.userInfo().gid
+                  ),
+
+            runPHPContainerCommandTask('chmod g+ws /composer/home/cache'),
+            runPHPContainerCommandTask('chmod g+w /composer/home/cache')
+        ])
+})
+
+module.exports = {
+    makeFilesWritableForGroupMembers,
+    makeNewFilesCreatedInFolderUseDirectoryGroup,
+    setupMagentoFilePermissions,
+    setupComposerCachePermissions
+}

package/lib/tasks/php/php-container.js

@@ -1,9 +1,12 @@
 /* eslint-disable no-use-before-define */
+const os = require('os')
 const { deepmerge } = require('../../util/deepmerge')
 const { containerApi } = require('../docker/containers')
 
 /**
- * @type {typeof import('./php-container')['runPHPContainerCommand']}
+ * @param {Parameters<typeof import('./php-container')['runPHPContainerCommand']>[0]} ctx
+ * @param {Parameters<typeof import('./php-container')['runPHPContainerCommand']>[1]} command
+ * @param {Parameters<typeof import('./php-container')['runPHPContainerCommand']>[2] & { useAutomaticUser?: boolean}} [options]
  */
 const runPHPContainerCommand = async (ctx, command, options = {}) => {
     const { php } = ctx.config.docker.getContainers(ctx.ports)
@@ -23,11 +26,21 @@ const runPHPContainerCommand = async (ctx, command, options = {}) => {
             php,
             {
                 detach: false,
-                rm: true
-            },
-            {
+                rm: true,
                 command
-            }
+            },
+            options.user
+                ? {
+                      user: options.user
+                  }
+                : {},
+            options.useAutomaticUser
+                ? {
+                      user: ctx.isDockerDesktop
+                          ? 'www-data:www-data'
+                          : `${os.userInfo().uid}:${os.userInfo().gid}`
+                  }
+                : {}
         ),
         options
     )
@@ -68,7 +81,8 @@ const execPHPContainerCommand = async (ctx, command, options = {}) => {
         {
             container: php.name,
             ...deepmerge(php, options.env ? { env: options.env } : {}),
-            command
+            command,
+            ...(options.user ? { user: options.user } : {})
         },
         options
     )

package/lib/tasks/php/update-env-php.js

@@ -1,5 +1,4 @@
 const path = require('path')
-const os = require('os')
 const getJsonfileData = require('../../util/get-jsonfile-data')
 const pathExists = require('../../util/path-exists')
 const { containerApi } = require('../docker/containers')
@@ -65,21 +64,16 @@ const updateEnvPHP = () => ({
                 HOST_MACHINE: hostMachine,
                 PORTS: JSON.stringify(ctx.ports)
             },
-            command: 'php ./update-env-php.php',
+            command: 'php ./update-env.php',
             mountVolumes: [
                 `${path.join(__dirname, 'update-env.php')}:${
                     ctx.config.baseConfig.containerMagentoDir
-                }/update-env-php.php`,
+                }/update-env.php`,
                 `${envPhpPath}:${ctx.config.baseConfig.containerMagentoDir}/env.php`
             ],
             image: php.image,
             detach: false,
-            rm: true,
-            user:
-                (ctx.platform === 'linux' && isDockerDesktop) ||
-                !isDockerDesktop
-                    ? `${os.userInfo().uid}:${os.userInfo().gid}`
-                    : ''
+            rm: true
         })
 
         task.output = result

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

@@ -0,0 +1,69 @@
+const semver = require('semver')
+const { execAsync } = require('../../util/exec-async')
+const { systemApi } = require('../docker/system')
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const checkCGroupVersion = () => ({
+    title: 'Checking CGroup version',
+    task: async (ctx, task) => {
+        ctx.cgroupVersion = 'v1'
+
+        let cgroupVersionDetected
+
+        if (ctx.platform === 'linux' && !ctx.isWsl) {
+            const cgroupVersion = await execAsync(`stat -fc %T /sys/fs/cgroup/`)
+
+            if (cgroupVersion && cgroupVersion.includes('cgroup2')) {
+                ctx.cgroupVersion = 'v2'
+
+                cgroupVersionDetected = true
+            } else {
+                const kernelReleaseVersionResult =
+                    ctx.platformVersion.match(/(\d+\.\d+\.\d+)/)
+
+                if (
+                    kernelReleaseVersionResult &&
+                    kernelReleaseVersionResult.length > 0
+                ) {
+                    const kernelVersion = kernelReleaseVersionResult[1]
+
+                    if (semver.satisfies(kernelVersion, '>=6.12.0')) {
+                        ctx.cgroupVersion = 'v2'
+
+                        cgroupVersionDetected = true
+                    } else {
+                        cgroupVersionDetected = true
+                    }
+                }
+            }
+        }
+
+        if (!cgroupVersionDetected) {
+            const dockerSystemVersions = await systemApi.version({
+                formatToJSON: true
+            })
+
+            const kernelReleaseVersionResult =
+                dockerSystemVersions.Server.KernelVersion.match(
+                    /(\d+\.\d+\.\d+)/
+                )
+
+            if (
+                kernelReleaseVersionResult &&
+                kernelReleaseVersionResult.length > 0
+            ) {
+                const kernelVersion = kernelReleaseVersionResult[1]
+
+                if (semver.satisfies(kernelVersion, '>=6.12.0')) {
+                    ctx.cgroupVersion = 'v2'
+                }
+            }
+        }
+
+        task.title = `Using CGroup ${ctx.cgroupVersion}`
+    }
+})
+
+module.exports = checkCGroupVersion

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')
 
@@ -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

@@ -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/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

@@ -17,7 +17,9 @@ const executeInContainer = ({ containerName, command, user }) => {
     const execArgs = execCommand({
         container: containerName,
         command,
-        user
+        user,
+        tty: true,
+        interactive: true
     })
 
     spawn('bash', ['-c', execArgs.join(' ')], {

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.1",
+    "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": "93c885dd9506109a56c5363a22c1eb9a0a234ef4"
+    "gitHead": "ec855efd799e10f263e82b3bf610d400892db6dc"
 }