Skip to content
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

fix database path #44

Merged
merged 2 commits into from
Oct 7, 2015
Merged

fix database path #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd75cc2
fix database path
djih Oct 6, 2015
145da67
added success checks before updating db number and deleting events ar…
djih Oct 7, 2015
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
4 changes: 2 additions & 2 deletions Amplitude/AMPConstants.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
NSString *const kAMPEventLogDomain = @"api.amplitude.com";
NSString *const kAMPEventLogUrl = @"https://api.amplitude.com/";
const int kAMPApiVersion = 2;
const int kAMPDBVersion = 1;
const int kAMPDBFirstVersion = 1; // to detect if DB exists yet
const int kAMPDBVersion = 2;
const int kAMPDBFirstVersion = 2; // to detect if DB exists yet
const int kAMPEventUploadThreshold = 30;
const int kAMPEventUploadMaxBatchSize = 100;
const int kAMPEventMaxCount = 1000;
Expand Down
2 changes: 1 addition & 1 deletion Amplitude/AMPDatabaseHelper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
+ (AMPDatabaseHelper*)getDatabaseHelper;
- (BOOL)createTables;
- (BOOL)dropTables;
- (void)upgrade:(int) oldVersion newVersion:(int) newVersion;
- (BOOL)upgrade:(int) oldVersion newVersion:(int) newVersion;
- (BOOL)resetDB:(BOOL) deleteDB;
- (BOOL)deleteDB;

Expand Down
22 changes: 14 additions & 8 deletions Amplitude/AMPDatabaseHelper.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ - (id) init
if (self = [super init]) {

NSString *databaseDirectory = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) objectAtIndex: 0];
_databasePath = SAFE_ARC_RETAIN([databaseDirectory stringByAppendingString:@"com.amplitude.database"]);
_databasePath = SAFE_ARC_RETAIN([databaseDirectory stringByAppendingPathComponent:@"com.amplitude.database"]);
_dbQueue = SAFE_ARC_RETAIN([FMDatabaseQueue databaseQueueWithPath:_databasePath flags:(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE)]);
if (![[NSFileManager defaultManager] fileExistsAtPath:_databasePath]) {
[self createTables];
Expand Down Expand Up @@ -109,7 +109,7 @@ - (BOOL)createTables
return success;
}

- (void)upgrade:(int) oldVersion newVersion:(int) newVersion
- (BOOL)upgrade:(int) oldVersion newVersion:(int) newVersion
{
__block BOOL success = YES;

Expand All @@ -122,17 +122,21 @@ - (void)upgrade:(int) oldVersion newVersion:(int) newVersion
}

