internal dump method helper

nan-li · nan-li · commit ced921e44f4b · 2025-11-10T12:27:20.000-08:00
* internal for now, put in information you want to log for each product that conforms to OSLoggable
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/SwiftTest.swift b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/SwiftTest.swift
@@ -38,5 +38,6 @@ class SwiftTest: NSObject, OSLogListener {
         let token = OneSignal.User.pushSubscription.token
         OneSignal.Debug.addLogListener(self)
         OneSignal.Debug.removeLogListener(self)
+        OneSignal.Debug._dump()
     }
 }
diff --git a/iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m b/iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m
@@ -137,6 +137,7 @@ - (IBAction)sendTagButton:(id)sender {
 - (IBAction)getTagsButton:(id)sender {
     NSDictionary<NSString *, NSString*> *tags = [OneSignal.User getTags];
     NSLog(@"Tags: %@", tags);
+    [OneSignal.Debug _dump];
 }
 
 - (IBAction)sendTagsButton:(id)sender {
diff --git a/iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj b/iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj
@@ -56,6 +56,7 @@
 		3C0151922C2E298F0079E076 /* OneSignalInAppMessages.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DEBAAE282A4211D900BF2C1C /* OneSignalInAppMessages.framework */; };
 		3C01519C2C2E29F90079E076 /* IAMRequestTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C01519B2C2E29F90079E076 /* IAMRequestTests.m */; };
 		3C0EF49E28A1DBCB00E5434B /* OSUserInternalImpl.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C0EF49D28A1DBCB00E5434B /* OSUserInternalImpl.swift */; };
+		3C10E0632BF5651500A7B37F /* OSLoggable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C10E0622BF5651500A7B37F /* OSLoggable.swift */; };
 		3C115165289A259500565C41 /* OneSignalOSCore.docc in Sources */ = {isa = PBXBuildFile; fileRef = 3C115164289A259500565C41 /* OneSignalOSCore.docc */; };
 		3C115171289A259500565C41 /* OneSignalOSCore.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C115163289A259500565C41 /* OneSignalOSCore.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		3C115185289ADE4F00565C41 /* OSModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C115184289ADE4F00565C41 /* OSModel.swift */; };
@@ -1241,6 +1242,7 @@
 		3C01518E2C2E298E0079E076 /* OneSignalInAppMessagesTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = OneSignalInAppMessagesTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		3C01519B2C2E29F90079E076 /* IAMRequestTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = IAMRequestTests.m; sourceTree = "<group>"; };
 		3C0EF49D28A1DBCB00E5434B /* OSUserInternalImpl.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = OSUserInternalImpl.swift; sourceTree = "<group>"; };
+		3C10E0622BF5651500A7B37F /* OSLoggable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSLoggable.swift; sourceTree = "<group>"; };
 		3C115161289A259500565C41 /* OneSignalOSCore.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = OneSignalOSCore.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		3C115163289A259500565C41 /* OneSignalOSCore.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalOSCore.h; sourceTree = "<group>"; };
 		3C115164289A259500565C41 /* OneSignalOSCore.docc */ = {isa = PBXFileReference; lastKnownFileType = folder.documentationcatalog; path = OneSignalOSCore.docc; sourceTree = "<group>"; };
@@ -2125,6 +2127,7 @@
 				4710EA522B8FCFB200435356 /* OSDispatchQueue.swift */,
 				DEFB3E642BB7346D00E65DAD /* OSLiveActivities.swift */,
 				DEFB3E662BB735B500E65DAD /* OSStubLiveActivities.swift */,
+				3C10E0622BF5651500A7B37F /* OSLoggable.swift */,
 			);
 			path = Source;
 			sourceTree = "<group>";
@@ -4189,6 +4192,7 @@
 				5BC1DE602C90B83900CA8807 /* OSConsistencyKeyEnum.swift in Sources */,
 				3C4F9E4428A4466C009F453A /* OSOperationRepo.swift in Sources */,
 				3C11518B289ADEEB00565C41 /* OSEventProducer.swift in Sources */,
