@scandipwa/magento-scripts 2.2.2 → 2.3.0

package/lib/tasks/start.js

@@ -34,7 +34,6 @@ 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')
@@ -42,6 +41,7 @@ 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>}
@@ -135,7 +135,7 @@ const configureProject = () => ({
             {
                 task: (ctx, subTask) =>
                     subTask.newListr(
-                        [checkPHPVersion(), checkElasticSearchVersion()],
+                        [checkPHPVersion(), checkSearchEngineVersion()],
                         {
                             concurrent: true
                         }

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

@@ -147,6 +147,15 @@ const elasticsearchConfigurationSchema = Joi.object({
     env: Joi.object().optional()
 })
 
+const opensearchConfigurationSchema = Joi.object({
+    image: Joi.string().optional(),
+    env: Joi.object().optional()
+})
+
+const searchEngineConfiguration = Joi.string().valid(
+    'elasticsearch',
+    'opensearch'
+)
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ComposerConfiguration>}
  */
@@ -208,6 +217,8 @@ const configurationSchema = Joi.object({
     nginx: nginxConfigurationSchema.optional(),
     mariadb: mariadbConfigurationSchema.optional(),
     elasticsearch: elasticsearchConfigurationSchema.optional(),
+    opensearch: opensearchConfigurationSchema.optional(),
+    searchengine: searchEngineConfiguration.optional(),
     redis: serviceConfigurationSchema.optional(),
     composer: composerConfigurationSchema.optional(),
     varnish: varnishConfigurationSchema.optional(),

package/lib/util/database.js

@@ -2,7 +2,7 @@
  * Update table in **magento** database
  * @param {String} table Table name
  * @param {{ path: string, value: string | number | null }[]} values
- * @param {{ databaseConnection: import('../../typings/context').ListrContext['databaseConnection'], task: import('listr2').ListrTaskWrapper<import('../../typings/context').ListrContext, any> }} param2
+ * @param {{ databaseConnection: import('../../typings/context').ListrContext['databaseConnection'], task: { skip(): void } }} param2
  */
 const updateTableValues = async (
     table,
@@ -78,6 +78,36 @@ const updateTableValues = async (
     }
 }
 
+/**
+ * Insert values into table in **magento** database
+ * @description Will not insert values that already exist in the table
+ * @param {string} table Table name
+ * @param {{ path: string, value: string | number | null }[]} values
+ * @param {{ databaseConnection: import('../../typings/context').ListrContext['databaseConnection'] }} param2
+ */
+const insertTableValues = async (table, values, { databaseConnection }) => {
+    const [rows] = await databaseConnection.query(`
+        SELECT * FROM ${table}
+        WHERE ${values.map((p) => `path = '${p.path}'`).join(' OR ')};
+    `)
+
+    if (rows.filter(Boolean).length !== values.length) {
+        const lostConfigs = values.filter(
+            (p) => !rows.some((row) => row.path === p.path)
+        )
+        for (const config of lostConfigs) {
+            await databaseConnection.query(
+                `
+                INSERT INTO ${table}
+                (scope, path, value)
+                VALUES ('default', ?, ?);
+            `,
+                [config.path, config.value]
+            )
+        }
+    }
+}
+
 /**
  * @param {String} database
  * @param {String} tableName
@@ -182,6 +212,7 @@ const databaseQuery = async (
 
 module.exports = {
     updateTableValues,
+    insertTableValues,
     isTableExists,
     databaseQuery
 }

package/lib/util/resolve-configuration-with-overrides.js

@@ -31,6 +31,12 @@ const resolveConfigurationWithOverrides = async (
             configuration,
             userConfiguration
         )
+        // let chosenEngine = overridenConfiguration.configuration.searchengine.engine
+        // const newSearchEngineConfiguration = {
+        //     ...overridenConfiguration.configuration.searchengine,
+        //     ...overridenConfiguration.configuration[chosenEngine]
+        // }
+        // overridenConfiguration.configuration.searchengine = newSearchEngineConfiguration
 
         return {
             userConfiguration,

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.2.2",
+    "version": "2.3.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -59,5 +59,5 @@
         "@types/node": "^20.10.4",
         "@types/yargs": "^17.0.13"
     },
-    "gitHead": "879928472eb7a4a684df143dbae4c1adcc5071e8"
+    "gitHead": "d3c78393ace803e0c2f1b13c704996de932bfd2e"
 }

package/typings/context.d.ts

@@ -24,6 +24,7 @@ export interface ListrContext {
     composerVersion: string
     phpVersion: string
     elasticSearchVersion: string
+    openSearchVersion: string
     port?: number
     ports: {
         app: number
@@ -32,6 +33,7 @@ export interface ListrContext {
         mariadb: number
         redis: number
         elasticsearch: number
+        opensearch: number
         varnish: number
         sslTerminator: number
         maildevSMTP: number

package/typings/index.d.ts

@@ -16,6 +16,13 @@ export interface ServiceWithImage {
     image: string
 }
 
+export interface ServiceWithoutImage {
+    /**
+     * Service Docker image
+     */
+    image: string
+}
+
 export interface MariaDBConfiguration extends ServiceWithImage {
     /**
      * Use MariaDB [optimizer-switch](https://mariadb.com/kb/en/optimizer-switch/) configuration.
@@ -50,6 +57,15 @@ export interface ElasticSearchConfiguration extends ServiceWithImage {
     env: Record<string, unknown>
 }
 
+export interface OpenSearchSearchConfiguration extends ServiceWithoutImage {
+    /**
+     * Environmental variables used for OpenSearch container
+     */
+    env: Record<string, unknown>
+}
+
+export type SearchEngineConfiguration = 'elasticsearch' | 'opensearch'
+
 export interface VarnishConfiguration extends ServiceWithImage {
     /**
      * Enable or disable Varnish in the project
@@ -282,6 +298,16 @@ export interface CMAConfiguration {
          */
         elasticsearch: ElasticSearchConfiguration
 
+        /**
+         * OpenSearch configuration
+         */
+        opensearch: OpenSearchSearchConfiguration
+
+        /**
+         * Search engine configuration
+         */
+        searchengine?: SearchEngineConfiguration
+
         /**
          * Redis configuration
          */

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

@@ -1,131 +0,0 @@
-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>}
- */
-const configureElasticSearchInDatabase = () => ({
-    title: 'Configuring Elasticsearch',
-    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',
-            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} --update-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())
-    }
-})