Skip to content

[FIX] Move the storage location on iOS to Application Support #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 10, 2020
Merged

[FIX] Move the storage location on iOS to Application Support #274

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7cb5d27
Move the storage location on iOS to Application Support
HeyImChris Jan 3, 2020
ad83d34
remove unnecessary dispatch_once calls
HeyImChris Jan 7, 2020
0c4153d
Add sequential migration and optional clearData flags so we can opt i…
HeyImChris Feb 1, 2020
4e281b3
Merge branch 'LEGACY' into heyImChris/storageLocationFix_iOS
HeyImChris Feb 1, 2020
1f01ddc
Option to not overwrite ApplicationSupport data
HeyImChris Feb 6, 2020
a7a85ed
Merge branch 'heyImChris/storageLocationFix_iOS' of https://github.co…
HeyImChris Feb 6, 2020
17ac36a
merge two flags into one
HeyImChris Feb 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 61 additions & 40 deletions ios/RNCAsyncStorage.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,24 @@ static void RCTAppendError(NSDictionary *error, NSMutableArray<NSDictionary *> *
return nil;
}

// DO NOT USE
// This is used internally to migrate data from the old file location to the new one.
// Please use `RCTCreateStorageDirectoryPath` instead
static NSString *RCTCreateStorageDirectoryPath_deprecated(NSString *storageDir) {
NSString *storageDirectoryPath;
#if TARGET_OS_TV
storageDirectoryPath = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject;
#else
storageDirectoryPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject;
#endif
storageDirectoryPath = [storageDirectoryPath stringByAppendingPathComponent:storageDir];
return storageDirectoryPath;
}

