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

package/lib/config/docker.js

@@ -73,11 +73,11 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         redis: {
             name: `${prefix}_redis-data`
         },
-        elasticsearch: {
-            name: `${prefix}_elasticsearch-data`
-        },
         opensearch: {
-            name: `${prefix}_opensearch-data`
+            name:
+                searchengine === 'elasticsearch'
+                    ? `${prefix}_elasticsearch-data`
+                    : `${prefix}_opensearch-data`
         },
         maildev: {
             name: `${prefix}_maildev-data`
@@ -394,15 +394,13 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ports: [`127.0.0.1:${ports.elasticsearch}:9200`],
                 forwardedPorts: [`127.0.0.1:${ports.elasticsearch}:9200`],
                 mountVolumes: [
-                    searchengine === 'elasticsearch'
-                        ? containerVolume({
-                              source: volumes.elasticsearch.name,
-                              target: '/usr/share/elasticsearch/data'
-                          })
-                        : containerVolume({
-                              source: volumes.opensearch.name,
-                              target: '/usr/share/opensearch/data'
-                          })
+                    containerVolume({
+                        source: volumes.opensearch.name,
+                        target:
+                            searchengine === 'elasticsearch'
+                                ? '/usr/share/elasticsearch/data'
+                                : '/usr/share/opensearch/data'
+                    })
                 ],
                 env:
                     searchengine === 'elasticsearch'
@@ -426,9 +424,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                             : elasticsearch.image
                         : opensearch.image
                 }`,
-                name: `${prefix}_${searchengine}`,
-                serviceReadyLog:
-                    searchengine === 'elasticsearch' ? '"started"' : '] started'
+                name: `${prefix}_${searchengine}`
             },
             maildev: {
                 _: 'MailDev',
@@ -450,7 +446,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 mountVolumes: [
                     containerVolume({
                         source: volumes.maildev.name,
-                        target: '/tmp/maildev'
+                        target: '/tmp'
                     })
                 ],
                 env: {
@@ -460,7 +456,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     MAILDEV_WEB_PORT: isDockerDesktop
                         ? '1080'
                         : ports.maildevWeb,
-                    MAILDEV_MAIL_DIRECTORY: '/tmp/maildev'
+                    MAILDEV_MAIL_DIRECTORY: '/tmp'
                 },
                 name: `${prefix}_maildev`,
                 network: isDockerDesktop ? network.name : 'host',

package/lib/tasks/docker/convert-mysql-to-mariadb.js

@@ -24,7 +24,7 @@ const { createCacheFolder } = require('../cache')
 const { getSystemConfigTask } = require('../../config/system-config')
 const sleep = require('../../util/sleep')
 const { setProjectConfigTask } = require('../project-config')
-const checkElasticSearchVersion = require('../requirements/elasticsearch-version')
+const checkSearchEngineVersion = require('../requirements/searchengine-version')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -235,23 +235,13 @@ Please wait, this will take some time and do not restart the MySQL container unt
                     dockerNetwork.tasks.createNetwork(),
                     createVolumes(),
                     buildProjectImage(),
-                    {
-                        task: (ctx, subTask) =>
-                            subTask.newListr(
-                                [
-                                    checkPHPVersion(),
-                                    checkElasticSearchVersion()
-                                ],
-                                {
-                                    concurrent: true
-                                }
-                            )
-                    },
+                    checkPHPVersion(),
                     getComposerVersionTask(),
                     prepareFileSystem(),
                     installMagentoProject(),
                     enableMagentoComposerPlugins(),
                     startServices(),
+                    checkSearchEngineVersion(),
                     connectToDatabase(),
                     importDumpToDatabase(),
                     {

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

@@ -316,9 +316,11 @@ const buildProjectImage = () => ({
 ${dockerFileInstructions}
 EOF`,
                             {
-                                callback: (r) => {
-                                    task.output = r
-                                }
+                                callback: !ctx.verbose
+                                    ? undefined
+                                    : (t) => {
+                                          task.output = t
+                                      }
                             }
                         )
                     } catch (e) {
@@ -344,9 +346,11 @@ EOF`,
 ${debugImageInstructions}
 EOF`,
                             {
-                                callback: (r) => {
-                                    task.output = r
-                                }
+                                callback: !ctx.verbose
+                                    ? undefined
+                                    : (t) => {
+                                          task.output = t
+                                      }
                             }
                         )
                     } catch (e) {

package/lib/tasks/magento/setup-magento/configure-searchengine.js

@@ -167,6 +167,8 @@ const configureElasticSearchInDatabase = () => ({
                 }
             }
         )
