App lifecycle logging & log persistence

RadarSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name                  = 'RadarSDK'
-  s.version               = '3.8.12'
+  s.version               = '3.8.13'
   s.summary               = 'iOS SDK for Radar, the leading geofencing and location tracking platform'
   s.homepage              = 'https://radar.com'
   s.author                = { 'Radar Labs, Inc.' => '[email protected]' }

RadarSDK.xcodeproj/project.pbxproj

@@ -159,6 +159,8 @@
 		DD8E2F7A24018C37002D51AB /* CLLocationManagerMock.m in Sources */ = {isa = PBXBuildFile; fileRef = DD8E2F7924018C37002D51AB /* CLLocationManagerMock.m */; };
 		DD8E2F7D24018C54002D51AB /* CLVisitMock.m in Sources */ = {isa = PBXBuildFile; fileRef = DD8E2F7C24018C54002D51AB /* CLVisitMock.m */; };
 		DE1E7644239724FD006F34A1 /* search_geofences.json in Resources */ = {isa = PBXBuildFile; fileRef = DE1E7643239724FD006F34A1 /* search_geofences.json */; };
+		E6EEC56E2B20F41A00DD096B /* RadarFileStorage.h in Headers */ = {isa = PBXBuildFile; fileRef = E6EEC56D2B20F41A00DD096B /* RadarFileStorage.h */; };
+		E6EEC5702B20F45D00DD096B /* RadarFileStorage.m in Sources */ = {isa = PBXBuildFile; fileRef = E6EEC56F2B20F45D00DD096B /* RadarFileStorage.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -315,6 +317,8 @@
 		DDD7BD0325EC3015002473B3 /* RadarRouteMatrix.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RadarRouteMatrix.m; sourceTree = "<group>"; };
 		DDF1157C2524E18100D575C4 /* RadarTrip.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RadarTrip.m; sourceTree = "<group>"; };
 		DE1E7643239724FD006F34A1 /* search_geofences.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = search_geofences.json; sourceTree = "<group>"; };
+		E6EEC56D2B20F41A00DD096B /* RadarFileStorage.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RadarFileStorage.h; sourceTree = "<group>"; };
+		E6EEC56F2B20F45D00DD096B /* RadarFileStorage.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RadarFileStorage.m; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -447,6 +451,8 @@
 				58F950CF2407038300364B15 /* RadarCollectionAdditions.m */,
 				01F99CFA2965C182004E8CF3 /* RadarConfig.h */,
 				01F99CFC2965C1C4004E8CF3 /* RadarConfig.m */,
+				E6EEC56D2B20F41A00DD096B /* RadarFileStorage.h */,
+				E6EEC56F2B20F45D00DD096B /* RadarFileStorage.m */,
 				96A5A11727ADA02E007B960B /* RadarDelegateHolder.h */,
 				DD4C104925D87E3E009C2E36 /* RadarDelegateHolder.m */,
 				DD236CF723088F8400EB88F9 /* RadarLocationManager.h */,
@@ -604,6 +610,7 @@
 				96A5A10527AD9F7F007B960B /* RadarTrackingOptions.h in Headers */,
 				96A5A10927AD9F7F007B960B /* RadarContext.h in Headers */,
 				0107AA1226220049008AB52F /* RadarCollectionAdditions.h in Headers */,
+				E6EEC56E2B20F41A00DD096B /* RadarFileStorage.h in Headers */,
 				015C53AD29B8E8BA004F53A6 /* (null) in Headers */,
 				0107AA1C26220055008AB52F /* RadarPermissionsHelper.h in Headers */,
 				96A5A11227AD9F7F007B960B /* Radar.h in Headers */,
@@ -790,6 +797,7 @@
 				9679F4A327CD8DE200800797 /* CLLocation+Radar.m in Sources */,
 				0107AB08262201CE008AB52F /* RadarAPIClient.m in Sources */,
 				0107AB05262201CB008AB52F /* Radar.m in Sources */,
+				E6EEC5702B20F45D00DD096B /* RadarFileStorage.m in Sources */,
 				0107AB29262201F4008AB52F /* RadarTrackingOptions.m in Sources */,
 				0107AB2F262201FB008AB52F /* RadarUtils.m in Sources */,
 				0107AA8926220140008AB52F /* RadarChain.m in Sources */,
@@ -860,7 +868,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.8.12;
+				MARKETING_VERSION = 3.8.13;
 				PRODUCT_BUNDLE_IDENTIFIER = io.radar.sdk;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -890,7 +898,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.8.12;
+				MARKETING_VERSION = 3.8.13;
 				PRODUCT_BUNDLE_IDENTIFIER = io.radar.sdk;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -973,7 +981,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
-				MARKETING_VERSION = 3.8.12;
+				MARKETING_VERSION = 3.8.13;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
 				ONLY_ACTIVE_ARCH = YES;
@@ -1031,7 +1039,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
-				MARKETING_VERSION = 3.8.12;
+				MARKETING_VERSION = 3.8.13;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				MTL_FAST_MATH = YES;
 				OTHER_CFLAGS = "-fembed-bitcode";

RadarSDK/Include/Radar.h

@@ -1003,6 +1003,24 @@ logConversionWithNotification
  */
 + (void)setLogLevel:(RadarLogLevel)level;
 
+/**
+ Log application terminating. Include this in your application delegate's applicationWillTerminate: method.
+
+ */
++ (void)logTermination;
+
+/**
+ Log application entering background. Include this in your application delegate's applicationDidEnterBackground: method.
+ */
++ (void)logEnterBackground;
+
+/**
+ Log application resigning active. Include this in your application delegate's applicationWillResignActive: method.
+
+ */
++ (void)logResignActive;
+
+
 #pragma mark - Helpers
 
 /**

RadarSDK/Radar.m

@@ -66,7 +66,9 @@ + (void)initializeWithPublishableKey:(NSString *)publishableKey {
                                      completionHandler:^(RadarStatus status, RadarConfig *config) {
                                          [[RadarLocationManager sharedInstance] updateTrackingFromMeta:config.meta];
                                          [RadarSettings setFeatureSettings:config.meta.featureSettings];
+                                         [self flushLogs];
                                      }];
+
 }
 
 #pragma mark - Properties
@@ -1036,6 +1038,20 @@ + (void)setLogLevel:(RadarLogLevel)level {
     [RadarSettings setLogLevel:level];
 }
 
++ (void)logTermination { 
+    [[RadarLogger sharedInstance] logWithLevel:RadarLogLevelInfo type:RadarLogTypeNone message:@"App terminating" includeDate:YES includeBattery:YES append:YES];
+}
+
++ (void)logEnterBackground {
+    [[RadarLogger sharedInstance] logWithLevel:RadarLogLevelInfo type:RadarLogTypeNone message:@"App entering background" includeDate:YES includeBattery:YES append:YES];
+    [[RadarLogBuffer sharedInstance] persistLogs];
+}
+
++ (void)logResignActive {
+    [[RadarLogger sharedInstance] logWithLevel:RadarLogLevelInfo type:RadarLogTypeNone message:@"App resigning active" includeDate:YES includeBattery:YES];
+}
+
+
 #pragma mark - Helpers
 
 + (NSString *)stringForStatus:(RadarStatus)status {
@@ -1256,21 +1272,14 @@ + (void)flushLogs {
         return;
     }
 
-    NSArray<RadarLog *> *flushableLogs = [[RadarLogBuffer sharedInstance] flushableLogs];
-
+    NSArray<RadarLog *> *flushableLogs = [[RadarLogBuffer sharedInstance] flushableLogs]; 
     NSUInteger pendingLogCount = [flushableLogs count];
     if (pendingLogCount == 0) {
         return;
     }
 
-    // remove logs from buffer to handle multiple flushLogs calls
-    [[RadarLogBuffer sharedInstance] removeLogsFromBuffer:pendingLogCount];
-
     RadarSyncLogsAPICompletionHandler onComplete = ^(RadarStatus status) {
-        // if an error occurs in syncing, add the logs back to the buffer
-        if (status != RadarStatusSuccess) {
-            [[RadarLogBuffer sharedInstance] addLogsToBuffer:flushableLogs];
-        }
+        [[RadarLogBuffer sharedInstance] onFlush:status == RadarStatusSuccess logs:flushableLogs];
     };
 
     [[RadarAPIClient sharedInstance] syncLogs:flushableLogs

RadarSDK/RadarFeatureSettings.h

@@ -21,14 +21,16 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, assign) BOOL usePersistence;
 @property (nonatomic, assign) BOOL extendFlushReplays;
+@property (nonatomic, assign) BOOL useLogPersistence;
 
 /**
  Initializes a new RadarFeatureSettings object with given value.
 
  @param usePersistence A flag indicating whether to use persistence.
  */
 - (instancetype)initWithUsePersistence:(BOOL)usePersistence
-                    extendFlushReplays:(BOOL)extendFlushReplays;
+                    extendFlushReplays:(BOOL)extendFlushReplays
+                    useLogPersistence:(BOOL)useLogPersistence;
 
 /**
  Creates a RadarFeatureSettings object from the provided dictionary.

RadarSDK/RadarFeatureSettings.m

@@ -10,17 +10,19 @@
 @implementation RadarFeatureSettings
 
 - (instancetype)initWithUsePersistence:(BOOL)usePersistence
-             extendFlushReplays:(BOOL)extendFlushReplays {
+             extendFlushReplays:(BOOL)extendFlushReplays
+             useLogPersistence:(BOOL)useLogPersistence {
     if (self = [super init]) {
         _usePersistence = usePersistence;
         _extendFlushReplays = extendFlushReplays;
+        _useLogPersistence = useLogPersistence;
     }
     return self;
 }
 
 + (RadarFeatureSettings *_Nullable)featureSettingsFromDictionary:(NSDictionary *)dict {
     if (!dict) {
-        return [[RadarFeatureSettings alloc] initWithUsePersistence:NO extendFlushReplays:NO];
+        return [[RadarFeatureSettings alloc] initWithUsePersistence:NO extendFlushReplays:NO useLogPersistence:NO];
     }
 
     NSObject *usePersistenceObj = dict[@"usePersistence"]; 
@@ -34,13 +36,21 @@ + (RadarFeatureSettings *_Nullable)featureSettingsFromDictionary:(NSDictionary *
     if (extendFlushReplaysObj && [extendFlushReplaysObj isKindOfClass:[NSNumber class]]) {
        extendFlushReplays = [(NSNumber *)extendFlushReplaysObj boolValue]; 
     }
-    return [[RadarFeatureSettings alloc] initWithUsePersistence:usePersistence extendFlushReplays:extendFlushReplays];
+
+    NSObject *useLogPersistenceObj = dict[@"useLogPersistence"]; 
+    BOOL useLogPersistence = NO;
+    if (useLogPersistenceObj && [useLogPersistenceObj isKindOfClass:[NSNumber class]]) {
+        useLogPersistence = [(NSNumber *)useLogPersistenceObj boolValue];
+    }
+
+    return [[RadarFeatureSettings alloc] initWithUsePersistence:usePersistence extendFlushReplays:extendFlushReplays useLogPersistence:useLogPersistence];
 }
 
 - (NSDictionary *)dictionaryValue {
     NSMutableDictionary *dict = [NSMutableDictionary new];
     [dict setValue:@(self.usePersistence) forKey:@"usePersistence"];
     [dict setValue:@(self.extendFlushReplays) forKey:@"extendFlushReplays"];
+    [dict setValue:@(self.useLogPersistence) forKey:@"useLogPersistence"];
 
     return dict;
 }

RadarSDK/RadarFileStorage.h

@@ -0,0 +1,24 @@
+//
+//  RadarFileStorage.h
+//  RadarSDK
+//
+//  Created by Kenny Hu on 12/6/23.
+//  Copyright © 2023 Radar Labs, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface RadarFileStorage : NSObject
+
+
+- (NSData *)readFileAtPath:(NSString *)filePath;
+
+- (void)writeData:(NSData *)data toFileAtPath:(NSString *)filePath;
+
+- (void)deleteFileAtPath:(NSString *)filePath;
+
+- (NSArray<NSString *> *)sortedFilesInDirectory:(NSString *)directoryPath;
+
+- (NSArray<NSString *> *)sortedFilesInDirectory:(NSString *)directoryPath usingComparator:(NSComparator)comparator;
+
+@end

RadarSDK/RadarFileStorage.m

@@ -0,0 +1,61 @@
+//
+//  RadarFileStorage.m
+//  RadarSDK
+//
+//  Created by Kenny Hu on 12/6/23.
+//  Copyright © 2023 Radar Labs, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "RadarFileStorage.h"
+
+@implementation RadarFileStorage
+
+
+
+- (NSData *)readFileAtPath:(NSString *)filePath {
+    __block NSData *fileData = nil;
+
+    NSFileCoordinator *fileCoordinator = [[NSFileCoordinator alloc] init];
+    [fileCoordinator coordinateReadingItemAtURL:[NSURL fileURLWithPath:filePath] options:0 error:nil byAccessor:^(NSURL *newURL) {
+        fileData = [NSData dataWithContentsOfURL:newURL];
+    }];
+
+    return fileData;
+}
+
+- (void)writeData:(NSData *)data toFileAtPath:(NSString *)filePath {
+
+    NSFileCoordinator *fileCoordinator = [[NSFileCoordinator alloc] init];
+    [fileCoordinator coordinateWritingItemAtURL:[NSURL fileURLWithPath:filePath] options:NSFileCoordinatorWritingForReplacing error:nil byAccessor:^(NSURL *newURL) {
+        [data writeToURL:newURL options:NSDataWritingAtomic error:nil];
+    }];
+}
+
+- (void)deleteFileAtPath:(NSString *)filePath {
+    NSFileCoordinator *fileCoordinator = [[NSFileCoordinator alloc] init];
+    [fileCoordinator coordinateWritingItemAtURL:[NSURL fileURLWithPath:filePath] options:NSFileCoordinatorWritingForDeleting error:nil byAccessor:^(NSURL *newURL) {
+        [[NSFileManager defaultManager] removeItemAtURL:newURL error:nil];
+    }];
+}
+
+- (NSArray<NSString *> *)sortedFilesInDirectory:(NSString *)directoryPath {
+    return [self sortedFilesInDirectory:directoryPath usingComparator:^NSComparisonResult(NSString *fileName1, NSString *fileName2) {
+        return [fileName1 compare:fileName2];
+    }];
+}
+
+- (NSArray<NSString *> *)sortedFilesInDirectory:(NSString *)directoryPath usingComparator:(NSComparator)comparator {
+    NSFileManager *fileManager = [NSFileManager defaultManager];
+    NSError *error = nil;
+    NSArray<NSString *> *files = [fileManager contentsOfDirectoryAtPath:directoryPath error:&error];
+
+    if (error) {
+        NSLog(@"Failed to get files in directory: %@", [error localizedDescription]);
+        return nil;
+    }
+
+    return [files sortedArrayUsingComparator: comparator];
+}
+
+@end

RadarSDK/RadarLog.h

@@ -10,7 +10,7 @@
 /**
  Represents a debug log.
  */
-@interface RadarLog : NSObject
+@interface RadarLog : NSObject <NSCoding>
 
 /**
  The levels for debug logs.

RadarSDK/RadarLog.m

@@ -94,4 +94,24 @@ - (NSDictionary *)dictionaryValue {
     return arr;
 }
 
+#pragma mark - NSCoding
+
+- (instancetype)initWithCoder:(NSCoder *)coder {
+    self = [super init];
+    if (self) {
+        _level = [coder decodeIntegerForKey:@"level"];
+        _type = [coder decodeIntegerForKey:@"type"];
+        _message = [coder decodeObjectForKey:@"message"];
+        _createdAt = [coder decodeObjectForKey:@"createdAt"];
+    }
+    return self;
+}
+
+- (void)encodeWithCoder:(NSCoder *)coder {
+    [coder encodeInteger:_level forKey:@"level"];
+    [coder encodeInteger:_type forKey:@"type"];
+    [coder encodeObject:_message forKey:@"message"];
+    [coder encodeObject:_createdAt forKey:@"createdAt"];
+}
+
 @end

RadarSDK/RadarLogBuffer.h

@@ -8,22 +8,31 @@
 #import <Foundation/Foundation.h>
 
 #import "RadarLog.h"
+#import "RadarFileStorage.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface RadarLogBuffer : NSObject
 
 @property (assign, nonatomic, readonly) NSArray<RadarLog *> *flushableLogs;
+@property (strong, nonatomic) NSString *logFileDir;
+@property (strong, nonatomic) RadarFileStorage *fileHandler;
+@property (nonatomic, strong) NSTimer *timer;
+@property (nonatomic, assign) BOOL persistentLogFeatureFlag;
 
 + (instancetype)sharedInstance;
 
 - (void)write:(RadarLogLevel)level type:(RadarLogType)type message:(NSString *)message;
 
-- (void)purgeOldestLogs;
+- (void)write:(RadarLogLevel)level type:(RadarLogType)type message:(NSString *)message forcePersist:(BOOL)forcePersist;
 
-- (void)removeLogsFromBuffer:(NSUInteger)numLogs;
+- (void)persistLogs;
 
-- (void)addLogsToBuffer:(NSArray<RadarLog *> *)logs;
+- (void)clearBuffer;
+
+- (void)setPersistentLogFeatureFlag:(BOOL)persistentLogFeatureFlag;
+
+- (void)onFlush:(BOOL)success logs:(NSArray<RadarLog *> *)logs;
 
 @end