Merge pull request #537 from MindscapeHQ/mb/singleton-client-asp-net-…

…framework-http-module Use Singleton RaygunClient in RaygunHttpModule (.NET Framework)
MindscapeHQ · Jul 25, 2024 · c1ed837 · c1ed837
2 parents ff5ef7e + f350e0b
commit c1ed837
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 25 deletions.
diff --git a/CHANGE-LOG.md b/CHANGE-LOG.md
@@ -1,5 +1,9 @@
 # Full Change Log for Raygun4Net.* packages
 
+### v11.0.3
+- Update `RaygunHttpModule` (Raygun4Net ASP.NET Framework) to use a singleton `RaygunClient` instance
+  - See: https://github.com/MindscapeHQ/raygun4net/pull/537
+
 ### v11.0.2
 - Fix null signature issue when Debug Symbols are set to None and the application is built in Release mode
   - See: https://github.com/MindscapeHQ/raygun4net/pull/535 
@@ -127,4 +131,4 @@
 - Fixed issue with signed packages for NetCore nugets
 
 ### v6.7.0
-- Changed `SendInBackground` to no longer be blocking
+- Changed `SendInBackground` to no longer be blocking
diff --git a/Mindscape.Raygun4Net4/RaygunClient.cs b/Mindscape.Raygun4Net4/RaygunClient.cs
@@ -438,6 +438,7 @@ public void SendInBackground(Func<RaygunMessage> raygunMessage)
 
     private void StripAndSend(Exception exception, IList<string> tags, IDictionary userCustomData, RaygunIdentifierMessage userInfo, DateTime? currentTime)
     {
+      var contextId = GetContextId();
       var requestMessage = BuildRequestMessage();
       IList<RaygunBreadcrumb> breadcrumbs = BuildBreadCrumbList();
 
@@ -447,23 +448,14 @@ private void StripAndSend(Exception exception, IList<string> tags, IDictionary u
         {
           x.Details.Request = requestMessage;
           x.Details.Breadcrumbs = breadcrumbs;
+          x.Details.ContextId = contextId;
         }));
       }
     }
 
-    private static IList<RaygunBreadcrumb> BuildBreadCrumbList()
-    {
-      IList<RaygunBreadcrumb> breadCrumbs = null;
-      foreach (var breadCrumb in _breadcrumbs)
-      {
-        breadCrumbs ??= new List<RaygunBreadcrumb>();
-        breadCrumbs.Add(breadCrumb);
-      }
-      return breadCrumbs ?? Array.Empty<RaygunBreadcrumb>();
-    }
-
     private void StripAndSendInBackground(Exception exception, IList<string> tags, IDictionary userCustomData, RaygunIdentifierMessage userInfo, DateTime? currentTime)
     {
+      var contextId = GetContextId();
       var requestMessage = BuildRequestMessage();
       IList<RaygunBreadcrumb> breadcrumbs = BuildBreadCrumbList();
 
@@ -473,10 +465,22 @@ private void StripAndSendInBackground(Exception exception, IList<string> tags, I
         {
           x.Details.Request = requestMessage;
           x.Details.Breadcrumbs = breadcrumbs;
+          x.Details.ContextId = contextId;
         }));
       }
     }
 
+    private static IList<RaygunBreadcrumb> BuildBreadCrumbList()
+    {
+      IList<RaygunBreadcrumb> breadCrumbs = null;
+      foreach (var breadCrumb in _breadcrumbs)
+      {
+        breadCrumbs ??= new List<RaygunBreadcrumb>();
+        breadCrumbs.Add(breadCrumb);
+      }
+      return breadCrumbs ?? Array.Empty<RaygunBreadcrumb>();
+    }
+
     /// <summary>
     /// Posts a RaygunMessage to the Raygun API endpoint.
     /// </summary>
@@ -600,7 +604,6 @@ protected RaygunMessage BuildMessage(Exception exception, IList<string> tags, ID
         .SetVersion(ApplicationVersion)
         .SetTags(tags)
         .SetUserCustomData(userCustomData)
-        .SetContextId(ContextId)
         .SetUser(userInfoMessage ?? UserInfo ?? (!string.IsNullOrEmpty(User) ? new RaygunIdentifierMessage(User) : null))
         .Customise(customise)
         .Build();
@@ -668,6 +671,11 @@ protected IEnumerable<Exception> StripWrapperExceptions(Exception exception)
       }
     }
 
+    private string GetContextId()
+    {
+      return HttpContext.Current?.Session?.SessionID;
+    }
+
     #endregion // Message Building Methods
 
     #region Message Offline Storage

diff --git a/Mindscape.Raygun4Net4/RaygunHttpModule.cs b/Mindscape.Raygun4Net4/RaygunHttpModule.cs
@@ -8,6 +8,8 @@ namespace Mindscape.Raygun4Net
 {
   public class RaygunHttpModule : IHttpModule
   {
+    private RaygunClient _raygunClient;
+
     private bool ExcludeErrorsBasedOnHttpStatusCode { get; set; }
 
     private bool ExcludeErrorsFromLocal { get; set; }
@@ -68,20 +70,12 @@ public void SendError(HttpApplication application, Exception exception)
 
     protected RaygunClient GetRaygunClient(HttpApplication application)
     {
-      var raygunApplication = application as IRaygunApplication;
-      return raygunApplication != null ? raygunApplication.GenerateRaygunClient() : GenerateDefaultRaygunClient(application);
-    }
-
-    private RaygunClient GenerateDefaultRaygunClient(HttpApplication application)
-    {
-      var instance = new RaygunClient();
-
-      if (HttpContext.Current != null && HttpContext.Current.Session != null)
+      if (application is IRaygunApplication raygunApplication)
       {
-        instance.ContextId = HttpContext.Current.Session.SessionID;
+        return raygunApplication.GenerateRaygunClient();
       }
 
-      return instance;
+      return _raygunClient ??= new RaygunClient();
     }
 
     protected bool CanSend(Exception exception)
@@ -111,4 +105,4 @@ private Assembly GetWebEntryAssembly(HttpApplication application)
       return type == null ? null : type.Assembly;
     }
   }
-}
+}