@scandipwa/magento-scripts 2.1.4 → 2.2.0

package/lib/tasks/docker/containers/container-api.js

@@ -25,7 +25,8 @@ const runCommand = (options) => {
         detach = true,
         rm = false,
         tty = false,
-        user
+        user,
+        memory
     } = options
 
     const detachArg = (detach && '-d') || ''
@@ -59,6 +60,7 @@ const runCommand = (options) => {
         (tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs=${t}`)) || ''
     const userArg = (user && `--user=${user}`) || ''
     const addHostArg = (addHost && `--add-host=${addHost}`) || ''
+    const memoryArg = (memory && `--memory=${memory}`) || ''
 
     const dockerCommand = [
         'docker',
@@ -80,6 +82,7 @@ const runCommand = (options) => {
         tmpfsArg,
         userArg,
         addHostArg,
+        memoryArg,
         image,
         command
     ]

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

@@ -193,6 +193,27 @@ const buildDockerFileInstructions = async (ctx, { image, tag }) => {
         })
     }
 
+    if (ctx.config.overridenConfiguration.configuration.newRelic.enabled) {
+        const { agentVersion, licenseKey } =
+            ctx.config.overridenConfiguration.configuration.newRelic
+
+        // eslint-disable-next-line max-len
+        dockerFileInstructions.run('apk add --no-cache gcompat')
+            .run(`curl -L https://download.newrelic.com/php_agent/archive/${agentVersion}/newrelic-php5-${agentVersion}-linux.tar.gz | tar -C /tmp -zx \
+&& export NR_INSTALL_USE_CP_NOT_LN=1 \
+&& export NR_INSTALL_SILENT=1 \
+&& /tmp/newrelic-php5-${agentVersion}-linux/newrelic-install install \
+&& rm -rf /tmp/newrelic-php5-* /tmp/nrinstall*`)
+            .run(`sed -i -e "s/REPLACE_WITH_REAL_KEY/${licenseKey}/" \
+-e "s/newrelic.appname[[:space:]]=[[:space:]].*/newrelic.appname=\\"${
+            ctx.config.baseConfig.prefix
+        }\\"/" \
+-e '\\$anewrelic.daemon.address="${
+            ctx.isDockerDesktop ? 'host.docker.internal' : 'localhost'
+        }:31339"' \
+\\$PHP_INI_DIR/conf.d/newrelic.ini`)
+    }
+
     return dockerFileInstructions
 }
 

package/lib/tasks/file-system/create-nginx-config.js

