@scandipwa/magento-scripts 2.1.4 → 2.2.0-alpha.0

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

@@ -1,5 +1,6 @@
 const UnknownError = require('../../errors/unknown-error')
-const { runContainerImage } = require('../../util/run-container-image')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { containerApi } = require('../docker/containers')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -7,10 +8,64 @@ const { runContainerImage } = require('../../util/run-container-image')
 const checkElasticSearchVersion = () => ({
     title: 'Checking container ElasticSearch version',
     task: async (ctx, task) => {
-        const elasticSearchVersionResponse = await runContainerImage(
-            ctx.config.overridenConfiguration.configuration.elasticsearch.image,
-            'elasticsearch --version'
-        )
+        const { elasticsearch } =
+            ctx.config.overridenConfiguration.configuration
+        const { ports } = ctx
+
+        let elasticSearchVersionResponse
+
+        try {
+            elasticSearchVersionResponse = await containerApi.run({
+                ...elasticsearch,
+                command: 'elasticsearch --version',
+                detach: false,
+                rm: true,
+                ports: [`127.0.0.1:${ports.elasticsearch}:9200`],
+                memory: '512mb'
+            })
+        } catch (e) {
+            elasticSearchVersionResponse = e.message
+        }
+
+        // if (elasticSearchVersionResponse === '') {
+        //     const tryDisablingSwappingForES = await task.prompt({
+        //         type: 'Select',
+        //         message: `It looks like ElasticSearch wasn't able to start properly, do you want to try disabling swapping and running it again?
+
+        //         (Note that if it works, you should edit cma.js and add this to ${logger.style.code(
+        //             'configuration.elasticsearch.env'
+        //         )} as { 'bootstrap.mlockall': false })`,
+        //         choices: [
+        //             {
+        //                 name: 'yes',
+        //                 message: `Try disabling swapping and run ElasticSearch`
+        //             },
+        //             {
+        //                 name: 'no',
+        //                 message: "Skip, I don't care"
+        //             }
+        //         ]
+        //     })
+
+        //     if (tryDisablingSwappingForES === 'yes') {
+        //         try {
+        //             elasticSearchVersionResponse = await containerApi.run({
+        //                 ...elasticsearch,
+        //                 env: {
+        //                     ...elasticsearch.env,
+        //                     'bootstrap.mlockall': false
+        //                 },
+        //                 command: 'elasticsearch --version',
+        //                 detach: false,
+        //                 rm: true,
+        //                 ports: [`127.0.0.1:${ports.elasticsearch}:9200`],
+        //                 memory: '512mb'
+        //             })
+        //         } catch (e) {
+        //             elasticSearchVersionResponse = e.message
+        //         }
+        //     }
+        // }
 
         const elasticSearchVersionResponseResult =
             elasticSearchVersionResponse.match(/Version:\s(\d+\.\d+\.\d+)/i)
@@ -28,7 +83,8 @@ const checkElasticSearchVersion = () => ({
                 `Cannot retrieve ElasticSearch Version!\n\n${elasticSearchVersionResponse}`
             )
         }
-    }
+    },
+    exitOnError: false
 })
 
 module.exports = checkElasticSearchVersion

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

@@ -25,17 +25,7 @@ const versionValidator = (value, helpers) => {
     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 helpers.error('any.invalid')
     }
 
     return undefined
