@scandipwa/magento-scripts 2.0.2 → 2.0.3-alpha.0

package/lib/config/docker.js

@@ -24,7 +24,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         elasticsearch,
         mariadb,
         varnish,
-        maildev
+        maildev,
+        newRelic
     } = configuration;
 
     const php = getPhpConfig(overridenConfiguration, baseConfig);
@@ -347,6 +348,22 @@ 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',
+                mountVolumes: [
+                    '/var/run/docker.sock:/var/run/docker.sock',
+                    '/:/host:ro',
+                    `${path.join(process.cwd(), 'newrelic-infra.yml')}:/etc/newrelic-infra.yml`
+                ],
+                capAdd: 'SYS_PTRACE'
+            };
+        }
+
         return dockerConfig;
     };
 

package/lib/config/versions/index.js

@@ -4,7 +4,13 @@ const semver = require('semver');
 const { deepmerge } = require('../../util/deepmerge');
 
 const defaultCMAConfig = {
-    prefix: true
+    prefix: true,
+    configuration: {
+        newRelic: {
+            enabled: false,
+            agentVersion: '10.2.0.314'
+        }
+    }
 };
 
 const magentoVersions = fs.readdirSync(__dirname, {

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

@@ -128,6 +128,23 @@ const buildDockerFileInstructions = async (ctx, { image, tag }) => {
             PATH: `${ imagePathEnv.split('=').pop() }:${ magentoBinDir }:${vendorBinDir }`
         });
 
+    if (ctx.config.overridenConfiguration.configuration.newRelic.enabled) {
+        const { agentVersion, licenseKey } = ctx.config.overridenConfiguration.configuration.newRelic;
+
+        dockerFileInstructions
+            .run('apk add --no-cache gcompat')
+        // eslint-disable-next-line max-len
+            .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/util/config-file-validator.js

@@ -111,12 +111,12 @@ const elasticsearchConfigurationSchema = Joi.object({
  * @type {Joi.ObjectSchema<import('../../typings').ComposerConfiguration>}
  */
 const composerConfigurationSchema = Joi.object({
-    version: Joi.string().optional().custom((value) => {
+    version: Joi.string().optional().custom((value, helpers) => {
         if (['1', '2'].includes(value)) {
             return undefined;
         }
 
-        return versionValidator(value);
+        return versionValidator(value, helpers);
     }),
     plugins: Joi.object()
         .pattern(
@@ -130,6 +130,21 @@ 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.message('when newRelic is enabled license key is required!');
+    }
+
+    return true;
+});
+
 /**
  * @type {Joi.ObjectSchema<import('../../typings').CMAConfiguration['configuration']>}
  */
@@ -142,7 +157,8 @@ const configurationSchema = Joi.object({
     composer: composerConfigurationSchema.optional(),
     varnish: varnishConfigurationSchema.optional(),
     sslTerminator: nginxConfigurationSchema.optional(),
-    maildev: serviceConfigurationSchema.optional()
+    maildev: serviceConfigurationSchema.optional(),
+    newRelic: newRelicConfigurationSchema.optional()
 });
 
 /**

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.0.2",
+    "version": "2.0.3-alpha.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -54,5 +54,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "676d083e666a985e1942a7b1d216ca6d6b6151f8"
+    "gitHead": "c9e600b48c4f6d2dd612d234aaf839f8cbcf1734"
 }

package/typings/index.d.ts

@@ -199,6 +199,23 @@ export interface SSLConfiguration {
     ssl_certificate_key: string
 }
 
+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 {
     /**
      * Services configuration
@@ -243,6 +260,11 @@ export interface CMAConfiguration {
          * SSL Terminator configuration
          */
         sslTerminator: SSLTerminatorConfiguration
+
+        /**
+         * New Relic configuration
+         */
+        newRelic: NewRelicConfiguration
     }
     /**
      * Magento configuration