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

package/lib/config/docker.js

@@ -17,7 +17,7 @@ const defaultMagentoUser = require('../tasks/database/default-magento-user')
  */
 module.exports = async (ctx, overridenConfiguration, baseConfig) => {
     const { configuration, ssl, host } = overridenConfiguration
-    const { nginx, redis, elasticsearch, mariadb, varnish, maildev } =
+    const { nginx, redis, elasticsearch, mariadb, varnish, maildev, newRelic } =
         configuration
 
     const php = getPhpConfig(overridenConfiguration, baseConfig)
@@ -120,6 +120,16 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
      * @param {Record<string, number>} ports
      */
     const getContainers = (ports = {}) => {
+        const composerAuthEnv = process.env.COMPOSER_AUTH
+            ? {
+                  COMPOSER_AUTH: JSON.stringify(
+                      JSON.parse(process.env.COMPOSER_AUTH),
+                      null,
+                      0
+                  )
+              }
+            : {}
+
         /**
          * @type {Record<string, import('../tasks/docker/containers/container-api').ContainerRunOptions & { _?: string, forwardedPorts?: string[], debugImage?: string, remoteImages?: string[], connectCommand?: string[], description?: string }>}
          */
@@ -153,15 +163,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                           ]
                         : []
                 ),
-                env: process.env.COMPOSER_AUTH
-                    ? {
-                          COMPOSER_AUTH: JSON.stringify(
-                              JSON.parse(process.env.COMPOSER_AUTH),
-                              null,
-                              0
-                          )
-                      }
-                    : {},
+                env: deepmerge(composerAuthEnv, php.env || {}),
                 restart: 'on-failure:5',
                 image: `local-cma-project:${prefix}`,
                 debugImage: `local-cma-project:${prefix}.debug`,
@@ -397,6 +399,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         }
 
         if (ssl && ssl.enabled && isDockerDesktop) {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
             dockerConfig.sslTerminator.ports.push(
                 `${isIpAddress(host) ? host : '127.0.0.1'}:443:443`
             )
@@ -446,6 +450,16 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
             }
         }
 
+        if (newRelic.enabled) {
+            dockerConfig.newRelicPHPDaemon = {
+                _: 'New Relic PHP daemon',
+                ports: [],
+                name: `${prefix}_newrelic-php-daemon`,
+                network: isDockerDesktop ? network.name : 'host',
+                image: 'newrelic/php-daemon'
+            }
+        }
+
         return dockerConfig
     }
 

package/lib/config/get-magento-version-config.js

@@ -7,6 +7,10 @@ const longestMagentoName = allVersions
     .map(({ name }) => name)
     .reduce((acc, val) => (val.length > acc ? val.length : acc), 0)
 
