feat: Add Screenshots automatically. (#76)

lucas-zimerman · web-flow · commit 411be60d6167 · 2021-08-03T18:33:28.000-04:00
diff --git a/Samples/Sample.Xamarin.Core/Sample.Xamarin.Core.csproj b/Samples/Sample.Xamarin.Core/Sample.Xamarin.Core.csproj
@@ -15,7 +15,7 @@
     <PackageReference Include="Rg.Plugins.Popup" Version="2.0.0.9" />
     <PackageReference Include="Xamanimation" Version="1.3.0" />
     <PackageReference Include="Xamarin.Forms" Version="4.8.0.1451" />
-    <PackageReference Include="Xamarin.Essentials" Version="1.5.3.2" />
+    <PackageReference Include="Xamarin.Essentials" Version="1.6.1" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/Samples/Sample.Xamarin.Droid/MainActivity.cs b/Samples/Sample.Xamarin.Droid/MainActivity.cs
@@ -19,9 +19,8 @@ protected override void OnCreate(Bundle savedInstanceState)
             {
                 options.Dsn = "https://5a193123a9b841bc8d8e42531e7242a1@o447951.ingest.sentry.io/5560112";
                 options.AddXamarinFormsIntegration();
-#if DEBUG
                 options.Debug = true;
-#endif
+                options.AttachScreenshots = true;
             });
 
             TabLayoutResource = Resource.Layout.Tabbar;
diff --git a/Samples/Sample.Xamarin.Droid/Sample.Xamarin.Droid.csproj b/Samples/Sample.Xamarin.Droid/Sample.Xamarin.Droid.csproj
@@ -67,7 +67,7 @@
       <Version>4.3.4</Version>
     </PackageReference>
     <PackageReference Include="Xamarin.Forms" Version="4.8.0.1451" />
-    <PackageReference Include="Xamarin.Essentials" Version="1.5.3.2" />
+    <PackageReference Include="Xamarin.Essentials" Version="1.6.1" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Dependencies\NativeCrash.cs" />
diff --git a/Samples/Sample.Xamarin.UWP/App.xaml.cs b/Samples/Sample.Xamarin.UWP/App.xaml.cs
@@ -1,4 +1,5 @@
 ﻿using Sentry;
+using Sentry.Infrastructure;
 using System;
 using Windows.ApplicationModel;
 using Windows.ApplicationModel.Activation;
@@ -16,9 +17,9 @@ protected override void OnLaunched(LaunchActivatedEventArgs e)
             {
                 options.Dsn = "https://5a193123a9b841bc8d8e42531e7242a1@o447951.ingest.sentry.io/5560112";
                 options.AddXamarinFormsIntegration();
-#if DEBUG
                 options.Debug = true;
-#endif
+                options.DiagnosticLogger = new TraceDiagnosticLogger(SentryLevel.Debug);
+                options.AttachScreenshots = true;
             });
             Frame rootFrame = Window.Current.Content as Frame;
 
diff --git a/Samples/Sample.Xamarin.UWP/Package.appxmanifest b/Samples/Sample.Xamarin.UWP/Package.appxmanifest
@@ -4,7 +4,8 @@
   xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
   xmlns:mp="http://schemas.microsoft.com/appx/2014/phone/manifest"
   xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
-  IgnorableNamespaces="uap mp">
+  xmlns:uap6="http://schemas.microsoft.com/appx/manifest/uap/windows10/6"
+  IgnorableNamespaces="uap mp uap6">
 
   <Identity
     Name="com.companyname.Sample.Xamarin.UWP"
@@ -45,5 +46,6 @@
 
   <Capabilities>
     <Capability Name="internetClient" />
+    <uap6:Capability Name="graphicsCapture"/>
   </Capabilities>
 </Package>
diff --git a/Samples/Sample.Xamarin.UWP/Sample.Xamarin.UWP.csproj b/Samples/Sample.Xamarin.UWP/Sample.Xamarin.UWP.csproj
@@ -159,7 +159,7 @@
       <Version>2.0.0.9</Version>
     </PackageReference>
     <PackageReference Include="Xamarin.Essentials">