static NSString *RCTCreateStorageDirectoryPath(NSString *storageDir) {
NSString *storageDirectoryPath;
#if TARGET_OS_TV
storageDirectoryPath = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject;
#else
storageDirectoryPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject;
#endif
// We should use the "Application Support/[bundleID]" folder for persistent data storage that's hidden from users
NSString *storageDirectoryPath = NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES).firstObject;
storageDirectoryPath = [storageDirectoryPath stringByAppendingPathComponent:[[NSBundle mainBundle] bundleIdentifier]]; // Per Apple's docs, all app content in Application Support must be within a subdirectory of the app's bundle identifier
storageDirectoryPath = [storageDirectoryPath stringByAppendingPathComponent:storageDir];
return storageDirectoryPath;
}
Expand All @@ -102,7 +113,7 @@ static void RCTAppendError(NSDictionary *error, NSMutableArray<NSDictionary *> *

static NSString *RCTCreateManifestFilePath(NSString *storageDirectory)
{
return [RCTCreateStorageDirectoryPath(storageDirectory) stringByAppendingPathComponent:RCTManifestFileName];
return [storageDirectory stringByAppendingPathComponent:RCTManifestFileName];
}

static NSString *RCTGetManifestFilePath()
Expand Down Expand Up @@ -194,58 +205,62 @@ static void RCTStorageDirectoryMigrationLogError(NSString *reason, NSError *erro
RCTLogWarn(@"%@: %@", reason, error ? error.description : @"");
}

static void RCTStorageDirectoryCleanupOld()
static void RCTStorageDirectoryCleanupOld(NSString *oldDirectoryPath)
{
NSError *error;
if (![[NSFileManager defaultManager] removeItemAtPath:RCTCreateStorageDirectoryPath(RCTOldStorageDirectory) error:&error]) {
if (![[NSFileManager defaultManager] removeItemAtPath:oldDirectoryPath error:&error]) {
RCTStorageDirectoryMigrationLogError(@"Failed to remove old storage directory during migration", error);
}
}

static void RCTStorageDirectoryMigrate()
static void RCTStorageDirectoryMigrate(NSString *oldDirectoryPath, NSString *newDirectoryPath, BOOL shouldCleanupOldDirectory)
{
NSError *error;
// Migrate data by copying old storage directory to new storage directory location
if (![[NSFileManager defaultManager] copyItemAtPath:RCTCreateStorageDirectoryPath(RCTOldStorageDirectory) toPath:RCTGetStorageDirectory() error:&error]) {
if (![[NSFileManager defaultManager] copyItemAtPath:oldDirectoryPath toPath:newDirectoryPath error:&error]) {
RCTStorageDirectoryMigrationLogError(@"Failed to copy old storage directory to new storage directory location during migration", error);
} else {
} else if (shouldCleanupOldDirectory) {
// If copying succeeds, remove old storage directory
RCTStorageDirectoryCleanupOld();
RCTStorageDirectoryCleanupOld(oldDirectoryPath);
}
}

/**
* This check is added to make sure that anyone coming from pre-1.2.2 does not lose cached data.
* Data is migrated from the "RNCAsyncLocalStorage_V1" directory to the "RCTAsyncLocalStorage_V1" directory.
* Check that data is migrated from the old location to the new location
* fromStorageDirectory: the directory where the older data lives
* toStorageDirectory: the directory where the new data should live
* shouldCleanupOldDirectory: YES if we should delete the old directory's contents after migrating to the new directory
* shouldOverwriteNewDirectory: YES if we should overwrite the new directory with the contents of the old directory IF the old directory has more recent content. If NO, perform no such overwrite on the new directory regardless of when data was last modified.
*/
static void RCTStorageDirectoryMigrationCheck()
static void RCTStorageDirectoryMigrationCheck(NSString *fromStorageDirectory, NSString *toStorageDirectory, BOOL shouldCleanupOldDirectory, BOOL shouldOverwriteNewDirectory)
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
NSError *error;
BOOL isDir;
// If the old directory exists, it means we may need to migrate old data to the new directory
if ([[NSFileManager defaultManager] fileExistsAtPath:RCTCreateStorageDirectoryPath(RCTOldStorageDirectory) isDirectory:&isDir] && isDir) {
// Check if the new storage directory location already exists
if ([[NSFileManager defaultManager] fileExistsAtPath:RCTGetStorageDirectory()]) {
// If new storage location exists, check if the new storage has been modified sooner
if ([RCTManifestModificationDate(RCTGetManifestFilePath()) compare:RCTManifestModificationDate(RCTCreateManifestFilePath(RCTOldStorageDirectory))] == 1) {
// If new location has been modified more recently, simply clean out old data
RCTStorageDirectoryCleanupOld();
NSError *error;
BOOL isDir;
NSFileManager *fileManager = [NSFileManager defaultManager];
// If the old directory exists, it means we may need to migrate old data to the new directory
if ([fileManager fileExistsAtPath:fromStorageDirectory isDirectory:&isDir] && isDir) {
// Check if the new storage directory location already exists
if ([fileManager fileExistsAtPath:toStorageDirectory]) {
// If new storage location exists, check if the new storage has been modified sooner in which case we may want to cleanup the old location
if ([RCTManifestModificationDate(RCTCreateManifestFilePath(toStorageDirectory)) compare:RCTManifestModificationDate(RCTCreateManifestFilePath(fromStorageDirectory))] == 1) {
// If new location has been modified more recently, simply clean out old data
if (shouldCleanupOldDirectory) {
RCTStorageDirectoryCleanupOld(fromStorageDirectory);
}
} else if (shouldOverwriteNewDirectory) {
// If old location has been modified more recently, remove new storage and migrate
if (![fileManager removeItemAtPath:toStorageDirectory error:&error]) {
RCTStorageDirectoryMigrationLogError(@"Failed to remove new storage directory during migration", error);
} else {
// If old location has been modified more recently, remove new storage and migrate
if (![[NSFileManager defaultManager] removeItemAtPath:RCTGetStorageDirectory() error:&error]) {
RCTStorageDirectoryMigrationLogError(@"Failed to remove new storage directory during migration", error);
} else {
RCTStorageDirectoryMigrate();
}
RCTStorageDirectoryMigrate(fromStorageDirectory, toStorageDirectory, shouldCleanupOldDirectory);
}
} else {
// If new storage location doesn't exist, migrate data
RCTStorageDirectoryMigrate();
}
} else {
// If new storage location doesn't exist, migrate data
RCTStorageDirectoryMigrate(fromStorageDirectory, toStorageDirectory, shouldCleanupOldDirectory);
}
});
}
}

#pragma mark - RNCAsyncStorage
Expand All @@ -269,7 +284,13 @@ - (instancetype)init
if (!(self = [super init])) {
return nil;
}
RCTStorageDirectoryMigrationCheck();

// First migrate our deprecated path "Documents/.../RNCAsyncLocalStorage_V1" to "Documents/.../RCTAsyncLocalStorage_V1"
RCTStorageDirectoryMigrationCheck(RCTCreateStorageDirectoryPath_deprecated(RCTOldStorageDirectory), RCTCreateStorageDirectoryPath_deprecated(RCTStorageDirectory), YES, YES);

// Then migrate what's in "Documents/.../RCTAsyncLocalStorage_V1" to "Application Support/[bundleID]/RCTAsyncLocalStorage_V1"
RCTStorageDirectoryMigrationCheck(RCTCreateStorageDirectoryPath_deprecated(RCTStorageDirectory), RCTCreateStorageDirectoryPath(RCTStorageDirectory), NO, NO);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you're passing YES, YES to first migration, then NO, NO to the second one, you can actually use one parameter for that, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, but they represent pretty different actions. Also it sounds like we're going to drop RNC* migration support soon anyway so this leads us to a pretty easy plan there (drop the last parameter and keep the other one)


return self;
}

Expand Down Expand Up @@ -346,7 +367,7 @@ - (NSDictionary *)_ensureSetup

if (!_haveSetup) {
NSDictionary *errorOut = nil;
NSString *serialized = RCTReadFile(RCTGetManifestFilePath(), RCTManifestFileName, &errorOut);
NSString *serialized = RCTReadFile(RCTCreateStorageDirectoryPath(RCTGetManifestFilePath(), RCTManifestFileName, &errorOut);
if (!serialized) {
if (errorOut) {
// We cannot simply create a new manifest in case the file does exist but we have no access to it.
Expand Down Expand Up @@ -377,7 +398,7 @@ - (NSDictionary *)_writeManifest:(NSMutableArray<NSDictionary *> **)errors
{
NSError *error;
NSString *serialized = RCTJSONStringify(_manifest, &error);
[serialized writeToFile:RCTGetManifestFilePath() atomically:YES encoding:NSUTF8StringEncoding error:&error];
[serialized writeToFile:RCTCreateStorageDirectoryPath(RCTGetManifestFilePath()) atomically:YES encoding:NSUTF8StringEncoding error:&error];
NSDictionary *errorOut;
if (error) {
errorOut = RCTMakeError(@"Failed to write manifest file.", error, nil);
Expand Down