+				3C10E0632BF5651500A7B37F /* OSLoggable.swift in Sources */,
 				3C115165289A259500565C41 /* OneSignalOSCore.docc in Sources */,
 				5BC1DE5E2C90B80E00CA8807 /* OSCondition.swift in Sources */,
 				5BC1DE5C2C90B7E600CA8807 /* OSConsistencyManager.swift in Sources */,
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.h b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.h
@@ -70,9 +70,10 @@ typedef NS_ENUM(NSUInteger, ONE_S_LOG_LEVEL) {
  */
 + (void)removeLogListener:(NSObject<OSLogListener>*_Nonnull)listener NS_REFINED_FOR_SWIFT;
 
++ (void)_dump;
 @end
 
-@interface OneSignalLog : NSObject<OSDebug>
+@interface OneSignalLog : NSObject <OSDebug>
 + (Class<OSDebug>)Debug;
 + (void)onesignalLog:(ONE_S_LOG_LEVEL)logLevel message:(NSString* _Nonnull)message;
 + (ONE_S_LOG_LEVEL)getLogLevel;
diff --git a/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.m b/iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalLog.m
@@ -38,6 +38,10 @@ - (instancetype)initWithLevel:(ONE_S_LOG_LEVEL)level entry:(NSString*)entry {
 }
 @end
 
+/**
+ Implements the Log Level methods of protocol `OSDebug`.
+ The `_dump` method will be implemented in OneSignal module.
+ */
 @implementation OneSignalLog
 
 static ONE_S_LOG_LEVEL _nsLogLevel = ONE_S_LL_WARN;
@@ -72,6 +76,8 @@ + (void)removeLogListener:(NSObject<OSLogListener>*_Nonnull)listener {
     [self.logListeners removeObject:listener];
 }
 
++ (void)_dump {}
+
 + (void)onesignalLog:(ONE_S_LOG_LEVEL)logLevel message:(NSString* _Nonnull)message {
     onesignal_Log(logLevel, message);
 }
diff --git a/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSLoggable.swift b/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSLoggable.swift
@@ -0,0 +1,30 @@
+/*
+ Modified MIT License
+
+ Copyright 2024 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
+
+public protocol OSLoggable {
+    func logSelf()
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationExecutor.swift b/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationExecutor.swift
@@ -30,7 +30,7 @@ import OneSignalCore
 /**
  Concrete executors drop OSDeltas and Requests when initializing from the cache, when they cannot be connected to their respective models anymore. These cannot be sent, so they are dropped..
  */
-public protocol OSOperationExecutor {
+public protocol OSOperationExecutor: OSLoggable {
     var supportedDeltas: [String] { get }
     var deltaQueue: [OSDelta] { get }
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationRepo.swift b/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationRepo.swift
@@ -178,3 +178,9 @@ public class OSOperationRepo: NSObject {
         }
     }
 }
+
+extension OSOperationRepo: OSLoggable {
+    public func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSIdentityOperationExecutor.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSIdentityOperationExecutor.swift
@@ -289,3 +289,9 @@ class OSIdentityOperationExecutor: OSOperationExecutor {
         }
     }
 }
+
+extension OSIdentityOperationExecutor: OSLoggable {
+    func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSPropertyOperationExecutor.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSPropertyOperationExecutor.swift
@@ -301,3 +301,9 @@ class OSPropertyOperationExecutor: OSOperationExecutor {
         }
     }
 }
+
+extension OSPropertyOperationExecutor: OSLoggable {
+    func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSSubscriptionOperationExecutor.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSSubscriptionOperationExecutor.swift
@@ -446,3 +446,9 @@ class OSSubscriptionOperationExecutor: OSOperationExecutor {
         }
     }
 }
+
+extension OSSubscriptionOperationExecutor: OSLoggable {
+    func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSUserExecutor.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/Executors/OSUserExecutor.swift
@@ -605,3 +605,9 @@ extension OSUserExecutor {
         return response?["identity"] as? [String: String]
     }
 }
