Sentry integration (#644)

* Sentry integration * Force crash button fix * Unit tests fixes
bcc-code · Jan 3, 2025 · 1877701 · 1877701
1 parent 08c4a12
commit 1877701
Show file tree

Hide file tree

Showing 14 changed files with 101 additions and 32 deletions.
diff --git a/BMM.Core/BMM.Core.csproj b/BMM.Core/BMM.Core.csproj
@@ -18,11 +18,11 @@
       <PackageReference Include="IdentityModel.OidcClient" Version="6.0.0" />
       <PackageReference Include="Microsoft.AppCenter" Version="5.0.1" />
       <PackageReference Include="Microsoft.AppCenter.Analytics" Version="5.0.1" />
-      <PackageReference Include="Microsoft.AppCenter.Crashes" Version="5.0.1" />
       <PackageReference Include="MvvmCross" Version="9.2.0" />
       <PackageReference Include="MvvmCross.Plugin.JsonLocalization" Version="9.2.0" />
       <PackageReference Include="MvvmCross.Plugin.Messenger" Version="9.2.0" />
       <PackageReference Include="MvvmCross.Plugin.Visibility" Version="9.2.0" />
+      <PackageReference Include="Sentry" Version="5.0.0" />
       <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="6.34.0" />
       <PackageReference Include="TagLibSharp" Version="2.3.0" />
       <PackageReference Update="Microsoft.Maui.Graphics" Version="8.0.80" />

diff --git a/BMM.Core/Exceptions/ForcedExceptions.cs b/BMM.Core/Exceptions/ForcedExceptions.cs
@@ -0,0 +1,9 @@
+namespace BMM.Core.Exceptions
+{
+    public class ForcedException : Exception
+    {
+        public ForcedException(object sender) : base(sender.ToString())
+        {
+        }
+    }
+}
diff --git a/BMM.Core/Helpers/AnalyticsInitializer.cs b/BMM.Core/Helpers/AnalyticsInitializer.cs
@@ -0,0 +1,57 @@
+using Microsoft.AppCenter;
+using Microsoft.AppCenter.Analytics;
+using Microsoft.Maui.Devices;
+
+namespace BMM.Core.Helpers
+{
+    public abstract class AnalyticsInitializer
+    {
+        private static string iOSPrefix = "ios_";
+        private static string AndroidPrefix = "android_";
+        private static string Dev = "dev";
+        private static string Prod = "prod";
+
+        public static void DroidRegister()
+        {
+            if (!AppCenter.Configured)
+                AppCenter.Start(GlobalConstants.DroidAppSecret, typeof(Analytics));
+
+            InitSentry();
+        }
+
+        public static void IOSRegister()
+        {
+            if (!AppCenter.Configured)
+                AppCenter.Start(GlobalConstants.iOSAppSecret, typeof(Analytics));
+
+            InitSentry();
+        }
+
+        private static void InitSentry()
+        {
+            SentrySdk.Init(options =>
+            {
+                options.Dsn = GlobalConstants.SentryDsn;
+                options.Environment = GetSentryEnvironment();
+                options.Debug = false;
+                options.TracesSampleRate = 1.0;
+                options.ProfilesSampleRate = 1.0;
+            });
+        }
+
+        private static string GetSentryEnvironment()
+        {
+            string env;
+
+#if ENV_INT
+            env = Dev;
+#else
+            env = Prod;
+#endif
+
+            return DeviceInfo.Current.Platform == DevicePlatform.Android
+                ? $"{AndroidPrefix}{env}"
+                : $"{iOSPrefix}{env}";
+        }
+    }
+}
diff --git a/BMM.Core/Helpers/AppCenterHelper.cs b/BMM.Core/Helpers/AppCenterHelper.cs
diff --git a/BMM.Core/Helpers/GlobalConstants.cs b/BMM.Core/Helpers/GlobalConstants.cs
@@ -57,7 +57,8 @@ public class GlobalConstants
         public const int DefaultNumberOfPodcastTracksToDownload = 3;
         public const string DroidAppSecret = "#{Android_APP_SECRET_PLACEHOLDER}#";
         public const string iOSAppSecret = "#{iOS_APP_SECRET_PLACEHOLDER}#";
-
+        public const string SentryDsn = "#{SENTRY_DSN_PLACEHOLDER}#";
+
         public const string AndroidUpdateLink = "https://play.google.com/store/apps/details?id=org.brunstad.bmm";
         public const string IosUpdateLink = "itms-apps://apps.apple.com/no/app/bmm-brunstad/id777577855";
     }

diff --git a/BMM.Core/Implementations/Logger/BaseLogger.cs b/BMM.Core/Implementations/Logger/BaseLogger.cs
@@ -4,7 +4,6 @@
 using BMM.Core.Implementations.Security;
 using BMM.Core.Utils;
 using Microsoft.AppCenter;