-      <Version>1.5.3.2</Version>
+      <Version>1.6.1</Version>
     </PackageReference>
     <PackageReference Include="Xamarin.Forms">
       <Version>4.8.0.1451</Version>
@@ -196,4 +196,4 @@
   <Target Name="AfterBuild">
   </Target>
   -->
-</Project>
+</Project>
diff --git a/Samples/Sample.Xamarin.iOS/Sample.Xamarin.iOS.csproj b/Samples/Sample.Xamarin.iOS/Sample.Xamarin.iOS.csproj
@@ -132,7 +132,7 @@
       <Version>2.0.0.9</Version>
     </PackageReference>
     <PackageReference Include="Xamarin.Forms" Version="4.8.0.1451" />
-    <PackageReference Include="Xamarin.Essentials" Version="1.5.3.2" />
+    <PackageReference Include="Xamarin.Essentials" Version="1.6.1" />
     <!-- Required to work around an issue with Mono and transient dependencies that require this type -->
     <PackageReference Include="System.Memory" Version="4.5.4" IncludeAssets="None" />
   </ItemGroup>
diff --git a/Src/Sentry.Xamarin/Extensions/SentryXamarinOptionsExtensions.cs b/Src/Sentry.Xamarin/Extensions/SentryXamarinOptionsExtensions.cs
@@ -2,6 +2,7 @@
 using Xamarin.Essentials;
 using Sentry.Xamarin.Internals;
 using Sentry.Internals.Session;