+
+        task.title = `Using Elasticsearch ${ctx.elasticSearchVersion}`
     }
 })
 
@@ -356,6 +358,8 @@ const configureOpenSearchInDatabase = () => ({
                 }
             }
         )
+
+        task.title = `Using OpenSearch ${ctx.openSearchVersion}`
     }
 })
 

package/lib/tasks/magento/setup-magento/enable-full-page-cache-with-varnish.js

@@ -0,0 +1,30 @@
+const envPhpToJson = require('../../../util/env-php-json')
+const magentoTask = require('../../../util/magento-task')
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const enableFullPageCacheWithVarnish = () => ({
+    skip: (ctx) => {
+        const { varnish } = ctx.config.overridenConfiguration.configuration
+
+        return !varnish.enabled
+    },
+    task: async (ctx, task) => {
+        const envData = await envPhpToJson(ctx)
+        if (
+            envData &&
+            envData.cache_types &&
+            typeof envData.cache_types.full_page === 'number' &&
+            envData.cache_types.full_page !== 1
+        ) {
+            task.title =
+                'Enabling full_page cache in Magento (Varnish is enabled)'
+            return task.newListr(magentoTask('cache:enable full_page'))
+        }
+
+        task.skip()
+    }
+})
+
+module.exports = enableFullPageCacheWithVarnish

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

@@ -1,16 +1,14 @@
 const flushRedisConfig = require('./flush-redis-config')
-const waitingForRedis = require('./waiting-for-redis')
 const migrateDatabase = require('./migrate-database')
 const createAdmin = require('./create-admin')
 const setDeploymentMode = require('./set-deployment-mode')
 const setBaseUrl = require('./set-base-url')
 const disableMaintenanceMode = require('./disable-maintenance-mode')
-const disable2fa = require('./disable-2fa')
 const setUrlRewrite = require('./set-url-rewrite')
 const increaseAdminSessionLifetime = require('./increase-admin-session-lifetime')
 const magentoTask = require('../../../util/magento-task')
 const urnHighlighter = require('./urn-highlighter')
-const adjustFullPageCache = require('./adjust-full-page-cache')
+const enableFullPageCacheWithVarnish = require('./enable-full-page-cache-with-varnish')
 const updateEnvPHP = require('../../php/update-env-php')
 const setMailConfig = require('./set-mail-config')
 const { setupMagentoFilePermissions } = require('./setup-file-permissions')