+/**
+ * @param {{ name: string }} version
+ * @returns {string}
+ */
 const getMagentoVersionMessage = (version) => {
     const pureMagentoVersion = version.name.replace(/-p[0-9]+$/i, '')
     if (scandipwaMagentoVersionMapping[pureMagentoVersion]) {
@@ -25,7 +29,6 @@ const getMagentoVersionMessage = (version) => {
  * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const getMagentoVersion = () => ({
-    // title: 'Loading Magento version',
     task: async (ctx, task) => {
         const {
             throwMagentoVersionMissing = false,

package/lib/config/php-config.js

@@ -18,7 +18,8 @@ module.exports = (overridenConfiguration, baseConfig) => {
         debugTemplatePath: php.debugTemplate,
         fpmTemplatePath: php.fpmConfigTemplate,
         fpmConfPath: path.join(cacheDir, 'php-fpm.conf'),
-        extensions: php.extensions
+        extensions: php.extensions,
+        env: php.env
     }
 
     return phpConfiguration

package/lib/config/services/composer/versions/composer-1.js

@@ -2,7 +2,7 @@
  * @returns {import('../../../../../typings/index').ComposerConfiguration}
  */
 const composer1 = () => ({
-    version: '1',
+    version: 'latest-1.x',
     plugins: {
         'hirak/prestissimo': {
             enabled: true

package/lib/config/services/composer/versions/composer-2.2.js

@@ -0,0 +1,8 @@
+/**
+ * @returns {import('../../../../../typings/index').ComposerConfiguration}
+ */
+const composer22 = () => ({
+    version: 'latest-2.2.x'
+})
+
+module.exports = composer22

package/lib/config/services/composer/versions/composer-2.js

@@ -2,7 +2,7 @@
  * @returns {import('../../../../../typings/index').ComposerConfiguration}
  */
 const composer2 = () => ({
-    version: '2'
+    version: 'latest-2.x'
 })
 
 module.exports = composer2

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

@@ -1,4 +1,5 @@
 module.exports = {
     composer1: require('./composer-1'),
-    composer2: require('./composer-2')
+    composer2: require('./composer-2'),
+    composer22: require('./composer-2.2')
 }

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

@@ -5,7 +5,10 @@ const defaultEnv = require('../default-es-env')
  */
 const elasticsearch84 = () => ({
     image: 'elasticsearch:8.4.3',
-    env: defaultEnv
+    env: {
+        ...defaultEnv,
+        'indices.id_field_data.enabled': true
+    }
 })
 
 module.exports = elasticsearch84

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

@@ -5,7 +5,10 @@ const defaultEnv = require('../default-es-env')
  */
 const elasticsearch85 = () => ({
     image: 'elasticsearch:8.5.3',
-    env: defaultEnv
+    env: {
+        ...defaultEnv,
+        'indices.id_field_data.enabled': true
+    }
 })
 
 module.exports = elasticsearch85

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

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

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

@@ -8,6 +8,7 @@ const elasticsearch716 = require('./elasticsearch-7.16')
 const elasticsearch717 = require('./elasticsearch-7.17')
 const elasticsearch84 = require('./elasticsearch-8.4')
 const elasticsearch85 = require('./elasticsearch-8.5')
+const elasticsearch87 = require('./elasticsearch-8.7')
 
 module.exports = {
     elasticsearch68,
@@ -19,5 +20,6 @@ module.exports = {
     elasticsearch716,
     elasticsearch717,
     elasticsearch84,
-    elasticsearch85
+    elasticsearch85,
+    elasticsearch87
 }

package/lib/config/services/mysql/versions/mysql-8.0.js

@@ -1,5 +1,5 @@
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import("../../../../../typings/common").CMAConfigurationWithMySQL['configuration']['mysql']}
  */
 const mysql80 = () => ({
     image: 'mysql:8.0'

package/lib/config/services/php/default-php-env.js

@@ -0,0 +1,6 @@
+/**
+ * @type {import("../../../../typings").PHPConfiguration['env']}
+ */
+module.exports = {
+    COMPOSER_MEMORY_LIMIT: -1
+}

package/lib/config/services/php/versions/php-7.2.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const { repo } = require('../base-repo')
 const xdebug = require('../extensions/xdebug')
+const defaultPhpEnv = require('../default-php-env')
 
 /**
  * @param {Object} param0
@@ -22,7 +23,8 @@ const php72 = ({
     extensions: {
         xdebug,
         ...extensions
-    }
+    },
+    env: defaultPhpEnv
 })
 
 module.exports = php72

package/lib/config/services/php/versions/php-7.3.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const { repo } = require('../base-repo')
 const xdebug = require('../extensions/xdebug')
+const defaultPhpEnv = require('../default-php-env')
 
 /**
  * @param {Object} param0
@@ -22,7 +23,8 @@ const php73 = ({
     extensions: {
         xdebug,
         ...extensions
-    }
+    },
+    env: defaultPhpEnv
 })
 
 module.exports = php73

package/lib/config/services/php/versions/php-7.4.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const { repo } = require('../base-repo')
 const xdebug = require('../extensions/xdebug')
+const defaultPhpEnv = require('../default-php-env')
 
 /**
  * @param {Object} param0
@@ -22,7 +23,8 @@ const php74 = ({
     extensions: {
         xdebug,
         ...extensions
-    }
+    },
+    env: defaultPhpEnv
 })
 
 module.exports = php74

package/lib/config/services/php/versions/php-8.1.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const { repo } = require('../base-repo')
 const xdebug = require('../extensions/xdebug')
+const defaultPhpEnv = require('../default-php-env')
 
 /**
  * @param {Object} param0
@@ -22,7 +23,8 @@ const php81 = ({
     extensions: {
         xdebug,
         ...extensions
-    }
+    },
+    env: defaultPhpEnv
 })
 
 module.exports = php81

package/lib/config/services/php/versions/php-8.2.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const { repo } = require('../base-repo')
 const xdebug = require('../extensions/xdebug')
+const defaultPhpEnv = require('../default-php-env')
 
 /**
  * @param {Object} param0
@@ -25,7 +26,8 @@ const php82 = ({
             version: '3.2.1'
         },
         ...extensions
-    }
+    },
+    env: defaultPhpEnv
 })
 
 module.exports = php82

package/lib/config/ssl-config.js

@@ -0,0 +1,9 @@
+/**
+ * @type {import("../../typings").SSLConfiguration}
+ */
+const sslConfig = {
+    enabled: false,
+    ssl_external_provider: false
+}
+
+module.exports = sslConfig

package/lib/config/templates/nginx.fastcgi_params.template

@@ -10,10 +10,10 @@ fastcgi_param  DOCUMENT_URI       $document_uri;
 fastcgi_param  DOCUMENT_ROOT      $document_root;
 fastcgi_param  SERVER_PROTOCOL    $server_protocol;
 fastcgi_param  REQUEST_SCHEME     $scheme;
-<% if (it.isNgrok) { %>
+<% if (it.sslEnabled) { %>
 fastcgi_param  HTTPS              on;
 <% } else { %>
-fastcgi_param  HTTPS              $https if_not_empty;
+fastcgi_param  HTTPS              off;
 <% } %>
 
 fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;

package/lib/config/templates/nginx.template.conf

@@ -5,11 +5,23 @@ upstream fastcgi_backend {
     keepalive 16;
 }
 
+<% if (it.useStoreDomainMapping) { %>
+map $http_host $SITE_CODE_MAPPING {
+    <% for (const [key, value] of Object.entries(it.storeDomains)) { %>
+        <%= value %> <%= key %>;
+    <% } %>
+}
+<% } %>
+
 server {
     listen <%= it.hostPort %>;
     server_name _;
-
+    set $MAGE_MODE <%= it.config.magento.mode %>;
     set $MAGE_ROOT "<%= it.mageRoot %>";
+    set $MAGE_RUN_TYPE website;
+<% if (it.useStoreDomainMapping) { %>
+    set $MAGE_RUN_CODE $SITE_CODE_MAPPING;
+<% } %>
     resolver 127.0.0.11;
 
     root $MAGE_ROOT/pub;
@@ -20,7 +32,6 @@ server {
     client_max_body_size 64M;
     error_page 404 403 = /errors/404.php;
 
-
     # Deny access to sensitive files
     location /.user.ini {
         deny all;
@@ -168,6 +179,12 @@ server {
         fastcgi_keep_conn on;
         fastcgi_index index.php;
         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+
+        fastcgi_param MAGE_RUN_TYPE $MAGE_RUN_TYPE;
+<% if (it.useStoreDomainMapping) { %>
+        fastcgi_param MAGE_RUN_CODE $MAGE_RUN_CODE;
+<% } %>
+
         include fastcgi_params;
     }
 

package/lib/config/templates/ssl-terminator.template.conf

@@ -11,18 +11,14 @@ upstream app_backend {
 
 server {
     listen <%= it.hostPort %>;
-<% if (it.config.ssl.enabled) { %>  listen 443 ssl;
+<% if (it.config.ssl.enabled && !it.config.ssl.external_provider) { %>  listen 443 ssl;
 
     ssl on;
     ssl_certificate /etc/nginx/conf.d/ssl_certificate.pem;
     ssl_certificate_key /etc/nginx/conf.d/ssl_certificate-key.pem;
     ssl_protocols TLSv1.2;<% } %>
 
-     <% if (it.config.host) { %>
-    server_name <%= it.config.host %><% if (it.config.ssl.enabled) { %> <%= it.networkToBindTo %><% } %>;
-    <% } else { %>
-    server_name <% if (it.config.ssl.enabled) { %> <%= it.networkToBindTo %><% } else { %>_<% } %>;
-    <% } %>
+     server_name _;
 
     location / {
         proxy_buffer_size   128k;

package/lib/config/versions/index.js

@@ -1,10 +1,23 @@
 const path = require('path')
 const fs = require('fs')
-const semver = require('semver')
 const { deepmerge } = require('../../util/deepmerge')
+const { defaultMagentoConfig } = require('../magento-config')
 
 const defaultCMAConfig = {
-    prefix: true
+    prefix: true,
+    configuration: {
+        newRelic: {
+            enabled: false,
+            agentVersion: '10.11.0.3'
+        }
+    },
+    magento: defaultMagentoConfig,
+    ssl: {
+        enabled: false
+    },
+    storeDomains: {
+        admin: 'localhost'
+    }
 }
 
 const magentoVersions = fs
@@ -28,37 +41,7 @@ const getConfigurations = (config = {}) =>
 
 const allVersions = Object.entries(getConfigurations())
     .map(([name, magentoConfig]) => ({ ...magentoConfig, name }))
-    .sort((a, b) => {
-        if (
-            a.magentoVersion.replace(/-p[0-9]+$/i, '') ===
-            b.magentoVersion.replace(/-p[0-9]+$/i, '')
-        ) {
-            if (
-                a.magentoVersion.includes('-p') &&
-                !b.magentoVersion.includes('-p')
-            ) {
-                return 1
-            }
-            const aPatchVersion =
-                (a.magentoVersion.includes('-p') &&
-                    Number.parseInt(
-                        a.magentoVersion.match(/-p([0-9]+)$/i)[1],
-                        10
-                    )) ||
-                0
-            const bPatchVersion =
-                (b.magentoVersion.includes('-p') &&
-                    Number.parseInt(
-                        b.magentoVersion.match(/-p([0-9]+)$/i)[1],
-                        10
-                    )) ||
-                0
-
-            return aPatchVersion - bPatchVersion
-        }
-
-        return semver.gt(a.magentoVersion, b.magentoVersion) ? 1 : -1
-    })
+    .sort((a, b) => a.magentoVersion.localeCompare(b.magentoVersion))
     .reverse()
 
 module.exports = {

package/lib/config/versions/magento-2.2.10.js

@@ -1,4 +1,3 @@
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { varnish66 } = require('../services/varnish')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.2.10',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })

package/lib/config/versions/magento-2.3.0.js

@@ -1,4 +1,3 @@
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { varnish66 } = require('../services/varnish')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.3.0',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })

package/lib/config/versions/magento-2.3.1.js

@@ -1,5 +1,4 @@
 const { elasticsearch68 } = require('../services/elasticsearch/versions')
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { redis50 } = require('../services/redis')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.3.1',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })

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

@@ -1,5 +1,4 @@
 const { elasticsearch68 } = require('../services/elasticsearch/versions')
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { redis50 } = require('../services/redis')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.3.2-p1',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })

package/lib/config/versions/magento-2.3.2-p2.js

@@ -1,5 +1,4 @@
 const { elasticsearch68 } = require('../services/elasticsearch/versions')
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { redis50 } = require('../services/redis')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.3.2-p2',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })

package/lib/config/versions/magento-2.3.2.js

@@ -1,5 +1,4 @@
 const { elasticsearch68 } = require('../services/elasticsearch/versions')
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { redis50 } = require('../services/redis')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.3.2',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })

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

@@ -1,5 +1,4 @@
 const { elasticsearch68 } = require('../services/elasticsearch/versions')
-const { defaultMagentoConfig } = require('../magento-config')
 const {
     magento23PHPExtensionList
 } = require('../magento/required-php-extensions')
@@ -14,9 +13,7 @@ const { redis50 } = require('../services/redis')
 const { mariadb102 } = require('../services/mariadb/versions')
 
 /**
- * @param {Object} param0
- * @param {string} param0.templateDir
- * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.3.3-p1',
@@ -37,10 +34,5 @@ module.exports = ({ templateDir }) => ({
         varnish: varnish66({ templateDir }),
         sslTerminator: sslTerminator({ templateDir }),
         maildev: maildev()
-    },
-    magento: defaultMagentoConfig,
-    host: 'localhost',
-    ssl: {
-        enabled: false
     }
 })