Merge pull request #53 from patchkit-net/feature/zlib-exception-in-unpacking

Cherrypicking the zlib exception handling into 3.10

Author: witcher112

Assets/PatchKit Patcher/Scripts/AppData/Local/Pack1Unarchiver.cs

@@ -8,6 +8,8 @@
 using PatchKit.Unity.Patcher.Data;
 using PatchKit.Unity.Patcher.Debug;
 using PatchKit.Unity.Utilities;
+using SharpRaven;
+using SharpRaven.Data;
 
 namespace PatchKit.Unity.Patcher.AppData.Local
 {
@@ -225,16 +227,33 @@ private void ExtractFileFromStream(
             {
                 using (var gzipStream = new GZipStream(cryptoStream, Ionic.Zlib.CompressionMode.Decompress))
                 {
-                    long bytesProcessed = 0;
-                    const int bufferSize = 128 * 1024;
-                    var buffer = new byte[bufferSize];
-                    int count;
-                    while ((count = gzipStream.Read(buffer, 0, bufferSize)) != 0)
+                    try
                     {
-                        cancellationToken.ThrowIfCancellationRequested();
-                        targetStream.Write(buffer, 0, count);
-                        bytesProcessed += count;
-                        onProgress((double) gzipStream.Position / file.Size.Value);
+                        long bytesProcessed = 0;
+                        const int bufferSize = 128 * 1024;
+                        var buffer = new byte[bufferSize];
+                        int count;
+                        while ((count = gzipStream.Read(buffer, 0, bufferSize)) != 0)
+                        {
+                            targetStream.Write(buffer, 0, count);
+                            bytesProcessed += count;
+                            onProgress(bytesProcessed / (double) file.Size.Value);
+                        }
+                    }
+                    catch (Exception e)
+                    {
+                        DebugLogger.LogException(e);
+
+                        var logManager = PatcherLogManager.Instance;
+                        PatcherLogSentryRegistry sentryRegistry = logManager.SentryRegistry;
+                        RavenClient ravenClient = sentryRegistry.RavenClient;
+
+                        var sentryEvent = new SentryEvent(e);
+                        PatcherLogSentryRegistry.AddDataToSentryEvent(sentryEvent, logManager.Storage.Guid.ToString());
+
+                        ravenClient.Capture(sentryEvent);
+
+                        throw;
                     }
                 }
             }

Assets/PatchKit Patcher/Scripts/Debug/PatcherLogManager.cs

@@ -36,6 +36,14 @@ public static PatcherLogManager Instance
             }
         }
 
+        public PatcherLogSentryRegistry SentryRegistry
+        {
+            get 
+            {
+                return _sentryRegistry;
+            }
+        }
+
         private static readonly DebugLogger DebugLogger = new DebugLogger(typeof(PatcherLogManager));
 
         private PatcherLogStream _stream;
@@ -45,6 +53,8 @@ public static PatcherLogManager Instance
         private PatcherLogRegisterTriggers _registerTriggers;
 
         private PatcherLogStorage _storage;
+
+        public PatcherLogStorage Storage { get { return _storage; } }
 
         private PatcherLogSentryRegistry _sentryRegistry;
 

Assets/PatchKit Patcher/Scripts/Debug/PatcherLogSentryRegistry.cs

@@ -8,15 +8,23 @@ namespace PatchKit.Unity.Patcher.Debug
 {
     public class PatcherLogSentryRegistry
     {
+        public RavenClient RavenClient
+        {
+            get 
+            {
+                return _ravenClient;
+            }
+        }
+        
         private readonly RavenClient _ravenClient;
 
+        public static readonly string RavenClientId = "https://cb13d9a4a32f456c8411c79c6ad7be9d:[email protected]/175617"; 
+
         public PatcherLogSentryRegistry()
         {
             ServicePointManager.ServerCertificateValidationCallback += (sender, certificate, chain, errors) => true; 
 
-            _ravenClient
-                = new RavenClient( 
-                    "https://cb13d9a4a32f456c8411c79c6ad7be9d:[email protected]/175617"); 
+            _ravenClient = new RavenClient(RavenClientId); 
         }
 
         public void RegisterWithException(Issue issue, string logFileGuid)
@@ -41,7 +49,7 @@ public void RegisterWithException(Exception exception, string logFileGuid)
             }, logFileGuid);
         }
 
-        private static void AddDataToSentryEvent(SentryEvent sentryEvent, string logFileGuid)
+        public static void AddDataToSentryEvent(SentryEvent sentryEvent, string logFileGuid)
         {
             sentryEvent.Exception.Data.Add("log-guid", logFileGuid);
             sentryEvent.Exception.Data.Add("log-link", string.Format(

CHANGELOG.md

@@ -30,6 +30,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Rename PK_PATCHER_MAIN_URL environmental variable to PK_PATCHER_API_URL
 - The patcher will now delete the lockfile when quitting
 
+## [3.9.2]
+### Added
+- Logging the probable cause of the Zlib exception when unpacking
+
 ## [3.9.1]
 ### Fixed
 - Use 'any' instead of 'all' for publish method