Merge pull request #153 from bugsnag/release/3.0.0

Release 3.0.0

Author: yousif-bugsnag

Bugsnag.snk

@@ -1,6 +1,22 @@
 Changelog
 =========
 
+## 3.0.0 (2022-01-31)
+
+### Breaking Changes
+ 
+The `Bugnsag.dll`, `Bugsnag.AspNet.dll`, `Bugsnag.AspNet.Mvc.dll` and `Bugsnag.AspNet.WebApi.dll` assemblies are now strong-name signed. The strong name key file `Bugsnag.snk` has been added to the repository. `Bugsnag.AspNet.Core.dll` remains unchanged. See the upgrade guide for more details.
+
+### Bug fixes
+
+* Strong name sign assemblies
+  | [yousif-bugsnag](https://github.com/yousif-bugsnag)
+  | [#151](https://github.com/bugsnag/bugsnag-dotnet/pull/151)
+  
+* Ensure breadcrumbs are returned in the correct order
+  | [yousif-bugsnag](https://github.com/yousif-bugsnag)
+  | [#150](https://github.com/bugsnag/bugsnag-dotnet/pull/150)
+
 ## 2.2.3 (2021-09-06)
 
 ### Enhancements

CHANGELOG.md

@@ -1,5 +1,7 @@
 <Project>
   <PropertyGroup>
     <OutputPath>$(BaseOutputPath)</OutputPath>
+	<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)Bugsnag.snk</AssemblyOriginatorKeyFile>
+    <SignAssembly>true</SignAssembly>
   </PropertyGroup>
 </Project>

Directory.build.props

@@ -1,6 +1,15 @@
 Upgrading
 =========
 
+## 2.x to 3.x
+
+If you are targeting .NET Framework, v3.0.0 contains binary breaking changes due to the introduction of strong name signing. You will need to re-compile your application against the new version. If you are referencing a library that also references Bugsnag you may also need to add a binding redirect or enable automatic binding redirection in your project file:
+
+```
+<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
+```
+
+.NET Core and .NET 5/6 do not recognise strong names so there is no action required if targetting one of those.
 ## 1.x to 2.x
 
 *Our .NET notifier has gone through some major improvements, and there are some changes you'll need to make to get onto the new version.*

UPGRADING.md

@@ -4,6 +4,7 @@
     <Title>Bugsnag .NET ASP.NET Core Notifier</Title>
     <Description>The Bugsnag Notifier for ASP.NET Core gives you instant notification of exceptions thrown from your ASP.NET Core applications. Any uncaught exceptions will trigger a notification to be sent to your Bugsnag project.</Description>
     <TargetFrameworks>netstandard1.3;netstandard2.0</TargetFrameworks>
+	<SignAssembly>false</SignAssembly>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\Bugsnag\Bugsnag.csproj" />

src/Bugsnag.AspNet.Core/Bugsnag.AspNet.Core.csproj

@@ -1,5 +1,6 @@
 using Bugsnag.Payload;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace Bugsnag
 {
@@ -43,8 +44,7 @@ public class Breadcrumbs : IBreadcrumbs
   {
     private readonly object _lock = new object();
     private readonly int _maximumBreadcrumbs;
-    private readonly Breadcrumb[] _breadcrumbs;
-    private int _current;
+    private readonly LinkedList<Breadcrumb> _breadcrumbs;
 
     /// <summary>
     /// Constructs a collection of breadcrumbs
@@ -53,8 +53,7 @@ public class Breadcrumbs : IBreadcrumbs
     public Breadcrumbs(IConfiguration configuration)
     {
       _maximumBreadcrumbs = configuration.MaximumBreadcrumbs;
-      _current = 0;
-      _breadcrumbs = new Breadcrumb[_maximumBreadcrumbs];
+      _breadcrumbs = new LinkedList<Breadcrumb>();
     }
 
     /// <summary>
@@ -83,13 +82,19 @@ public void Leave(string message, BreadcrumbType type, IDictionary<string, strin
     /// <param name="breadcrumb"></param>
     public void Leave(Breadcrumb breadcrumb)
     {
-      if (breadcrumb != null)
+      if (breadcrumb == null || _maximumBreadcrumbs < 1)
       {
-        lock (_lock)
+        return;
+      }
+
+      lock (_lock)
+      {
+        if (_breadcrumbs.Count >= _maximumBreadcrumbs)
         {
-          _breadcrumbs[_current] = breadcrumb;
-          _current = (_current + 1) % _maximumBreadcrumbs;
+          _breadcrumbs.RemoveFirst();
         }
+
+        _breadcrumbs.AddLast(breadcrumb);
       }
     }
 
@@ -101,18 +106,7 @@ public IEnumerable<Breadcrumb> Retrieve()
     {
       lock (_lock)
       {
-        var numberOfBreadcrumbs = System.Array.IndexOf(_breadcrumbs, null);
-
-        if (numberOfBreadcrumbs < 0) numberOfBreadcrumbs = _maximumBreadcrumbs;
-
-        var breadcrumbs = new Breadcrumb[numberOfBreadcrumbs];
-
-        for (int i = 0; i < numberOfBreadcrumbs; i++)
-        {
-          breadcrumbs[i] = _breadcrumbs[i];
-        }
-
-        return breadcrumbs;
+        return _breadcrumbs.ToList();
       }
     }
   }

src/Bugsnag/Breadcrumbs.cs

@@ -117,7 +117,7 @@ public void Notify(System.Exception exception, HandledState handledState)
 
     public void Notify(System.Exception exception, HandledState handledState, Middleware callback)
     {
-      var report = new Report(_configuration, exception, handledState, Breadcrumbs.Retrieve().ToArray(), SessionTracking.CurrentSession);
+      var report = new Report(_configuration, exception, handledState, Breadcrumbs.Retrieve(), SessionTracking.CurrentSession);
 
       Notify(report, callback);
     }

src/Bugsnag/Client.cs

@@ -35,7 +35,7 @@ public class Report : Dictionary<string, object>, IPayload
     /// <param name="severity"></param>
     /// <param name="breadcrumbs"></param>
     /// <param name="session"></param>
-    public Report(IConfiguration configuration, System.Exception exception, HandledState severity, Breadcrumb[] breadcrumbs, Session session)
+    public Report(IConfiguration configuration, System.Exception exception, HandledState severity, IEnumerable<Breadcrumb> breadcrumbs, Session session)
     {
       _ignored = false;
       Endpoint = configuration.Endpoint;

src/Bugsnag/Payload/Report.cs

@@ -1,4 +1,7 @@
 <Project>
+
+  <Import Project="..\Directory.Build.props"/>
+
   <PropertyGroup>
     <Authors>snmaynard kattrali martin308</Authors>
     <Version></Version>

src/Directory.build.props

@@ -36,14 +36,14 @@ public void CorrectBreadcrumbsAreReturned()
     {
       var breadcrumbs = new Breadcrumbs(new Configuration { MaximumBreadcrumbs = 5 });
 
-      for (int i = 0; i < 10; i++)
+      for (int i = 0; i < 6; i++)
       {
         breadcrumbs.Leave($"{i}");
       }
 
       var breadcrumbNames = breadcrumbs.Retrieve().Select(b => b.Name);
 
-      Assert.Equal(new string[] { "5", "6", "7", "8", "9" }, breadcrumbNames);
+      Assert.Equal(new string[] { "1", "2", "3", "4", "5" }, breadcrumbNames);
     }
   }
 }

tests/Bugsnag.Tests/BreadcrumbsTests.cs

@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <SignAssembly>false</SignAssembly>
+  </PropertyGroup>
+</Project>