@@ -27,14 +25,12 @@ const setupMagento = (options = {}) => ({
         if (options.onlyInstallMagento) {
             return task.newListr([
                 flushRedisConfig(),
-                waitingForRedis(),
                 migrateDatabase({ onlyInstallMagento: true })
             ])
         }
 
         return task.newListr(
             [
-                waitingForRedis(),
                 setupMagentoFilePermissions(),
                 updateEnvPHP(),
                 migrateDatabase(),
@@ -60,9 +56,8 @@ const setupMagento = (options = {}) => ({
                 createAdmin(),
                 setDeploymentMode(),
                 disableMaintenanceMode(),
-                disable2fa(),
                 urnHighlighter(),
-                adjustFullPageCache(),
+                enableFullPageCacheWithVarnish(),
                 magentoTask('cache:flush')
             ],
             {

package/lib/tasks/magento/setup-magento/migrate-database.js

@@ -9,6 +9,7 @@ const varnishConfigSetup = require('./varnish-config')
 const pathExists = require('../../../util/path-exists')
 const updateEnvPHP = require('../../php/update-env-php')
 const UnknownError = require('../../../errors/unknown-error')
+const checkSearchEngineVersion = require('../../requirements/searchengine-version')
 
 /**
  * @param {Object} [options]
@@ -19,6 +20,7 @@ const migrateDatabase = (options = {}) => ({
     title: 'Migrating database',
     task: async (ctx, task) => {
         const { databaseConnection } = ctx
+        const { varnish } = ctx.config.overridenConfiguration.configuration
 
         const [[{ tableCount }]] = await databaseConnection.query(`
             SELECT count(*) AS tableCount
@@ -44,12 +46,17 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr(
                 [
+                    checkSearchEngineVersion(),
                     installMagento({ isDbEmpty: true }),
                     updateEnvPHP(),
                     varnishConfigSetup(),
                     configureSearchEngine(),
                     upgradeMagento(),
-                    magentoTask('cache:enable')
+                    magentoTask(
+                        `cache:disable block_html layout${
+                            !varnish.enabled ? ' full_page' : ''
+                        }`
+                    )
                 ],
                 {
                     concurrent: false,
@@ -75,7 +82,11 @@ const migrateDatabase = (options = {}) => ({
                 ctx.isSetupUpgradeNeeded = false
                 // no setup is needed, but still to be sure configure ES
                 return task.newListr(
-                    [varnishConfigSetup(), configureSearchEngine()],
+                    [
+                        checkSearchEngineVersion(),
+                        varnishConfigSetup(),
+                        configureSearchEngine()
+                    ],
                     {
                         concurrent: false,
                         exitOnError: true,
@@ -90,6 +101,7 @@ const migrateDatabase = (options = {}) => ({
                 if (options.onlyInstallMagento) {
                     ctx.isSetupUpgradeNeeded = false
                     return task.newListr([
+                        checkSearchEngineVersion(),
                         installMagentoProject(),
                         installMagento()
                     ])
@@ -97,13 +109,18 @@ const migrateDatabase = (options = {}) => ({
 
                 return task.newListr(
                     [
+                        checkSearchEngineVersion(),
                         installMagentoProject(),
                         installMagento(),
                         updateEnvPHP(),
                         varnishConfigSetup(),
                         configureSearchEngine(),
                         upgradeMagento(),
-                        magentoTask('cache:enable')
+                        magentoTask(
+                            `cache:disable block_html layout${
+                                !varnish.enabled ? ' full_page' : ''
+                            }`
+                        )
                     ],
                     {
                         concurrent: false,
@@ -118,6 +135,7 @@ const migrateDatabase = (options = {}) => ({
             case 2: {
                 return task.newListr(
                     [
+                        checkSearchEngineVersion(),
                         varnishConfigSetup(),
                         configureSearchEngine(),
                         upgradeMagento()

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

@@ -1,18 +1,70 @@
-const checkElasticSearchVersion = require('./elasticsearch-version')
-const checkOpenSearchVersion = require('./opensearch-version')
+const { request } = require('smol-request')
+const UnknownError = require('../../errors/unknown-error')
+const waitForLogs = require('../../util/wait-for-logs')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkSearchEngineVersion = () => ({
     task: async (ctx, task) => {
-        const { searchengine = 'elasticsearch' } =
-            ctx.config.overridenConfiguration.configuration
-        if (searchengine === 'opensearch') {
-            return task.newListr(checkOpenSearchVersion())
-        }
+        const {
+            ports,
+            config: {
+                overridenConfiguration: {
+                    configuration: { searchengine }
+                }
+            }
+        } = ctx
+
+        const { elasticsearch } = ctx.config.docker.getContainers(ports)
+
+        await waitForLogs({
+            containerName: elasticsearch.name,
+            matchText:
+                searchengine === 'elasticsearch' ? '"started"' : '] started'
+        })
 
-        return task.newListr(checkElasticSearchVersion())
+        try {
+            const response = await request(
+                `http://localhost:${ports.elasticsearch}/`,
+                {
+                    method: 'GET',
+                    responseType: 'json'
+                }
+            )
+
+            if (response.status !== 200) {
+                if (
+                    ctx.config.overridenConfiguration.configuration
+                        .searchengine === 'opensearch'
+                ) {
+                    throw new UnknownError(
+                        `OpenSearch container is not running!\n\nStatus code: ${response.status}, Response: ${response.data.message}`
+                    )
+                } else {
+                    throw new UnknownError(
+                        `ElasticSearch container is not running!\n\nStatus code: ${response.status}, Response: ${response.data.message}`
+                    )
+                }
+            }
+
+            const searchEngineVersion = response.data.version.number
+            if (searchengine === 'elasticsearch') {
+                ctx.elasticSearchVersion = searchEngineVersion
+            } else {
+                ctx.openSearchVersion = searchEngineVersion
+            }
+        } catch (e) {
+            if (searchengine === 'opensearch') {
+                throw new UnknownError(
+                    `Cannot connect to OpenSearch container!\n\n${e.message}`
+                )
+            } else {
+                throw new UnknownError(
+                    `Cannot connect to ElasticSearch container!\n\n${e.message}`
+                )
+            }
+        }
     }
 })
 

package/lib/tasks/start.js

@@ -38,7 +38,6 @@ const { setProjectConfigTask } = require('./project-config')
 const {
     convertComposerHomeToComposerCacheVolume
 } = require('./docker/convert-composer-home-to-composer-cache-volume')
-const checkSearchEngineVersion = require('./requirements/searchengine-version')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -129,15 +128,7 @@ const configureProject = () => ({
                         { concurrent: true }
                     )
             },
-            {
-                task: (ctx, subTask) =>
-                    subTask.newListr(
-                        [checkPHPVersion(), checkSearchEngineVersion()],
-                        {
-                            concurrent: true
-                        }
-                    )
-            },
+            checkPHPVersion(),
             buildProjectImage(),
             getComposerVersionTask(),
             prepareFileSystem(),

package/lib/tasks/theme/link-theme.js

@@ -1,6 +1,6 @@
 const symlinkTheme = require('./symlink-theme')
 const installTheme = require('./install-theme')
-const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache')
+const enableFullPageCacheWithVarnish = require('../magento/setup-magento/enable-full-page-cache-with-varnish')
 const disablePageBuilder = require('../magento/setup-magento/disable-page-builder')
 const buildTheme = require('./build-theme')
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento')
@@ -55,7 +55,7 @@ const linkTheme = () => ({
             installTheme(theme),
             updateEnvPHP(),
             upgradeMagento(),
-            adjustFullPageCache(),
+            enableFullPageCacheWithVarnish(),
             ...(isPageBuilderInstalled && Number(isPagebuilderEnabled)
                 ? [disablePageBuilder()]
                 : []),

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.2-alpha.1",
+    "version": "2.4.2-alpha.2",
     "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": "96732295d12ac0fc5cf37a70aaeec93fb85503d7"
+    "gitHead": "3b0fbecf1e4a2ac197e21a53b5433cafeb81eaae"
 }

package/lib/tasks/magento/setup-magento/adjust-full-page-cache.js

@@ -1,42 +0,0 @@
-const envPhpToJson = require('../../../util/env-php-json')
-const magentoTask = require('../../../util/magento-task')
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const disableFullPageCache = () => ({
-    title: 'Adjusting full_page cache setting',
-    task: async (ctx, task) => {
-        const envData = await envPhpToJson(ctx)
-        if (
-            envData &&
-            envData.cache_types &&
-            typeof envData.cache_types.full_page === 'number'
-        ) {
-            if (
-                envData.cache_types.full_page !== 0 &&
-                !ctx.config.overridenConfiguration.configuration.varnish.enabled
-            ) {
-                task.title = 'Disabling full_page cache in Magento'
-                return task.newListr(magentoTask('cache:disable full_page'))
-            }
-
-            if (
-                ctx.config.overridenConfiguration.configuration.varnish
-                    .enabled &&
-                envData.cache_types.full_page !== 1
-            ) {
-                task.title =
-                    'Enabling full_page cache in Magento (Varnish is enabled)'
-                return task.newListr(magentoTask('cache:enable full_page'))
-            }
-        } else {
-            task.skip('full_page cache type is not set in env.php')
-            return
-        }
-
-        task.skip()
-    }
-})
-
-module.exports = disableFullPageCache

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

@@ -1,87 +0,0 @@
-const { getPort } = require('../../config/port-config')
-const KnownError = require('../../errors/known-error')
-const UnknownError = require('../../errors/unknown-error')
-const { containerApi } = require('../docker/containers')
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const checkElasticSearchVersion = () => ({
-    title: 'Checking container ElasticSearch version',
-    task: async (ctx, task) => {
-        const { elasticsearch } =
-            ctx.config.overridenConfiguration.configuration
-        const { ports } = ctx
-
-        const { elasticsearch: elasticSearchContainer } =
-            ctx.config.docker.getContainers(ports)
-
-        let elasticSearchVersionResponse
-
-        const elasticSearchContainerRunning = await containerApi.ls({
-            filter: `name=${elasticSearchContainer.name}`,
-            formatToJSON: true
-        })
-
-        if (
-            elasticSearchContainerRunning.length !== 0 &&
-            elasticSearchContainerRunning[0].State === 'running'
-        ) {
-            elasticSearchVersionResponse = await containerApi.exec({
-                command: 'elasticsearch --version',
-                container: elasticSearchContainer.name
-            })
-        } else {
-            try {
-                const availableElasticSearchPort = await getPort(
-                    ports.elasticsearch
-                )
-                elasticSearchVersionResponse = await containerApi.run({
-                    ...elasticsearch,
-                    command: 'elasticsearch --version',
-                    detach: false,
-                    rm: true,
-                    ports: [`127.0.0.1:${availableElasticSearchPort}:9200`],
-                    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)
-
-        if (
-            elasticSearchVersionResponseResult &&
-            elasticSearchVersionResponseResult.length > 0
-        ) {
-            const elasticSearchVersion = elasticSearchVersionResponseResult[1]
-
-            ctx.elasticSearchVersion = elasticSearchVersion
-            task.title = `Using ElasticSearch version ${elasticSearchVersion} in container`
-        } else {
-            throw new UnknownError(
-                `Cannot retrieve ElasticSearch Version!\n\n${elasticSearchVersionResponse}`
-            )
-        }
-    }
-})
-
-module.exports = checkElasticSearchVersion

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

@@ -1,71 +0,0 @@
-const { getPort } = require('../../config/port-config')
-const UnknownError = require('../../errors/unknown-error')
-const { containerApi } = require('../docker/containers')
-
-/**
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const checkOpenSearchVersion = () => ({
-    title: 'Checking container OpenSearch version',
-    task: async (ctx, task) => {
-        const { opensearch } = ctx.config.overridenConfiguration.configuration
-        const { ports } = ctx
-
-        const { elasticsearch: openSearchContainer } =
-            ctx.config.docker.getContainers(ports)
-
-        let openSearchVersionResponse
-
-        const openSearchContainerRunning = await containerApi.ls({
-            filter: `name=${openSearchContainer.name}`,
-            formatToJSON: true
-        })
-
-        if (
-            openSearchContainerRunning.length !== 0 &&
-            openSearchContainerRunning[0].State === 'running'
-        ) {
-            openSearchVersionResponse = await containerApi.exec({
-                command: 'opensearch --version',
-                container: openSearchContainer.name
-            })
-        } else {
-            try {
-                const availableOpenSearchPort = await getPort(
-                    ports.elasticsearch
-                )
-                openSearchVersionResponse = await containerApi.run({
-                    ...opensearch,
-                    command: 'opensearch --version',
-                    detach: false,
-                    rm: true,
-                    ports: [`127.0.0.1:${availableOpenSearchPort}:9200`],
-                    memory: '2gb'
-                })
-            } catch (e) {
-                openSearchVersionResponse = e.message
-            }
-        }
-
-        const openSearchVersionResponseResult = openSearchVersionResponse.match(
-            /Version:\s(\d+\.\d+\.\d+)/i
-        )
-
-        if (
-            openSearchVersionResponseResult &&
-            openSearchVersionResponseResult.length > 0
-        ) {
-            const openSearchVersion = openSearchVersionResponseResult[1]
-
-            ctx.openSearchVersion = openSearchVersion
-            task.title = `Using OpenSearch version ${openSearchVersion} in container`
-        } else {
-            throw new UnknownError(
-                `Cannot retrieve OpenSearch Version!\n\n${openSearchVersionResponse}`
-            )
-        }
-    },
-    exitOnError: false
-})
-
-module.exports = checkOpenSearchVersion