Merge pull request #155 from namecheap/feature/RND-326

Feature/rnd 326: Added ability to wrap NewRelic client side JS with custom wrapper

docs/installation_guide.md

@@ -48,5 +48,11 @@ ILC supports integration with [NewRelic APM](https://newrelic.com/products/appli
 
 To turn it on you need to pass your NewRelic license key in `NR_LICENSE_KEY` env variable to ILC & Registry containers.
 
+You can also wrap JS code that NR will generate if you have NewRelic Browser product enabled via `NR_CUSTOM_CLIENT_JS_WRAPPER`
+env variable. This may be useful for the compliance with GDPR customer settings. Example of usage:
+```html
+<script type="text/javascript">(function mygdprWrapper(){ %CONTENT% })()</script>`
+```
+
 Custom metrics sent to Insights:
 * PageAction with Action Name `routeChange`. It contains duration of the reroute in ms.

ilc/config/custom-environment-variables.json5

@@ -15,6 +15,7 @@
     },
     newrelic: {
         licenseKey: 'NR_LICENSE_KEY',
+        customClientJsWrapper: 'NR_CUSTOM_CLIENT_JS_WRAPPER',
     },
     overrideConfigTrustedOrigins: 'OVERRIDE_CONFIG_TRUSTED_ORIGINS'
 }

ilc/config/default.json5

@@ -14,6 +14,10 @@
     },
     newrelic: {
         licenseKey: null,
+        /**
+         * Usage example: <script type="text/javascript">(function mygdprWrapper(){ %CONTENT% })()</script>
+         */
+        customClientJsWrapper: null,
     },
     overrideConfigTrustedOrigins: null
 }

ilc/config/development.json5

@@ -1,3 +1,3 @@
 {
-  productionMode: false
-}
+    productionMode: false
+}

ilc/server/app.js

@@ -10,7 +10,7 @@ const errorHandler = require('./errorHandler');
 
 app.register(require('./ping'));
 
-const tailor = tailorFactory(config.get('cdnUrl'));
+const tailor = tailorFactory(config.get('cdnUrl'), config.get('newrelic.customClientJsWrapper'));
 
 if (config.get('cdnUrl') === null) {
     app.use('/_ilc/', serveStatic(config.get('productionMode')));

ilc/server/tailor/configs-injector.js

@@ -3,12 +3,14 @@ const urljoin = require('url-join');
 const newrelic = require('newrelic');
 
 module.exports = class ConfigsInjector {
+    #nrCustomClientJsWrapper;
     #cdnUrl;
     #jsInjectionPlaceholder = '<!-- ILC_JS -->';
     #cssInjectionPlaceholder = '<!-- ILC_CSS -->';
 
-    constructor(cdnUrl = null) {
+    constructor(cdnUrl = null, nrCustomClientJsWrapper = null) {
         this.#cdnUrl = cdnUrl;
+        this.#nrCustomClientJsWrapper = nrCustomClientJsWrapper;
     }
 
     inject(request, registryConfig, template, slots) {
@@ -35,7 +37,7 @@ module.exports = class ConfigsInjector {
             `<script>window.ilcApps = [];</script>`,
             this.#getPolyfill(),
             this.#wrapWithAsyncScriptTag(this.#getClientjsUrl()),
-            newrelic.getBrowserTimingHeader(),
+            this.#getNewRelicScript(),
         );
 
         if (document.includes(this.#jsInjectionPlaceholder)) {
@@ -154,11 +156,23 @@ module.exports = class ConfigsInjector {
 
     #wrapWithFragmentStylesheetLink = (url, fragmentId) => {
         return `<link rel="stylesheet" href="${url}" data-fragment-id="${fragmentId}">`;
-    }
+    };
 
     #getCrossoriginAttribute = (url) => {
         return (this.#cdnUrl !== null && url.includes(this.#cdnUrl)) || url.includes('://') ? 'crossorigin' : '';
     };
 
     #wrapWithIgnoreDuringParsing = (...content) => `<!-- TailorX: Ignore during parsing START -->${content.join('')}<!-- TailorX: Ignore during parsing END -->`;
+
+    #getNewRelicScript = () => {
+        let nrCode = newrelic.getBrowserTimingHeader();
+
+        if (this.#nrCustomClientJsWrapper === null || !nrCode) {
+            return nrCode;
+        }
+
+        nrCode = nrCode.replace(/<script.*?>(.*)<\/script\s*>/s, '$1');
+
+        return this.#nrCustomClientJsWrapper.replace('%CONTENT%', nrCode);
+    }
 };

ilc/server/tailor/factory.js

@@ -13,9 +13,9 @@ const fragmentHooks = require('./fragment-hooks');
 const ConfigsInjector = require('./configs-injector');
 
 
-module.exports = function (cdnUrl) {
+module.exports = function (cdnUrl, nrCustomClientJsWrapper = null) {
     const router = new Router(console);
-    const configsInjector = new ConfigsInjector(cdnUrl);
+    const configsInjector = new ConfigsInjector(cdnUrl, nrCustomClientJsWrapper);
 
     const tailor = new Tailor({
         fetchTemplate: fetchTemplate(