Send out log messages via UDP even if global logging queue is suspended

Author: tmolitor-stud-tu

Monal/Classes/HelperTools.m

@@ -394,10 +394,38 @@ @implementation DDLog (AllowQueueFreeze)
 
 -(void) swizzled_queueLogMessage:(DDLogMessage*) logMessage asynchronously:(BOOL) asyncFlag
 {
+    //make sure this method remains performant even when checking for udp logging presence
+    static BOOL udpLoggerEnabled = NO;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        udpLoggerEnabled = [[HelperTools defaultsDB] boolForKey:@"udpLoggerEnabled"];
+    });
+    
     //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];
+    //don't use _suspensionHandling_lock here because that can introduce deadlocks
+    //(for example if we have log statements in our MLLogFileManager code rotating the logfile and creating a new one)
+    BOOL isSuspended = _suspensionHandling_isSuspended;
+    if(isSuspended && udpLoggerEnabled)
+    {
+        //use udp logger to log all messages, even if the loggging queue is in suspended state
+        //this hopefully enables us to catch strange bugs sometimes hanging and then watchdog-killing the app when resuming from resumption
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+        [MLUDPLogger directlyWriteLogMessage:[[DDLogMessage alloc]
+             initWithFormat:[NSString stringWithFormat:@"+++ LOG_QUEUE_DISABLED+++ %@", logMessage.messageFormat]
+                  formatted:[NSString stringWithFormat:@"+++ LOG_QUEUE_DISABLED+++ %@", logMessage.message]
+                      level:logMessage.level
+                       flag:logMessage.flag
+                    context:logMessage.context
+                       file:logMessage.file
+                   function:logMessage.function
+                       line:logMessage.line
+                        tag:logMessage.tag
+                    options:logMessage.options
+                  timestamp:logMessage.timestamp]];
+#pragma clang diagnostic pop
     }
+    return [self swizzled_queueLogMessage:logMessage asynchronously:isSuspended ? YES : asyncFlag];
 }
 
 //see https://stackoverflow.com/a/13326633 and https://fek.io/blog/method-swizzling-in-obj-c-and-swift/
@@ -2090,30 +2118,35 @@ +(NSData* _Nullable) convertLogmessageToJsonData:(DDLogMessage*) logMessage coun
     //construct json dictionary
     (*counter)++;
     NSDictionary* representedObject = @{
-        @"queueThreadLabel": [self getQueueThreadLabelFor:logMessage],
+        @"queueThreadLabel": nilWrapper([self getQueueThreadLabelFor:logMessage]),
         @"processType": [self isAppExtension] ? @"appex" : @"mainapp",
-        @"processName": [[[NSBundle mainBundle] executablePath] lastPathComponent],
+        @"processName": nilWrapper([[[NSBundle mainBundle] executablePath] lastPathComponent]),
         @"counter": [NSNumber numberWithUnsignedLongLong:*counter],
-        @"processID": _processID,
-        @"qosName": qos2name(logMessage.qos),
-        @"representedObject": logMessage.representedObject ? logMessage.representedObject : [NSNull null],
+        @"processID": nilWrapper(_processID),
+        @"qosName": nilWrapper(qos2name(logMessage.qos)),
+        @"loggingQueueSuspended": bool2str(_suspensionHandling_isSuspended),
+        @"representedObject": nilWrapper(logMessage.representedObject),
     };
     NSDictionary* msgDict = @{
-        @"messageFormat": logMessage.messageFormat,
-        @"message": logMessage.message,
+        @"messageFormat": nilWrapper(logMessage.messageFormat),
+        @"message": nilWrapper(logMessage.message),
         @"level": [NSNumber numberWithInteger:logMessage.level],
         @"flag": [NSNumber numberWithInteger:logMessage.flag],
         @"context": [NSNumber numberWithInteger:logMessage.context],
-        @"file": logMessage.file,
-        @"fileName": logMessage.fileName,
-        @"function": logMessage.function,
+        @"file": nilWrapper(logMessage.file),
+        @"fileName": nilWrapper(logMessage.fileName),
+        @"function": nilWrapper(logMessage.function),
         @"line": [NSNumber numberWithInteger:logMessage.line],
-        @"tag": representedObject,
+        @"representedObject": nilWrapper(representedObject),
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+        @"tag": nilWrapper(logMessage.tag),
+#pragma clang diagnostic pop
         @"options": [NSNumber numberWithInteger:logMessage.options],
         @"timestamp": [dateFormatter stringFromDate:logMessage.timestamp],
-        @"threadID": logMessage.threadID,
-        @"threadName": logMessage.threadName,
-        @"queueLabel": logMessage.queueLabel,
+        @"threadID": nilWrapper(logMessage.threadID),
+        @"threadName": nilWrapper(logMessage.threadName),
+        @"queueLabel": nilWrapper(logMessage.queueLabel),
         @"qos": [NSNumber numberWithInteger:logMessage.qos],
     };
 

Monal/Classes/MLUDPLogger.h

@@ -11,9 +11,12 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+FOUNDATION_EXPORT DDLoggerName const DDLoggerNameUDP NS_SWIFT_NAME(DDLoggerName.udp); // MLUDPLogger
+
 @interface MLUDPLogger : DDAbstractLogger <DDLogger>
 
 +(void) flushWithTimeout:(double) timeout;
++(void) directlyWriteLogMessage:(DDLogMessage*) logMessage;
 
 @end
 

Monal/Classes/MLUDPLogger.m

@@ -19,6 +19,8 @@
 #import "MLContact.h"
 #import "xmpp.h"
 
+DDLoggerName const DDLoggerNameUDP = @"monal.loggger.udp.mainQueue";
+
 static NSData* _key;
 static volatile MLUDPLogger* _self;
 
@@ -78,6 +80,16 @@ +(void) flushWithTimeout:(double) timeout
     }
 }
 
++(void) directlyWriteLogMessage:(DDLogMessage*) logMessage
+{
+    if(_self == nil)
+    {
+        [[self class] logError:@"Ignoring call to directlySyncWriteLogMessage: _self still nil!"];
+        return;
+    }
+    return [_self logMessage:logMessage];
+}
+
 -(void) dealloc
 {
     _self = nil;
@@ -87,14 +99,20 @@ -(void) didAddLogger
 {
     _self = self;
     _send_condition = [NSCondition new];
-    _send_queue = dispatch_queue_create("MLUDPLoggerSendQueue", dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_USER_INTERACTIVE, 0));
+    _send_queue = dispatch_queue_create("MLUDPLoggerInternalSendQueue", dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_USER_INTERACTIVE, 0));
 }
 
 -(void) willRemoveLogger
 {
     _self = nil;
 }
 
+
+-(DDLoggerName) loggerName
+{
+    return DDLoggerNameUDP;
+}
+
 +(void) logError:(NSString*) format, ... NS_FORMAT_FUNCTION(1, 2)
 {
 #ifdef IS_ALPHA