@scandipwa/magento-scripts 2.4.5 → 2.4.6

package/lib/config/docker.js

@@ -9,6 +9,14 @@ const defaultEsEnv = require('./services/elasticsearch/default-es-env')
 const logger = require('@scandipwa/scandipwa-dev-utils/logger')
 const defaultMagentoUser = require('../tasks/database/default-magento-user')
 const defaultOsEnv = require('./services/opensearch/default-os-env')
+const { getArchSync } = require('../util/arch')
+
+const rosettaTranslatedContainers =
+    os.platform() === 'darwin' &&
+    getArchSync() === 'arm64' &&
+    process.env.CMA_USE_AMD64_CONTAINERS
+        ? process.env.CMA_USE_AMD64_CONTAINERS.split(',')
+        : []
 
 /**
  * @param {Partial<Record<'rw' | 'ro' | 'cached', boolean>>} directives
@@ -115,7 +123,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[], serviceReadyLog?: 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, platform?: string }>}
          */
         const dockerConfig = {
             php: {
@@ -168,7 +176,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     !isDockerDesktop
                         ? `${os.userInfo().uid}:${os.userInfo().gid}`
                         : '',
-                serviceReadyLog: 'ready to handle connections'
+                serviceReadyLog: 'ready to handle connections',
+                platform: rosettaTranslatedContainers.includes('php')
+                    ? 'linux/amd64'
+                    : undefined
             },
             phpWithXdebug: {
                 _: 'PHP with Xdebug',
@@ -226,7 +237,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     !isDockerDesktop
                         ? `${os.userInfo().uid}:${os.userInfo().gid}`
                         : '',
-                serviceReadyLog: 'ready to handle connections'
+                serviceReadyLog: 'ready to handle connections',
+                platform: rosettaTranslatedContainers.includes('php')
+                    ? 'linux/amd64'
+                    : undefined
             },
             sslTerminator: {
                 _: 'SSL Terminator (Nginx)',
@@ -270,7 +284,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 }`,
                 name: `${prefix}_ssl-terminator`,
                 command: "nginx -g 'daemon off;'",
-                dependsOn: ['nginx']
+                dependsOn: ['nginx'],
+                platform: rosettaTranslatedContainers.includes('nginx')
+                    ? 'linux/amd64'
+                    : undefined
             },
             nginx: {
                 _: 'Nginx',
@@ -319,7 +336,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 }`,
                 name: `${prefix}_nginx`,
                 command: "nginx -g 'daemon off;'",
-                dependsOn: ['php', 'phpWithXdebug']
+                dependsOn: ['php', 'phpWithXdebug'],
+                platform: rosettaTranslatedContainers.includes('nginx')
+                    ? 'linux/amd64'
+                    : undefined
             },
             redis: {
                 _: 'Redis',
@@ -335,7 +355,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 }`,
                 name: `${prefix}_redis`,
                 connectCommand: ['redis-cli'],
-                serviceReadyLog: 'Ready to accept connections'
+                serviceReadyLog: 'Ready to accept connections',
+                platform: rosettaTranslatedContainers.includes('redis')
+                    ? 'linux/amd64'
+                    : undefined
             },
             mariadb: {
                 _: 'MariaDB',
@@ -376,7 +399,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     defaultMagentoUser.user
                 )} with password ${logger.style.command(
                     defaultMagentoUser.password
-                )}`
+                )}`,
+                platform: rosettaTranslatedContainers.includes('mariadb')
+                    ? 'linux/amd64'
+                    : undefined
             },
             elasticsearch: {
                 _:
@@ -419,7 +445,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                             : elasticsearch.image
                         : opensearch.image
                 }`,
-                name: `${prefix}_${searchengine}`
+                name: `${prefix}_${searchengine}`,
+                platform: rosettaTranslatedContainers.includes(searchengine)
+                    ? 'linux/amd64'
+                    : undefined
             },
             maildev: {
                 _: 'MailDev',
@@ -462,7 +491,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     cmd: `wget -O - http://127.0.0.1:${
                         isDockerDesktop ? '1080' : ports.maildevWeb
                     }/healthz || exit 1`
-                }
+                },
+                platform: rosettaTranslatedContainers.includes('maildev')
+                    ? 'linux/amd64'
+                    : undefined
             }
         }
 
@@ -515,7 +547,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 description: `Varnish HealthCheck status: ${logger.style.command(
                     varnish.healthCheck ? 'enabled' : 'disabled'
                 )}`,
-                dependsOn: ['nginx']
+                dependsOn: ['nginx'],
+                platform: rosettaTranslatedContainers.includes('varnish')
+                    ? 'linux/amd64'
+                    : undefined
             }
 
             dockerConfig.sslTerminator.dependsOn.push('varnish')