@@ -64,9 +54,25 @@ const magentoSchema = Joi.object({
  * @type {Joi.ObjectSchema<import('../../typings').SSLConfiguration>}
  */
 const sslSchema = Joi.object({
-    enabled: Joi.bool().required(),
-    ssl_certificate: Joi.string().required(),
-    ssl_certificate_key: Joi.string().required()
+    enabled: Joi.boolean().required(),
+    ssl_certificate: Joi.string().optional(),
+    ssl_certificate_key: Joi.string().optional(),
+    external_provider: Joi.boolean().optional()
+}).custom((d, helpers) => {
+    if (d.enabled) {
+        if (!d.ssl_certificate && !d.external_provider) {
+            return helpers.error(
+                'ssl_certificate must be provided! or set ssl.external_provider to true!'
+            )
+        }
+        if (!d.ssl_certificate_key && !d.external_provider) {
+            return helpers.error(
+                'ssl_certificate_key must be provided! or set ssl.external_provider to true!'
+            )
+        }
+    }
+
+    return true
 })
 
 /**
@@ -92,7 +98,10 @@ const phpConfigurationSchema = Joi.object({
     fpmConfigTemplate: Joi.string().optional(),
     configTemplate: Joi.string().optional().custom(fileExistsValidator),
     debugTemplate: Joi.string().optional().custom(fileExistsValidator),
-    extensions: phpExtensionConfiguration.optional()
+    extensions: phpExtensionConfiguration.optional(),
+    env: Joi.object()
+        .pattern(Joi.string(), [Joi.string(), Joi.number()])
+        .optional()
 })
 
 /**
@@ -150,6 +159,19 @@ const composerConfigurationSchema = Joi.object({
             }
 
             return versionValidator(value, helper)
+        })
+        .messages({
+            'any.invalid': `Composer version is not valid!
+Allowed patterns:
+- latest-stable
+- latest-preview
+- latest-2.2.x
+- latest-2.x
+- latest-1.x
+- 2.2.21
+
+Please check you composer configuration in cma.js!
+`
         }),
     plugins: Joi.object().pattern(
         Joi.string(),
@@ -161,6 +183,23 @@ const composerConfigurationSchema = Joi.object({
     )
 })
 
+/**
+ * @type {Joi.ObjectSchema<import('../../typings').NewRelicConfiguration>}
+ */
+const newRelicConfigurationSchema = Joi.object({
+    enabled: Joi.boolean().optional(),
+    agentVersion: Joi.string().optional(),
+    licenseKey: Joi.string().optional()
+}).custom((d, helpers) => {
+    if (d.enabled && !d.licenseKey) {
+        return helpers.error(
+            'when newRelic is enabled license key is required!'
+        )
+    }
+
+    return true
+})
+
 /**
  * @type {Joi.ObjectSchema<import('../../typings').CMAConfiguration['configuration']>}
  */
@@ -173,7 +212,8 @@ const configurationSchema = Joi.object({
     composer: composerConfigurationSchema.optional(),
     varnish: varnishConfigurationSchema.optional(),
     sslTerminator: nginxConfigurationSchema.optional(),
-    maildev: serviceConfigurationSchema.optional()
+    maildev: serviceConfigurationSchema.optional(),
+    newRelic: newRelicConfigurationSchema.optional()
 })
 
 /**
@@ -182,8 +222,9 @@ const configurationSchema = Joi.object({
 const configFileSchema = Joi.object({
     magento: magentoSchema.required(),
     host: Joi.string().optional(),
+    storeDomains: Joi.object().pattern(Joi.string(), Joi.string()).optional(),
     ssl: sslSchema.optional(),
-    prefix: Joi.bool().optional(),
+    prefix: Joi.boolean().optional(),
     configuration: configurationSchema.required()
 })
 
@@ -191,8 +232,8 @@ const configFileSchema = Joi.object({
  * @type {Joi.ObjectSchema<{ useNonOverlappingPorts:boolean, analytics:boolean }>}
  */
 const systemConfigurationSchema = Joi.object({
-    useNonOverlappingPorts: Joi.bool().optional(),
-    analytics: Joi.bool().optional()
+    useNonOverlappingPorts: Joi.boolean().optional(),
+    analytics: Joi.boolean().optional()
 })
 
 module.exports = {

package/lib/util/config-php-json.js

@@ -5,6 +5,8 @@ const pathExists = require('./path-exists')
 
 /**
  * @param {import('../../typings/context').ListrContext} ctx
+ *
+ * @returns {Promise<import('../../typings/common').ConfigPHPType | null>}
  */
 const configPhpToJson = async (ctx) => {
     const configPhpOnSystemPath = path.join(

package/lib/util/database.js

@@ -99,7 +99,89 @@ const isTableExists = async (database, tableName, { databaseConnection }) => {
     return tableCount > 0
 }
 
+/**
+ * @param {TemplateStringsArray} sqlString
+ * @param  {...any} variables
+ * @returns {string}
+ */
+const sql = (sqlString, ...variables) => {
+    return sqlString.reduce(
+        (acc, val, i) =>
+            `${acc}${
+                typeof variables[i] === 'undefined'
+                    ? ''
+                    : typeof variables[i] === 'string'
+                    ? `'${variables[i]}'`
+                    : String(variables[i])
+            }${val}`,
+        ''
+    )
+}
+
+/**
+ * @param {Object} param0
+ * @param {string} param0.table
+ * @param {[string, string, any][]} param0.where
+ * @param {Record<string, any>} param0.data
+ * @param {import('../../typings/context').ListrContext} param1
+ */
+const databaseQuery = async (
+    { table, where, data },
+    { databaseConnection }
+) => {
+    const values = Object.entries(data).map(([key, val]) => ({
+        path: key,
+        value: val
+    }))
+
+    const whereInQuery = where
+        .map(([key, operator, val]) => `${key} ${operator} ${sql`${val}`}`)
+        .join(' AND ')
+
+    const query = `
+        SELECT * FROM ${table}
+        WHERE ${whereInQuery};`
+
+    const [rows] = await databaseConnection.query(query)
+
+    if (rows.length === 0) {
+        const query2 = `INSERT INTO ${table}
+        (${[...where.map(([key]) => key), ...values.map((p) => p.path)].join(
+            ', '
+        )})
+        VALUES (${[
+            ...where.map(([, , val]) => sql`${val}`),
+            ...values.map((p) => sql`${p.value}`)
+        ].join(', ')});`
+
+        await databaseConnection.query(query2)
+
+        return true
+    }
+
+    const [row] = rows
+
+    const incorrectData = Object.entries(data).filter(
+        ([key, val]) => row[key] !== val
+    )
+
+    if (incorrectData.length > 0) {
+        await databaseConnection.query(
+            `UPDATE ${table}
+            SET ${incorrectData
+                .map(([key, val]) => `${key} = ${sql`${val}`}`)
+                .join(', ')}
+            WHERE ${whereInQuery};`
+        )
+
+        return true
+    }
+
+    return false
+}
+
 module.exports = {
     updateTableValues,
-    isTableExists
+    isTableExists,
+    databaseQuery
 }

package/lib/util/instance-metadata.js

@@ -24,7 +24,7 @@ const getInstanceMetadata = (ctx) => {
         ports,
         config: {
             magentoConfiguration,
-            overridenConfiguration: { host, ssl }
+            overridenConfiguration: { ssl, storeDomains }
         }
     } = ctx
 
@@ -43,25 +43,22 @@ const getInstanceMetadata = (ctx) => {
      */
     const maildev = []
 
-    const isNgrok = host.endsWith('ngrok.io')
+    frontend.push({
+        title: WEB_LOCATION_TITLE,
+        text: `${ssl.enabled ? 'https' : 'http'}://${storeDomains.admin}${
+            ssl.enabled || ports.sslTerminator === 80
+                ? ''
+                : `:${ports.sslTerminator}`
+        }/`
+    })
 
-    if (isNgrok) {
-        frontend.push({
-            title: WEB_LOCAL_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://localhost${
-                ssl.enabled || ports.sslTerminator === 80
-                    ? ''
-                    : `:${ports.sslTerminator}`
-            }/`
-        })
-        frontend.push({
-            title: WEB_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://${host}/`
-        })
-    } else {
+    for (const [storeCode, domain] of Object.entries(storeDomains)) {
+        if (storeCode === 'admin') {
+            continue
+        }
         frontend.push({
-            title: WEB_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://${host}${
+            title: `Frontend store ${logger.style.file(storeCode)} location`,
+            text: `${ssl.enabled ? 'https' : 'http'}://${domain}${
                 ssl.enabled || ports.sslTerminator === 80
                     ? ''
                     : `:${ports.sslTerminator}`
@@ -87,7 +84,7 @@ const getInstanceMetadata = (ctx) => {
 
     maildev.push({
         title: WEB_MAILDEV_LOCATION_TITLE,
-        text: `http://${host}:${ports.maildevWeb}/`
+        text: `http://localhost:${ports.maildevWeb}/`
     })
 
     return {

package/lib/util/match-filesystem.js

@@ -17,6 +17,7 @@ const matchFilesystem = async (cwd, structure) => {
 
         return ok
     }
+
     if (typeof structure === 'object') {
         const ok = (
             await Promise.all(

package/lib/util/run-magento.js

@@ -6,6 +6,7 @@ const { runPHPContainerCommand } = require('../tasks/php/php-container')
  * @param {import('../../typings/context').ListrContext} ctx
  * @param {String} command magento command
  * @param {Parameters<typeof import('../tasks/php/php-container')['runPHPContainerCommand']>[2] & { throwNonZeroCode?: boolean }} options
+ * @returns {Promise<{ code: number, result: string }>}
  */
 const runMagentoCommand = async (ctx, command, options = {}) => {
     const { throwNonZeroCode = true } = options

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.4",
+    "version": "2.2.0-alpha.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -58,5 +58,5 @@
     "devDependencies": {
         "@types/yargs": "^17.0.13"
     },
-    "gitHead": "71b3bef6b620023fedca851dd529b60e22b113e0"
+    "gitHead": "f019bf2b569373558c7a90a036db5a4464ece57f"
 }

package/tsconfig.json

@@ -12,7 +12,8 @@
         "moduleResolution": "Node",
         "types": [
             "./typings"
-        ]
+        ],
+        "noEmit": true
     },
     "exclude": [
         "**/node_modules",

package/typings/common.d.ts

@@ -0,0 +1,53 @@
+import { CMAConfiguration, ServiceWithImage } from "./index"
+import { ListrContext } from "./context"
+
+export type MagentoVersionConfigurationFunction = (args: ListrContext['config']['baseConfig']) => MagentoVersionConfiguration
+
+export type MagentoVersionConfiguration = CMAConfigurationWithMySQL &  {
+    magentoVersion: string
+    isDefault?: boolean
+}
+
+export type CMAConfigurationWithMySQL = Optional<CMAConfiguration, 'storeDomains' | 'host' | 'magento' | 'prefix' | 'ssl'> & {
+    configuration: {
+        mysql: Optional<ServiceWithImage, 'image'>
+    }
+}
+
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>
+
+export interface ConfigPHPType {
+    modules: Record<string, number>
+    scopes?: {
+        websites: {
+            [websiteCode: string]: {
+                website_id: string
+                code: string
+                name: string
+                sort_order: string
+                default_group_id: string
+                is_default: string
+            }
+        }
+        groups: {
+            group_id: string
+            website_id: string
+            code: string
+            name: string
+            root_category_id: string
+            default_store_id: string
+        }[]
+        stores: {
+            [storeCode: string]: {
+                store_id: string
+                code: string
+                website_id: string
+                group_id: string
+                name: string
+                sort_order: string
+                is_active: string
+            }
+        }
+    }
+    system?: any
+}

package/typings/index.d.ts

@@ -202,6 +202,11 @@ export interface PHPConfiguration {
      * Extensions for PHP
      */
     extensions: PHPExtensions
+
+    /**
+     * Environmental variables used for PHP container
+     */
+    env: Record<string, unknown>
 }
 export interface SSLConfiguration {
     /**
@@ -224,6 +229,32 @@ export interface SSLConfiguration {
      * `./ssl_certificate-key.pem`
      */
     ssl_certificate_key?: string
+
+    /**
+     * SSL external provider configuration
+     *
+     * Set to `true` if you don't need locally provided SSL certificates
+     *
+     * @default false
+     */
+    external_provider?: boolean
+}
+
+export interface NewRelicConfiguration {
+    /**
+     * Enables or disables New Relic in application
+     */
+    enabled: boolean
+
+    /**
+     * New Relic Agent version
+     */
+    agentVersion?: string
+
+    /**
+     * New Relic license key
+     */
+    licenseKey?: string
 }
 
 export interface CMAConfiguration {
@@ -271,6 +302,11 @@ export interface CMAConfiguration {
          */
         sslTerminator: SSLTerminatorConfiguration
 
+        /**
+         * New Relic configuration
+         */
+        newRelic?: NewRelicConfiguration
+
         /**
          * MailDev configuration
          */
@@ -316,9 +352,28 @@ export interface CMAConfiguration {
     /**
      *  Custom host for website base url
      *  @default 'localhost'
+     *
+     * @deprecated Use `storeDomains` instead, as follows: `storeDomains: { admin: 'localhost' }`
      */
     host: string
 
+    /**
+     * Custom domains for magento stores by store code
+     *
+     * Note: you can look up **scope_id** in `app/etc/config.php` in `scopes` section.
+     *
+     * @default { admin: 'localhost' }
+     *
+     * @example ```js
+     *  storeDomains: {
+     *   admin: 'localhost',
+     *   custom_store_code: 'scandipwa.local',
+     *   another_store_code: 'another-store.local'
+     * }
+     * ```
+     */
+    storeDomains: { admin: string } & Record<string, string>
+
     /**
      * SSL Configuration
      */