Add exception handling for SQLite Cipher Database migration. (#624)

* Added Exception handling in database migration.

* Added Database migration retries.

Author: prateek-kommunicate

kommunicate/src/main/java/io/kommunicate/commons/AppSpecificSettings.java

@@ -21,11 +21,12 @@ public class AppSpecificSettings {
     private static final String DATABASE_NAME = "DATABASE_NAME";
     private static final String ENABLE_TEXT_LOGGING = "ENABLE_TEXT_LOGGING";
     private static final String TEXT_LOG_FILE_NAME = "TEXT_LOG_FILE_NAME";
-    private static final String AL_BASE_URL = "AL_BASE_URL";
+    private static final String BASE_URL = "AL_BASE_URL";
     private static final String KM_BASE_URL = "KM_BASE_URL";
-    private static final String AL_SUPPORT_EMAIL_ID = "AL_SUPPORT_EMAIL_ID";
+    private static final String SUPPORT_EMAIL_ID = "AL_SUPPORT_EMAIL_ID";
     private static final String ENABLE_LOGGING_IN_RELEASE_BUILD = "ENABLE_LOGGING_IN_RELEASE_BUILD";
-    private static final String AL_NOTIFICATION_AFTER_TIME = "AL_NOTIFICATION_AFTER_TIME";
+    private static final String NOTIFICATION_AFTER_TIME = "AL_NOTIFICATION_AFTER_TIME";
+    private static final String DATABASE_MIGRATION_RETRY_COUNT = "DATABASE_MIGRATION_RETRY_COUNT";
 
     private AppSpecificSettings(Context context) {
         this.sharedPreferences = AppContextService.getContext(context).getSharedPreferences(MY_PREFERENCE, Context.MODE_PRIVATE);
@@ -66,11 +67,11 @@ public String getTextLogFileName() {
     }
 
     public String getAlBaseUrl() {
-        return sharedPreferences.getString(AL_BASE_URL, null);
+        return sharedPreferences.getString(BASE_URL, null);
     }
 
     public AppSpecificSettings setAlBaseUrl(String url) {
-        sharedPreferences.edit().putString(AL_BASE_URL, url).commit();
+        sharedPreferences.edit().putString(BASE_URL, url).commit();
         return this;
     }
 
@@ -84,11 +85,11 @@ public AppSpecificSettings setKmBaseUrl(String url) {
     }
 
     public String getSupportEmailId() {
-        return sharedPreferences.getString(AL_SUPPORT_EMAIL_ID, APPLOZIC_SUPPORT);
+        return sharedPreferences.getString(SUPPORT_EMAIL_ID, APPLOZIC_SUPPORT);
     }
 
     public AppSpecificSettings setSupportEmailId(String emailId) {
-        sharedPreferences.edit().putString(AL_SUPPORT_EMAIL_ID, emailId).commit();
+        sharedPreferences.edit().putString(SUPPORT_EMAIL_ID, emailId).commit();
         return this;
     }
 
@@ -102,16 +103,25 @@ public boolean isLoggingEnabledForReleaseBuild() {
     }
 
     public AppSpecificSettings setNotificationAfterTime(long notificationAfterTime) {
-        sharedPreferences.edit().putLong(AL_NOTIFICATION_AFTER_TIME, notificationAfterTime).commit();
+        sharedPreferences.edit().putLong(NOTIFICATION_AFTER_TIME, notificationAfterTime).commit();
         return this;
     }
 
     public boolean isAllNotificationMuted() {
-        long notificationAfterTime = sharedPreferences.getLong(AL_NOTIFICATION_AFTER_TIME, 0);
+        long notificationAfterTime = sharedPreferences.getLong(NOTIFICATION_AFTER_TIME, 0);
         Date date = Calendar.getInstance(TimeZone.getTimeZone("UTC")).getTime();
         return (notificationAfterTime - date.getTime() > 0);
     }
 
+    public int getCurrentDatabaseMigrationRetryCount() {
+        return sharedPreferences.getInt(DATABASE_MIGRATION_RETRY_COUNT, 0);
+    }
+
+    public AppSpecificSettings setCurrentDatabaseMigrationRetryCount(int databaseMigrationRetryCount) {
+        sharedPreferences.edit().putInt(DATABASE_MIGRATION_RETRY_COUNT, databaseMigrationRetryCount).apply();
+        return this;
+    }
+
     public boolean clearAll() {
         if (sharedPreferences != null) {
             return sharedPreferences.edit().clear().commit();

kommunicate/src/main/java/io/kommunicate/database/DatabaseMigrationHelper.kt

@@ -6,11 +6,13 @@ import io.kommunicate.devkit.api.MobiComKitClientService
 import io.kommunicate.commons.AppContextService
 import net.sqlcipher.database.SQLiteDatabase
 import net.sqlcipher.database.SQLiteException
+import kotlin.Throws
 
 object DatabaseMigrationHelper {
     private const val TEMP_ENCRYPTED_DB_NAME = "temp_encrypted.db"
 
     @JvmStatic
+    @Throws(Exception::class)
     fun migrateDatabase(context: Context, dbName: String) {
         val databaseName = if(context.getDatabasePath(dbName).exists()) {
             dbName
@@ -70,6 +72,7 @@ object DatabaseMigrationHelper {
     }
 
     // Copy tables and data from one database to another
+    @Throws(Exception::class)
     private fun copyDataBetweenDatabases(sourceDb: SQLiteDatabase, destinationDb: SQLiteDatabase) {
         val cursor: Cursor =
             sourceDb.rawQuery("SELECT name FROM sqlite_master WHERE type='table'", null)

kommunicate/src/main/java/io/kommunicate/devkit/database/MobiComDatabaseHelper.java

@@ -14,6 +14,8 @@
 import io.kommunicate.commons.commons.core.utils.Utils;
 
 import io.kommunicate.database.DatabaseMigrationHelper;
+import io.sentry.Hint;
+import io.sentry.Sentry;
 
 public class MobiComDatabaseHelper extends SQLiteOpenHelper {
 
@@ -247,6 +249,7 @@ public class MobiComDatabaseHelper extends SQLiteOpenHelper {
     private static final String TAG = "MobiComDatabaseHelper";
     private static MobiComDatabaseHelper sInstance;
     private Context context;
+    private static final int MAX_DATABASE_MIGRATION_RETRY_COUNT = 3;
 
     private MobiComDatabaseHelper(Context context) {
         this(context, !TextUtils.isEmpty(AppSpecificSettings.getInstance(AppContextService.getContext(context)).getDatabaseName()) ? AppSpecificSettings.getInstance(AppContextService.getContext(context)).getDatabaseName() : "MCK_" + MobiComKitClientService.getApplicationKey(AppContextService.getContext(context)), null, DB_VERSION);
@@ -256,8 +259,17 @@ private MobiComDatabaseHelper(Context context) {
     public MobiComDatabaseHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
         super(context, name, factory, version);
         SQLiteDatabase.loadLibs(context);
-        if (!DBUtils.isDatabaseEncrypted(context, name)) {
-            DatabaseMigrationHelper.migrateDatabase(context, name);
+        AppSpecificSettings appSpecificSettings = AppSpecificSettings.getInstance(context);
+        int currentRetryCount = appSpecificSettings.getCurrentDatabaseMigrationRetryCount();
+        if (!DBUtils.isDatabaseEncrypted(context, name) && currentRetryCount < MAX_DATABASE_MIGRATION_RETRY_COUNT) {
+            try {
+                DatabaseMigrationHelper.migrateDatabase(context, name);
+            } catch (Exception e) {
+                // Database Exception handled.
+                Sentry.captureException(e);
+            }
+            currentRetryCount+=1;
+            appSpecificSettings.setCurrentDatabaseMigrationRetryCount(currentRetryCount);
         }
     }