@@ -527,7 +562,10 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ports: [],
                 name: `${prefix}_newrelic-php-daemon`,
                 network: isDockerDesktop ? network.name : 'host',
-                image: 'newrelic/php-daemon'
+                image: 'newrelic/php-daemon',
+                platform: rosettaTranslatedContainers.includes('newrelic')
+                    ? 'linux/amd64'
+                    : undefined
             }
         }
 

package/lib/tasks/docker/containers/container-api.d.ts

@@ -161,6 +161,11 @@ export interface ContainerRunOptions {
      * Memory option [docs](https://docs.docker.com/engine/reference/commandline/run/#memory)
      */
     memory?: string
+
+    /**
+     * Platform option [docs](https://docs.docker.com/engine/reference/commandline/run/#platform)
+     */
+    platform?: string
 }
 
 export function run<T>(

package/lib/tasks/docker/containers/container-api.js

@@ -26,7 +26,8 @@ const runCommand = (options) => {
         rm = false,
         tty = false,
         user,
-        memory
+        memory,
+        platform
     } = options
 
     const detachArg = (detach && '-d') || ''
@@ -49,7 +50,14 @@ const runCommand = (options) => {
         ''
     const envArgs = !env
         ? ''
-        : Object.entries(env).map(([key, value]) => `--env=${key}='${value}'`)
+        : Object.entries(env).map(
+              ([key, value]) =>
+                  `--env=${key}=${
+                      typeof value === 'string'
+                          ? value.replaceAll(' ', '\\ ')
+                          : value
+                  }`
+          )
     const nameArg = (name && `--name=${name}`) || ''
     const entrypointArg = (entrypoint && `--entrypoint="${entrypoint}"`) || ''
     const healthCheckArg =
@@ -67,6 +75,7 @@ const runCommand = (options) => {
     const userArg = (user && `--user=${user}`) || ''
     const addHostArg = (addHost && `--add-host=${addHost}`) || ''
     const memoryArg = (memory && `--memory=${memory}`) || ''
+    const platformArg = (platform && `--platform=${platform}`) || ''
 
     const dockerCommand = [
         'docker',
@@ -89,6 +98,7 @@ const runCommand = (options) => {
         userArg,
         addHostArg,
         memoryArg,
+        platformArg,
         image,
         command
     ]
@@ -113,7 +123,10 @@ const execCommand = (options) => {
     const envArgs = !env
         ? ''
         : Object.entries(env)
-              .map(([key, value]) => `--env ${key}='${value}'`)
+              .map(
+                  ([key, value]) =>
+                      `--env ${key}=${value.replaceAll(' ', '\\ ')}`
+              )
               .join(' ')
     const ttyArg = tty ? '--tty' : ''
     const userArg = user ? `--user=${user}` : ''

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

@@ -5,7 +5,14 @@ const { execAsyncSpawn } = require('../../util/exec-async-command')
 const KnownError = require('../../errors/known-error')
 const { runContainerImage } = require('../../util/run-container-image')
 const { imageApi } = require('./image')
-
+const { getArchSync } = require('../../util/arch')
+
+const rosettaTranslatedContainers =
+    os.platform() === 'darwin' &&
+    getArchSync() === 'arm64' &&
+    process.env.CMA_USE_AMD64_CONTAINERS
+        ? process.env.CMA_USE_AMD64_CONTAINERS.split(',')
+        : []
 /**
  * Get enabled extensions list with versions
  * @param {string} imageWithTag
@@ -297,13 +304,17 @@ const buildDebugDockerFileInstructions = async (ctx, { image, tag }) => {
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const buildProjectImage = () => ({
-    title: 'Building Project Images',
+    title: rosettaTranslatedContainers.includes('php')
+        ? 'Building Project Images (for x86)'
+        : 'Building Project Images',
     task: async (ctx, task) => {
         const containers = ctx.config.docker.getContainers(ctx.ports)
 
         return task.newListr([
             {
-                title: 'Building PHP image',
+                title: rosettaTranslatedContainers.includes('php')
+                    ? 'Building PHP image (for x86)'
+                    : 'Building PHP image',
                 task: async () => {
                     const [image, tag = 'latest'] =
                         ctx.config.overridenConfiguration.configuration.php.baseImage.split(
@@ -318,7 +329,11 @@ const buildProjectImage = () => ({
 
                     try {
                         await execAsyncSpawn(
-                            `docker build -t ${containers.php.image} -<<EOF
+                            `docker build -t ${containers.php.image}${
+                                rosettaTranslatedContainers.includes('php')
+                                    ? ' --platform linux/amd64'
+                                    : ''
+                            } -<<EOF
 ${dockerFileInstructions}
 EOF`,
                             {
@@ -337,7 +352,9 @@ EOF`,
                 }
             },
             {
-                title: 'Building PHP with XDebug image',
+                title: rosettaTranslatedContainers.includes('php')
+                    ? 'Building PHP with XDebug image (for x86)'
+                    : 'Building PHP with XDebug image',
                 task: async () => {
                     const [phpImage, phpTag] = containers.php.image.split(':')
                     const debugImageInstructions =
@@ -348,7 +365,11 @@ EOF`,
 
                     try {
                         await execAsyncSpawn(
-                            `docker build -t ${containers.phpWithXdebug.image} -<<EOF
+                            `docker build -t ${containers.phpWithXdebug.image}${
+                                rosettaTranslatedContainers.includes('php')
+                                    ? ' --platform linux/amd64'
+                                    : ''
+                            } -<<EOF
 ${debugImageInstructions}
 EOF`,
                             {

package/lib/tasks/file-system/create-git-hook-notification.js

@@ -1,58 +1,92 @@
 const path = require('path')
 const fs = require('fs')
 const UnknownError = require('../../errors/unknown-error')
-const setConfigFile = require('../../util/set-config')
 const { execAsyncSpawn } = require('../../util/exec-async-command')
+const pathExists = require('../../util/path-exists')
+
+/**
+ * @param {string} p
+ */
+function isExec(p) {
+    try {
+        fs.accessSync(p, fs.constants.X_OK)
+        return true
+    } catch (e) {
+        return false
+    }
+}
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createGitHookNotification = () => ({
-    title: 'Setting git hook notification',
-    task: async (ctx) => {
+    title: 'Setting Git Hook Notification',
+    task: async (ctx, task) => {
         const gitHookTemplatePath = path.join(
             ctx.config.baseConfig.templateDir,
             'git-postcheckout-hook.template'
         )
 
-        const gitRoot = await execAsyncSpawn('git rev-parse --show-toplevel')
+        const [gitRootResult, currentGitHookPathResult] = await Promise.all([
+            execAsyncSpawn('git rev-parse --show-toplevel', {
+                withCode: true
+            }),
+            execAsyncSpawn(`git config --get core.hooksPath`, {
+                withCode: true
+            })
+        ])
 
-        let currentGitHookPath = await execAsyncSpawn(
-            `git config --get core.hooksPath`
-        )
+        if (gitRootResult.code !== 0) {
+            throw new UnknownError(
+                `Unexpected error accrued during git hook notification creation\n\n${gitRootResult.result}`
+            )
+        }
 
-        if (!currentGitHookPath.trim()) {
-            await execAsyncSpawn(`git config core.hooksPath .git/hooks`)
+        const tasks = []
 
-            currentGitHookPath = '.git/hooks'
+        if (!currentGitHookPathResult.result.trim()) {
+            tasks.push({
+                title: 'Setting Git Hook Path',
+                task: async () => {
+                    await execAsyncSpawn(
+                        `git config core.hooksPath .git/hooks`,
+                        {
+                            withCode: true
+                        }
+                    )
+
+                    currentGitHookPathResult.result = '.git/hooks'
+                }
+            })
         }
 
         const gitHookPath = path.join(
-            gitRoot,
-            currentGitHookPath,
+            gitRootResult.result,
+            currentGitHookPathResult.result.trim(),
             'post-checkout'
         )
 
-        try {
-            await setConfigFile({
-                configPathname: gitHookPath,
-                template: gitHookTemplatePath,
-                overwrite: false
-            })
-        } catch (e) {
-            throw new UnknownError(
-                `Unexpected error accrued during git hook notification creation\n\n${e}`
-            )
-        }
+        tasks.push({
+            title: 'Copying Git Hook Template',
+            skip: async () => !(await pathExists(gitHookPath)),
+            task: async () => {
+                await fs.promises.cp(gitHookTemplatePath, gitHookPath)
+            }
+        })
 
-        // check if gitHookPath is executable
-        const isExecutable = await fs.promises.stat(gitHookPath)
-        if (isExecutable.mode & 0o111) {
-            return
-        }
+        tasks.push({
+            title: 'Making Git Hook Executable',
+            skip: () => isExec(gitHookPath),
+            task: async () => {
+                await execAsyncSpawn(`chmod +x ${gitHookPath}`, {
+                    withCode: true
+                })
+            }
+        })
 
-        await execAsyncSpawn(`chmod +x ${gitHookPath}`)
-    }
+        return task.newListr(tasks)
+    },
+    exitOnError: false
 })
 
 module.exports = createGitHookNotification

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.5",
+    "version": "2.4.6",
     "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": "1251d345bd3105a6ce83dd6041c05dad345ba9b7"
+    "gitHead": "0a31342676df9251f4fcf01a3c628bd048788228"
 }

package/typings/context.d.ts

@@ -119,6 +119,7 @@ export interface ListrContext {
                     connectCommand: string[]
                     dependsOn?: string[]
                     serviceReadyLog?: string
+                    platform?: string
                 }
             >
         }