Remove migration logic from document folder to application folder (#4033)

Author: charlotteliang

Example/InstanceID/Tests/FIRInstanceIDBackupExcludedPlistTest.m

@@ -79,48 +79,6 @@ - (void)testWriteToPlistInApplicationSupportFolder {
   XCTAssertTrue([self doesPlistFileExist]);
 }
 
-- (void)testMovePlistToApplicationSupportDirectorySuccess {
-  NSDictionary *plistContents = @{@"hello" : @"world", @"id" : @123};
-  [self.plist writeDictionary:plistContents error:nil];
-  [self.plist moveToApplicationSupportSubDirectory:kSubDirectoryName];
-  XCTAssertTrue([self doesPlistFileExist]);
-  XCTAssertFalse([self isPlistInDocumentsDirectory]);
-
-  NSDictionary *newPlistContents = @{@"world" : @"hello"};
-  [self.plist writeDictionary:newPlistContents error:nil];
-  XCTAssertEqualObjects(newPlistContents, [self.plist contentAsDictionary]);
-}
-
-- (void)testMovePlistToApplicationSupportDirectoryFailure {
-  // This is to test moving data from deprecated document folder to application folder
-  // which should only apply to iOS.
-#if TARGET_OS_IOS
-  // Delete the subdirectory
-  [FIRInstanceIDStore removeSubDirectory:kSubDirectoryName error:nil];
-
-  // Create a new plistl This would try to move or write to the ApplicationSupport directory
-  // but since the subdirectory is not there anymore it will fail and rather write to the
-  // Documents folder.
-  self.plist = [[FIRInstanceIDBackupExcludedPlist alloc] initWithFileName:kTestPlistFileName
-                                                             subDirectory:kSubDirectoryName];
-
-  NSDictionary *plistContents = @{@"hello" : @"world", @"id" : @123};
-  [self.plist writeDictionary:plistContents error:nil];
-
-  XCTAssertFalse([self doesPlistFileExist]);
-  XCTAssertTrue([self isPlistInDocumentsDirectory]);
-
-  NSDictionary *newPlistContents = @{@"world" : @"hello"};
-  [self.plist writeDictionary:newPlistContents error:nil];
-
-  XCTAssertEqualObjects(newPlistContents, [self.plist contentAsDictionary]);
-
-  // The new file should still be written to the Documents folder.
-  XCTAssertFalse([self doesPlistFileExist]);
-  XCTAssertTrue([self isPlistInDocumentsDirectory]);
-#endif
-}
-
 #pragma mark - Private Helpers
 
 - (BOOL)doesPlistFileExist {

Example/Messaging/Tests/FIRMessagingDataMessageManagerTest.m

@@ -22,6 +22,7 @@
 #import "Firebase/Messaging/FIRMessagingClient.h"
 #import "Firebase/Messaging/FIRMessagingConnection.h"
 #import "Firebase/Messaging/FIRMessagingDataMessageManager.h"
+#import "Firebase/Messaging/FIRMessagingRmq2PersistentStore.h"
 #import "Firebase/Messaging/FIRMessagingReceiver.h"
 #import "Firebase/Messaging/FIRMessagingRmqManager.h"
 #import "Firebase/Messaging/FIRMessagingSyncMessageManager.h"
@@ -50,6 +51,18 @@ - (NSString *)categoryForUpstreamMessages;
 
 @end
 
+@interface FIRMessagingRmqManager (ExposedForTest)
+
+@property(nonatomic, readwrite, strong) FIRMessagingRmq2PersistentStore *rmq2Store;
+
+@end
+
+@interface FIRMessagingRmq2PersistentStore (ExposedForTest)
+
+- (void)removeDatabase;
+
+@end
+
 @interface FIRMessagingDataMessageManagerTest : XCTestCase
 
 @property(nonatomic, readwrite, strong) id mockClient;
@@ -78,6 +91,12 @@ - (void)setUp {
   _mockDataMessageManager = OCMPartialMock(_dataMessageManager);
 }
 
+-(void)tearDown {
+    if (_dataMessageManager.rmq2Manager) {
+        [_dataMessageManager.rmq2Manager.rmq2Store removeDatabase];
+    }
+    [super tearDown];
+}
 
 - (void)testSendValidMessage_withNoConnection {
   // mock no connection initially
@@ -477,7 +496,6 @@ - (void)testResendSavedMessages {
   // Set a fake, valid bundle identifier
   [[[self.mockDataMessageManager stub] andReturn:@"gcm-dmm-test"] categoryForUpstreamMessages];
 
-  [FIRMessagingRmqManager removeDatabaseWithName:kRmqDatabaseName];
   FIRMessagingRmqManager *newRmqManager =
       [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
   [newRmqManager loadRmqId];
@@ -535,7 +553,6 @@ - (void)testResendingExpiredMessagesFails {
   // Set a fake, valid bundle identifier
   [[[self.mockDataMessageManager stub] andReturn:@"gcm-dmm-test"] categoryForUpstreamMessages];
 
-  [FIRMessagingRmqManager removeDatabaseWithName:kRmqDatabaseName];
   FIRMessagingRmqManager *newRmqManager =
       [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
   [newRmqManager loadRmqId];

Example/Messaging/Tests/FIRMessagingRmqManagerTest.m

@@ -19,11 +19,24 @@
 #import "Firebase/Messaging/FIRMessagingPersistentSyncMessage.h"
 #import "Firebase/Messaging/FIRMessagingRmqManager.h"
 #import "Firebase/Messaging/FIRMessagingUtilities.h"
+#import "Firebase/Messaging/FIRMessagingRmq2PersistentStore.h"
 #import "Firebase/Messaging/Protos/GtalkCore.pbobjc.h"
 
 static NSString *const kRmqDatabaseName = @"rmq-test-db";
 static NSString *const kRmqDataMessageCategory = @"com.google.gcm-rmq-test";
 
+@interface FIRMessagingRmqManager (ExposedForTest)
+
+@property(nonatomic, readwrite, strong) FIRMessagingRmq2PersistentStore *rmq2Store;
+
+@end
+
+@interface FIRMessagingRmq2PersistentStore (ExposedForTest)
+
+- (void)removeDatabase;
+
+@end
+
 @interface FIRMessagingRmqManagerTest : XCTestCase
 
 @property(nonatomic, readwrite, strong) FIRMessagingRmqManager *rmqManager;
@@ -35,13 +48,13 @@ @implementation FIRMessagingRmqManagerTest
 - (void)setUp {
   [super setUp];
   // Make sure we start off with a clean state each time
-  [FIRMessagingRmqManager removeDatabaseWithName:kRmqDatabaseName];
   _rmqManager = [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
+
 }
 
 - (void)tearDown {
+  [self.rmqManager.rmq2Store removeDatabase];
   [super tearDown];
-  [FIRMessagingRmqManager removeDatabaseWithName:kRmqDatabaseName];
 }
 
 /**

Example/Messaging/Tests/FIRMessagingSyncMessageManagerTest.m

@@ -17,13 +17,26 @@
 #import <XCTest/XCTest.h>
 
 #import "Firebase/Messaging/FIRMessagingPersistentSyncMessage.h"
+#import "Firebase/Messaging/FIRMessagingRmq2PersistentStore.h"
 #import "Firebase/Messaging/FIRMessagingRmqManager.h"
 #import "Firebase/Messaging/FIRMessagingSyncMessageManager.h"
 #import "Firebase/Messaging/FIRMessagingUtilities.h"
 #import "Firebase/Messaging/FIRMessagingConstants.h"
 
 static NSString *const kRmqSqliteFilename = @"rmq-sync-manager-test";
 
+@interface FIRMessagingRmqManager (ExposedForTest)
+
+@property(nonatomic, readwrite, strong) FIRMessagingRmq2PersistentStore *rmq2Store;
+
+@end
+
+@interface FIRMessagingRmq2PersistentStore (ExposedForTest)
+
+- (void)removeDatabase;
+
+@end
+
 @interface FIRMessagingSyncMessageManagerTest : XCTestCase
 
 @property(nonatomic, readwrite, strong) FIRMessagingRmqManager *rmqManager;
@@ -36,13 +49,12 @@ @implementation FIRMessagingSyncMessageManagerTest
 - (void)setUp {
   [super setUp];
   // Make sure the db state is clean before we begin.
-  [FIRMessagingRmqManager removeDatabaseWithName:kRmqSqliteFilename];
   self.rmqManager = [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqSqliteFilename];
   self.syncMessageManager = [[FIRMessagingSyncMessageManager alloc] initWithRmqManager:self.rmqManager];
 }
 
 - (void)tearDown {
-  [[self.rmqManager class] removeDatabaseWithName:kRmqSqliteFilename];
+  [self.rmqManager.rmq2Store removeDatabase];
   [super tearDown];
 }
 

Firebase/InstanceID/FIRIMessageCode.h

@@ -55,10 +55,10 @@ typedef NS_ENUM(NSInteger, FIRInstanceIDMessageCode) {
   kFIRInstanceIDMessageCodeAuthServiceCheckinInProgress = 5004,
 
   // FIRInstanceIDBackupExcludedPlist.m
+  // Do NOT USE 6003
   kFIRInstanceIDMessageCodeBackupExcludedPlist000 = 6000,
   kFIRInstanceIDMessageCodeBackupExcludedPlist001 = 6001,
   kFIRInstanceIDMessageCodeBackupExcludedPlist002 = 6002,
-  kFIRInstanceIDMessageCodeBackupExcludedPlistInvalidPlistEnum = 6003,
   // FIRInstanceIDCheckinService.m
   kFIRInstanceIDMessageCodeService000 = 7000,
   kFIRInstanceIDMessageCodeService001 = 7001,

Firebase/InstanceID/FIRInstanceIDBackupExcludedPlist.m

@@ -18,18 +18,10 @@
 
 #import "FIRInstanceIDLogger.h"
 
-typedef enum : NSUInteger {
-  FIRInstanceIDPlistDirectoryUnknown,
-  FIRInstanceIDPlistDirectoryDocuments,
-  FIRInstanceIDPlistDirectoryApplicationSupport,
-} FIRInstanceIDPlistDirectory;
-
 @interface FIRInstanceIDBackupExcludedPlist ()
 
 @property(nonatomic, readwrite, copy) NSString *fileName;
 @property(nonatomic, readwrite, copy) NSString *subDirectoryName;
-@property(nonatomic, readwrite, assign) BOOL fileInStandardDirectory;
-
 @property(nonatomic, readwrite, strong) NSDictionary *cachedPlistContents;
 
 @end
@@ -41,19 +33,12 @@ - (instancetype)initWithFileName:(NSString *)fileName subDirectory:(NSString *)s
   if (self) {
     _fileName = [fileName copy];
     _subDirectoryName = [subDirectory copy];
-#if TARGET_OS_IOS
-    _fileInStandardDirectory = [self moveToApplicationSupportSubDirectory:subDirectory];
-#else
-    // For tvOS and macOS, we never store the content in document folder, so
-    // the migration is unnecessary.
-    _fileInStandardDirectory = YES;
-#endif
   }
   return self;
 }
 
 - (BOOL)writeDictionary:(NSDictionary *)dict error:(NSError **)error {
-  NSString *path = [self plistPathInDirectory:[self plistDirectory]];
+  NSString *path = [self plistPathInDirectory];
   if (![dict writeToFile:path atomically:YES]) {
     FIRInstanceIDLoggerError(kFIRInstanceIDMessageCodeBackupExcludedPlist000,
                              @"Failed to write to %@.plist", self.fileName);
@@ -85,7 +70,7 @@ - (BOOL)writeDictionary:(NSDictionary *)dict error:(NSError **)error {
 
 - (BOOL)deleteFile:(NSError **)error {
   BOOL success = YES;
-  NSString *path = [self plistPathInDirectory:[self plistDirectory]];
+  NSString *path = [self plistPathInDirectory];
   if ([[NSFileManager defaultManager] fileExistsAtPath:path]) {
     success = [[NSFileManager defaultManager] removeItemAtPath:path error:error];
   }
@@ -96,101 +81,31 @@ - (BOOL)deleteFile:(NSError **)error {
 
 - (NSDictionary *)contentAsDictionary {
   if (!self.cachedPlistContents) {
-    NSString *path = [self plistPathInDirectory:[self plistDirectory]];
+    NSString *path = [self plistPathInDirectory];
     if ([[NSFileManager defaultManager] fileExistsAtPath:path]) {
       self.cachedPlistContents = [[NSDictionary alloc] initWithContentsOfFile:path];
     }
   }
   return self.cachedPlistContents;
 }
 
-- (BOOL)moveToApplicationSupportSubDirectory:(NSString *)subDirectoryName {
-  NSArray *directoryPaths =
-      NSSearchPathForDirectoriesInDomains([self supportedDirectory], NSUserDomainMask, YES);
-  // This only going to happen inside iOS so it is an applicationSupportDirectory.
-  NSString *applicationSupportDirPath = directoryPaths.lastObject;
-  NSArray *components = @[ applicationSupportDirPath, subDirectoryName ];
-  NSString *subDirectoryPath = [NSString pathWithComponents:components];
-  BOOL hasSubDirectory;
-  if (![[NSFileManager defaultManager] fileExistsAtPath:subDirectoryPath
-                                            isDirectory:&hasSubDirectory]) {
-    // Cannot move to non-existent directory
-    return NO;
-  }
-
-  if ([self doesFileExistInDirectory:FIRInstanceIDPlistDirectoryDocuments]) {
-    NSString *oldPlistPath = [self plistPathInDirectory:FIRInstanceIDPlistDirectoryDocuments];
-    NSString *newPlistPath =
-        [self plistPathInDirectory:FIRInstanceIDPlistDirectoryApplicationSupport];
-    if ([self doesFileExistInDirectory:FIRInstanceIDPlistDirectoryApplicationSupport]) {
-      // File exists in both Documents and ApplicationSupport
-      return NO;
-    }
-    NSError *moveError;
-    if (![[NSFileManager defaultManager] moveItemAtPath:oldPlistPath
-                                                 toPath:newPlistPath
-                                                  error:&moveError]) {
-      FIRInstanceIDLoggerError(kFIRInstanceIDMessageCodeBackupExcludedPlist002,
-                               @"Failed to move file %@ from %@ to %@. Error: %@", self.fileName,
-                               oldPlistPath, newPlistPath, moveError);
-      return NO;
-    }
-  }
-  // We moved the file if it existed, otherwise we didn't need to do anything
-  return YES;
-}
-
 - (BOOL)doesFileExist {
-  return [self doesFileExistInDirectory:[self plistDirectory]];
+  NSString *path = [self plistPathInDirectory];
+  return [[NSFileManager defaultManager] fileExistsAtPath:path];
 }
 
 #pragma mark - Private
 
-- (FIRInstanceIDPlistDirectory)plistDirectory {
-  if (_fileInStandardDirectory) {
-    return FIRInstanceIDPlistDirectoryApplicationSupport;
-  } else {
-    return FIRInstanceIDPlistDirectoryDocuments;
-  };
-}
-
-- (NSString *)plistPathInDirectory:(FIRInstanceIDPlistDirectory)directory {
-  return [self pathWithName:self.fileName inDirectory:directory];
-}
-
-- (NSString *)pathWithName:(NSString *)plistName
-               inDirectory:(FIRInstanceIDPlistDirectory)directory {
+- (NSString *)plistPathInDirectory {
   NSArray *directoryPaths;
-  NSArray *components = @[];
-  NSString *plistNameWithExtension = [NSString stringWithFormat:@"%@.plist", plistName];
-  switch (directory) {
-    case FIRInstanceIDPlistDirectoryDocuments:
-      directoryPaths =
-          NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
-      components = @[ directoryPaths.lastObject, plistNameWithExtension ];
-      break;
-
-    case FIRInstanceIDPlistDirectoryApplicationSupport:
-      directoryPaths =
-          NSSearchPathForDirectoriesInDomains([self supportedDirectory], NSUserDomainMask, YES);
-      components = @[ directoryPaths.lastObject, _subDirectoryName, plistNameWithExtension ];
-      break;
-
-    default:
-      FIRInstanceIDLoggerError(kFIRInstanceIDMessageCodeBackupExcludedPlistInvalidPlistEnum,
-                               @"Invalid plist directory type: %lu", (unsigned long)directory);
-      NSAssert(NO, @"Invalid plist directory type: %lu", (unsigned long)directory);
-      break;
-  }
+  NSString *plistNameWithExtension = [NSString stringWithFormat:@"%@.plist", self.fileName];
+  directoryPaths =
+      NSSearchPathForDirectoriesInDomains([self supportedDirectory], NSUserDomainMask, YES);
+  NSArray *components = @[ directoryPaths.lastObject, _subDirectoryName, plistNameWithExtension ];
 
   return [NSString pathWithComponents:components];
 }
 
-- (BOOL)doesFileExistInDirectory:(FIRInstanceIDPlistDirectory)directory {
-  NSString *path = [self plistPathInDirectory:directory];
-  return [[NSFileManager defaultManager] fileExistsAtPath:path];
-}
-
 - (NSSearchPathDirectory)supportedDirectory {
 #if TARGET_OS_TV
   return NSCachesDirectory;

Firebase/Messaging/FIRMMessageCode.h

@@ -143,7 +143,7 @@ typedef NS_ENUM(NSInteger, FIRMessagingMessageCode) {
   kFIRMessagingMessageCodeRmq2PersistentStore006 = 13006,  // I-FCM013006
   kFIRMessagingMessageCodeRmq2PersistentStoreErrorCreatingDatabase = 13007,  // I-FCM013007
   kFIRMessagingMessageCodeRmq2PersistentStoreErrorOpeningDatabase = 13008,  // I-FCM013008
-  kFIRMessagingMessageCodeRmq2PersistentStoreInvalidRmqDirectory = 13009,  // I-FCM013009
+  kFIRMessagingMessageCodeRmq2PersistentStoreInvalidRmqDirectory = 13009,  // no longer used
   kFIRMessagingMessageCodeRmq2PersistentStoreErrorCreatingTable = 13010,  // I-FCM013010
   // FIRMessagingRmqManager.m
   kFIRMessagingMessageCodeRmqManager000 = 14000,  // I-FCM014000

Firebase/Messaging/FIRMessagingRmq2PersistentStore.h

@@ -121,13 +121,6 @@ extern NSString *const kTableS2DRmqIds;
 - (int)deleteMessagesFromTable:(NSString *)tableName
                     withRmqIds:(NSArray *)rmqIds;
 
-/**
- *  Remove database from the device.
- *
- *  @param dbName The database name to be deleted.
- */
-+ (void)removeDatabase:(NSString *)dbName;
-
 #pragma mark - Sync Messages
 
 /**