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

package/lib/tasks/database/create-magento-user.js

@@ -1,4 +1,5 @@
 const mysql2 = require('mysql2/promise')
+const sleep = require('../../util/sleep')
 const defaultMagentoUser = require('./default-magento-user')
 
 /**
@@ -8,12 +9,31 @@ const createMagentoUser = () => ({
     title: 'Creating Magento user',
     task: async (ctx, task) => {
         const { mariadb } = ctx.config.docker.getContainers()
-        const connection = await mysql2.createConnection({
-            host: '127.0.0.1',
-            port: ctx.ports.mariadb,
-            user: 'root',
-            password: mariadb.env.MARIADB_ROOT_PASSWORD
-        })
+
+        /** @type {import('mysql2/promise').Connection | undefined} */
+        let connection
+        const maxTries = 20
+
+        for (let tries = 1; tries <= maxTries; tries++) {
+            try {
+                connection = await mysql2.createConnection({
+                    host: '127.0.0.1',
+                    port: ctx.ports.mariadb,
+                    user: 'root',
+                    password: mariadb.env.MARIADB_ROOT_PASSWORD
+                })
+                break
+            } catch (e) {
+                if (tries === maxTries) {
+                    throw e
+                }
+                await sleep(1000)
+            }
+        }
+
+        if (!connection) {
+            throw new Error('Failed to connect to MariaDB')
+        }
 
         const result = await connection.query(
             'select Host, User from mysql.user;'

package/lib/tasks/database/fix-db.js

@@ -36,11 +36,13 @@ const fixDB = () => ({
                     title: 'Deleting customers data',
                     skip: ({ withCustomersData }) => withCustomersData,
                     task: async (ctx, subTask) => {
-                        const deleteCustomerData = await subTask.prompt({
-                            type: 'Confirm',
-                            message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
+                        const deleteCustomerData = ctx.nonInteractive
+                            ? false
+                            : await subTask.prompt({
+                                  type: 'Confirm',
+                                  message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
 This will reduce database size and remove possible interference for your setup.`
-                        })
+                              })
 
                         if (!deleteCustomerData) {
                             subTask.skip()

package/lib/tasks/database/import-dump-to-database.js

@@ -60,25 +60,27 @@ const runSetGlobalLogBinTrustFunctionCreatorsCommand = () => ({
 const deleteDatabaseBeforeImportingDumpPrompt = () => ({
     title: 'Deleting magento database before importing dump',
     task: async (ctx, task) => {
-        const deleteDatabaseMagentoChoice = await task.prompt({
-            type: 'Select',
-            message: `Before importing database dump, would you like to delete existing database?
+        const deleteDatabaseMagentoChoice = ctx.nonInteractive
+            ? 'delete'
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Before importing database dump, would you like to delete existing database?
 
 It is possible that dump might interfere with existing data in database.
 
 Note that you will lose your existing database!`,
-            choices: [
-                {
-                    name: 'delete',
-                    message: 'YES I WANT TO DELETE magento DATABASE!'
-                },
-                {
-                    name: 'skip',
-                    message:
-                        "NO I DON'T WANT TO DELETE magento DATABASE! (Skip this step)"
-                }
-            ]
-        })
+                  choices: [
+                      {
+                          name: 'delete',
+                          message: 'YES I WANT TO DELETE magento DATABASE!'
+                      },
+                      {
+                          name: 'skip',
+                          message:
+                              "NO I DON'T WANT TO DELETE magento DATABASE! (Skip this step)"
+                      }
+                  ]
+              })
 
         if (deleteDatabaseMagentoChoice === 'delete') {
             await ctx.databaseConnection.query(
@@ -103,22 +105,24 @@ const executeImportDumpSQL = () => ({
         const { mariadb } = docker.getContainers(ports)
         const { binFileName } = overridenConfiguration.configuration.mariadb
 
-        const userCredentialsForMariaDBCLI = await task.prompt({
-            type: 'Select',
-            message: `Which user do you want to use to import db in ${mariadb._} client?`,
-            choices: [
-                {
-                    name: `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`,
-                    message: `root (${logger.style.command(
-                        'Probably safest option'
-                    )})`
-                },
-                {
-                    name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
-                    message: `${defaultMagentoUser.user}`
-                }
-            ]
-        })
+        const userCredentialsForMariaDBCLI = ctx.nonInteractive
+            ? `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Which user do you want to use to import db in ${mariadb._} client?`,
+                  choices: [
+                      {
+                          name: `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`,
+                          message: `root (${logger.style.command(
+                              'Probably safest option'
+                          )})`
+                      },
+                      {
+                          name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
+                          message: `${defaultMagentoUser.user}`
+                      }
+                  ]
+              })
 
         const importCommand = `docker exec ${mariadb.name} bash -c "${binFileName} ${userCredentialsForMariaDBCLI} magento < ./dump.sql"`
 
@@ -137,11 +141,13 @@ const executeImportDumpSQL = () => ({
             })
         } catch (e) {
             if (e.message.includes("Unknown collation: 'utf8mb4_0900_ai_ci'")) {
-                const confirmFixingCollation = await task.prompt({
-                    type: 'Select',
-                    message: `We got the following error while trying to import ${logger.style.file(
-                        'dump.sql'
-                    )}!
+                const confirmFixingCollation = ctx.nonInteractive
+                    ? 'yes'
+                    : await task.prompt({
+                          type: 'Select',
+                          message: `We got the following error while trying to import ${logger.style.file(
+                              'dump.sql'
+                          )}!
 
 ${e.message}
 
@@ -150,18 +156,19 @@ ${logger.style.command(
     "sed -i 's/utf8mb4_0900_ai_ci/utf8mb4_general_ci/g' dump.sql"
 )}
 `,
-                    choices: [
-                        {
-                            name: 'yes',
-                            message:
-                                'Yes, run the following commands, I reaaaalllyy want dump to work! (this will not edit original dump.sql)'
-                        },
-                        {
-                            name: 'no',
-                            message: 'Okay, I got it. Will try to fix myself'
-                        }
-                    ]
-                })
+                          choices: [
+                              {
+                                  name: 'yes',
+                                  message:
+                                      'Yes, run the following commands, I reaaaalllyy want dump to work! (this will not edit original dump.sql)'
+                              },
+                              {
+                                  name: 'no',
+                                  message:
+                                      'Okay, I got it. Will try to fix myself'
+                              }
+                          ]
+                      })
 
                 if (confirmFixingCollation === 'yes') {
                     task.output = 'Running fix command...'

package/lib/tasks/database/import-remote-db/ssh/index.js

@@ -19,11 +19,13 @@ const sshDb = () => ({
         ctx.ssh = ssh
 
         if (!password) {
-            const privateKey = await task.prompt({
-                type: 'Input',
-                message: `Please enter your private key location to connect to ${hostname}\n`,
-                initial: `${os.homedir()}/.ssh/id_rsa`
-            })
+            const privateKey = ctx.nonInteractive
+                ? `${os.homedir()}/.ssh/id_rsa`
+                : await task.prompt({
+                      type: 'Input',
+                      message: `Please enter your private key location to connect to ${hostname}\n`,
+                      initial: `${os.homedir()}/.ssh/id_rsa`
+                  })
 
             if (!(await pathExists(privateKey))) {
                 throw new KnownError(`Private key not found: ${privateKey}`)
@@ -31,11 +33,13 @@ const sshDb = () => ({
 
             ctx.privateKey = privateKey
 
-            const passphrase = await task.prompt({
-                type: 'Input',
-                message:
-                    'Please enter your private key passphrase (if you have it)'
-            })
+            const passphrase = ctx.nonInteractive
+                ? undefined
+                : await task.prompt({
+                      type: 'Input',
+                      message:
+                          'Please enter your private key passphrase (if you have it)'
+                  })
 
             ctx.passphrase = passphrase || undefined
 
@@ -67,14 +71,16 @@ const sshDb = () => ({
         const remoteFiles = remoteFilesOutput.split('\n')
 
         if (dumpFileNames.every((dumpFile) => remoteFiles.includes(dumpFile))) {
-            ctx.makeRemoteDumps = await task.prompt({
-                type: 'Toggle',
-                enabled: 'Yes!',
-                disabled: 'No, just download and import them.',
-                message: `We found dump files on remote server.
+            ctx.makeRemoteDumps = ctx.nonInteractive
+                ? true
+                : await task.prompt({
+                      type: 'Toggle',
+                      enabled: 'Yes!',
+                      disabled: 'No, just download and import them.',
+                      message: `We found dump files on remote server.
   Do you want to replace them with new dump files or use existing ones?
 `
-            })
+                  })
         } else {
             ctx.makeRemoteDumps = true
         }

package/lib/tasks/database/import-remote-db/ssh/regular-server.js

@@ -20,15 +20,17 @@ const regularSSHServer = () => ({
             /**
              * @type {string}
              */
-            const dumpCommand = await task.prompt({
-                type: 'Input',
-                message: `Edit (if needed) command to connect to remote mysql server and create dump files.
+            const dumpCommand = ctx.nonInteractive
+                ? databaseDumpCommandWithOptions.join(' ')
+                : await task.prompt({
+                      type: 'Input',
+                      message: `Edit (if needed) command to connect to remote mysql server and create dump files.
 Do not enter "--result-file" option, we need to control that part.
 
 (documentation reference available here: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html)
 `,
-                initial: databaseDumpCommandWithOptions.join(' ')
-            })
+                      initial: databaseDumpCommandWithOptions.join(' ')
+                  })
 
             if (dumpCommand.includes('--result-file')) {
                 throw new KnownError(

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/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=\\"${

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,9 @@ const executeTask = async (argv) => {
         {
             concurrent: false,
             exitOnError: true,
-            ctx: { throwMagentoVersionMissing: true },
-            renderer: process.stdout.isTTY ? 'default' : 'silent',
+            ctx: { throwMagentoVersionMissing: true, nonInteractive },
+            renderer:
+                nonInteractive || !process.stdout.isTTY ? 'silent' : 'default',
             rendererOptions: { collapse: false, clearOutput: true }
         }
     )
@@ -45,10 +49,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 +77,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 +99,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(
@@ -109,6 +134,21 @@ const executeTask = async (argv) => {
         }
 
         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/import-dump.js

@@ -51,22 +51,24 @@ const importDump = () => ({
                     },
                     task: async (subCtx, subTask) => {
                         const doYouWantToRunSetupOnEmptyDB =
-                            await subTask.prompt({
-                                type: 'Select',
-                                message: `We detected that Magento is not installed in database. Do you want to install Magento in database BEFORE importing database dump?`,
-                                choices: [
-                                    {
-                                        name: 'try-install',
-                                        message:
-                                            'Try installing Magento before importing database'
-                                    },
-                                    {
-                                        name: 'skip',
-                                        message:
-                                            'Skip installing Magento and import database dump right away!'
-                                    }
-                                ]
-                            })
+                            subCtx.nonInteractive
+                                ? 'skip'
+                                : await subTask.prompt({
+                                      type: 'Select',
+                                      message: `We detected that Magento is not installed in database. Do you want to install Magento in database BEFORE importing database dump?`,
+                                      choices: [
+                                          {
+                                              name: 'try-install',
+                                              message:
+                                                  'Try installing Magento before importing database'
+                                          },
+                                          {
+                                              name: 'skip',
+                                              message:
+                                                  'Skip installing Magento and import database dump right away!'
+                                          }
+                                      ]
+                                  })
 
                         if (doYouWantToRunSetupOnEmptyDB === 'skip') {
                             subTask.skip()

package/lib/tasks/magento/enable-magento-composer-plugins.js

@@ -180,16 +180,18 @@ const enableMagentoComposerPlugins = () => ({
                 })
             }
 
-            const answerForEnablingPlugins = await task.prompt({
-                type: 'Select',
-                message: `Composer 2.2 requires manually allowing composer-plugins to run.
+            const answerForEnablingPlugins = ctx.nonInteractive
+                ? 'all-individual'
+                : await task.prompt({
+                      type: 'Select',
+                      message: `Composer 2.2 requires manually allowing composer-plugins to run.
 Magento requires the following plugins to correctly operate:
 
 ${missingPluginsFromAllowPlugins.map((p) => logger.style.code(p)).join('\n')}
 
 Do you want to enable them all or disable some of them?`,
-                choices: pluginOptions
-            })
+                      choices: pluginOptions
+                  })
 
             switch (answerForEnablingPlugins.toLowerCase()) {
                 case 'all': {

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

@@ -22,21 +22,23 @@ const indexProducts = () => ({
             ({ status }) => status !== 'valid'
         )
 
-        const doYouWantToSkipIndexingPart = await task.prompt({
-            type: 'Select',
-            message: `Do you want to index the products? (There are ${invalidIndexers.length} invalid indexers, total indexers: ${data[0].length})\n`,
-            choices: [
-                {
-                    name: 'index',
-                    message: 'Yes, index them please'
-                },
-                {
-                    name: 'skip',
-                    message:
-                        'Skip, do not index them. I will do it later myself'
-                }
-            ]
-        })
+        const doYouWantToSkipIndexingPart = ctx.nonInteractive
+            ? 'index'
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Do you want to index the products? (There are ${invalidIndexers.length} invalid indexers, total indexers: ${data[0].length})\n`,
+                  choices: [
+                      {
+                          name: 'index',
+                          message: 'Yes, index them please'
+                      },
+                      {
+                          name: 'skip',
+                          message:
+                              'Skip, do not index them. I will do it later myself'
+                      }
+                  ]
+              })
 
         if (doYouWantToSkipIndexingPart === 'skip') {
             task.skip()

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',