@@ -15,13 +15,16 @@ const createNginxConfig = () => ({
         } = ctx
 
         const {
-            configuration: { nginx }
+            configuration: { nginx },
+            storeDomains
         } = overridenConfiguration
 
         const hostMachine = !isDockerDesktop
             ? '127.0.0.1'
             : 'host.docker.internal'
         const hostPort = !isDockerDesktop ? ports.app : 80
+        const useStoreDomainMapping =
+            storeDomains && Object.keys(storeDomains).length > 1
 
         try {
             await setConfigFile({
@@ -38,7 +41,9 @@ const createNginxConfig = () => ({
                     mageRoot: baseConfig.containerMagentoDir,
                     hostMachine,
                     hostPort,
-                    config: overridenConfiguration
+                    config: overridenConfiguration,
+                    storeDomains,
+                    useStoreDomainMapping
                 }
             })
         } catch (e) {

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/workspace-config.js

@@ -5,7 +5,7 @@ const { baseConfig } = require('../../../../config')
  * @param {import('../../../../../typings/index').CMAConfiguration} app
  */
 const getWorkspaceConfig = (app) => ({
-    debugServerAddress: `http://${app.host}`,
+    debugServerAddress: `http://${app.storeDomains.admin}`,
     serverName: 'create-magento-app',
     runManagerName: 'create-magento-app',
     sessionId: 'PHPSTORM',

package/lib/tasks/file-system/create-ssl-terminator-config.js

@@ -2,7 +2,6 @@ const path = require('path')
 const fs = require('fs')
 const setConfigFile = require('../../util/set-config')
 const pathExists = require('../../util/path-exists')
-const { isIpAddress } = require('../../util/ip')
 const KnownError = require('../../errors/known-error')
 const UnknownError = require('../../errors/unknown-error')
 
@@ -21,14 +20,19 @@ const createSSLTerminatorConfig = () => ({
 
         const {
             configuration: { sslTerminator },
-            ssl,
-            host
+            ssl
         } = overridenConfiguration
 
-        if (ssl.enabled) {
+        if (ssl.enabled && !ssl.external_provider) {
+            if (!ssl.ssl_certificate) {
+                throw new KnownError('ssl.ssl_certificate is not defined!')
+            }
             if (!(await pathExists(ssl.ssl_certificate))) {
                 throw new KnownError('ssl.ssl_certificate file does not exist!')
             }
+            if (!ssl.ssl_certificate_key) {
+                throw new KnownError('ssl.ssl_certificate_key is not defined!')
+            }
             if (!(await pathExists(ssl.ssl_certificate_key))) {
                 throw new KnownError(
                     'ssl.ssl_certificate_key file does not exist!'
@@ -66,7 +70,6 @@ const createSSLTerminatorConfig = () => ({
             )
         }
 
-        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1'
         const hostMachine = !isDockerDesktop
             ? '127.0.0.1'
             : 'host.docker.internal'
@@ -87,7 +90,6 @@ const createSSLTerminatorConfig = () => ({
                     hostMachine,
                     hostPort,
                     config: overridenConfiguration,
-                    networkToBindTo,
                     debug
                 }
             })
@@ -111,7 +113,7 @@ const createSSLTerminatorConfig = () => ({
                 ),
                 overwrite: true,
                 templateArgs: {
-                    isNgrok: host.endsWith('ngrok.io')
+                    sslEnabled: ssl.enabled
                 }
             })
         } catch (e) {

package/lib/tasks/magento/install-magento-project.js

@@ -1,5 +1,6 @@
 const path = require('path')
 const fs = require('fs')
+const semver = require('semver')
 const logger = require('@scandipwa/scandipwa-dev-utils/logger')
 const runComposerCommand = require('../../util/run-composer')
 const matchFilesystem = require('../../util/match-filesystem')
@@ -12,6 +13,8 @@ const { runPHPContainerCommand } = require('../php/php-container')
 const magentoProductEnterpriseEdition = 'magento/product-enterprise-edition'
 const magentoProductCommunityEdition = 'magento/product-community-edition'
 
+const magentoRootUpdatePlugin = 'magento/composer-root-update-plugin'
+
 /**
  * @param {import('../../../typings/context').ListrContext} ctx
  * @param {import('listr2').ListrTaskWrapper<import('../../../typings/context').ListrContext, any>} task
@@ -61,15 +64,15 @@ const adjustComposerJson = async (
         )
     }
 
+    const isPHP7 = semver.satisfies(ctx.phpVersion, '^7.x.x')
+    const rootUpdatePluginVersion = isPHP7 ? '^1' : '^2'
+
     // if composer-root-update-plugin is not installed in composer, install it.
-    if (
-        composerData &&
-        !composerData.require['magento/composer-root-update-plugin']
-    ) {
-        task.output = 'Installing magento/composer-root-update-plugin!'
+    if (composerData && !composerData.require[magentoRootUpdatePlugin]) {
+        task.output = `Installing ${magentoRootUpdatePlugin}:${rootUpdatePluginVersion}!`
         await runComposerCommand(
             ctx,
-            'require magento/composer-root-update-plugin:^1',
+            `require ${magentoRootUpdatePlugin}:${rootUpdatePluginVersion}`,
             {
                 callback: !ctx.verbose
                     ? undefined
@@ -195,7 +198,7 @@ const installMagentoProject = () => ({
         }
 
         task.title = `Installing Magento ${magentoPackageVersion}`
-        task.output = 'Creating Magento project'
+        task.output = `Creating Magento ${magentoPackageVersion} project`
 
         if (!(await pathExists(path.join(process.cwd(), 'composer.json')))) {
             await createMagentoProject(ctx, task, {

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

@@ -92,7 +92,7 @@ const installElasticSearch8Module = () => ({
     task: async (ctx, task) => {
         await runComposerCommand(
             ctx,
-            `require ${magentoModuleElasticSearch8} --with-all-dependencies`,
+            `require ${magentoModuleElasticSearch8} --update-with-all-dependencies`,
             {
                 callback: !ctx.verbose
                     ? undefined

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

@@ -1,10 +1,50 @@
 const magentoTask = require('../../../util/magento-task')
+// const runMagentoCommand = require('../../../util/run-magento')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const indexProducts = () => ({
-    task: (ctx, task) => task.newListr(magentoTask('index:reindex')),
+    title: 'Index Products',
+    task: async (ctx, task) => {
+        const { databaseConnection } = ctx
+        /** @type {{ indexer_id: string, status: string }[][]} */
+        const data = await databaseConnection.query(
+            `select indexer_id,status from indexer_state;`
+        )
+
+        if (data.length === 0) {
+            task.skip('No indexers found')
+            return
+        }
+
+        const invalidIndexers = data[0].filter(
+            ({ status }) => status !== 'valid'
+        )
+
+        const doYouWantToSkipIndexingPart = await task.prompt({
+            type: 'Select',
+            message: `Do you want to index the products? (There are ${invalidIndexers.length} invalid indexers, total indexers: ${data[0].length})\n`,
+            choices: [
+                {
+                    name: 'index',
+                    message: 'Yes, index them please'
+                },
+                {
+                    name: 'skip',
+                    message:
+                        'Skip, do not index them. I will do it later myself'
+                }
+            ]
+        })
+
+        if (doYouWantToSkipIndexingPart === 'skip') {
+            task.skip()
+            return
+        }
+
+        return task.newListr(magentoTask('index:reindex'))
+    },
     retry: 2
 })
 

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

@@ -48,7 +48,10 @@ const setupMagento = (options = {}) => ({
                                 increaseAdminSessionLifetime()
                             ],
                             {
-                                concurrent: true
+                                concurrent: true,
+                                rendererOptions: {
+                                    collapse: false
+                                }
                             }
                         )
                 },

package/lib/tasks/magento/setup-magento/set-base-url.js

@@ -1,34 +1,96 @@
-const { updateTableValues } = require('../../../util/database')
+const { updateTableValues, databaseQuery } = require('../../../util/database')
+const KnownError = require('../../../errors/known-error')
 
 /**
+ * @param {number} scopeId
+ * @param {string} code
+ * @param {string} host
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
-module.exports = () => ({
-    title: 'Setting baseurl and secure baseurl',
+const setBaseUrlForScope = (scopeId, code, host) => ({
+    title: `store code ${code} at ${host}`,
     task: async (ctx, task) => {
         const {
             ports,
             config: {
-                overridenConfiguration: { host, ssl }
-            },
-            databaseConnection
+                overridenConfiguration: { ssl }
+            }
         } = ctx
-        const isNgrok = host.endsWith('ngrok.io')
-        const enableSecureFrontend = isNgrok || ssl.enabled ? '1' : '0'
+
+        if (host.startsWith('http://') || host.startsWith('https://')) {
+            throw new KnownError(
+                `Host ${host} should not contain protocol, only domain name. Check your configuration in cma.js!`
+            )
+        }
+
         const location = `${host}${
-            !isNgrok && ports.sslTerminator !== 80
-                ? `:${ports.sslTerminator}`
-                : ''
+            ssl.enabled || ports.sslTerminator === 80
+                ? ''
+                : `:${ports.sslTerminator}`
         }/`
         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 table = 'core_config_data'
+        const values = [
+            {
+                path: 'web/unsecure/base_url',
+                value: httpUrl
+            },
+            {
+                path: 'web/unsecure/base_link_url',
+                value: httpUrl
+            },
+            {
+                path: 'web/secure/base_url',
+                value: httpsUrl
+            },
+            {
+                path: 'web/secure/base_link_url',
+                value: httpsUrl
+            }
+        ]
+
+        task.title = `store ${code} at ${ssl.enabled ? httpsUrl : httpUrl}`
+
+        await Promise.all(
+            values.map(async ({ path, value }) => {
+                await databaseQuery(
+                    {
+                        table,
+                        where: [
+                            ['scope_id', '=', scopeId],
+                            ['path', '=', path]
+                        ],
+                        data: {
+                            value
+                        }
+                    },
+                    ctx
+                )
+            })
+        )
+    }
+})
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setBaseUrl = () => ({
+    title: 'Setting base url for stores',
+    task: async (ctx, task) => {
+        const {
+            config: {
+                overridenConfiguration: { ssl, storeDomains }
+            },
+            databaseConnection
+        } = ctx
+
+        const enableSecureFrontend = ssl.enabled ? '1' : '0'
 
         await updateTableValues(
             'core_config_data',
             [
-                { path: 'web/unsecure/base_url', value: httpUrl },
-                { path: 'web/secure/base_url', value: httpsUrl },
                 {
                     path: 'web/secure/use_in_frontend',
                     value: enableSecureFrontend
@@ -45,5 +107,51 @@ module.exports = () => ({
             ],
             { databaseConnection, task }
         )
+
+        /** @type {{ website_id: number, code: string }[][]}} */
+        const [storeWebsites] = await databaseConnection.query(
+            `select * from store_website;`
+        )
+
+        if (!storeWebsites || storeWebsites.length === 0) {
+            throw new KnownError(
+                `No store websites found in database, store_website table is empty or does not exist`
+            )
+        }
+
+        const storeDomainsWithMapping = Object.entries(storeDomains).reduce(
+            (acc, [key, val]) => {
+                const storeWebsite = storeWebsites.find(
+                    ({ code }) => code === key
+                )
+                if (storeWebsite) {
+                    return {
+                        ...acc,
+                        [storeWebsite.code]: {
+                            websiteId: storeWebsite.website_id,
+                            domain: val
+                        }
+                    }
+                }
+
+                return acc
+            },
+            {}
+        )
+
+        return task.newListr(
+            Object.entries(storeDomainsWithMapping).map(
+                ([storeCode, { websiteId, domain }]) =>
+                    setBaseUrlForScope(websiteId, storeCode, domain)
+            ),
+            {
+                concurrent: true,
+                rendererOptions: {
+                    collapse: false
+                }
+            }
+        )
     }
 })
+
+module.exports = setBaseUrl

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

@@ -1,5 +1,5 @@
 const UnknownError = require('../../errors/unknown-error')
-const { runContainerImage } = require('../../util/run-container-image')
+const { containerApi } = require('../docker/containers')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -7,10 +7,24 @@ 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
+        }
 
         const elasticSearchVersionResponseResult =
             elasticSearchVersionResponse.match(/Version:\s(\d+\.\d+\.\d+)/i)
@@ -28,7 +42,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(