@scandipwa/magento-scripts 2.4.9 → 2.4.10

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,

package/lib/tasks/magento/setup-magento/urn-highlighter.js

@@ -8,8 +8,8 @@ const pathExists = require('../../../util/path-exists')
  *
  * @reference https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-urn.html
  */
-const urnHighlighter = () => ({
-    title: 'Generating URN highlighter',
+const urnHighlighterForPHPStorm = () => ({
+    title: 'Generating URN highlighter for PHPStorm',
     task: async (ctx, task) => {
         if (!(await pathExists(path.join(process.cwd(), './.idea')))) {
             await fs.promises.mkdir(path.join(process.cwd(), './.idea'))
@@ -26,4 +26,86 @@ const urnHighlighter = () => ({
     }
 })
 
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const vscodeSettingsXmlCatalogs = () => ({
+    task: async (ctx, task) => {
+        const settingsPath = path.join(process.cwd(), './.vscode/settings.json')
+        const catalogEntry = './.vscode/catalog.xml'
+
+        let settings = {}
+        if (await pathExists(settingsPath)) {
+            try {
+                const content = await fs.promises.readFile(settingsPath, 'utf8')
+                settings = JSON.parse(content)
+            } catch {
+                // If the file is not valid JSON, we'll overwrite the xml.catalogs key only
+            }
+        }
+
+        const existing = settings['xml.catalogs']
+        /** @type {string[]} */
+        const catalogs = Array.isArray(existing) ? existing : []
+
+        if (catalogs.includes(catalogEntry)) {
+            task.skip()
+            return
+        }
+
+        settings['xml.catalogs'] = [...catalogs, catalogEntry]
+        await fs.promises.writeFile(
+            settingsPath,
+            JSON.stringify(settings, null, 4),
+            'utf8'
+        )
+    }
+})
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ *
+ * @reference https://www.thebeardeddeveloper.co.uk/resources/articles/vscode-xml-autocomplete-for-magento
+ */
+const urnHighlighterForVSCode = () => ({
+    title: 'Generating URN highlighter for VSCode',
+    task: async (ctx, task) => {
+        if (!(await pathExists(path.join(process.cwd(), './.vscode')))) {
+            await fs.promises.mkdir(path.join(process.cwd(), './.vscode'))
+        }
+
+        const subtasks = []
+
+        if (
+            !(await pathExists(
+                path.join(process.cwd(), './.vscode/catalog.xml')
+            ))
+        ) {
+            subtasks.push(
+                magentoTask(
+                    'dev:urn-catalog:generate --ide=vscode ./.vscode/catalog.xml'
+                )
+            )
+        }
+
+        subtasks.push(vscodeSettingsXmlCatalogs())
+
+        return task.newListr(subtasks)
+    }
+})
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const urnHighlighter = () => ({
+    title: 'Generating URN highlighter',
+    task: (ctx, task) =>
+        task.newListr(
+            [urnHighlighterForPHPStorm(), urnHighlighterForVSCode()],
+            {
+                concurrent: true
+            }
+        )
+})
+
 module.exports = urnHighlighter

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

@@ -92,10 +92,32 @@ const checkSearchEngineVersion = () => ({
                 }
             )
         } else {
+            /** @param {string} line */
+            const legacyMatcher = (line) => {
+                if (!line.startsWith('[')) {
+                    return false
+                }
+                try {
+                    const message = line.replaceAll(/\[[\s\S]+\]/g, '').trim()
+
+                    return message.startsWith('started')
+                } catch {
+                    return false
+                }
+            }
+
             await waitForLogs({
                 containerName: elasticsearch.name,
-                matchText:
-                    searchengine === 'elasticsearch' ? '"started"' : '] started'
+                customLineParser: (line) => {
+                    try {
+                        const logObject = JSON.parse(line)
+
+                        return logObject.message.startsWith('started')
+                    } catch {
+                        return legacyMatcher(line)
+                    }
+                },
+                successOnTimeout: true
             })
 
             try {

package/lib/tasks/start.js

@@ -27,7 +27,7 @@ const getIsWsl = require('../util/is-wsl')
 const checkForXDGOpen = require('../util/xdg-open-exists')
 const {
     getInstanceMetadata,
-    constants: { WEB_LOCATION_TITLE }
+    constants: { WEB_ADMIN_LOCATION_TITLE }
 } = require('../util/instance-metadata')
 const waitingForVarnish = require('./magento/setup-magento/waiting-for-varnish')
 const checkPHPVersion = require('./requirements/php-version')
@@ -38,6 +38,7 @@ const { setProjectConfigTask } = require('./project-config')
 const {
     convertComposerHomeToComposerCacheVolume
 } = require('./docker/convert-composer-home-to-composer-cache-volume')
+const clearLogs = require('./magento/setup-magento/clear-logs')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -148,7 +149,7 @@ const finishProjectConfiguration = () => ({
     title: 'Finishing project configuration',
     skip: ({ skipSetup }) => Boolean(skipSetup),
     task: (ctx, task) =>
-        task.newListr([setupThemes(), waitingForVarnish()], {
+        task.newListr([setupThemes(), waitingForVarnish(), clearLogs()], {
             rendererOptions: {
                 collapse: false
             }
@@ -191,9 +192,12 @@ const start = () => ({
                     },
                     task: (ctx) => {
                         const instanceMetadata = getInstanceMetadata(ctx)
-                        const locationOnTheWeb = instanceMetadata.frontend.find(
-                            ({ title }) => title === WEB_LOCATION_TITLE
-                        )
+                        const locationOnTheWeb =
+                            instanceMetadata.frontend[0] ||
+                            instanceMetadata.admin.find(
+                                (u) => u.title === WEB_ADMIN_LOCATION_TITLE
+                            )
+
                         if (locationOnTheWeb) {
                             openBrowser(locationOnTheWeb.text)
                         }

package/lib/util/config-file-validator.js

@@ -101,7 +101,8 @@ const phpConfigurationSchema = Joi.object({
     extensions: phpExtensionConfiguration.optional(),
     env: Joi.object()
         .pattern(Joi.string(), [Joi.string(), Joi.number()])
-        .optional()
+        .optional(),
+    platform: Joi.string().optional()
 })
 
 /**
@@ -109,7 +110,9 @@ const phpConfigurationSchema = Joi.object({
  */
 const nginxConfigurationSchema = Joi.object({
     image: Joi.string().optional(),
-    configTemplate: Joi.string().optional().custom(fileExistsValidator)
+    configTemplate: Joi.string().optional().custom(fileExistsValidator),
+    platform: Joi.string().optional(),
+    runType: Joi.string().valid('website', 'store').optional()
 })
 
 /**
@@ -119,14 +122,16 @@ const varnishConfigurationSchema = Joi.object({
     enabled: Joi.boolean().optional(),
     healthCheck: Joi.boolean().optional(),
     image: Joi.string().optional(),
-    configTemplate: Joi.string().optional().custom(fileExistsValidator)
+    configTemplate: Joi.string().optional().custom(fileExistsValidator),
+    platform: Joi.string().optional()
 })
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ServiceWithImage>}
  */
 const serviceConfigurationSchema = Joi.object({
-    image: Joi.string().optional()
+    image: Joi.string().optional(),
+    platform: Joi.string().optional()
 })
 
 /**
@@ -136,7 +141,8 @@ const mariadbConfigurationSchema = Joi.object({
     image: Joi.string().optional(),
     useOptimizerSwitch: Joi.alternatives()
         .try(Joi.string(), Joi.boolean())
-        .optional()
+        .optional(),
+    platform: Joi.string().optional()
 })
 
 /**
@@ -144,12 +150,14 @@ const mariadbConfigurationSchema = Joi.object({
  */
 const elasticsearchConfigurationSchema = Joi.object({
     image: Joi.string().optional(),
-    env: Joi.object().optional()
+    env: Joi.object().optional(),
+    platform: Joi.string().optional()
 })
 
 const opensearchConfigurationSchema = Joi.object({
     image: Joi.string().optional(),
-    env: Joi.object().optional()
+    env: Joi.object().optional(),
+    platform: Joi.string().optional()
 })
 
 const searchEngineConfiguration = Joi.string().valid(

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

@@ -2,9 +2,9 @@ const { spawn } = require('child_process')
 const { execCommand, run } = require('../tasks/docker/containers/container-api')
 
 /**
- * @param {{ containerName: string, commands: string[], user?: string }} param0
+ * @param {{ containerName: string, commands: string[], user?: string, env?: Record<string, string> }} param0
  */
-const executeInContainer = ({ containerName, commands, user }) => {
+const executeInContainer = ({ containerName, commands, user, env }) => {
     if (!process.stdin.isTTY) {
         process.stderr.write('This app works only in TTY mode')
         process.exit(1)
@@ -16,7 +16,8 @@ const executeInContainer = ({ containerName, commands, user }) => {
         command: commandBin,
         user,
         tty: true,
-        interactive: true
+        interactive: true,
+        env: env || {}
     })
     const [command, ...args] = execArgs
 

package/lib/util/instance-metadata.js

@@ -24,7 +24,11 @@ const getInstanceMetadata = (ctx) => {
         ports,
         config: {
             magentoConfiguration,
-            overridenConfiguration: { ssl, storeDomains }
+            overridenConfiguration: {
+                ssl,
+                storeDomains,
+                magento: { adminuri }
+            }
         }
     } = ctx
 
@@ -66,14 +70,16 @@ const getInstanceMetadata = (ctx) => {
         })
     }
 
-    const webLocation = frontend.find((u) => u.title === WEB_LOCATION_TITLE)
-
-    if (webLocation) {
-        admin.push({
-            title: WEB_ADMIN_LOCATION_TITLE,
-            text: logger.style.link(`${webLocation.text}admin`)
-        })
-    }
+    admin.push({
+        title: WEB_ADMIN_LOCATION_TITLE,
+        text: logger.style.link(
+            `${ssl.enabled ? 'https' : 'http'}://${storeDomains.admin}${
+                ssl.enabled || ports.sslTerminator === 80
+                    ? ''
+                    : `:${ports.sslTerminator}`
+            }/${adminuri}/`
+        )
+    })
 
     admin.push({
         title: WEB_ADMIN_CREDENTIALS_TITLE,

package/lib/util/open-browser.js

@@ -1,11 +1,18 @@
 const { execAsync } = require('./exec-async')
 
+const isCMANoOpen =
+    process.env.CMA_NO_OPEN === '1' || process.env.CMA_NO_OPEN === 'true'
+
 // eslint-disable-next-line no-control-regex
 const consoleStyleReplacer = /[\u001b]\[\S+?m/g
 /**
  * @param {string} url
  */
 const openBrowser = async (url) => {
+    if (isCMANoOpen) {
+        return
+    }
+
     const start = process.platform === 'darwin' ? 'open' : 'xdg-open'
 
     await execAsync(`${start} ${url.replace(consoleStyleReplacer, '')}`)

package/lib/util/wait-for-logs.js

@@ -2,10 +2,16 @@ const { execAsyncSpawn } = require('./exec-async-command')
 const sleep = require('./sleep')
 
 /**
- * @param {{ containerName: string, timeout?: number, matchText: string }} param0
+ * @param {{ containerName: string, timeout?: number, matchText?: string | string[], customLineParser?: (line: string) => boolean, successOnTimeout?: boolean }} param0
  * @returns {Promise<void>}
  */
-const waitForLogs = ({ containerName, timeout = 30 * 1000, matchText }) =>
+const waitForLogs = ({
+    containerName,
+    timeout = 30 * 1000,
+    successOnTimeout = false,
+    matchText,
+    customLineParser
+}) =>
     // eslint-disable-next-line no-async-promise-executor
     new Promise(async (resolve, reject) => {
         let matched = false
@@ -26,9 +32,22 @@ const waitForLogs = ({ containerName, timeout = 30 * 1000, matchText }) =>
                     }
 
                     result.split('\n').forEach((line) => {
-                        if (line.includes(matchText)) {
-                            matched = true
-                            resolve()
+                        if (customLineParser) {
+                            if (customLineParser(line)) {
+                                matched = true
+                                resolve()
+                            }
+                        } else if (matchText) {
+                            if (
+                                Array.isArray(matchText)
+                                    ? matchText.some((text) =>
+                                          line.includes(text)
+                                      )
+                                    : line.includes(matchText)
+                            ) {
+                                matched = true
+                                resolve()
+                            }
                         }
                     })
 
@@ -40,8 +59,10 @@ const waitForLogs = ({ containerName, timeout = 30 * 1000, matchText }) =>
             })
         ])
 
-        if (timeoutExceeded) {
+        if (timeoutExceeded && !successOnTimeout) {
             reject(new Error('Timeout exception'))
+        } else {
+            resolve()
         }
     })
 

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.9",
+    "version": "2.4.10",
     "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": "84df2774959c2bac35204a36d92383b82dfd54b0"
+    "gitHead": "c901bd4d25f0e127f9fc286ba979e49d2a145757"
 }

package/typings/context.d.ts

@@ -67,15 +67,16 @@ export interface ListrContext {
     edition?: 'community' | 'enterprise'
     config: {
         php: {
+            iniPath: string
             iniTemplatePath: string
             fpmConfPath: string
             fpmTemplatePath: string
             debugIniPath: string
             debugTemplatePath: string
             debugFpmConfPath: string
-            debugFpmTemplatePath: string
             extensions: PHPExtensions
-            version: string
+            env: Record<string, unknown>
+            platform?: 'linux/amd64' | 'linux/arm64' | (string & {})
         }
         composer: {
             dirPath: string
@@ -120,6 +121,7 @@ export interface ListrContext {
                     dependsOn?: string[]
                     serviceReadyLog?: string
                     platform?: string
+                    execCommandEnv?: Record<string, string>
                 }
             >
         }

package/typings/index.d.ts

@@ -14,6 +14,11 @@ export interface ServiceWithImage {
      * Service Docker image
      */
     image: string
+
+    /**
+     * Service platform
+     */
+    platform?: 'linux/amd64' | 'linux/arm64' | (string & {})
 }
 
 export interface ServiceWithoutImage {
@@ -21,6 +26,11 @@ export interface ServiceWithoutImage {
      * Service Docker image
      */
     image: string
+
+    /**
+     * Service platform
+     */
+    platform?: 'linux/amd64' | 'linux/arm64' | (string & {})
 }
 
 export interface MariaDBConfiguration extends ServiceWithImage {
@@ -58,6 +68,13 @@ export interface NginxConfiguration extends ServiceWithImage {
      * @example ./my-nginx-config.conf
      */
     configTemplate: string
+
+    /**
+     * Magento run type for nginx configuration
+     *
+     * @default 'website'
+     */
+    runType?: 'website' | 'store' | (string & {})
 }
 
 export interface ElasticSearchConfiguration extends ServiceWithImage {
@@ -228,6 +245,11 @@ export interface PHPConfiguration {
      * Environmental variables used for PHP container
      */
     env: Record<string, unknown>
+
+    /**
+     * Service platform
+     */
+    platform?: 'linux/amd64' | 'linux/arm64' | (string & {})
 }
 export interface SSLConfiguration {
     /**

package/lib/config/services/elasticsearch/base-repo.js

@@ -1,3 +0,0 @@
-module.exports = {
-    repo: 'ghcr.io/scandipwa/create-magento-app'
-}