Merge pull request #292 from bugsnag/fix-app-version-serialisation

Respect appVersion override when serialising KSCrash report

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## 5.X.X (TBD)
+
+### Bug Fixes
+
+* Respect appVersion override when serialising KSCrash report [#292](https://github.com/bugsnag/bugsnag-cocoa/pull/292)
+
 ## 5.16.0 (02 Jul 2018)
 
 This release alters the behaviour of the notifier to track sessions automatically.

Source/BugsnagCrashReport.m

@@ -242,8 +242,8 @@ - (instancetype)initWithKSReport:(NSDictionary *)report {
         _context = BSGParseContext(report, _metaData);
         _deviceState = BSGParseDeviceState(report);
         _device = BSGParseDevice(report);
-        _app = BSGParseApp(report[BSGKeySystem]);
-        _appState = BSGParseAppState(report[BSGKeySystem]);
+        _app = BSGParseApp(report);
+        _appState = BSGParseAppState(report);
         _groupingHash = BSGParseGroupingHash(report, _metaData);
         _overrides = [report valueForKeyPath:@"user.overrides"];
         _customException = BSGParseCustomException(report, [_errorClass copy],

Source/BugsnagKSCrashSysInfoParser.m

@@ -61,9 +61,11 @@
 }
 
 NSDictionary *BSGParseApp(NSDictionary *report) {
+    NSDictionary *system = report[BSGKeySystem];
+
     NSMutableDictionary *appState = [NSMutableDictionary dictionary];
 
-    NSDictionary *stats = report[@"application_stats"];
+    NSDictionary *stats = system[@"application_stats"];
 
     NSInteger activeTimeSinceLaunch =
     [stats[@"active_time_since_launch"] doubleValue] * 1000.0;
@@ -73,23 +75,30 @@
     BSGDictSetSafeObject(appState, @(activeTimeSinceLaunch),
                          @"durationInForeground");
 
-    BSGDictSetSafeObject(appState, report[BSGKeyExecutableName], BSGKeyName);
+    BSGDictSetSafeObject(appState, system[BSGKeyExecutableName], BSGKeyName);
     BSGDictSetSafeObject(appState,
                          @(activeTimeSinceLaunch + backgroundTimeSinceLaunch),
                          @"duration");
     BSGDictSetSafeObject(appState, stats[@"application_in_foreground"],
                          @"inForeground");
-    BSGDictSetSafeObject(appState, report[@"CFBundleIdentifier"], BSGKeyId);
+    BSGDictSetSafeObject(appState, system[@"CFBundleIdentifier"], BSGKeyId);
     return appState;
 }
 
 NSDictionary *BSGParseAppState(NSDictionary *report) {
+    NSDictionary *system = report[BSGKeySystem];
     NSMutableDictionary *app = [NSMutableDictionary dictionary];
 
-    BSGDictSetSafeObject(app, report[@"CFBundleVersion"], @"bundleVersion");
+    NSString *version = [report valueForKeyPath:@"user.config.appVersion"];
+
+    if (!version) {
+        version = system[@"CFBundleShortVersionString"];
+    }
+
+    BSGDictSetSafeObject(app, system[@"CFBundleVersion"], @"bundleVersion");
     BSGDictSetSafeObject(app, [Bugsnag configuration].releaseStage,
                          BSGKeyReleaseStage);
-    BSGDictSetSafeObject(app, report[@"CFBundleShortVersionString"], BSGKeyVersion);
+    BSGDictSetSafeObject(app, version, BSGKeyVersion);
 
     BSGDictSetSafeObject(app, [Bugsnag configuration].codeBundleId, @"codeBundleId");
 

Tests/BugsnagCrashReportTests.m

@@ -513,4 +513,25 @@ - (void)testNoReportMetaData {
     XCTAssertEqual(report.metaData.count, 0);
 }
 
+- (void)testAppVersion {
+    NSDictionary *dictionary = [self.report toJson];
+    XCTAssertEqualObjects(@"1.0", dictionary[@"app"][@"version"]);
+}
+
+- (void)testAppVersionOverride {
+    BugsnagCrashReport *overrideReport = [[BugsnagCrashReport alloc] initWithKSReport:@{
+            @"system" : @{
+                    @"CFBundleShortVersionString": @"1.1",
+            },
+            @"user": @{
+                    @"config": @{
+                            @"appVersion": @"1.2.3"
+                    }
+            }
+    }];
+    NSDictionary *dictionary = [overrideReport toJson];
+    XCTAssertEqualObjects(@"1.2.3", dictionary[@"app"][@"version"]);
+}
+
+
 @end

examples/swift-ios/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - Bugsnag (5.15.6)
+  - Bugsnag (5.16.0)
 
 DEPENDENCIES:
   - Bugsnag (from `../..`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: "../.."
 
 SPEC CHECKSUMS:
-  Bugsnag: ff5f5e3059e6a9c9d27a899f3bf3774067553483
+  Bugsnag: 47bcc70b43e3c616ec35d30c2ca94497b957199f
 
 PODFILE CHECKSUM: 2107babfbfdb18f0288407b9d9ebd48cbee8661c