@scandipwa/magento-scripts 2.4.10-alpha.0 → 2.4.11

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

@@ -70,10 +70,10 @@ export interface ContainerExecOptions {
     interactive?: boolean
 }
 
-export function exec<T>(
+export function exec<T extends boolean = false>(
     options: ContainerExecOptions,
     execOptions?: ExecAsyncSpawnOptions<T>
-): Promise<string>
+): Promise<T extends true ? { code: number; result: string } : string>
 
 export function execCommand(options: ContainerExecOptions): string[]
 
@@ -168,10 +168,10 @@ export interface ContainerRunOptions {
     platform?: string
 }
 
-export function run<T>(
+export function run<T extends boolean = false>(
     containerOptions: ContainerRunOptions,
     execOptions?: ExecAsyncSpawnOptions<T>
-): Promise<string>
+): Promise<T extends true ? { code: number; result: string } : string>
 
 export function runCommand(options: ContainerRunOptions): string[]
 

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

@@ -16,9 +16,9 @@ const transformEnvValue = (value) => {
 
     for (const [key, val] of Object.entries(value)) {
         if (typeof val === 'string' && val) {
-            envArguments.push(`--env ${key}='${val.replaceAll("'", "\\'")}'`)
+            envArguments.push(`--env=${key}='${val.replaceAll("'", "\\'")}'`)
         } else if (String(val)) {
-            envArguments.push(`--env ${key}=${val}`)
+            envArguments.push(`--env=${key}=${val}`)
         }
     }
 

package/lib/tasks/docker/containers/tasks.js

@@ -16,23 +16,28 @@ const stopAndRemoveContainers = async (containers) => {
 }
 
 /**
- * @param {string} image
- */
-const pull = async (image) => execAsyncSpawn(`docker pull ${image}`)
-
-/**
- * @param {string[]} acc
- * @param {{ remoteImages?: string[], image: string }} val
+ * @param {{ image: string, platform?: string }[]} acc
+ * @param {{ remoteImages?: string[], image: string, platform?: string }} val
  */
 const remoteImageReducer = (acc, val) => {
     if (
         Array.isArray(val.remoteImages) &&
         val.remoteImages.every((image) => typeof image === 'string')
     ) {
-        return acc.concat(val.remoteImages)
+        return acc.concat(
+            val.remoteImages.map((image) => ({
+                image,
+                platform: val.platform
+            }))
+        )
     }
 
-    return acc.concat([val.image])
+    return acc.concat([
+        {
+            image: val.image,
+            platform: val.platform
+        }
+    ])
 }
 
 /**
@@ -59,10 +64,10 @@ const pullImages = () => ({
                 containers
                     .filter(filterNonPullableImages)
                     .reduce(remoteImageReducer, [])
-                    .map((image) => {
+                    .map(({ image, platform }) => {
                         const [repo, tag = 'latest'] = image.split(':')
 
-                        return { repo, tag }
+                        return { repo, tag, platform }
                     })
                     .reduce(
                         (acc, val) =>
@@ -76,11 +81,15 @@ const pullImages = () => ({
                             ),
                         []
                     )
-                    .map(({ repo, tag }) => ({
+                    .map(({ repo, tag, platform }) => ({
                         title: `Pulling ${logger.style.file(
                             `${repo}:${tag}`
                         )} image`,
-                        task: () => pull(`${repo}:${tag}`)
+                        task: () =>
+                            imageApi.pull({
+                                image: `${repo}:${tag}`,
+                                platform
+                            })
                     })),
                 {
                     concurrent: true,
@@ -92,7 +101,7 @@ const pullImages = () => ({
         const imagesFilter = containers
             .filter(filterNonPullableImages)
             .reduce(remoteImageReducer, [])
-            .map((image) => `reference='${image}'`)
+            .map(({ image }) => `reference='${image}'`)
 
         const existingImages = await imageApi.ls({
             formatToJSON: true,
@@ -102,10 +111,10 @@ const pullImages = () => ({
         const missingContainerImages = containers
             .filter(filterNonPullableImages)
             .reduce(remoteImageReducer, [])
-            .map((image) => {
+            .map(({ image, platform }) => {
                 const [repo, tag = 'latest'] = image.split(':')
 
-                return { repo, tag }
+                return { repo, tag, platform }
             })
             .filter(
                 ({ repo, tag }) =>
@@ -132,9 +141,13 @@ const pullImages = () => ({
         }
 
         return task.newListr(
-            missingContainerImages.map(({ repo, tag }) => ({
+            missingContainerImages.map(({ repo, tag, platform }) => ({
                 title: `Pulling ${logger.style.file(`${repo}:${tag}`)} image`,
-                task: () => pull(`${repo}:${tag}`)
+                task: () =>
+                    imageApi.pull({
+                        image: `${repo}:${tag}`,
+                        platform
+                    })
             })),
             {
                 concurrent: true,

package/lib/tasks/docker/image/image-api.d.ts

@@ -75,3 +75,15 @@ export function inspect(
     options?: ImagesInspectOptions<true>,
     execOptions?: ExecAsyncSpawnOptions<false>
 ): Promise<ImagesInspectResult>
+
+export interface ImagesPullOptions {
+    image: string
+    allTags?: boolean
+    platform?: string
+    quiet?: boolean
+}
+
+export function pull(
+    options?: ImagesPullOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>

package/lib/tasks/docker/image/image-api.js

@@ -78,7 +78,28 @@ const inspect = async (options, execOptions = {}) => {
     return execAsyncSpawn(`docker image inspect ${args}`, execOptions)
 }
 
+/**
+ * @param {import('./image-api').ImagesPullOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const pull = async (options, execOptions = {}) => {
+    const { image, allTags, platform, quiet } = options
+
+    const allTagsArg = typeof allTags === 'boolean' ? '--all-tags' : ''
+    const platformArg =
+        typeof platform === 'string' ? `--platform=${platform}` : ''
+
+    const quietArg = typeof quiet === 'boolean' ? '--quiet' : ''
+
+    const args = [allTagsArg, platformArg, quietArg, image]
+        .filter(Boolean)
+        .join(' ')
+
+    return execAsyncSpawn(`docker image pull ${args}`, execOptions)
+}
+
 module.exports = {
     ls,
-    inspect
+    inspect,
+    pull
 }

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

@@ -223,11 +223,13 @@ const buildDockerFileInstructions = async (
         const { agentVersion, licenseKey } = newRelic
 
         // eslint-disable-next-line max-len
+        // Use linux-musl archive for Alpine-based images.
+        const newRelicArchive = `newrelic-php5-${agentVersion}-linux-musl`
         dockerFileInstructions.run('apk add --no-cache gcompat')
-            .run(`curl -L https://download.newrelic.com/php_agent/archive/${agentVersion}/newrelic-php5-${agentVersion}-linux.tar.gz | tar -C /tmp -zx \
+            .run(`curl -L https://download.newrelic.com/php_agent/archive/${agentVersion}/${newRelicArchive}.tar.gz | tar -C /tmp -zx \
 && export NR_INSTALL_USE_CP_NOT_LN=1 \
 && export NR_INSTALL_SILENT=1 \
-&& /tmp/newrelic-php5-${agentVersion}-linux/newrelic-install install \
+&& /tmp/${newRelicArchive}/newrelic-install install \
 && rm -rf /tmp/newrelic-php5-* /tmp/nrinstall*`)
             .run(`sed -i -e "s/REPLACE_WITH_REAL_KEY/${licenseKey}/" \
 -e "s/newrelic.appname[[:space:]]=[[:space:]].*/newrelic.appname=\\"${
@@ -302,17 +304,25 @@ const buildDebugDockerFileInstructions = async (ctx, { image, tag }) => {
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const buildProjectImage = () => ({
-    title: rosettaTranslatedContainers.includes('php')
-        ? 'Building Project Images (for x86)'
-        : 'Building Project Images',
+    title: 'Building Project Images',
     task: async (ctx, task) => {
         const containers = ctx.config.docker.getContainers(ctx.ports)
+        const isUsingLinuxAmd64Platform =
+            rosettaTranslatedContainers.includes('php') ||
+            containers.php.platform === 'linux/amd64'
+
+        if (isUsingLinuxAmd64Platform) {
+            task.title = 'Building Project Images (for x86)'
+        } else if (
+            containers.php.platform &&
+            containers.php.platform !== 'linux/amd64'
+        ) {
+            task.title = `Building Project Images (for ${containers.php.platform})`
+        }
 
         return task.newListr([
             {
-                title: rosettaTranslatedContainers.includes('php')
-                    ? 'Building PHP image (for x86)'
-                    : 'Building PHP image',
+                title: 'Building PHP image',
                 task: async () => {
                     const [image, tag = 'latest'] =
                         ctx.config.overridenConfiguration.configuration.php.baseImage.split(
@@ -328,8 +338,10 @@ const buildProjectImage = () => ({
                     try {
                         await execAsyncSpawn(
                             `docker build -t ${containers.php.image}${
-                                rosettaTranslatedContainers.includes('php')
+                                isUsingLinuxAmd64Platform
                                     ? ' --platform linux/amd64'
+                                    : containers.php.platform
+                                    ? ` --platform ${containers.php.platform}`
                                     : ''
                             } -<<EOF
 ${dockerFileInstructions}
@@ -350,9 +362,7 @@ EOF`,
                 }
             },
             {
-                title: rosettaTranslatedContainers.includes('php')
-                    ? 'Building PHP with XDebug image (for x86)'
-                    : 'Building PHP with XDebug image',
+                title: 'Building PHP with XDebug image',
                 task: async () => {
                     const [phpImage, phpTag] = containers.php.image.split(':')
                     const debugImageInstructions =
@@ -364,8 +374,10 @@ EOF`,
                     try {
                         await execAsyncSpawn(
                             `docker build -t ${containers.phpWithXdebug.image}${
-                                rosettaTranslatedContainers.includes('php')
+                                isUsingLinuxAmd64Platform
                                     ? ' --platform linux/amd64'
+                                    : containers.php.platform
+                                    ? ` --platform ${containers.php.platform}`
                                     : ''
                             } -<<EOF
 ${debugImageInstructions}

package/lib/tasks/execute.js

@@ -8,7 +8,9 @@ const { getCachedPorts } = require('../config/get-port-config')
 const checkPHPVersion = require('./requirements/php-version')
 const {
     executeInContainer,
-    runInContainer
+    executeInContainerNonInteractive,
+    runInContainer,
+    runInContainerNonInteractive
 } = require('../util/execute-in-container')
 const { containerApi } = require('./docker/containers')
 const dockerNetwork = require('./docker/network')
@@ -17,10 +19,11 @@ const { prepareFileSystem } = require('./file-system')
 
 /**
  *
- * @param {{ containerName: string, commands: string[] }} argv
+ * @param {{ containerName: string, commands: string[], nonInteractive?: boolean }} argv
  * @returns
  */
 const executeTask = async (argv) => {
+    const { nonInteractive = false } = argv
     const tasks = new Listr(
         [
             checkRequirements(),
@@ -35,8 +38,12 @@ const executeTask = async (argv) => {
         {
             concurrent: false,
             exitOnError: true,
-            ctx: { throwMagentoVersionMissing: true },
-            renderer: process.stdout.isTTY ? 'default' : 'silent',
+            ctx: /** @type {any} */ ({ throwMagentoVersionMissing: true }),
+            renderer: nonInteractive
+                ? 'silent'
+                : process.stdout.isTTY
+                ? 'default'
+                : 'silent',
             rendererOptions: { collapse: false, clearOutput: true }
         }
     )
@@ -45,10 +52,12 @@ const executeTask = async (argv) => {
     try {
         ctx = await tasks.run()
     } catch (e) {
-        logger.error(e.message || e)
+        logger.error(e instanceof Error ? e.message : String(e))
         process.exit(1)
     }
-    const containers = ctx.config.docker.getContainers(ctx.ports)
+    const containers = /** @type {Record<string, any>} */ (
+        ctx.config.docker.getContainers(ctx.ports)
+    )
     const services = Object.keys(containers)
 
     if (
@@ -71,6 +80,11 @@ const executeTask = async (argv) => {
                 ? containerResult[1]
                 : containerResult
 
+        if (nonInteractive && argv.commands.length === 0) {
+            logger.error('Non-interactive mode requires a command to execute')
+            process.exit(1)
+        }
+
         if (argv.commands.length === 0) {
             // if we have default connect command then use it
             if (container.connectCommand) {
@@ -88,6 +102,20 @@ const executeTask = async (argv) => {
         })
 
         if (containerList.length > 0) {
+            if (nonInteractive) {
+                const result = await executeInContainerNonInteractive({
+                    containerName: container.name,
+                    commands: argv.commands,
+                    user: container.user,
+                    env: container.execCommandEnv
+                })
+
+                if (result.result) {
+                    process.stdout.write(`${result.result}\n`)
+                }
+                process.exit(result.code)
+            }
+
             if (process.stdout.isTTY) {
                 logger.logN(
                     `Executing container ${logger.style.misc(
@@ -101,13 +129,29 @@ const executeTask = async (argv) => {
             const result = executeInContainer({
                 containerName: container.name,
                 commands: argv.commands,
-                user: container.user
+                user: container.user,
+                env: container.execCommandEnv
             })
 
             return result
         }
 
         if (container.name.includes('php')) {
+            if (nonInteractive) {
+                const result = await runInContainerNonInteractive(
+                    {
+                        ...container,
+                        name: `${container.name}_exec-${Date.now()}`
+                    },
+                    argv.commands
+                )
+
+                if (result.result) {
+                    process.stdout.write(`${result.result}\n`)
+                }
+                process.exit(result.code)
+            }
+
             if (process.stdout.isTTY) {
                 logger.logN(
                     `Starting container ${logger.style.misc(

package/lib/tasks/magento/setup-magento/clear-logs.js

@@ -0,0 +1,31 @@
+const fs = require('fs')
+const path = require('path')
+const pathExists = require('../../../util/path-exists')
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const clearLogs = () => ({
+    title: 'Clearing Magento logs',
+    task: async (ctx, task) => {
+        let deletedLogsCount = 0
+        await Promise.all(
+            [
+                './var/log/system.log',
+                './var/log/debug.log',
+                './var/log/xdebug.log'
+            ].map(async (logPath) => {
+                if (await pathExists(path.join(process.cwd(), logPath))) {
+                    await fs.promises.rm(path.join(process.cwd(), logPath))
+                    deletedLogsCount++
+                }
+            })
+        )
+
+        if (deletedLogsCount === 0) {
+            task.skip()
+        }
+    }
+})
+
+module.exports = clearLogs

package/lib/tasks/magento/setup-magento/disable-2fa.js

@@ -1,6 +1,7 @@
 const configPhpToJson = require('../../../util/config-php-json')
 const getJsonfileData = require('../../../util/get-jsonfile-data')
 const path = require('path')
+const semver = require('semver')
 const composerTask = require('../../../util/composer-task')
 const magentoTask = require('../../../util/magento-task')
 
@@ -9,6 +10,18 @@ const magentoTask = require('../../../util/magento-task')
  */
 module.exports = () => ({
     title: 'Disabling 2FA module',
+    // this module is only for magento 2.4 or newer
+    skip: (ctx) => {
+        const { magentoVersion } = ctx
+
+        const pureMagentoVersion = magentoVersion.match(
+            /^([0-9]+\.[0-9]+\.[0-9]+)/
+        )[1]
+
+        const isMagento24 = semver.satisfies(pureMagentoVersion, '>=2.4.0')
+
+        return !isMagento24
+    },
     task: async (ctx, task) => {
         // Check if MarkShust module is already installed via composer.lock
         const composerLockPath = path.join(

package/lib/tasks/magento/setup-magento/index.js

@@ -26,7 +26,21 @@ const setupMagento = (options = {}) => ({
         if (options.onlyInstallMagento) {
             return task.newListr([
                 flushRedisConfig(),
-                migrateDatabase({ onlyInstallMagento: true })
+                migrateDatabase({ onlyInstallMagento: true }),
+                {
+                    title: 'Disabling Magento caches',
+                    task: (ctx, task) => {
+                        const { varnish } =
+                            ctx.config.overridenConfiguration.configuration
+                        return task.newListr(
+                            magentoTask(
+                                `cache:disable block_html layout${
+                                    !varnish.enabled ? ' full_page' : ''
+                                }`
+                            )
+                        )
+                    }
+                }
             ])
         }
 
@@ -35,6 +49,20 @@ const setupMagento = (options = {}) => ({
                 setupMagentoFilePermissions(),
                 updateEnvPHP(),
                 migrateDatabase(),
+                {
+                    title: 'Disabling Magento caches',
+                    task: (ctx, task) => {
+                        const { varnish } =
+                            ctx.config.overridenConfiguration.configuration
+                        return task.newListr(
+                            magentoTask(
+                                `cache:disable block_html layout${
+                                    !varnish.enabled ? ' full_page' : ''
+                                }`
+                            )
+                        )
+                    }
+                },
                 flushRedisConfig(),
                 {
                     title: 'Configuring Magento settings',

package/lib/tasks/magento/setup-magento/set-base-url.js

@@ -5,9 +5,10 @@ const KnownError = require('../../../errors/known-error')
  * @param {number} scopeId
  * @param {string} code
  * @param {string} host
+ * @param {'websites' | 'stores'} scopeType
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
-const setBaseUrlForScope = (scopeId, code, host) => ({
+const setBaseUrlForScope = (scopeId, code, host, scopeType) => ({
     title: `store code ${code} at ${host}`,
     task: async (ctx, task) => {
         const {
@@ -31,7 +32,7 @@ const setBaseUrlForScope = (scopeId, code, host) => ({
         const secureLocation = `${host}/` // SSL will work only on port 443, so you cannot run multiple projects with SSL at the same time.
         const httpUrl = `http://${location}`
         const httpsUrl = `https://${secureLocation}`
-        const scope = scopeId === 0 ? 'default' : 'websites'
+        const scope = scopeId === 0 ? 'default' : scopeType
         const table = 'core_config_data'
         const values = [
             {
@@ -83,11 +84,13 @@ const setBaseUrl = () => ({
     task: async (ctx, task) => {
         const {
             config: {
-                overridenConfiguration: { ssl, storeDomains }
+                overridenConfiguration: { ssl, storeDomains, configuration }
             },
             databaseConnection
         } = ctx
 
+        const runType = configuration?.nginx?.runType || 'website'
+
         const enableSecureFrontend = ssl.enabled ? '1' : '0'
 
         await updateTableValues(
@@ -110,27 +113,33 @@ const setBaseUrl = () => ({
             { databaseConnection, task }
         )
 
-        /** @type {{ website_id: number, code: string }[][]}} */
-        const [storeWebsites] = await databaseConnection.query(
-            `select * from store_website;`
+        const scopeType = runType === 'store' ? 'stores' : 'websites'
+        const tableName = runType === 'store' ? 'store' : 'store_website'
+        const idField = runType === 'store' ? 'store_id' : 'website_id'
+
+        const [entities] = await databaseConnection.query(
+            `select * from ${tableName};`
         )
 
-        if (!storeWebsites || storeWebsites.length === 0) {
+        if (!entities || entities.length === 0) {
             throw new KnownError(
-                `No store websites found in database, store_website table is empty or does not exist`
+                `No ${
+                    runType === 'store' ? 'stores' : 'store websites'
+                } found in database, ${tableName} table is empty or does not exist`
             )
         }
 
         const storeDomainsWithMapping = Object.entries(storeDomains).reduce(
             (acc, [key, val]) => {
-                const storeWebsite = storeWebsites.find(
-                    ({ code }) => code === key
+                const entity = entities.find(
+                    /** @param {{ code: string }} entity */
+                    (entity) => entity.code === key
                 )
-                if (storeWebsite) {
+                if (entity) {
                     return {
                         ...acc,
-                        [storeWebsite.code]: {
-                            websiteId: storeWebsite.website_id,
+                        [entity.code]: {
+                            scopeId: entity[idField],
                             domain: val
                         }
                     }
@@ -141,10 +150,28 @@ const setBaseUrl = () => ({
             {}
         )
 
+        // Check for missing store codes when runType is 'store'
+        if (runType === 'store') {
+            const missingCodes = Object.keys(storeDomains).filter(
+                (code) =>
+                    !entities.some(
+                        /** @param {{ code: string }} entity */
+                        (entity) => entity.code === code
+                    )
+            )
+            if (missingCodes.length > 0) {
+                throw new KnownError(
+                    `Store codes not found in database: ${missingCodes.join(
+                        ', '
+                    )}. Please check your storeDomains configuration in cma.js matches the store codes in the store table.`
+                )
+            }
+        }
+
         return task.newListr(
             Object.entries(storeDomainsWithMapping).map(
-                ([storeCode, { websiteId, domain }]) =>
-                    setBaseUrlForScope(websiteId, storeCode, domain)
+                ([storeCode, { scopeId, domain }]) =>
+                    setBaseUrlForScope(scopeId, storeCode, domain, scopeType)
             ),
             {
                 concurrent: true,