Fix logging deadlock on app resume

monal-im · Dec 16, 2024 · e77cc30 · e77cc30
1 parent 03602f6
commit e77cc30
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 16 deletions.
diff --git a/Monal/Classes/HelperTools.m b/Monal/Classes/HelperTools.m
@@ -81,6 +81,15 @@ -(id) swizzled_objectForKey:(NSString*) defaultName;
 -(void) swizzled_setObject:(id) value forKey:(NSString*) defaultName;
 @end
 
+//make method visible
+@interface DDLog()
+-(void) queueLogMessage:(DDLogMessage*) logMessage asynchronously:(BOOL) asyncFlag;
+@end
+
+@interface DDLog (AllowQueueFreeze)
+-(void) swizzled_queueLogMessage:(DDLogMessage*) logMessage asynchronously:(BOOL) asyncFlag;
+@end
+
 static char* _crashBundleName = "UnifiedReport";
 static NSString* _processID;
 static DDFileLogger* _fileLogger = nil;
@@ -89,8 +98,8 @@ -(void) swizzled_setObject:(id) value forKey:(NSString*) defaultName;
 static char _origProfilePath[1024] = "";
 static char _profilePath[1024] = "";
 static NSObject* _isAppExtensionLock = nil;
-static NSObject* _suspensionHandlingLock = nil;
-static BOOL _suspensionHandlingIsSuspended = NO;
+static NSObject* _suspensionHandling_lock = nil;
+static BOOL _suspensionHandling_isSuspended = NO;
 static NSMutableDictionary* _versionInfoCache;
 static MLStreamRedirect* _stdoutRedirector = nil;
 static MLStreamRedirect* _stderrRedirector = nil;
@@ -381,12 +390,36 @@ +(void) load
 }
 @end
 
+@implementation DDLog (AllowQueueFreeze)
+
+-(void) swizzled_queueLogMessage:(DDLogMessage*) logMessage asynchronously:(BOOL) asyncFlag
+{
+    //don't do sync logging for any message (usually ERROR), while the global logging queue is suspended
+    @synchronized(_suspensionHandling_lock) {
+        return [self swizzled_queueLogMessage:logMessage asynchronously:_suspensionHandling_isSuspended ? YES : asyncFlag];
+    }
+}
+
+//see https://stackoverflow.com/a/13326633 and https://fek.io/blog/method-swizzling-in-obj-c-and-swift/
++(void) load
+{
+    if(self == DDLog.self)
+    {
+        static dispatch_once_t onceToken;
+        dispatch_once(&onceToken, ^{
+            swizzle([self class], @selector(queueLogMessage:asynchronously:), @selector(swizzled_queueLogMessage:asynchronously:));
+        });
+    }
+}
+
+@end
+
 @implementation HelperTools
 
 +(void) initialize
 {
-    _suspensionHandlingLock = [NSObject new];
-    _suspensionHandlingIsSuspended = NO;
+    _suspensionHandling_lock = [NSObject new];
+    _suspensionHandling_isSuspended = NO;
     _isAppExtensionLock = [NSObject new];
     _versionInfoCache = [NSMutableDictionary new];
 
@@ -2103,13 +2136,13 @@ +(void) flushLogsWithTimeout:(double) timeout
 
 +(void) signalSuspension
 {
-    @synchronized(_suspensionHandlingLock) {
-        if(!_suspensionHandlingIsSuspended)
+    @synchronized(_suspensionHandling_lock) {
+        if(!_suspensionHandling_isSuspended)
         {
             DDLogVerbose(@"Suspending logger queue...");
             [HelperTools flushLogsWithTimeout:0.100];
             dispatch_suspend([DDLog loggingQueue]);
-            _suspensionHandlingIsSuspended = YES;
+            _suspensionHandling_isSuspended = YES;
 
             DDLogVerbose(@"Posting kMonalFrozen notification now...");
             [[NSNotificationCenter defaultCenter] postNotificationName:kMonalFrozen object:nil];
@@ -2119,12 +2152,12 @@ +(void) signalSuspension
 
 +(void) signalResumption
 {
-    @synchronized(_suspensionHandlingLock) {
-        if(_suspensionHandlingIsSuspended)
+    @synchronized(_suspensionHandling_lock) {
+        if(_suspensionHandling_isSuspended)
         {
             DDLogVerbose(@"Resuming logger queue...");
             dispatch_resume([DDLog loggingQueue]);
-            _suspensionHandlingIsSuspended = NO;
+            _suspensionHandling_isSuspended = NO;
 
             DDLogVerbose(@"Posting kMonalUnfrozen notification now...");
             [[NSNotificationCenter defaultCenter] postNotificationName:kMonalUnfrozen object:nil];

diff --git a/Monal/Classes/MonalAppDelegate.m b/Monal/Classes/MonalAppDelegate.m
@@ -1578,9 +1578,6 @@ -(void) handleBackgroundProcessingTask:(BGTask*) task
         }];
     };
 
-    //resume logging and other core tasks
-    [HelperTools signalResumption];
-
     //only proceed with our BGTASK if the NotificationServiceExtension is not running
     [MLProcessLock lock];
     [[IPC sharedInstance] sendMessage:@"Monal.disconnectAll" withData:nil to:@"NotificationServiceExtension"];
@@ -1685,9 +1682,6 @@ -(void) handleBackgroundRefreshingTask:(BGTask*) task
         }];
     };
 
-    //resume logging and other core tasks
-    [HelperTools signalResumption];
-
     //only proceed with our BGTASK if the NotificationServiceExtension is not running
     [MLProcessLock lock];
     [[IPC sharedInstance] sendMessage:@"Monal.disconnectAll" withData:nil to:@"NotificationServiceExtension"];
@@ -1731,6 +1725,9 @@ -(void) handleBackgroundRefreshingTask:(BGTask*) task
 -(void) configureBackgroundTasks
 {
     [[BGTaskScheduler sharedScheduler] registerForTaskWithIdentifier:kBackgroundProcessingTask usingQueue:dispatch_get_main_queue() launchHandler:^(BGTask *task) {
+        //resume logging and other core tasks
+        [HelperTools signalResumption];
+
         DDLogDebug(@"RUNNING BGPROCESSING LAUNCH HANDLER");
         DDLogInfo(@"BG time available: %f", [UIApplication sharedApplication].backgroundTimeRemaining);
         if(![HelperTools isInBackground])
@@ -1751,6 +1748,9 @@ -(void) configureBackgroundTasks
     }];
 
     [[BGTaskScheduler sharedScheduler] registerForTaskWithIdentifier:kBackgroundRefreshingTask usingQueue:dispatch_get_main_queue() launchHandler:^(BGTask *task) {
+        //resume logging and other core tasks
+        [HelperTools signalResumption];
+
         DDLogDebug(@"RUNNING BGREFRESHING LAUNCH HANDLER");
         DDLogInfo(@"BG time available: %f", [UIApplication sharedApplication].backgroundTimeRemaining);
         if(![HelperTools isInBackground])