Skip to content

[FCM] Recovery logic for a corrupt database #15573

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −11
Draft

[FCM] Recovery logic for a corrupt database #15573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 31 additions & 11 deletions FirebaseMessaging/Sources/FIRMessagingRmqManager.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ - (void)openDatabase {
#ifdef SQLITE_OPEN_FILEPROTECTION_NONE
flags |= SQLITE_OPEN_FILEPROTECTION_NONE;
#endif
int result = sqlite3_open_v2([path UTF8String], &self -> _database, flags, NULL);
int result = sqlite3_open_v2([path UTF8String], &self->_database, flags, NULL);
if (result != SQLITE_OK) {
NSString *errorString = FIRMessagingStringFromSQLiteResult(result);
NSString *errorMessage = [NSString
Expand All @@ -517,21 +517,41 @@ - (void)openDatabase {
[self createTableWithName:kTableLastRmqId command:kCreateTableLastRmqId];
[self createTableWithName:kTableS2DRmqIds command:kCreateTableS2DRmqIds];
} else {
// Calling sqlite3_open should create the database, since the file doesn't exist.
// The file exists, try to open it. If it fails, it might be corrupt.
int flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
#ifdef SQLITE_OPEN_FILEPROTECTION_NONE
flags |= SQLITE_OPEN_FILEPROTECTION_NONE;
#endif
int result = sqlite3_open_v2([path UTF8String], &self -> _database, flags, NULL);
int result = sqlite3_open_v2([path UTF8String], &self->_database, flags, NULL);

// If opening the database failed, it might be corrupt. Try to recover by deleting and
// recreating it.
if (result != SQLITE_OK) {
NSString *errorString = FIRMessagingStringFromSQLiteResult(result);
NSString *errorMessage =
[NSString stringWithFormat:@"Could not create RMQ database at path %@, error: %@", path,
errorString];
FIRMessagingLoggerError(kFIRMessagingMessageCodeRmq2PersistentStoreErrorCreatingDatabase,
@"%@", errorMessage);
NSAssert(NO, errorMessage);
didOpenDatabase = NO;
FIRMessagingLoggerWarn(kFIRMessagingMessageCodeRmq2PersistentStoreErrorOpeningDatabase,
@"Could not open RMQ database at path: %@. "
"Will delete and try to recreate it.",
path);
[[NSFileManager defaultManager] removeItemAtPath:path error:nil];
// After deleting, try to open it again.
result = sqlite3_open_v2([path UTF8String], &self->_database, flags, NULL);
// If it still fails after the recovery attempt, then assert and crash.
if (result != SQLITE_OK) {
NSString *errorString = FIRMessagingStringFromSQLiteResult(result);
NSString *errorMessage = [NSString
stringWithFormat:@"Could not open or create RMQ database at path %@, error: %@", path,
errorString];
FIRMessagingLoggerError(kFIRMessagingMessageCodeRmq2PersistentStoreErrorOpeningDatabase,
@"%@", errorMessage);
NSAssert(NO, errorMessage);
didOpenDatabase = NO; // Still failed, so indicate database did not open.
} else {
// Successfully recreated after corruption, so treat as a new database for table creation.
didOpenDatabase = YES; // Indicate successful opening after recreation.
[self createTableWithName:kTableOutgoingRmqMessages
command:kCreateTableOutgoingRmqMessages];
[self createTableWithName:kTableLastRmqId command:kCreateTableLastRmqId];
[self createTableWithName:kTableS2DRmqIds command:kCreateTableS2DRmqIds];
}
} else {
[self updateDBWithStringRmqID];
}
Expand Down
Loading