-using Microsoft.AppCenter.Crashes;
 
 namespace BMM.Core.Implementations.Logger
 {
@@ -47,7 +46,11 @@ public void Warn(string tag, string message)
         public virtual void Error(string tag, string message)
         {
             var parameters = InitializeDictionaryWithBasicParameters(tag, message);
-            Crashes.TrackError(new ErrorWithoutException(tag + " - " + message), parameters);
+
+            SentrySdk.CaptureMessage(tag + " - " + message,
+                GetSentryScope(parameters),
+                SentryLevel.Error);
+
             AppCenterLog.Error(tag, message);
             Microsoft.AppCenter.Analytics.Analytics.TrackEvent("Error without exception", parameters);
         }
@@ -56,7 +59,7 @@ public virtual void Error(string tag, string message, Exception exception, bool
         {
             var parameters = InitializeDictionaryWithBasicParameters(tag, message, presentedToUser);
 
-            Crashes.TrackError(exception, parameters);
+            SentrySdk.CaptureException(exception, GetSentryScope(parameters));
             AppCenterLog.Error(tag, message, exception);
 
             parameters.Add(StackTrackParameterName, exception.StackTrace);
@@ -65,6 +68,14 @@ public virtual void Error(string tag, string message, Exception exception, bool
             Microsoft.AppCenter.Analytics.Analytics.TrackEvent("Error with exception", parameters);
         }
 
+        private static Action<Scope> GetSentryScope(IDictionary<string, string> parameters)
+        {
+            return scope =>
+            {
+                scope.SetExtras(parameters.Select(s => new KeyValuePair<string, object>(s.Key, s.Value)));
+            };
+        }
+
         private void AddConnectionType(IDictionary<string, string> parameters)
         {
             parameters.Add(AnalyticsConstants.ConnectionParameterName, AnalyticsUtils.GetConnectionType(_connection));

diff --git a/BMM.Core/ViewModels/SettingsViewModel.cs b/BMM.Core/ViewModels/SettingsViewModel.cs
@@ -2,6 +2,7 @@
 using System.ComponentModel;
 using System.Text;
 using Acr.UserDialogs;
+using BMM.Core.Exceptions;
 using BMM.Core.Extensions;
 using BMM.Core.GuardedActions.BibleStudy.Interfaces;
 using BMM.Core.GuardedActions.DebugInfo.Interfaces;
@@ -32,6 +33,7 @@
 using BMM.Core.Translation;
 using BMM.Core.Utils;
 using BMM.Core.ViewModels.Base;
+using Microsoft.Maui.ApplicationModel;
 using Microsoft.Maui.Devices;
 using MvvmCross;
 using MvvmCross.Commands;
@@ -541,7 +543,7 @@ private async Task ShowCachedTracks()
 
         private void CrashTheApp()
         {
-            throw new Exception("Forcefully crash the app!");
+            throw new ForcedException("Forcefully crash the app!");
         }
 
         private async Task Logout()

diff --git a/BMM.Tests/BMM.Core.Test/Unit/ViewModels/SettingsViewModelTests.cs b/BMM.Tests/BMM.Core.Test/Unit/ViewModels/SettingsViewModelTests.cs
@@ -4,6 +4,7 @@
 using System.Threading.Tasks;
 using Acr.UserDialogs;
 using BMM.Api.Implementation.Models;
+using BMM.Core.Exceptions;
 using BMM.Core.GuardedActions.BibleStudy.Interfaces;
 using BMM.Core.GuardedActions.Settings.Interfaces;
 using BMM.Core.Implementations;
@@ -19,12 +20,14 @@
 using BMM.Core.Implementations.FirebaseRemoteConfig;
 using BMM.Core.Implementations.Notifications;
 using BMM.Core.Implementations.Security;
+using BMM.Core.Implementations.Storage;
 using BMM.Core.Implementations.UI;
 using BMM.Core.Models;
 using BMM.Core.Models.POs.Other;
 using BMM.Core.Test.Unit.ViewModels.Base;
 using BMM.Core.Translation;
 using BMM.Core.ViewModels;
+using Microsoft.Maui.Storage;
 using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.Resources;
 using Moq;
 using MvvmCross.Localization;
@@ -66,6 +69,7 @@ public class SettingsViewModelTests : BaseViewModelTests
         private Mock<IMvxNavigationService> _mvxNavigationService;
         private Mock<IBadgeService> _badgeService;
         private Mock<IMvxMessenger> _messageService;
+        private IPreferences _preferencesMock;
 
         public override void SetUp()
         {
@@ -128,6 +132,9 @@ public override void SetUp()
             _storageManager.Setup(x => x.Storages).Returns(new ObservableCollection<IFileStorage>() {defaultStorage.Object});
             _storageManager.Setup(x => x.SelectedStorage).Returns(defaultStorage.Object);
             _storageManager.Setup(x => x.HasMultipleStorageSupport).Returns(true);
+
+            _preferencesMock = Substitute.For<IPreferences>();
+            AppSettings.SetImplementation(_preferencesMock);
         }
 
         public SettingsViewModel CreateSettingsViewModel()
@@ -200,7 +207,7 @@ public async Task OnSelectedItem_ShouldCrashAppUsingDedicatedButton()
             await settingsViewModel.Initialize();
 
             // Act & Assert
-            Assert.Throws<Exception>(() => settingsViewModel.ListItems.OfType<SelectableListItem>().FirstOrDefault(x => x.Title == "Crash the app")?.OnSelected.Execute());
+            Assert.Throws<ForcedException>(() => settingsViewModel.ListItems.OfType<SelectableListItem>().FirstOrDefault(x => x.Title == "Crash the app")?.OnSelected.Execute());
         }
 
         [Test]

diff --git a/BMM.UI.Android/Application/Helpers/SetupHelper.cs b/BMM.UI.Android/Application/Helpers/SetupHelper.cs
@@ -10,7 +10,7 @@ public class SetupHelper
         /// </summary>
         public static void EnsureInitialized()
         {
-            AppCenterHelper.DroidRegister();
+            AnalyticsInitializer.DroidRegister();
             var setup = MvxAndroidSetupSingleton.EnsureSingletonAvailable(BmmApplication.Instance);
             setup.EnsureInitialized();
         }

diff --git a/BMM.UI.Android/BMM.UI.Droid.csproj b/BMM.UI.Android/BMM.UI.Droid.csproj
@@ -28,6 +28,7 @@
     <PackageReference Include="MvvmCross.DroidX.SwipeRefreshLayout" Version="9.2.0" />
     <PackageReference Include="MvvmCross.Plugin.Color" Version="9.2.0" />
     <PackageReference Include="MvvmCross.Plugin.JsonLocalization" Version="9.2.0" />
+    <PackageReference Include="Sentry" Version="5.0.0" />
     <PackageReference Include="Serilog.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="XAB.FlexboxLayout" Version="3.0.0.2" />
     <PackageReference Include="Xam.Plugins.Android.ExoPlayer" Version="2.19.1" />

diff --git a/BMM.UI.Android/SplashScreenActivity.cs b/BMM.UI.Android/SplashScreenActivity.cs
@@ -36,7 +36,7 @@ public SplashScreenActivity() : base(Resource.Layout.splash_screen)
 
         protected override void OnCreate(Bundle savedInstanceState)
         {
-            AppCenterHelper.DroidRegister();
+            AnalyticsInitializer.DroidRegister();
             base.OnCreate(savedInstanceState);
             SetNotificationToHandle();
         }

diff --git a/BMM.UI.iOS/Application/TableViewSource/Base/BaseTableViewSource.cs b/BMM.UI.iOS/Application/TableViewSource/Base/BaseTableViewSource.cs
@@ -1,4 +1,5 @@
 using BMM.Api.Framework;
+using BMM.Core.Exceptions;
 using BMM.Core.Implementations.Analytics;
 using BMM.UI.iOS.TableViewCell.Base;
 using MvvmCross;
@@ -62,7 +63,7 @@ public override void RowSelected(UITableView tableView, NSIndexPath indexPath)
                 tableView.DeselectRow(indexPath, true);
                 base.RowSelected(tableView, indexPath);
             }
-            catch (Exception e)
+            catch (Exception e) when (e is not ForcedException)
             {
                 Mvx
                     .IoCProvider

diff --git a/BMM.UI.iOS/BMM.UI.iOS.csproj b/BMM.UI.iOS/BMM.UI.iOS.csproj
@@ -598,6 +598,7 @@
     <PackageReference Include="MvvmCross" Version="9.2.0" />
     <PackageReference Include="MvvmCross.Plugin.Color" Version="9.2.0" />
     <PackageReference Include="MvvmCross.Plugin.JsonLocalization" Version="9.2.0" />
+    <PackageReference Include="Sentry" Version="5.0.0" />
     <PackageReference Include="Serilog" Version="4.0.1" />
     <PackageReference Include="Serilog.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="Xamarin.Firebase.iOS.CloudMessaging" Version="8.10.0.3" />

diff --git a/BMM.UI.iOS/Main.cs b/BMM.UI.iOS/Main.cs
@@ -7,7 +7,7 @@ public class Application
         // This is the main entry point of the application.
         private static void Main(string[] args)
         {
-            AppCenterHelper.IOSRegister();
+            AnalyticsInitializer.IOSRegister();
             BmmApplication.Main(args, "BmmApplication", "AppDelegate");
         }
     }