+using Sentry.Internals.Device.Screenshot;
 
 namespace Sentry
 {
@@ -62,6 +63,16 @@ internal static void RegisterXamarinEventProcessors(this SentryXamarinOptions op
 #endif
         }
 
+        internal static void RegisterScreenshotEventProcessor(this SentryXamarinOptions options)
+        {
+#if NATIVE_PROCESSOR && !UAP10_0_16299
+            if (options.AttachScreenshots)
+            {
+                options.AddEventProcessor(new ScreenshotEventProcessor(options));
+            }
+#endif
+        }
+
         internal static bool RegisterNativeIntegrations(this SentryXamarinOptions options)
         {
             if (options.NativeIntegrationEnabled)
diff --git a/Src/Sentry.Xamarin/Internals/Device/Screenshot/ScreenshotAttachment.cs b/Src/Sentry.Xamarin/Internals/Device/Screenshot/ScreenshotAttachment.cs
@@ -0,0 +1,26 @@
+﻿using System;
+using System.IO;
+
+namespace Sentry.Internals.Device.Screenshot
+{
+    internal class ScreenshotAttachment : Attachment
+    {
+        public ScreenshotAttachment(ScreenshotAttachmentContent content)
+        : this(
+        AttachmentType.Default,
+        content,
+        "screenshot",
+        "image/jpeg")
+        {
+        }
+
+        private ScreenshotAttachment(
+            AttachmentType type,
+            IAttachmentContent content,
+            string fileName,
+            string? contentType)
+            : base(type, content, fileName, contentType)
+        {
+        }
+    }
+}
diff --git a/Src/Sentry.Xamarin/Internals/Device/Screenshot/ScreenshotAttachmentContent.cs b/Src/Sentry.Xamarin/Internals/Device/Screenshot/ScreenshotAttachmentContent.cs
@@ -0,0 +1,48 @@
+﻿using System.IO;
+
+namespace Sentry.Internals.Device.Screenshot
+{
+    internal class ScreenshotAttachmentContent : IAttachmentContent
+    {
+        private byte[] _data { get; set; }
+
+        private bool _wasRead { get; set; }
+
+        /// <summary>
+        /// The content ctor
+        /// </summary>
+        /// <param name="stream">A Ready once stream containing the image data.</param>
+        public ScreenshotAttachmentContent(Stream stream)
+        {
+            SetNewData(stream);
+        }
+
+        public void SetNewData(Stream stream)
+        {
+            _data = new byte[stream.Length];
+            stream.Read(_data, 0, _data.Length);
+        }
+
+        /// <summary>
+        /// Inform is the content was previously read.
+        /// By calling this function you will reset the read state to false and return the current state.
+        /// </summary>
+        /// <returns>true if the content was read.</returns>
+        public bool ResetWasRead()
+        {
+            var read = _wasRead;
+            _wasRead = false;
+            return read;
+        }
+
+        /// <summary>
+        /// Get a stream from the attachment data.
+        /// </summary>
+        /// <returns>A Memory stream containing the data.</returns>
+        public Stream GetStream()
+        {
+            _wasRead = true;
+            return new MemoryStream(_data);
+        }
+    }
+}
diff --git a/Src/Sentry.Xamarin/Internals/Device/Screenshot/ScreenshotEventProcessor.droid.ios.cs b/Src/Sentry.Xamarin/Internals/Device/Screenshot/ScreenshotEventProcessor.droid.ios.cs
@@ -0,0 +1,53 @@
+﻿using Sentry.Extensibility;
+using Xamarin.Essentials;
+using System.IO;
+using System;
+
+namespace Sentry.Internals.Device.Screenshot
+{
+    internal class ScreenshotEventProcessor : ISentryEventProcessor
+    {
+        private ScreenshotAttachmentContent? _screenshot { get; set; }
+        private SentryXamarinOptions _options { get; }
+
+        public ScreenshotEventProcessor(SentryXamarinOptions options) => _options = options;
+
+        public SentryEvent? Process(SentryEvent @event)
+        {
+            try
+            {
+                if (_options.SessionLogger?.IsBackground() == false)
+                {
+                    var stream = Capture();
+                    if (stream != null)
+                    {
+                        /* Create a new attachment if no screenshot attachment was found.
+                         * If there's an attachment content but it wasnt read during the last event processing
+                         * Assume it was cleared and create a new one.
+                         */
+                        if (_screenshot?.ResetWasRead() != true)
+                        {
+                            _screenshot = new ScreenshotAttachmentContent(stream);
+                            SentrySdk.ConfigureScope(s => s.AddAttachment(new ScreenshotAttachment(_screenshot)));
+                        }
+                        else 
+                        {
+                            _screenshot.SetNewData(stream);
+                        }
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                _options.DiagnosticLogger?.LogError("Failed to capture a screenshot", ex);
+            }
+            return @event;
+        }
+
+        private Stream Capture()
+        {
+            var screenStream = global::Xamarin.Essentials.Screenshot.CaptureAsync().ConfigureAwait(false).GetAwaiter().GetResult();
+            return screenStream.OpenReadAsync(ScreenshotFormat.Jpeg).ConfigureAwait(false).GetAwaiter().GetResult();
+        }
+    }
+}
diff --git a/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.droid.cs b/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.droid.cs
@@ -9,6 +9,12 @@ internal class DeviceActiveLogger : IDeviceActiveLogger
         /// </summary>
         private bool IsPaused;
 
+        /// <summary>
+        /// Informs if the device is on background.
+        /// </summary>
+        /// <returns>True if the app is on background, otherwise false</returns>
+        public bool IsBackground() => IsPaused;
+
         /// <inheritdoc cref="IHub.PauseSession"/>
         public void StatePaused()
         {
diff --git a/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.ios.cs b/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.ios.cs
diff --git a/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.ios.uwp.cs b/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.ios.uwp.cs
@@ -0,0 +1,27 @@
+﻿namespace Sentry.Internals.Session
+{
+    internal class DeviceActiveLogger : IDeviceActiveLogger
+    {
+        private bool _isPaused { get; set; } = true;
+
+        /// <summary>
+        /// Informs if the device is on background.
+        /// </summary>
+        /// <returns>True if the app is on background, otherwise false</returns>
+        public bool IsBackground() => _isPaused;
+
+        /// <inheritdoc cref="IHub.PauseSession"/>
+        public void StatePaused()
+        {
+            _isPaused = true;
+            SentrySdk.PauseSession();
+        }
+
+        /// <inheritdoc cref="IHub.ResumeSession"/>
+        public void StateResumed()
+        {
+            _isPaused = false;
+            SentrySdk.ResumeSession();
+        }
+    }
+}
diff --git a/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.uwp.cs b/Src/Sentry.Xamarin/Internals/Session/DeviceActiveLogger.uwp.cs
diff --git a/Src/Sentry.Xamarin/Internals/Session/IDeviceActiveLogger.cs b/Src/Sentry.Xamarin/Internals/Session/IDeviceActiveLogger.cs
@@ -5,5 +5,7 @@ internal interface IDeviceActiveLogger
         void StatePaused();
 
         void StateResumed();
+
+        bool IsBackground();
     }
 }
diff --git a/Src/Sentry.Xamarin/Sentry.Xamarin.csproj b/Src/Sentry.Xamarin/Sentry.Xamarin.csproj
@@ -30,37 +30,37 @@
 	</PropertyGroup>	
 	
 	<ItemGroup>	
-		<Compile Remove="Internals\**\*.netstandard.cs" />
-		<Compile Remove="Internals\**\*.ios.cs" />
-		<Compile Remove="Internals\**\*.droid.cs" />
-		<Compile Remove="Internals\**\*.uwp.cs" />
+		<Compile Remove="Internals\**\*.netstandard*.cs" />
+		<Compile Remove="Internals\**\*.ios*.cs" />
+		<Compile Remove="Internals\**\*.droid*.cs" />
+		<Compile Remove="Internals\**\*.uwp*.cs" />
+
+		<None Include="Internals\**\*.netstandard*.cs" />
+		<None Include="Internals\**\*.ios*.cs" />
+		<None Include="Internals\**\*.droid*.cs" />
+		<None Include="Internals\**\*.uwp*.cs" />
+	</ItemGroup>	
 
-		<None Include="Internals\**\*.netstandard.cs" />
-		<None Include="Internals\**\*.ios.cs" />
-		<None Include="Internals\**\*.droid.cs" />
-		<None Include="Internals\**\*.uwp.cs" />
-	</ItemGroup>
-	
 	<ItemGroup>
-		<PackageReference Include="Xamarin.Essentials" Version="1.4.0" />
+		<PackageReference Include="Xamarin.Essentials" Version="1.6.1" />
 	</ItemGroup>
 
 	<ItemGroup Condition=" $(TargetFramework.StartsWith('Xamarinios')) ">
-		<Compile Include="Internals\**\*.ios.cs" />
+		<Compile Include="Internals\**\*.ios*.cs" />
 		<PackageReference Include="System.Memory" Version="4.5.4" />
 		<PackageReference Include="System.Buffers" Version="4.5.1" />
 	</ItemGroup>
 
 	<ItemGroup Condition=" $(TargetFramework.StartsWith('monoandroid')) ">
-		<Compile Include="Internals\**\*.droid.cs" />
+		<Compile Include="Internals\**\*.droid*.cs" />
 	</ItemGroup>
 
 	<ItemGroup Condition="$(TargetFramework.StartsWith('uap'))">
-		<Compile Include="Internals\**\*.uwp.cs" />
+		<Compile Include="Internals\**\*.uwp*.cs" />
 		<PackageReference Include="Microsoft.NETCore.UniversalWindowsPlatform" Version="6.2.9" />
 	</ItemGroup>
 
 	<ItemGroup Condition=" $(TargetFramework.StartsWith('netstandard')) ">
-		<Compile Include="Internals\**\*.netstandard.cs" />
+		<Compile Include="Internals\**\*.netstandard*.cs" />
 	</ItemGroup>
 </Project>
diff --git a/Src/Sentry.Xamarin/SentryXamarin.cs b/Src/Sentry.Xamarin/SentryXamarin.cs
@@ -37,6 +37,7 @@ public static void Init(SentryXamarinOptions options)
             options.RegisterNativeActivityStatus();
             options.RegisterNativeIntegrations();
             options.RegisterXamarinEventProcessors();
+            options.RegisterScreenshotEventProcessor();
             options.RegisterXamarinInAppExclude();
             options.ProtocolPackageName ??= ProtocolPackageName;
             SentrySdk.Init(options);
diff --git a/Src/Sentry.Xamarin/SentryXamarinOptions.cs b/Src/Sentry.Xamarin/SentryXamarinOptions.cs