switch (oldVersion) {
case 0: {
case 0:
case 1: {
NSString *createEventsTable = [NSString stringWithFormat:CREATE_EVENT_TABLE, EVENT_TABLE_NAME, ID_FIELD, EVENT_FIELD];
[db executeUpdate:createEventsTable];
success &= [db executeUpdate:createEventsTable];

NSString *createStoreTable = [NSString stringWithFormat:CREATE_STORE_TABLE, STORE_TABLE_NAME, KEY_FIELD, VALUE_FIELD];
[db executeUpdate:createStoreTable];
success &= [db executeUpdate:createStoreTable];

NSString *createLongStoreTable = [NSString stringWithFormat:CREATE_LONG_STORE_TABLE, LONG_STORE_TABLE_NAME, KEY_FIELD, VALUE_FIELD];
[db executeUpdate:createLongStoreTable];
success &= [db executeUpdate:createLongStoreTable];

if (newVersion <= 1) break;
if (newVersion <= 2) break;
}
case 2: {
if (newVersion <= 3) break;
}
default:
success = NO;
Expand All @@ -143,8 +147,10 @@ - (void)upgrade:(int) oldVersion newVersion:(int) newVersion

if (!success) {
NSLog(@"upgrade with unknown oldVersion %d", oldVersion);
[self resetDB:NO];
return [self resetDB:NO];
}

return success;
}

- (BOOL)dropTables
Expand Down
40 changes: 22 additions & 18 deletions Amplitude/Amplitude.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ - (id)init
_propertyList = SAFE_ARC_RETAIN([self deserializePList:_propertyListPath]);
if (!_propertyList) {
_propertyList = SAFE_ARC_RETAIN([NSMutableDictionary dictionary]);
[_propertyList setObject:[NSNumber numberWithInt:0] forKey:DATABASE_VERSION];
[_propertyList setObject:[NSNumber numberWithInt:1] forKey:DATABASE_VERSION];
BOOL success = [self savePropertyList];
if (!success) {
NSLog(@"ERROR: Unable to save propertyList to file on initialization");
Expand All @@ -219,22 +219,28 @@ - (id)init
}

// update database if necessary
int oldDBVersion = 0;
int oldDBVersion = 1;
NSNumber *oldDBVersionSaved = [_propertyList objectForKey:DATABASE_VERSION];
if (oldDBVersionSaved != nil) {
oldDBVersion = [oldDBVersionSaved intValue];
}

// update the database
if (oldDBVersion < kAMPDBVersion) {
[[AMPDatabaseHelper getDatabaseHelper] upgrade:oldDBVersion newVersion:kAMPDBVersion];
[_propertyList setObject:[NSNumber numberWithInt:kAMPDBVersion] forKey:DATABASE_VERSION];
[self savePropertyList];
if ([[AMPDatabaseHelper getDatabaseHelper] upgrade:oldDBVersion newVersion:kAMPDBVersion]) {
[_propertyList setObject:[NSNumber numberWithInt:kAMPDBVersion] forKey:DATABASE_VERSION];
[self savePropertyList];
}
}

// migrate all of old _eventsData object to database store if database just created
if (oldDBVersion < kAMPDBFirstVersion) {
[self migrateEventsDataToDB];
if ([self migrateEventsDataToDB]) {
// delete events data so don't need to migrate next time
if ([[NSFileManager defaultManager] fileExistsAtPath:_eventsDataPath]) {
[[NSFileManager defaultManager] removeItemAtPath:_eventsDataPath error:NULL];
}
}
}
SAFE_ARC_RELEASE(_eventsDataPath);

Expand Down Expand Up @@ -263,50 +269,48 @@ - (id)init
return self;
};

- (void) migrateEventsDataToDB
- (BOOL) migrateEventsDataToDB
{
NSDictionary *eventsData = [self unarchive:_eventsDataPath];
if (eventsData == nil) {
return;
return NO;
}

AMPDatabaseHelper *dbHelper = [AMPDatabaseHelper getDatabaseHelper];
BOOL success = YES;

// migrate events
NSArray *events = [eventsData objectForKey:EVENTS];
for (id event in events) {
NSData *jsonData = [NSJSONSerialization dataWithJSONObject:event options:0 error:NULL];
NSString *jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
[dbHelper addEvent:jsonString];
success &= [dbHelper addEvent:jsonString];
SAFE_ARC_RELEASE(jsonString);
}

// migrate remaining properties
NSString *userId = [eventsData objectForKey:USER_ID];
if (userId != nil) {
[dbHelper insertOrReplaceKeyValue:USER_ID value:userId];
success &= [dbHelper insertOrReplaceKeyValue:USER_ID value:userId];
}
NSNumber *optOut = [eventsData objectForKey:OPT_OUT];
if (optOut != nil) {
[dbHelper insertOrReplaceKeyLongValue:OPT_OUT value:optOut];
success &= [dbHelper insertOrReplaceKeyLongValue:OPT_OUT value:optOut];
}
NSString *deviceId = [eventsData objectForKey:DEVICE_ID];
if (deviceId != nil) {
[dbHelper insertOrReplaceKeyValue:DEVICE_ID value:deviceId];
success &= [dbHelper insertOrReplaceKeyValue:DEVICE_ID value:deviceId];
}
NSNumber *previousSessionId = [eventsData objectForKey:PREVIOUS_SESSION_ID];
if (previousSessionId != nil) {
[dbHelper insertOrReplaceKeyLongValue:PREVIOUS_SESSION_ID value:previousSessionId];
success &= [dbHelper insertOrReplaceKeyLongValue:PREVIOUS_SESSION_ID value:previousSessionId];
}
NSNumber *previousSessionTime = [eventsData objectForKey:PREVIOUS_SESSION_TIME];
if (previousSessionTime != nil) {
[dbHelper insertOrReplaceKeyLongValue:PREVIOUS_SESSION_TIME value:previousSessionTime];
success &= [dbHelper insertOrReplaceKeyLongValue:PREVIOUS_SESSION_TIME value:previousSessionTime];
}

// delete events data so don't need to migrate next time
if ([[NSFileManager defaultManager] fileExistsAtPath:_eventsDataPath]) {
[[NSFileManager defaultManager] removeItemAtPath:_eventsDataPath error:NULL];
}
return success;
}

- (void) addObservers
Expand Down
31 changes: 29 additions & 2 deletions AmplitudeTests/AMPDatabaseHelperTests.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ - (void)testGetNthEventId {
XCTAssertEqual(-1, [self.databaseHelper getNthEventId:1]);
}

- (void)testUpgradeFromVersion0ToVersion1{
- (void)testUpgradeFromVersion1ToVersion2{
// inserts will fail since no tables exist
[self.databaseHelper dropTables];
XCTAssertFalse([self.databaseHelper addEvent:@"test_event"]);
Expand All @@ -148,7 +148,34 @@ - (void)testUpgradeFromVersion0ToVersion1{

// after upgrade, can insert into event, store, long_store
[self.databaseHelper dropTables];
[self.databaseHelper upgrade:0 newVersion:1];
XCTAssertTrue([self.databaseHelper upgrade:1 newVersion:2]);
XCTAssertTrue([self.databaseHelper addEvent:@"test"]);
XCTAssertTrue([self.databaseHelper insertOrReplaceKeyValue:@"key" value:@"value"]);
XCTAssertTrue([self.databaseHelper insertOrReplaceKeyLongValue:@"key" value:[NSNumber numberWithLongLong:0LL]]);
}

- (void)testUpgradeFromVersion0ToVersion2{
// inserts will fail since no tables exist
[self.databaseHelper dropTables];
XCTAssertFalse([self.databaseHelper addEvent:@"test_event"]);

[self.databaseHelper dropTables];
XCTAssertFalse([self.databaseHelper insertOrReplaceKeyValue:@"test_key" value:@"test_value"]);

[self.databaseHelper dropTables];
XCTAssertFalse([self.databaseHelper insertOrReplaceKeyLongValue:@"test_key" value:[NSNumber numberWithInt:0]]);

// after upgrade, can insert into event, store, long_store
[self.databaseHelper dropTables];
XCTAssertTrue([self.databaseHelper upgrade:0 newVersion:2]);
XCTAssertTrue([self.databaseHelper addEvent:@"test"]);
XCTAssertTrue([self.databaseHelper insertOrReplaceKeyValue:@"key" value:@"value"]);
XCTAssertTrue([self.databaseHelper insertOrReplaceKeyLongValue:@"key" value:[NSNumber numberWithLongLong:0LL]]);
}

- (void)testUpgradeFromVersion2ToVersion2{
// upgrade does nothing, can insert into event, store, long_store
XCTAssertTrue([self.databaseHelper upgrade:2 newVersion:2]);
XCTAssertTrue([self.databaseHelper addEvent:@"test"]);
XCTAssertTrue([self.databaseHelper insertOrReplaceKeyValue:@"key" value:@"value"]);
XCTAssertTrue([self.databaseHelper insertOrReplaceKeyLongValue:@"key" value:[NSNumber numberWithLongLong:0LL]]);
Expand Down