Improve the error messaging when an enum is not parsed correctly (#4730)

david-livefront · web-flow · commit 22931bbd3876 · 2025-02-17T15:03:05.000-06:00
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/AuthRequestTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/AuthRequestTypeJson.kt
@@ -21,5 +21,7 @@ enum class AuthRequestTypeJson {
 }
 
 @Keep
-private class AuthRequestTypeSerializer :
-    BaseEnumeratedIntSerializer<AuthRequestTypeJson>(AuthRequestTypeJson.entries.toTypedArray())
+private class AuthRequestTypeSerializer : BaseEnumeratedIntSerializer<AuthRequestTypeJson>(
+    className = "AuthRequestTypeJson",
+    values = AuthRequestTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/KdfTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/KdfTypeJson.kt
@@ -18,5 +18,7 @@ enum class KdfTypeJson {
 }
 
 @Keep
-private class KdfTypeSerializer :
-    BaseEnumeratedIntSerializer<KdfTypeJson>(KdfTypeJson.entries.toTypedArray())
+private class KdfTypeSerializer : BaseEnumeratedIntSerializer<KdfTypeJson>(
+    className = "KdfTypeJson",
+    values = KdfTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/TwoFactorAuthMethod.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/TwoFactorAuthMethod.kt
@@ -39,5 +39,7 @@ enum class TwoFactorAuthMethod(val value: UInt) {
 }
 
 @Keep
-private class TwoFactorAuthMethodSerializer :
-    BaseEnumeratedIntSerializer<TwoFactorAuthMethod>(TwoFactorAuthMethod.entries.toTypedArray())
+private class TwoFactorAuthMethodSerializer : BaseEnumeratedIntSerializer<TwoFactorAuthMethod>(
+    className = "TwoFactorAuthMethod",
+    values = TwoFactorAuthMethod.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializer.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializer.kt
@@ -15,6 +15,7 @@ import kotlinx.serialization.encoding.Encoder
  */
 @Suppress("UnnecessaryAbstractClass")
 abstract class BaseEnumeratedIntSerializer<T : Enum<T>>(
+    private val className: String,
     private val values: Array<T>,
     private val default: T? = null,
 ) : KSerializer<T> {
@@ -29,7 +30,7 @@ abstract class BaseEnumeratedIntSerializer<T : Enum<T>>(
         val decodedValue = decoder.decodeInt().toString()
         return values.firstOrNull { it.serialNameAnnotation?.value == decodedValue }
             ?: default
-            ?: throw IllegalArgumentException("Unknown value $decodedValue")
+            ?: throw IllegalArgumentException("Unknown value $decodedValue for $className")
     }
 
     override fun serialize(encoder: Encoder, value: T) {
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/NotificationType.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/NotificationType.kt
@@ -63,5 +63,7 @@ enum class NotificationType {
 }
 
 @Keep
-private class NotificationTypeSerializer :
-    BaseEnumeratedIntSerializer<NotificationType>(NotificationType.entries.toTypedArray())
+private class NotificationTypeSerializer : BaseEnumeratedIntSerializer<NotificationType>(
+    className = "NotificationType",
+    values = NotificationType.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/OrganizationEventType.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/OrganizationEventType.kt
@@ -130,5 +130,6 @@ enum class OrganizationEventType {
 
 @Keep
 private class OrganizationEventTypeSerializer : BaseEnumeratedIntSerializer<OrganizationEventType>(
+    className = "OrganizationEventType",
     values = OrganizationEventType.entries.toTypedArray(),
 )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/PasscodeGenerationOptions.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/PasscodeGenerationOptions.kt
@@ -91,5 +91,6 @@ data class PasscodeGenerationOptions(
 @Keep
 private class PasscodeTypeSerializer :
     BaseEnumeratedIntSerializer<PasscodeGenerationOptions.PasscodeType>(
-        PasscodeGenerationOptions.PasscodeType.entries.toTypedArray(),
+        className = "PasscodeGenerationOptions.PasscodeType",
+        values = PasscodeGenerationOptions.PasscodeType.entries.toTypedArray(),
     )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/UsernameGenerationOptions.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/UsernameGenerationOptions.kt
@@ -122,11 +122,13 @@ data class UsernameGenerationOptions(
 @Keep
 private class UsernameTypeSerializer :
     BaseEnumeratedIntSerializer<UsernameGenerationOptions.UsernameType>(
-        UsernameGenerationOptions.UsernameType.entries.toTypedArray(),
+        className = "UsernameGenerationOptions.UsernameType",
+        values = UsernameGenerationOptions.UsernameType.entries.toTypedArray(),
     )
 
 @Keep
 private class ForwardedEmailServiceTypeSerializer :
     BaseEnumeratedIntSerializer<UsernameGenerationOptions.ForwardedEmailServiceType>(
-        UsernameGenerationOptions.ForwardedEmailServiceType.entries.toTypedArray(),
+        className = "UsernameGenerationOptions.ForwardedEmailServiceType",
+        values = UsernameGenerationOptions.ForwardedEmailServiceType.entries.toTypedArray(),
     )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherRepromptTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherRepromptTypeJson.kt
@@ -25,5 +25,6 @@ enum class CipherRepromptTypeJson {
 
 @Keep
 private class CipherRepromptTypeSerializer : BaseEnumeratedIntSerializer<CipherRepromptTypeJson>(
-    CipherRepromptTypeJson.entries.toTypedArray(),
+    className = "CipherRepromptTypeJson",
+    values = CipherRepromptTypeJson.entries.toTypedArray(),
 )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherTypeJson.kt
@@ -42,5 +42,7 @@ enum class CipherTypeJson {
 }
 
 @Keep
-private class CipherTypeSerializer :
-    BaseEnumeratedIntSerializer<CipherTypeJson>(CipherTypeJson.entries.toTypedArray())
+private class CipherTypeSerializer : BaseEnumeratedIntSerializer<CipherTypeJson>(
+    className = "CipherTypeJson",
+    values = CipherTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FieldTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FieldTypeJson.kt
@@ -36,5 +36,7 @@ enum class FieldTypeJson {
 }
 
 @Keep
-private class FieldTypeSerializer :
-    BaseEnumeratedIntSerializer<FieldTypeJson>(FieldTypeJson.entries.toTypedArray())
+private class FieldTypeSerializer : BaseEnumeratedIntSerializer<FieldTypeJson>(
+    className = "FieldTypeJson",
+    values = FieldTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FileUploadType.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FileUploadType.kt
@@ -19,5 +19,6 @@ enum class FileUploadType {
 
 @Keep
 private class FileUploadTypeSerializer : BaseEnumeratedIntSerializer<FileUploadType>(
-    FileUploadType.entries.toTypedArray(),
+    className = "FileUploadType",
+    values = FileUploadType.entries.toTypedArray(),
 )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/LinkedIdTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/LinkedIdTypeJson.kt
@@ -180,5 +180,7 @@ enum class LinkedIdTypeJson(val value: UInt) {
 }
 
 @Keep
-private class LinkedIdTypeSerializer :
-    BaseEnumeratedIntSerializer<LinkedIdTypeJson>(LinkedIdTypeJson.entries.toTypedArray())
+private class LinkedIdTypeSerializer : BaseEnumeratedIntSerializer<LinkedIdTypeJson>(
+    className = "LinkedIdTypeJson",
+    values = LinkedIdTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationStatusType.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationStatusType.kt
@@ -32,5 +32,6 @@ enum class OrganizationStatusType {
 @Keep
 private class OrganizationStatusTypeSerializer :
     BaseEnumeratedIntSerializer<OrganizationStatusType>(
-        OrganizationStatusType.entries.toTypedArray(),
+        className = "OrganizationStatusType",
+        values = OrganizationStatusType.entries.toTypedArray(),
     )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationType.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationType.kt
@@ -43,5 +43,6 @@ enum class OrganizationType {
 
 @Keep
 private class OrganizationTypeSerializer : BaseEnumeratedIntSerializer<OrganizationType>(
-    OrganizationType.entries.toTypedArray(),
+    className = "OrganizationType",
+    values = OrganizationType.entries.toTypedArray(),
 )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/PolicyTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/PolicyTypeJson.kt
@@ -100,6 +100,7 @@ enum class PolicyTypeJson {
 
 @Keep
 private class PolicyTypeSerializer : BaseEnumeratedIntSerializer<PolicyTypeJson>(
+    className = "PolicyTypeJson",
     values = PolicyTypeJson.entries.toTypedArray(),
     default = PolicyTypeJson.UNKNOWN,
 )
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SecureNoteTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SecureNoteTypeJson.kt
@@ -18,5 +18,7 @@ enum class SecureNoteTypeJson {
 }
 
 @Keep
-private class SecureNoteTypeSerializer :
-    BaseEnumeratedIntSerializer<SecureNoteTypeJson>(SecureNoteTypeJson.entries.toTypedArray())
+private class SecureNoteTypeSerializer : BaseEnumeratedIntSerializer<SecureNoteTypeJson>(
+    className = "SecureNoteTypeJson",
+    values = SecureNoteTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SendTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SendTypeJson.kt
@@ -24,5 +24,7 @@ enum class SendTypeJson {
 }
 
 @Keep
-private class SendTypeSerializer :
-    BaseEnumeratedIntSerializer<SendTypeJson>(SendTypeJson.entries.toTypedArray())
+private class SendTypeSerializer : BaseEnumeratedIntSerializer<SendTypeJson>(
+    className = "SendTypeJson",
+    values = SendTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/UriMatchTypeJson.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/UriMatchTypeJson.kt
@@ -48,5 +48,7 @@ enum class UriMatchTypeJson {
 }
 
 @Keep
-private class UriMatchTypeSerializer :
-    BaseEnumeratedIntSerializer<UriMatchTypeJson>(UriMatchTypeJson.entries.toTypedArray())
+private class UriMatchTypeSerializer : BaseEnumeratedIntSerializer<UriMatchTypeJson>(
+    className = "UriMatchTypeJson",
+    values = UriMatchTypeJson.entries.toTypedArray(),
+)
diff --git a/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializerTest.kt b/app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializerTest.kt
@@ -62,6 +62,7 @@ private enum class TestEnum {
 }
 
 private class TestEnumSerializer : BaseEnumeratedIntSerializer<TestEnum>(
+    className = "TestEnum",
     values = TestEnum.entries.toTypedArray(),
     default = TestEnum.UNKNOWN,
 )

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,7 @@ enum class AuthRequestTypeJson {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`@Keep`
`24`		`-private class AuthRequestTypeSerializer :`
`25`		`- BaseEnumeratedIntSerializer<AuthRequestTypeJson>(AuthRequestTypeJson.entries.toTypedArray())`
	`24`	`+private class AuthRequestTypeSerializer : BaseEnumeratedIntSerializer<AuthRequestTypeJson>(`
	`25`	`+ className = "AuthRequestTypeJson",`
	`26`	`+ values = AuthRequestTypeJson.entries.toTypedArray(),`
	`27`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,7 @@ enum class KdfTypeJson {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`@Keep`
`21`		`-private class KdfTypeSerializer :`
`22`		`- BaseEnumeratedIntSerializer<KdfTypeJson>(KdfTypeJson.entries.toTypedArray())`
	`21`	`+private class KdfTypeSerializer : BaseEnumeratedIntSerializer<KdfTypeJson>(`
	`22`	`+ className = "KdfTypeJson",`
	`23`	`+ values = KdfTypeJson.entries.toTypedArray(),`
	`24`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,7 @@ enum class TwoFactorAuthMethod(val value: UInt) {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`@Keep`
`42`		`-private class TwoFactorAuthMethodSerializer :`
`43`		`- BaseEnumeratedIntSerializer<TwoFactorAuthMethod>(TwoFactorAuthMethod.entries.toTypedArray())`
	`42`	`+private class TwoFactorAuthMethodSerializer : BaseEnumeratedIntSerializer<TwoFactorAuthMethod>(`
	`43`	`+ className = "TwoFactorAuthMethod",`
	`44`	`+ values = TwoFactorAuthMethod.entries.toTypedArray(),`
	`45`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -63,5 +63,7 @@ enum class NotificationType {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`@Keep`
`66`		`-private class NotificationTypeSerializer :`
`67`		`- BaseEnumeratedIntSerializer<NotificationType>(NotificationType.entries.toTypedArray())`
	`66`	`+private class NotificationTypeSerializer : BaseEnumeratedIntSerializer<NotificationType>(`
	`67`	`+ className = "NotificationType",`
	`68`	`+ values = NotificationType.entries.toTypedArray(),`
	`69`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -130,5 +130,6 @@ enum class OrganizationEventType {`
`130`	`130`
`131`	`131`	`@Keep`
`132`	`132`	`private class OrganizationEventTypeSerializer : BaseEnumeratedIntSerializer<OrganizationEventType>(`
	`133`	`+ className = "OrganizationEventType",`
`133`	`134`	`values = OrganizationEventType.entries.toTypedArray(),`
`134`	`135`	`)`
Original file line number	Diff line number	Diff line change
`@@ -91,5 +91,6 @@ data class PasscodeGenerationOptions(`
`91`	`91`	`@Keep`
`92`	`92`	`private class PasscodeTypeSerializer :`
`93`	`93`	`BaseEnumeratedIntSerializer<PasscodeGenerationOptions.PasscodeType>(`
`94`		`- PasscodeGenerationOptions.PasscodeType.entries.toTypedArray(),`
	`94`	`+ className = "PasscodeGenerationOptions.PasscodeType",`
	`95`	`+ values = PasscodeGenerationOptions.PasscodeType.entries.toTypedArray(),`
`95`	`96`	`)`
Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,6 @@ enum class CipherRepromptTypeJson {`
`25`	`25`
`26`	`26`	`@Keep`
`27`	`27`	`private class CipherRepromptTypeSerializer : BaseEnumeratedIntSerializer<CipherRepromptTypeJson>(`
`28`		`- CipherRepromptTypeJson.entries.toTypedArray(),`
	`28`	`+ className = "CipherRepromptTypeJson",`
	`29`	`+ values = CipherRepromptTypeJson.entries.toTypedArray(),`
`29`	`30`	`)`
Original file line number	Diff line number	Diff line change
`@@ -42,5 +42,7 @@ enum class CipherTypeJson {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`@Keep`
`45`		`-private class CipherTypeSerializer :`
`46`		`- BaseEnumeratedIntSerializer<CipherTypeJson>(CipherTypeJson.entries.toTypedArray())`
	`45`	`+private class CipherTypeSerializer : BaseEnumeratedIntSerializer<CipherTypeJson>(`
	`46`	`+ className = "CipherTypeJson",`
	`47`	`+ values = CipherTypeJson.entries.toTypedArray(),`
	`48`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -36,5 +36,7 @@ enum class FieldTypeJson {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`@Keep`
`39`		`-private class FieldTypeSerializer :`
`40`		`- BaseEnumeratedIntSerializer<FieldTypeJson>(FieldTypeJson.entries.toTypedArray())`
	`39`	`+private class FieldTypeSerializer : BaseEnumeratedIntSerializer<FieldTypeJson>(`
	`40`	`+ className = "FieldTypeJson",`
	`41`	`+ values = FieldTypeJson.entries.toTypedArray(),`
	`42`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,6 @@ enum class FileUploadType {`
`19`	`19`
`20`	`20`	`@Keep`
`21`	`21`	`private class FileUploadTypeSerializer : BaseEnumeratedIntSerializer<FileUploadType>(`
`22`		`- FileUploadType.entries.toTypedArray(),`
	`22`	`+ className = "FileUploadType",`
	`23`	`+ values = FileUploadType.entries.toTypedArray(),`
`23`	`24`	`)`