Merge pull request #76 from bitstadium/feature/changes-for-4.1.0

Feature/changes for 4.1.0

Author: Benjamin Scholtysik (Reimold)

Classes/CrashReporting/BITCrashManager.m

@@ -166,11 +166,7 @@ - (instancetype)initWithAppIdentifier:(NSString *)appIdentifier hockeyAppClient:
     _crashesDir = bit_settingsDir();
     _settingsFile = [_crashesDir stringByAppendingPathComponent:BITHOCKEY_CRASH_SETTINGS];
     _analyzerInProgressFile = [_crashesDir stringByAppendingPathComponent:BITHOCKEY_CRASH_ANALYZER];
-    
-    if ([_fileManager fileExistsAtPath:_analyzerInProgressFile]) {
-      NSError *theError = nil;
-      [_fileManager removeItemAtPath:_analyzerInProgressFile error:&theError];
-    }
+
   }
   return self;
 }
@@ -280,7 +276,7 @@ - (void)cleanCrashReports {
   }
 }
 
-- (void)persistAttachment:(BITHockeyAttachment *)attachment withFilename:(NSString *)filename {
+- (BOOL)persistAttachment:(BITHockeyAttachment *)attachment withFilename:(NSString *)filename {
   NSString *attachmentFilename = [filename stringByAppendingString:@".data"];
   NSMutableData *data = [[NSMutableData alloc] init];
   NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
@@ -289,7 +285,7 @@ - (void)persistAttachment:(BITHockeyAttachment *)attachment withFilename:(NSStri
 
   [archiver finishEncoding];
 
-  [data writeToFile:attachmentFilename atomically:YES];
+  return [data writeToFile:attachmentFilename atomically:YES];
 }
 
 - (void)persistUserProvidedMetaData:(BITCrashMetaData *)userProvidedMetaData {
@@ -460,6 +456,8 @@ - (void)generateTestCrash {
  *  @param filename the crash reports temp filename
  */
 - (void)storeMetaDataForCrashReportFilename:(NSString *)filename {
+  BITHockeyLogVerbose(@"Storing meta data for crash report with filename %@", filename);
+
   NSError *error = NULL;
   NSMutableDictionary *metaDict = [NSMutableDictionary dictionaryWithCapacity:4];
   NSString *applicationLog = @"";
@@ -476,20 +474,32 @@ - (void)storeMetaDataForCrashReportFilename:(NSString *)filename {
   metaDict[kBITCrashMetaApplicationLog] = applicationLog;
 
   if (self.delegate != nil && [self.delegate respondsToSelector:@selector(attachmentForCrashManager:)]) {
+    BITHockeyLogVerbose(@"Processing attachment for crash report with filename %@", filename);
+
     BITHockeyAttachment *attachment = [self.delegate attachmentForCrashManager:self];
 
     if (attachment) {
-      [self persistAttachment:attachment withFilename:[_crashesDir stringByAppendingPathComponent: filename]];
+      BOOL success = [self persistAttachment:attachment withFilename:[_crashesDir stringByAppendingPathComponent: filename]];
+      if (!success) {
+        BITHockeyLogError(@"Persisting the crash attachment failed");
+      } else {
+        BITHockeyLogVerbose(@"Crash attachment successfully persisted.");
+      }
+    } else {
+      BITHockeyLogVerbose(@"Crash attachment was nil");
     }
   }
 
   NSData *plist = [NSPropertyListSerialization dataFromPropertyList:(id)metaDict
                                                              format:NSPropertyListBinaryFormat_v1_0
                                                    errorDescription:&errorString];
   if (plist) {
-    [plist writeToFile:[_crashesDir stringByAppendingPathComponent: [filename stringByAppendingPathExtension:@"meta"]] atomically:YES];
+    BOOL success = [plist writeToFile:[_crashesDir stringByAppendingPathComponent: [filename stringByAppendingPathExtension:@"meta"]] atomically:YES];
+    if (!success) {
+      BITHockeyLogError(@"Writing crash meta data failed.");
+    }
   } else {
-    BITHockeyLogError(@"ERROR: Writing crash meta data failed. %@", error);
+    BITHockeyLogError(@"Serializing crash meta dict failed. %@", error);
   }
 }
 
@@ -534,12 +544,15 @@ - (BOOL)handleUserInput:(BITCrashManagerUserInput)userInput withUserProvidedMeta
 
 // Called to handle a pending crash report.
 - (void)handleCrashReport {
+  BITHockeyLogVerbose(@"Handling crash report");
+
   NSError *error = NULL;
 
   // check if the next call ran successfully the last time
   if (![_fileManager fileExistsAtPath:_analyzerInProgressFile]) {
     // mark the start of the routine
     [_fileManager createFileAtPath:_analyzerInProgressFile contents:nil attributes:nil];
+    BITHockeyLogVerbose(@"AnalyzerInProgress file created");
 
     [self saveSettings];
 

Classes/CrashReporting/BITCrashManagerPrivate.h

@@ -50,7 +50,7 @@
 - (void)cleanCrashReports;
 - (NSString *)extractAppUUIDs:(BITPLCrashReport *)report;
 
-- (void)persistAttachment:(BITHockeyAttachment *)attachment withFilename:(NSString *)filename;
+- (BOOL)persistAttachment:(BITHockeyAttachment *)attachment withFilename:(NSString *)filename;
 
 - (BITHockeyAttachment *)attachmentForCrashReport:(NSString *)filename;
 

Classes/Telemetry/BITEventData.h

@@ -4,5 +4,6 @@
 
 @property (nonatomic, copy, readonly) NSString *envelopeTypeName;
 @property (nonatomic, copy, readonly) NSString *dataTypeName;
+@property (nonatomic, strong) NSDictionary *measurements;
 
 @end

Classes/Telemetry/BITEventData.m

@@ -5,13 +5,17 @@ @implementation BITEventData
 @synthesize envelopeTypeName = _envelopeTypeName;
 @synthesize dataTypeName = _dataTypeName;
 @synthesize version = _version;
+@synthesize properties = _properties;
+@synthesize measurements = _measurements;
 
 /// Initializes a new instance of the class.
 - (instancetype)init {
   if (self = [super init]) {
     _envelopeTypeName = @"Microsoft.ApplicationInsights.Event";
     _dataTypeName = @"EventData";
     _version = @2;
+    _properties = [NSDictionary new];
+    _measurements = [NSDictionary new];
   }
   return self;
 }
@@ -25,6 +29,13 @@ - (NSDictionary *)serializeToDictionary {
   if (self.name != nil) {
     [dict setObject:self.name forKey:@"name"];
   }
+  if (self.properties !=nil) {
+    [dict setObject:self.properties forKey:@"properties"];
+  }
+  if (self.measurements) {
+    [dict setObject:self.measurements forKey:@"measurements"];
+  }
+  
   return dict;
 }
 
@@ -36,6 +47,8 @@ - (instancetype)initWithCoder:(NSCoder *)coder {
     _envelopeTypeName = [coder decodeObjectForKey:@"self.envelopeTypeName"];
     _dataTypeName = [coder decodeObjectForKey:@"self.dataTypeName"];
     _version = [coder decodeObjectForKey:@"self.version"];
+    _properties = [coder decodeObjectForKey:@"self.properties"];
+    _measurements = [coder decodeObjectForKey:@"self.measurements"];
   }
   return self;
 }
@@ -45,6 +58,8 @@ - (void)encodeWithCoder:(NSCoder *)coder {
   [coder encodeObject:self.envelopeTypeName forKey:@"self.envelopeTypeName"];
   [coder encodeObject:self.dataTypeName forKey:@"self.dataTypeName"];
   [coder encodeObject:self.version forKey:@"self.version"];
+  [coder encodeObject:self.properties forKey:@"self.properties"];
+  [coder encodeObject:self.measurements forKey:@"self.measurements"];
 }
 
 

Classes/Telemetry/BITMetricsManager.h

@@ -36,7 +36,18 @@ NS_ASSUME_NONNULL_BEGIN
  *
  *  @param eventName The event's name as a string.
  */
-- (void)trackEventWithName:(NSString *)eventName;
+- (void)trackEventWithName:(nonnull NSString *)eventName;
+
+/**
+ *  This method allows to track an event that happened in your app.
+ *  Remember to choose meaningful event names to have the best experience when diagnosing your app
+ *  in the web portal.
+ *
+ *  @param eventName the name of the event, which should be tracked.
+ *  @param properties key value pairs with additional info about the event.
+ *  @param measurements key value pairs, which contain custom metrics.
+ */
+- (void)trackEventWithName:(nonnull NSString *)eventName properties:(nullable NSDictionary<NSString *, NSString *> *)properties measurements:(nullable NSDictionary<NSString *, NSNumber *> *)measurements;
 
 @end
 

Classes/Telemetry/BITMetricsManager.m

@@ -199,6 +199,25 @@ - (void)trackEventWithName:(NSString *)eventName {
   });
 }
 
+- (void)trackEventWithName:(nonnull NSString *)eventName properties:(nullable NSDictionary<NSString *, NSString *> *)properties measurements:(nullable NSDictionary<NSString *, NSNumber *> *)measurements {
+  if (!eventName) { return; }
+  if (self.disabled) {
+    BITHockeyLogDebug(@"INFO: BITMetricsManager is disabled, therefore this tracking call was ignored.");
+    return;
+  }
+  
+  __weak typeof(self) weakSelf = self;
+  dispatch_async(self.metricsEventQueue, ^{
+    typeof(self) strongSelf = weakSelf;
+    BITEventData *eventData = [BITEventData new];
+    [eventData setName:eventName];
+    [eventData setProperties:properties];
+    [eventData setMeasurements:measurements];
+    [strongSelf trackDataItem:eventData];
+  });
+}
+
+
 #pragma mark Track DataItem
 
 - (void)trackDataItem:(BITTelemetryData *)dataItem {

Classes/Telemetry/BITTelemetryData.h

@@ -11,6 +11,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (nonatomic, copy) NSNumber *version;
 @property (nonatomic, copy) NSString *name;
+@property (nonatomic, strong) NSDictionary *properties;
 
 @end
 

Classes/Telemetry/BITTelemetryData.m

@@ -18,6 +18,7 @@ - (instancetype)initWithCoder:(NSCoder *)coder {
   if(self) {
     _version = [coder decodeObjectForKey:@"self.version"];
     _name = [coder decodeObjectForKey:@"self.name"];
+    _properties = [coder decodeObjectForKey:@"self.properties"];
   }
   return self;
 }
@@ -26,6 +27,7 @@ - (void)encodeWithCoder:(NSCoder *)coder {
   [super encodeWithCoder:coder];
   [coder encodeObject:self.version forKey:@"self.version"];
   [coder encodeObject:self.name forKey:@"self.name"];
+  [coder encodeObject:self.properties forKey:@"self.properties"];
 }
 
 @end