feat(logging): add public log listener methods

Adds the following new public methods:
* OneSignal.Debug.addLogListener
* OneSignal.Debug.removeLogListener

These new methods provide a way to capture all SDK log entires at runtime, allowing the app developer to store these and/or send them to their server.

The log listener is independent of logLevel, all message are always sent to listeners.

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -2678,9 +2678,9 @@
 				4529DF0B1FA932AC00CEAB1D /* OneSignalTrackFirebaseAnalytics.m */,
 				DE7D1831270279D9002D3A5D /* OSNotificationClasses.h */,
 				DE7D183527027AA0002D3A5D /* OneSignalLog.h */,
+				DE7D183327027A73002D3A5D /* OneSignalLog.m */,
 				3CCF44BC299B17290021964D /* OneSignalWrapper.h */,
 				3CCF44BD299B17290021964D /* OneSignalWrapper.m */,
-				DE7D183327027A73002D3A5D /* OneSignalLog.m */,
 				DE7D187627037A16002D3A5D /* OneSignalCoreHelper.h */,
 				DE7D187827037A26002D3A5D /* OneSignalCoreHelper.m */,
 				7AE28B8725B8ADF400529100 /* OSMacros.h */,

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.h

@@ -36,10 +36,41 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
     ONE_S_LL_VERBOSE
 };
 
+@interface OneSignalLogEvent : NSObject
+@property(readonly)ONE_S_LOG_LEVEL level;
+@property(readonly, nonnull)NSString *entry;
+@end
+
+@protocol OSLogListener <NSObject>
+- (void)onLogEvent:(OneSignalLogEvent *_Nonnull)event;
+@end
+
 @protocol OSDebug <NSObject>
+/**
+ The log level the OneSignal SDK should be writing to the Xcode log. Defaults to [LogLevel.WARN].
+ 
+ WARNING: This should not be set higher than LogLevel.WARN in a production setting.
+ */
 + (void)setLogLevel:(ONE_S_LOG_LEVEL)logLevel;
+/**
+ The log level the OneSignal SDK should be showing as a modal. Defaults to [LogLevel.NONE].
+ 
+ WARNING: This should not be used in a production setting.
+ */
 + (void)setAlertLevel:(ONE_S_LOG_LEVEL)logLevel NS_REFINED_FOR_SWIFT;
 + (void)_dump;
+/**
+ Add a listener to receive all logging messages the SDK produces.
+ Useful to capture and send logs to your server.
+ 
+ NOTE: All log messages are always passed, LogLevel has no effect on this.
+ */
++ (void)addLogListener:(NSObject<OSLogListener>*_Nonnull)listener NS_REFINED_FOR_SWIFT;
+/**
+ Removes a listener added by addLogListener
+ */
++ (void)removeLogListener:(NSObject<OSLogListener>*_Nonnull)listener NS_REFINED_FOR_SWIFT;
+
 @end
 
 @interface OneSignalLog : NSObject <OSDebug>

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.m

@@ -29,6 +29,14 @@
 #import "OneSignalLog.h"
 #import "OSDialogInstanceManager.h"
 
+@implementation OneSignalLogEvent
+- (instancetype)initWithLevel:(ONE_S_LOG_LEVEL)level entry:(NSString*)entry {
+    _level = level;
+    _entry = entry;
+    return self;
+}
+@end
+
 /**
  Implements the Log Level methods of protocol `OSDebug`.
  The `_dump` method will be implemented in OneSignal module.
@@ -42,6 +50,15 @@ @implementation OneSignalLog
     return self;
 }
 
++ (NSMutableArray<NSObject<OSLogListener> *>*)logListeners {
+    static NSMutableArray<NSObject<OSLogListener> *> *_logListeners;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        _logListeners = [NSMutableArray new];
+    });
+    return _logListeners;
+}
+
 + (void)setLogLevel:(ONE_S_LOG_LEVEL)nsLogLevel {
     _nsLogLevel = nsLogLevel;
 }
@@ -50,6 +67,18 @@ + (void)setAlertLevel:(ONE_S_LOG_LEVEL)logLevel {
     _alertLogLevel = logLevel;
 }
 
++ (void)addLogListener:(NSObject<OSLogListener>*_Nonnull)listener {
+    @synchronized(self.logListeners) {
+        [self.logListeners addObject:listener];
+    }
+}
+
++ (void)removeLogListener:(NSObject<OSLogListener>*_Nonnull)listener {
+    @synchronized(self.logListeners) {
+        [self.logListeners removeObject:listener];
+    }
+}
+
 + (void)_dump {}
 
 + (void)onesignalLog:(ONE_S_LOG_LEVEL)logLevel message:(NSString* _Nonnull)message {
@@ -92,6 +121,15 @@ void onesignal_Log(ONE_S_LOG_LEVEL logLevel, NSString* message) {
     if (logLevel <= _alertLogLevel) {
         [[OSDialogInstanceManager sharedInstance] presentDialogWithTitle:levelString withMessage:message withActions:nil cancelTitle:NSLocalizedString(@"Close", @"Close button") withActionCompletion:nil];
     }
+
+    @synchronized(OneSignalLog.logListeners) {
+        for (NSObject<OSLogListener> *listener in OneSignalLog.logListeners) {
+            if ([listener respondsToSelector:@selector(onLogEvent:)]) {
+                OneSignalLogEvent *event = [[OneSignalLogEvent alloc] initWithLevel:logLevel entry:[levelString stringByAppendingString:message]];
+                [listener onLogEvent:event];
+            }
+        }
+    }
 }
 
 @end

iOS_SDK/OneSignalSDK/Source/OneSignalSwiftInterface.swift

@@ -71,9 +71,29 @@ public extension OneSignal {
 }
 
 public extension OSDebug {
+    /**
+     The log level the OneSignal SDK should be showing as a modal. Defaults to [LogLevel.NONE].
+     
+     WARNING: This should not be used in a production setting.
+     */
     static func setAlertLevel(_ logLevel: ONE_S_LOG_LEVEL) {
         __setAlert(logLevel)
     }
+    /**
+     Add a listener to receive all logging messages the SDK produces.
+     Useful to capture and send logs to your server.
+     
+     NOTE: All log messages are always passed, LogLevel has no effect on this.
+     */
+    static func addLogListener(_ listener: OSLogListener) {
+        __add(listener)
+    }
+    /**
+     Removes a listener added by addLogListener
+     */
+    static func removeLogListener(_ listener: OSLogListener) {
+        __remove(listener)
+    }
 }
 
 public extension OSInAppMessages {