#1362 fix: back up and restore trigger keys without crashing due to serializing abstract classes

Author: sds100

app/src/main/java/io/github/sds100/keymapper/backup/BackupManager.kt

@@ -113,10 +113,12 @@ class BackupManagerImpl(
             .registerTypeAdapter(FingerprintMapEntity.DESERIALIZER)
             .registerTypeAdapter(KeyMapEntity.DESERIALIZER)
             .registerTypeAdapter(TriggerEntity.DESERIALIZER)
+            .registerTypeAdapter(TriggerKeyEntity.SERIALIZER)
             .registerTypeAdapter(TriggerKeyEntity.DESERIALIZER)
             .registerTypeAdapter(ActionEntity.DESERIALIZER)
             .registerTypeAdapter(Extra.DESERIALIZER)
-            .registerTypeAdapter(ConstraintEntity.DESERIALIZER).create()
+            .registerTypeAdapter(ConstraintEntity.DESERIALIZER)
+            .create()
     }
 
     private val backupAutomatically: Flow<Boolean> = preferenceRepository
@@ -426,7 +428,7 @@ class BackupManagerImpl(
         } catch (e: NoSuchElementException) {
             return Error.CorruptJsonFile(e.message ?: "")
         } catch (e: Exception) {
-            e.printStackTrace()
+            Timber.e(e)
 
             if (throwExceptions) {
                 throw e
@@ -448,45 +450,45 @@ class BackupManagerImpl(
             // delete the contents of the file
             output.clear()
 
-            val json = gson.toJson(
-                BackupModel(
-                    AppDatabase.DATABASE_VERSION,
-                    Constants.VERSION_CODE,
-                    keyMapList,
-                    fingerprintMaps,
-                    defaultLongPressDelay =
-                    preferenceRepository
-                        .get(Keys.defaultLongPressDelay)
-                        .first()
-                        .takeIf { it != PreferenceDefaults.LONG_PRESS_DELAY },
-                    defaultDoublePressDelay =
-                    preferenceRepository
-                        .get(Keys.defaultDoublePressDelay)
-                        .first()
-                        .takeIf { it != PreferenceDefaults.DOUBLE_PRESS_DELAY },
-                    defaultRepeatDelay =
-                    preferenceRepository
-                        .get(Keys.defaultRepeatDelay)
-                        .first()
-                        .takeIf { it != PreferenceDefaults.REPEAT_DELAY },
-                    defaultRepeatRate =
-                    preferenceRepository
-                        .get(Keys.defaultRepeatRate)
-                        .first()
-                        .takeIf { it != PreferenceDefaults.REPEAT_RATE },
-                    defaultSequenceTriggerTimeout =
-                    preferenceRepository
-                        .get(Keys.defaultSequenceTriggerTimeout)
-                        .first()
-                        .takeIf { it != PreferenceDefaults.SEQUENCE_TRIGGER_TIMEOUT },
-                    defaultVibrationDuration =
-                    preferenceRepository
-                        .get(Keys.defaultVibrateDuration)
-                        .first()
-                        .takeIf { it != PreferenceDefaults.VIBRATION_DURATION },
-                ),
+            val backupModel = BackupModel(
+                AppDatabase.DATABASE_VERSION,
+                Constants.VERSION_CODE,
+                keyMapList,
+                fingerprintMaps,
+                defaultLongPressDelay =
+                preferenceRepository
+                    .get(Keys.defaultLongPressDelay)
+                    .first()
+                    .takeIf { it != PreferenceDefaults.LONG_PRESS_DELAY },
+                defaultDoublePressDelay =
+                preferenceRepository
+                    .get(Keys.defaultDoublePressDelay)
+                    .first()
+                    .takeIf { it != PreferenceDefaults.DOUBLE_PRESS_DELAY },
+                defaultRepeatDelay =
+                preferenceRepository
+                    .get(Keys.defaultRepeatDelay)
+                    .first()
+                    .takeIf { it != PreferenceDefaults.REPEAT_DELAY },
+                defaultRepeatRate =
+                preferenceRepository
+                    .get(Keys.defaultRepeatRate)
+                    .first()
+                    .takeIf { it != PreferenceDefaults.REPEAT_RATE },
+                defaultSequenceTriggerTimeout =
+                preferenceRepository
+                    .get(Keys.defaultSequenceTriggerTimeout)
+                    .first()
+                    .takeIf { it != PreferenceDefaults.SEQUENCE_TRIGGER_TIMEOUT },
+                defaultVibrationDuration =
+                preferenceRepository
+                    .get(Keys.defaultVibrateDuration)
+                    .first()
+                    .takeIf { it != PreferenceDefaults.VIBRATION_DURATION },
             )
 
+            val json = gson.toJson(backupModel)
+
             val backupUid = uuidGenerator.random()
 
             tempBackupDir = fileAdapter.getPrivateFile("$TEMP_BACKUP_ROOT_DIR/$backupUid")
@@ -549,7 +551,7 @@ class BackupManagerImpl(
         val appVersion: Int,
 
         @SerializedName(NAME_KEYMAP_LIST)
-        val keymapList: List<KeyMapEntity>? = null,
+        val keyMapList: List<KeyMapEntity>? = null,
 
         @SerializedName(NAME_FINGERPRINT_MAP_LIST)
         val fingerprintMapList: List<FingerprintMapEntity>?,

app/src/main/java/io/github/sds100/keymapper/data/db/typeconverter/TriggerTypeConverter.kt

@@ -18,6 +18,7 @@ class TriggerTypeConverter {
     fun toTrigger(json: String): TriggerEntity {
         val gson = GsonBuilder()
             .registerTypeAdapter(TriggerEntity.DESERIALIZER)
+            .registerTypeAdapter(TriggerKeyEntity.SERIALIZER)
             .registerTypeAdapter(TriggerKeyEntity.DESERIALIZER)
             .registerTypeAdapter(Extra.DESERIALIZER).create()
 

app/src/main/java/io/github/sds100/keymapper/data/entities/TriggerKeyEntity.kt

@@ -6,9 +6,12 @@ import com.github.salomonbrys.kotson.byNullableInt
 import com.github.salomonbrys.kotson.byNullableString
 import com.github.salomonbrys.kotson.byString
 import com.github.salomonbrys.kotson.jsonDeserializer
+import com.github.salomonbrys.kotson.jsonSerializer
 import com.github.salomonbrys.kotson.obj
+import com.google.gson.Gson
 import com.google.gson.JsonDeserializer
 import com.google.gson.JsonElement
+import com.google.gson.JsonSerializer
 import java.util.UUID
 
 sealed class TriggerKeyEntity : Parcelable {
@@ -26,6 +29,17 @@ sealed class TriggerKeyEntity : Parcelable {
         const val LONG_PRESS = 1
         const val DOUBLE_PRESS = 2
 
+        /**
+         * This is required because they are subclasses and Gson doesn't know about their
+         * fields otherwise.
+         */
+        val SERIALIZER: JsonSerializer<TriggerKeyEntity> = jsonSerializer { (key) ->
+            when (key) {
+                is AssistantTriggerKeyEntity -> Gson().toJsonTree(key)
+                is KeyCodeTriggerKeyEntity -> Gson().toJsonTree(key)
+            }
+        }
+
         val DESERIALIZER: JsonDeserializer<TriggerKeyEntity> =
             jsonDeserializer { (json, _, _) ->
                 // nullable because this property was added after backup and restore was released.