[PR #4730] [MERGED] Improve the error messaging when an enum is not parsed correctly #5164

Closed
opened 2025-11-26 23:54:55 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/bitwarden/android/pull/4730
Author: @david-livefront
Created: 2/17/2025
Status: Merged
Merged: 2/17/2025
Merged by: @david-livefront

Base: mainHead: improved-enum-parsing-error


📝 Commits (1)

  • 99561ee Improve the error messaging when an enum is not parsed correctly

📊 Changes

20 files changed (+59 additions, -28 deletions)

View changed files

📝 app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/AuthRequestTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/KdfTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/TwoFactorAuthMethod.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializer.kt (+2 -1)
📝 app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/NotificationType.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/OrganizationEventType.kt (+1 -0)
📝 app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/PasscodeGenerationOptions.kt (+2 -1)
📝 app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/UsernameGenerationOptions.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherRepromptTypeJson.kt (+2 -1)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FieldTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FileUploadType.kt (+2 -1)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/LinkedIdTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationStatusType.kt (+2 -1)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationType.kt (+2 -1)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/PolicyTypeJson.kt (+1 -0)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SecureNoteTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SendTypeJson.kt (+4 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/UriMatchTypeJson.kt (+4 -2)
📝 app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializerTest.kt (+1 -0)

📄 Description

🎟️ Tracking

N/A

📔 Objective

This PR update failure logging for the BaseEnumeratedIntSerializer to indicate the enum it was trying to parse.

This will give us more context about the specific enum being decoded instead of errors like this:

Caused by java.lang.IllegalArgumentException: Unknown value 60

Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/bitwarden/android/pull/4730 **Author:** [@david-livefront](https://github.com/david-livefront) **Created:** 2/17/2025 **Status:** ✅ Merged **Merged:** 2/17/2025 **Merged by:** [@david-livefront](https://github.com/david-livefront) **Base:** `main` ← **Head:** `improved-enum-parsing-error` --- ### 📝 Commits (1) - [`99561ee`](https://github.com/bitwarden/android/commit/99561eeb50e1476b6ad16865989830d7449660cb) Improve the error messaging when an enum is not parsed correctly ### 📊 Changes **20 files changed** (+59 additions, -28 deletions) <details> <summary>View changed files</summary> 📝 `app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/AuthRequestTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/KdfTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/model/TwoFactorAuthMethod.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializer.kt` (+2 -1) 📝 `app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/NotificationType.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/platform/manager/model/OrganizationEventType.kt` (+1 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/PasscodeGenerationOptions.kt` (+2 -1) 📝 `app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/UsernameGenerationOptions.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherRepromptTypeJson.kt` (+2 -1) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/CipherTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FieldTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/FileUploadType.kt` (+2 -1) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/LinkedIdTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationStatusType.kt` (+2 -1) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/OrganizationType.kt` (+2 -1) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/PolicyTypeJson.kt` (+1 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SecureNoteTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/SendTypeJson.kt` (+4 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/datasource/network/model/UriMatchTypeJson.kt` (+4 -2) 📝 `app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/network/serializer/BaseEnumeratedIntSerializerTest.kt` (+1 -0) </details> ### 📄 Description ## 🎟️ Tracking N/A ## 📔 Objective This PR update failure logging for the `BaseEnumeratedIntSerializer` to indicate the enum it was trying to parse. This will give us more context about the specific enum being decoded instead of errors like this: ``` Caused by java.lang.IllegalArgumentException: Unknown value 60 ``` ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation or informed the documentation team ## 🦮 Reviewer guidelines <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2025-11-26 23:54:55 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/android#5164