@scandipwa/magento-scripts 2.1.1 → 2.1.3

package/lib/commands/status.js

@@ -9,6 +9,7 @@ const { statusContainers } = require('../tasks/docker/containers')
 const getProjectConfiguration = require('../config/get-project-configuration')
 const checkConfigurationFile = require('../config/check-configuration-file')
 const checkPHPVersion = require('../tasks/requirements/php-version')
+const checkElasticSearchVersion = require('../tasks/requirements/elasticsearch-version')
 const { getComposerVersionTask } = require('../tasks/composer')
 const { systemApi } = require('../tasks/docker/system')
 
@@ -35,6 +36,7 @@ module.exports = (yargs) => {
                                 [
                                     checkPHPVersion(),
                                     getComposerVersionTask(),
+                                    checkElasticSearchVersion(),
                                     {
                                         title: 'Retrieving Docker System data',
                                         task: async (ctx) => {

package/lib/config/scandipwa-versions.js

@@ -10,7 +10,8 @@ const scandipwaMagentoVersionMapping = {
     '2.4.1': '3.2.0 - 4.2.1',
     '2.4.2': '4.3.0 - 5.0.3',
     '2.4.3': '5.0.4 - 5.2.7',
-    '2.4.4': '5.3.0+'
+    '2.4.4': '5.3.0+',
+    '2.4.6': '6.2.0+'
 }
 
 module.exports = scandipwaMagentoVersionMapping

package/lib/config/services/elasticsearch/versions/elasticsearch-8.5.js

@@ -0,0 +1,11 @@
+const defaultEnv = require('../default-es-env')
+
+/**
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
+ */
+const elasticsearch85 = () => ({
+    image: 'elasticsearch:8.5.3',
+    env: defaultEnv
+})
+
+module.exports = elasticsearch85

package/lib/config/services/elasticsearch/versions/index.js

@@ -7,6 +7,7 @@ const elasticsearch712 = require('./elasticsearch-7.12')
 const elasticsearch716 = require('./elasticsearch-7.16')
 const elasticsearch717 = require('./elasticsearch-7.17')
 const elasticsearch84 = require('./elasticsearch-8.4')
+const elasticsearch85 = require('./elasticsearch-8.5')
 
 module.exports = {
     elasticsearch68,
@@ -17,5 +18,6 @@ module.exports = {
     elasticsearch712,
     elasticsearch716,
     elasticsearch717,
-    elasticsearch84
+    elasticsearch84,
+    elasticsearch85
 }

package/lib/config/services/varnish/index.js

@@ -2,5 +2,6 @@ module.exports = {
     varnish60: require('./varnish-6-0'),
     varnish66: require('./varnish-6-6'),
     varnish70: require('./varnish-7-0'),
-    varnish71: require('./varnish-7-1')
+    varnish71: require('./varnish-7-1'),
+    varnish73: require('./varnish-7-3')
 }

package/lib/config/services/varnish/varnish-7-3.js

@@ -0,0 +1,15 @@
+const path = require('path')
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @returns {import('../../../../typings/index').VarnishConfiguration}
+ */
+const varnish73 = ({ templateDir }) => ({
+    enabled: true,
+    healthCheck: false,
+    image: 'varnish:7.3',
+    configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
+})
+
+module.exports = varnish73

package/lib/config/versions/magento-2.4.4-p4.js

@@ -0,0 +1,47 @@
+const { defaultMagentoConfig } = require('../magento-config')
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish73 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx118 } = require('../services/nginx/versions')
+const { composer2 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis62 } = require('../services/redis')
+const { mariadb104 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.4-p4',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.1-magento-2.4`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: redis62(),
+        mysql: mysql80(),
+        mariadb: mariadb104(),
+        elasticsearch: elasticsearch717(),
+        composer: composer2(),
+        varnish: varnish73({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+})

package/lib/config/versions/magento-2.4.5-p3.js

@@ -0,0 +1,47 @@
+const { defaultMagentoConfig } = require('../magento-config')
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish73 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx118 } = require('../services/nginx/versions')
+const { composer2 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis62 } = require('../services/redis')
+const { mariadb104 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.5-p3',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.1-magento-2.4`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: redis62(),
+        mysql: mysql80(),
+        mariadb: mariadb104(),
+        elasticsearch: elasticsearch717(),
+        composer: composer2(),
+        varnish: varnish73({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+})

package/lib/config/versions/magento-2.4.6-p1.js

@@ -0,0 +1,47 @@
+const { defaultMagentoConfig } = require('../magento-config')
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish73 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx118 } = require('../services/nginx/versions')
+const { composer2 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis70 } = require('../services/redis')
+const { mariadb104 } = require('../services/mariadb/versions')
+const { elasticsearch85 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.6-p1',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.1-magento-2.4`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: redis70(),
+        mysql: mysql80(),
+        mariadb: mariadb104(),
+        elasticsearch: elasticsearch85(),
+        composer: composer2(),
+        varnish: varnish73({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+})

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

@@ -68,11 +68,12 @@ Note that you will lose your existing database!`,
             choices: [
                 {
                     name: 'delete',
-                    message: 'YES I AM SURE I WANT TO DELETE magento DATABASE!'
+                    message: 'YES I WANT TO DELETE magento DATABASE!'
                 },
                 {
                     name: 'skip',
-                    message: 'Skip this step'
+                    message:
+                        "NO I DON'T wANT TO DELETE magento DATABASE! (Skip this step)"
                 }
             ]
         })

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

@@ -27,6 +27,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')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -242,7 +243,18 @@ Please wait, this will take some time and do not restart the MySQL container unt
                                 }
                             )
                     },
-                    checkPHPVersion(),
+                    {
+                        task: (ctx, subTask) =>
+                            subTask.newListr(
+                                [
+                                    checkPHPVersion(),
+                                    checkElasticSearchVersion()
+                                ],
+                                {
+                                    concurrent: true
+                                }
+                            )
+                    },
                     getComposerVersionTask(),
                     prepareFileSystem(),
                     installMagentoProject(),

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

@@ -1,31 +1,131 @@
+const semver = require('semver')
+const path = require('path')
 const { updateTableValues, isTableExists } = require('../../../util/database')
+const getJsonfileData = require('../../../util/get-jsonfile-data')
+const runComposerCommand = require('../../../util/run-composer')
+
+const magentoModuleElasticSearch8 = 'magento/module-elasticsearch-8'
+
+/**
+ * @param {import('../../../../typings/context').ListrContext} ctx
+ */
+const isNeedToInstallElasticSearch8Module = async (ctx) => {
+    /**
+     * @type {{ packages: { name: string, version: string }[] } | null}
+     */
+    const composerLockData = await getJsonfileData(
+        path.join(ctx.config.baseConfig.magentoDir, 'composer.lock')
+    )
+
+    if (!composerLockData) {
+        return true
+    }
+
+    return !composerLockData.packages.some(
+        ({ name }) => name === magentoModuleElasticSearch8
+    )
+}
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
-module.exports = () => ({
+const configureElasticSearchInDatabase = () => ({
     title: 'Configuring Elasticsearch',
-    skip: async (ctx) =>
-        !(await isTableExists('magento', 'core_config_data', ctx)),
+    skip: async (ctx) => {
+        const isCoreConfigDataExists = await isTableExists(
+            'magento',
+            'core_config_data',
+            ctx
+        )
+        if (isCoreConfigDataExists) {
+            const elasticsearchConfig = await ctx.databaseConnection.query(
+                `SELECT path,value FROM core_config_data WHERE path='catalog/search/engine';`
+            )
+
+            if (elasticsearchConfig.length > 0) {
+                const { major: parsedESMajorVersion } = semver.parse(
+                    ctx.elasticSearchVersion
+                ) || { major: 7 }
+                const elasticsearchSearchEngine = `elasticsearch${parsedESMajorVersion}`
+
+                return (
+                    elasticsearchConfig[0].value === elasticsearchSearchEngine
+                )
+            }
+        }
+
+        return false
+    },
     task: async (ctx, task) => {
         const { ports, databaseConnection, isDockerDesktop } = ctx
         const hostMachine = !isDockerDesktop
             ? '127.0.0.1'
             : 'host.docker.internal'
+
+        const { major: parsedESMajorVersion } = semver.parse(
+            ctx.elasticSearchVersion
+        ) || { major: 7 }
+
+        const elasticsearchConfig = {
+            'catalog/search/engine': `elasticsearch${parsedESMajorVersion}`,
+            [`catalog/search/elasticsearch${parsedESMajorVersion}_server_hostname`]:
+                hostMachine,
+            [`catalog/search/elasticsearch${parsedESMajorVersion}_server_port`]: `${ports.elasticsearch}`
+        }
+
         await updateTableValues(
             'core_config_data',
-            [
-                { path: 'catalog/search/engine', value: 'elasticsearch7' },
-                {
-                    path: 'catalog/search/elasticsearch7_server_hostname',
-                    value: hostMachine
-                },
-                {
-                    path: 'catalog/search/elasticsearch7_server_port',
-                    value: `${ports.elasticsearch}`
-                }
-            ],
+            Object.entries(elasticsearchConfig).map(([path, value]) => ({
+                path,
+                value
+            })),
             { databaseConnection, task }
         )
     }
 })
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const installElasticSearch8Module = () => ({
+    title: 'Installing Magento ElasticSearch8 Module',
+    task: async (ctx, task) => {
+        await runComposerCommand(
+            ctx,
+            `require ${magentoModuleElasticSearch8} --with-all-dependencies`,
+            {
+                callback: !ctx.verbose
+                    ? undefined
+                    : (t) => {
+                          task.output = t
+                      }
+            }
+        )
+    },
+    options: {
+        bottomBar: 10
+    }
+})
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+module.exports = () => ({
+    task: async (ctx, task) => {
+        const { major: parsedESMajorVersion } = semver.parse(
+            ctx.elasticSearchVersion
+        ) || { major: 7 }
+
+        if (
+            parsedESMajorVersion === 8 &&
+            (await isNeedToInstallElasticSearch8Module(ctx))
+        ) {
+            return task.newListr([
+                installElasticSearch8Module(),
+                configureElasticSearchInDatabase()
+            ])
+        }
+
+        return task.newListr(configureElasticSearchInDatabase())
+    }
+})

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

@@ -0,0 +1,34 @@
+const UnknownError = require('../../errors/unknown-error')
+const { runContainerImage } = require('../../util/run-container-image')
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const checkElasticSearchVersion = () => ({
+    title: 'Checking container ElasticSearch version',
+    task: async (ctx, task) => {
+        const elasticSearchVersionResponse = await runContainerImage(
+            ctx.config.overridenConfiguration.configuration.elasticsearch.image,
+            'elasticsearch --version'
+        )
+
+        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/start.js

@@ -34,6 +34,7 @@ const {
 } = require('../util/instance-metadata')
 const waitingForVarnish = require('./magento/setup-magento/waiting-for-varnish')
 const checkPHPVersion = require('./requirements/php-version')
+const checkElasticSearchVersion = require('./requirements/elasticsearch-version')
 const volumes = require('./docker/volume/tasks')
 const convertMySQLDatabaseToMariaDB = require('./docker/convert-mysql-to-mariadb')
 const { cmaGlobalConfig } = require('../config/cma-config')
@@ -125,16 +126,24 @@ const configureProject = () => ({
         task.newListr([
             convertMySQLDatabaseToMariaDB(),
             {
-                task: (ctx, task) =>
-                    task.newListr(
+                task: (ctx, subTask) =>
+                    subTask.newListr(
                         [pullImages(), dockerNetwork.tasks.createNetwork()],
                         { concurrent: true }
                     )
             },
-            checkPHPVersion(),
             {
-                task: (ctx, task) =>
-                    task.newListr(
+                task: (ctx, subTask) =>
+                    subTask.newListr(
+                        [checkPHPVersion(), checkElasticSearchVersion()],
+                        {
+                            concurrent: true
+                        }
+                    )
+            },
+            {
+                task: (ctx, subTask) =>
+                    subTask.newListr(
                         [buildProjectImage(), buildDebugProjectImage()],
                         {
                             concurrent: true

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

@@ -1,5 +1,4 @@
 const Joi = require('joi')
-const semver = require('semver')
 const KnownError = require('../errors/known-error')
 const pathExistsSync = require('./path-exists-sync')
 
@@ -16,14 +15,27 @@ const fileExistsValidator = (value) => {
     return undefined
 }
 
+const composerVersionRegex =
+    /^latest-(\d+\.\d+\.?(x|\d)+?)$|^latest-stable$|^latest-preview$|^latest-(\d+\.x)$|^(\d+\.\d+\.\d+?)$/gi
+
 /**
  * @type {Joi.CustomValidator<string>}
  */
 const versionValidator = (value, helpers) => {
-    const isValid = semver.valid(value)
-
-    if (!isValid) {
-        return helpers.error('any.invalid')
+    const isValidComposerVersion = composerVersionRegex.test(value)
+
+    if (!isValidComposerVersion) {
+        return helpers.error('any.invalid', {
+            label: `Not a valid composer version!
+Allowed patterns:
+- latest-stable
+- latest-preview
+- latest-2.2.x
+- latest-2.x
+- latest-1.x
+- 2.2.21
+`
+        })
     }
 
     return undefined

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.1.1",
+    "version": "2.1.3",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -58,5 +58,5 @@
     "devDependencies": {
         "@types/yargs": "^17.0.13"
     },
-    "gitHead": "0c665d04295cce4c7f4e924389e50c3eb29f0f75"
+    "gitHead": "46f263a31736f8973bc04760b5bbdf779811cd32"
 }

package/typings/context.d.ts

@@ -23,6 +23,7 @@ export interface ListrContext {
     magentoVersion: string
     composerVersion: string
     phpVersion: string
+    elasticSearchVersion: string
     port?: number
     ports: {
         app: number

package/typings/index.d.ts

@@ -89,7 +89,12 @@ export interface ComposerConfiguration {
      *
      * @url https://getcomposer.org/download/
      */
-    version: string
+    version: 'latest-stable'
+    | 'latest-preview'
+    | 'latest-1.x'
+    | 'latest-2.x'
+    | 'latest-2.2.x'
+    | ''
 
     /**
      *  Composer global plugins that will be added to Docker image