Crashlytics cache key app version (#5132)

Author: samedson

Crashlytics/Crashlytics/Models/FIRCLSSettings.m

@@ -29,6 +29,7 @@
 NSString *const CreatedAtKey = @"created_at";
 NSString *const GoogleAppIDKey = @"google_app_id";
 NSString *const BuildInstanceID = @"build_instance_id";
+NSString *const AppVersion = @"app_version";
 
 @interface FIRCLSSettings ()
 
@@ -120,6 +121,15 @@ - (void)reloadFromCacheWithGoogleAppID:(NSString *)googleAppID
       self.isCacheKeyExpired = YES;
     }
   }
+
+  NSString *cacheAppVersion = cacheKey[AppVersion];
+  if (![cacheAppVersion isEqualToString:self.appIDModel.synthesizedVersion]) {
+    FIRCLSDebugLog(@"[Crashlytics:Settings] Settings expired because app version changed");
+
+    @synchronized(self) {
+      self.isCacheKeyExpired = YES;
+    }
+  }
 }
 
 - (void)cacheSettingsWithGoogleAppID:(NSString *)googleAppID
@@ -129,6 +139,7 @@ - (void)cacheSettingsWithGoogleAppID:(NSString *)googleAppID
     CreatedAtKey : createdAtTimestamp,
     GoogleAppIDKey : googleAppID,
     BuildInstanceID : self.appIDModel.buildInstanceID,
+    AppVersion : self.appIDModel.synthesizedVersion,
   };
 
   NSError *error = nil;

Crashlytics/Crashlytics/Settings/Models/FIRCLSApplicationIdentifierModel.h

@@ -34,6 +34,13 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, readonly, nullable) NSString* platform;
 @property(nonatomic, readonly, nullable) NSString* buildVersion;
 @property(nonatomic, readonly, nullable) NSString* displayVersion;
