Add support for injecting script tag with Url and RUM key configuration. Allow Retrace as a replacement for Stackify in configuration. Support more config via environment

Author: kbond-stackify

Src/StackifyLib/Config.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text.RegularExpressions;
 using StackifyLib.Utils;
 
 namespace StackifyLib
@@ -108,6 +109,26 @@ public static void LoadSettings()
                         LoggingJsonMaxFields = maxFields;
                     }
                 }
+
+                var rumScriptUrl = Get("Stackify.Rum_Script_Url", "https://stckjs.stackify.com/stckjs.js");
+
+                if (Uri.IsWellFormedUriString(rumScriptUrl, UriKind.Absolute))
+                {
+                    var uri = new Uri(rumScriptUrl);
+
+                    var scheme = uri.Scheme;
+
+                    if (string.Equals(scheme, "https", StringComparison.OrdinalIgnoreCase))
+                    {
+                        RumScriptUrl = rumScriptUrl;
+                    }
+                }
+
+                var rumKey = Get("Stackify.Rum_Key");
+                if (Regex.IsMatch(rumKey, "^[A-Za-z0-9-]+$"))
+                {
+                    RumKey = rumKey;
+                }
             }
             catch (Exception ex)
             {
@@ -150,6 +171,10 @@ public static void LoadSettings()
 
         public static int LoggingJsonMaxFields { get; set; } = 50;
 
+        public static string RumScriptUrl { get; set; }
+
+        public static string RumKey { get; set; }
+
 
         /// <summary>
         /// Attempts to fetch a setting value given the key.
@@ -171,6 +196,13 @@ internal static string Get(string key, string defaultValue = null)
                     {
                         var appSettings = _configuration.GetSection("Stackify");
                         v = appSettings[key.Replace("Stackify.", string.Empty)];
+
+                        if (string.IsNullOrEmpty(v))
+                        {
+                            // Search in Retrace, but key will likely still be Stackify.name, not Retrace.name in the code
+                            var retraceAppSettings = _configuration.GetSection("Retrace");
+                            v = retraceAppSettings[key.Replace("Stackify.", string.Empty)];
+                        }
                     }
 #endif
 
@@ -185,6 +217,22 @@ internal static string Get(string key, string defaultValue = null)
                     {
                         v = System.Environment.GetEnvironmentVariable(key);
                     }
+
+                    if (string.IsNullOrEmpty(v))
+                    {
+                        v = System.Environment.GetEnvironmentVariable(key.ToUpperInvariant());
+                    }
+
+                    if (string.IsNullOrEmpty(v))
+                    {
+                        // Linux systems do not allow period in an environment variable name
+                        v = System.Environment.GetEnvironmentVariable(key.Replace('.', '_').ToUpperInvariant());
+                    }
+
+                    if (string.IsNullOrEmpty(v) && key.StartsWith("Stackify."))
+                    {
+                        v = System.Environment.GetEnvironmentVariable("RETRACE_" + key.Substring(9).Replace('.', '_').ToUpperInvariant());
+                    }
                 }
             }
             finally

Src/StackifyLib/Utils/HelperFunctions.cs

@@ -8,6 +8,7 @@
 using System.Runtime.Remoting.Messaging;
 #endif
 using System.Text;
+using System.Text.RegularExpressions;
 using Newtonsoft.Json.Linq;
 
 
@@ -605,6 +606,83 @@ protected static bool IsBeingProfiled
             }
         }
 
+        public static String MaskReportingUrl(String url)
+        {
+            String maskedUrl = "";
+
+            try
+            {
+                String[] pathFields = url.Split('/');
+
+                List<String> stripFields = new List<String>(pathFields.Length);
+
+                foreach (String field in pathFields)
+                {
+                    stripFields.Add(Mask(field));
+                }
+
+                maskedUrl = string.Join("/", stripFields);
+
+                if (maskedUrl.EndsWith("/"))
+                {
+                    maskedUrl = maskedUrl.Substring(0, maskedUrl.Length - 1);
+                }
+            }
+            catch
+            {
+                // If we had errors, just return what we got.
+                return url;
+            }
+
+            return maskedUrl;
+        }
+
+
+        private static readonly Regex ID_REGEX = new Regex("^(\\d+)$", RegexOptions.Compiled);
+
+        private static readonly Regex GUID_REGEX =
+            new Regex("^(?i)(\\b[A-F0-9]{8}(?:-[A-F0-9]{4}){3}-[A-F0-9]{12}\\b)$", RegexOptions.Compiled);
+
+        private static readonly Regex EMAIL_REGEX =
+            new Regex(
+                "^((([!#$%&'*+\\-/=?^_`{|}~\\w])|([!#$%&'*+\\-/=?^_`{|}~\\w][!#$%&'*+\\-/=?^_`{|}~\\.\\w]{0,}[!#$%&'*+\\-/=?^_`{|}~\\w]))[@]\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*)$",
+                RegexOptions.Compiled);
+
+        private static readonly Regex IP_REGEX =
+            new Regex(
+                "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
+                RegexOptions.Compiled);
+
+        private static String Mask(String field)
+        {
+
+            if (ID_REGEX.IsMatch(field))
+            {
+                return "{id}";
+            }
+
+            if (GUID_REGEX.IsMatch(field))
+            {
+                return "{guid}";
+            }
+
+            if (EMAIL_REGEX.IsMatch(field))
+            {
+                return "{email}";
+            }
+
+            if (IP_REGEX.IsMatch(field))
+            {
+                return "{ip}";
+            }
+
+            if (field.Contains(';'))
+            {
+                return field.Substring(0, field.IndexOf(';'));
+            }
+
+            return field;
+        }
     }
 
     public class ToStringConverter : JsonConverter

Src/StackifyLib/Web/RealUserMonitoring.cs

@@ -11,6 +11,15 @@ public static class RealUserMonitoring
     {
         public static string GetHeaderScript()
         {
+            var rumScriptUrl = Config.RumScriptUrl;
+            var rumKey = Config.RumKey;
+
+            if (string.IsNullOrWhiteSpace(rumScriptUrl) || string.IsNullOrWhiteSpace(rumKey))
+            {
+                // If we don't have a key and url, don't insert the script
+                return "";
+            }
+
             var settings = new JObject();
             var reqId = HelperFunctions.GetRequestId();
             if (reqId != null)
@@ -33,10 +42,12 @@ public static string GetHeaderScript()
             var reportingUrl = HelperFunctions.GetReportingUrl();
             if (reportingUrl != null)
             {
+                reportingUrl = HelperFunctions.MaskReportingUrl(reportingUrl);
                 settings["Trans"] = Convert.ToBase64String(System.Text.Encoding.UTF8.GetBytes(reportingUrl));
             }
 
-            return string.Format(@"<script type=""text/javascript"">var StackifySettings = {0};</script>", settings.ToString(Formatting.None));
+            return string.Format(@"<script type=""text/javascript"">(window.StackifySetting || (window.StackifySettings = {0};))</script><script src=""{1}"" data-key=""{2}"" async></script>",
+                settings.ToString(Formatting.None), rumScriptUrl, rumKey);
         }
     }
 }