+
+extension OSUserExecutor: OSLoggable {
+    func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSIdentityModelRepo.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSIdentityModelRepo.swift
@@ -26,6 +26,7 @@
  */
 
 import Foundation
+import OneSignalOSCore
 
 /**
  This class stores all Identity Models that are being used during an app session.
@@ -53,3 +54,9 @@ class OSIdentityModelRepo {
         }
     }
 }
+
+extension OSIdentityModelRepo: OSLoggable {
+    func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift
@@ -888,3 +888,9 @@ extension OneSignalUserManagerImpl: OneSignalNotificationsDelegate {
         user.pushSubscriptionModel.address = pushToken
     }
 }
+
+extension OneSignalUserManagerImpl: OSLoggable {
+    @objc public func logSelf() {
+        // TODO: You fill in
+    }
+}
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignal.m b/iOS_SDK/OneSignalSDK/Source/OneSignal.m
@@ -77,6 +77,17 @@
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
 
+/**
+ Implements the `_dump` method of protocol `OSDebug`.
+ */
+@implementation OneSignalLog (OSLoggable)
++ (void)_dump {
+    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"OneSignal.Debug._dump called!"];
+    [OneSignalUserManagerImpl.sharedInstance logSelf];
+    // And more ...
+}
+@end
+
 @interface OneSignal (SessionStatusDelegate)
 @end
 

Original file line number	Diff line number	Diff line change
`@@ -38,5 +38,6 @@ class SwiftTest: NSObject, OSLogListener {`
`38`	`38`	`let token = OneSignal.User.pushSubscription.token`
`39`	`39`	`OneSignal.Debug.addLogListener(self)`
`40`	`40`	`OneSignal.Debug.removeLogListener(self)`
	`41`	`+ OneSignal.Debug._dump()`
`41`	`42`	`}`
`42`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,7 @@ - (IBAction)sendTagButton:(id)sender {`
`137`	`137`	`- (IBAction)getTagsButton:(id)sender {`
`138`	`138`	`NSDictionary<NSString , NSString> *tags = [OneSignal.User getTags];`
`139`	`139`	`NSLog(@"Tags: %@", tags);`
	`140`	`+ [OneSignal.Debug _dump];`
`140`	`141`	`}`
`141`	`142`
`142`	`143`	`- (IBAction)sendTagsButton:(id)sender {`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,10 @@ - (instancetype)initWithLevel:(ONE_S_LOG_LEVEL)level entry:(NSString*)entry {`
`38`	`38`	`}`
`39`	`39`	`@end`
`40`	`40`
	`41`	`+/**`
	`42`	+ Implements the Log Level methods of protocol `OSDebug`.
	`43`	+ The `_dump` method will be implemented in OneSignal module.
	`44`	`+ */`
`41`	`45`	`@implementation OneSignalLog`
`42`	`46`
`43`	`47`	`static ONE_S_LOG_LEVEL _nsLogLevel = ONE_S_LL_WARN;`
`@@ -72,6 +76,8 @@ + (void)removeLogListener:(NSObject<OSLogListener>*_Nonnull)listener {`
`72`	`76`	`[self.logListeners removeObject:listener];`
`73`	`77`	`}`
`74`	`78`
	`79`	`++ (void)_dump {}`
	`80`	`+`
`75`	`81`	`+ (void)onesignalLog:(ONE_S_LOG_LEVEL)logLevel message:(NSString* _Nonnull)message {`
`76`	`82`	`onesignal_Log(logLevel, message);`
`77`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -178,3 +178,9 @@ public class OSOperationRepo: NSObject {`
`178`	`178`	`}`
`179`	`179`	`}`
`180`	`180`	`}`
	`181`	`+`
	`182`	`+extension OSOperationRepo: OSLoggable {`
	`183`	`+ public func logSelf() {`
	`184`	`+ // TODO: You fill in`
	`185`	`+ }`
	`186`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -289,3 +289,9 @@ class OSIdentityOperationExecutor: OSOperationExecutor {`
`289`	`289`	`}`
`290`	`290`	`}`
`291`	`291`	`}`
	`292`	`+`
	`293`	`+extension OSIdentityOperationExecutor: OSLoggable {`
	`294`	`+ func logSelf() {`
	`295`	`+ // TODO: You fill in`
	`296`	`+ }`
	`297`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -301,3 +301,9 @@ class OSPropertyOperationExecutor: OSOperationExecutor {`
`301`	`301`	`}`
`302`	`302`	`}`
`303`	`303`	`}`
	`304`	`+`
	`305`	`+extension OSPropertyOperationExecutor: OSLoggable {`
	`306`	`+ func logSelf() {`
	`307`	`+ // TODO: You fill in`
	`308`	`+ }`
	`309`	`+}`