+
+/**
+ * Returns the synthesized app version, similar to how the backend does it
+ * <displayVersion> (<buildVersion>)
+ */
+@property(nonatomic, readonly, nullable) NSString* synthesizedVersion;
+
 @property(nonatomic, readonly) FIRCLSApplicationInstallationSourceType installSource;
 
 /**

Crashlytics/Crashlytics/Settings/Models/FIRCLSApplicationIdentifierModel.m

@@ -66,6 +66,10 @@ - (NSString *)displayVersion {
   return FIRCLSApplicationGetShortBundleVersion();
 }
 
+- (NSString *)synthesizedVersion {
+  return [NSString stringWithFormat:@"%@ (%@)", self.displayName, self.buildVersion];
+}
+
 - (FIRCLSApplicationInstallationSourceType)installSource {
   return FIRCLSApplicationInstallationSource();
 }

Crashlytics/UnitTests/FIRCLSSettingsTests.m

@@ -46,6 +46,12 @@
 NSString *FIRCLSDefaultMockBuildInstanceID = @"12345abcdef";
 NSString *FIRCLSDifferentMockBuildInstanceID = @"98765zyxwv";
 
+NSString *FIRCLSDefaultMockAppDisplayVersion = @"1.2.3-beta.2";
+NSString *FIRCLSDifferentMockAppDisplayVersion = @"1.2.3-beta.3";
+
+NSString *FIRCLSDefaultMockAppBuildVersion = @"1024";
+NSString *FIRCLSDifferentMockAppBuildVersion = @"2048";
+
 NSString *const TestGoogleAppID = @"1:test:google:app:id";
 NSString *const TestChangedGoogleAppID = @"2:changed:google:app:id";
 
@@ -77,6 +83,8 @@ - (void)setUp {
 
   _appIDModel = [[FABMockApplicationIdentifierModel alloc] init];
   _appIDModel.buildInstanceID = FIRCLSDefaultMockBuildInstanceID;
+  _appIDModel.displayVersion = FIRCLSDefaultMockAppDisplayVersion;
+  _appIDModel.buildVersion = FIRCLSDefaultMockAppBuildVersion;
 
   _settings = [[FIRCLSSettings alloc] initWithFileManager:_fileManager appIDModel:_appIDModel];
 }
@@ -291,6 +299,45 @@ - (void)testCacheExpiredFromBuildInstanceID {
   XCTAssertEqual(self.settings.errorLogBufferSize, 128000);
 }
 
+- (void)testCacheExpiredFromAppVersion {
+  NSError *error = nil;
+  [self writeSettings:FIRCLSTestSettingsActivated error:&error];
+  XCTAssertNil(error, "%@", error);
+
+  // 1 delete for clearing the cache key, plus 2 for the deletes from reloading and clearing the
+  // cache and cache key
+  self.fileManager.expectedRemoveCount = 3;
+
+  NSTimeInterval currentTimestamp = [NSDate timeIntervalSinceReferenceDate];
+  [self.settings cacheSettingsWithGoogleAppID:TestGoogleAppID currentTimestamp:currentTimestamp];
+
+  // Change the App Version
+  self.appIDModel.displayVersion = FIRCLSDifferentMockAppDisplayVersion;
+  self.appIDModel.buildVersion = FIRCLSDifferentMockAppBuildVersion;
+
+  [self.settings reloadFromCacheWithGoogleAppID:TestGoogleAppID currentTimestamp:currentTimestamp];
+
+  XCTAssertEqual(self.settings.isCacheExpired, YES);
+
+  // Since the TTL just expired, do not clear settings
+  XCTAssertEqualObjects(self.settings.orgID, @"010101000000111111111111");
+  XCTAssertEqualObjects(self.settings.fetchedBundleID, @"com.lets.test.crashlytics");
+  XCTAssertEqual(self.settings.errorLogBufferSize, 64 * 1000);
+
+  // Pretend we fetched settings again, but they had different values
+  [self writeSettings:FIRCLSTestSettingsInverse error:&error];
+  XCTAssertNil(error, "%@", error);
+
+  // Cache the settings
+  [self.settings cacheSettingsWithGoogleAppID:TestGoogleAppID currentTimestamp:currentTimestamp];
+
+  // We should have the updated values that were fetched, and should not be expired
+  XCTAssertEqual(self.settings.isCacheExpired, NO);
+  XCTAssertEqualObjects(self.settings.orgID, @"01e101a0000011b113115111");
+  XCTAssertEqualObjects(self.settings.fetchedBundleID, @"im.from.the.server");
+  XCTAssertEqual(self.settings.errorLogBufferSize, 128000);
+}
+
 - (void)testGoogleAppIDChanged {
   NSError *error = nil;
   [self writeSettings:FIRCLSTestSettingsInverse error:&error];

Crashlytics/UnitTests/Mocks/FABMockApplicationIdentifierModel.h

@@ -23,6 +23,12 @@ NS_ASSUME_NONNULL_BEGIN
 // Allows us to set this value in FIRCLSSettingsTests
 @property(nonatomic, copy) NSString* buildInstanceID;
 
+// Allows us to set this value in FIRCLSSettingsTests
+@property(nonatomic, copy) NSString* displayVersion;
+
+// Allows us to set this value in FIRCLSSettingsTests
+@property(nonatomic, copy) NSString* buildVersion;
+
 // Allows us to set this value in FIRCLSReportManagerTests
 @property(nonatomic, copy) NSString* bundleID;
 

Crashlytics/UnitTests/Mocks/FABMockApplicationIdentifierModel.m

@@ -19,6 +19,8 @@ @implementation FABMockApplicationIdentifierModel
 // Don't call the custom methods that compute this value, so we can
 // set it in FIRCLSSettingsTests
 @synthesize buildInstanceID;
+@synthesize displayVersion;
+@synthesize buildVersion;
 
 // Set in FIRCLSReportManagerTests
 @synthesize bundleID;