PM-19335 add throwable val to generator error results (#4894)

dseverns-livefront · web-flow · commit 475a82e0fb43 · 2025-03-18T17:08:11.000Z
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/GeneratorRepositoryImpl.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/GeneratorRepositoryImpl.kt
@@ -130,7 +130,7 @@ class GeneratorRepositoryImpl(
                     }
                     GeneratedPasswordResult.Success(generatedPassword)
                 },
-                onFailure = { GeneratedPasswordResult.InvalidRequest },
+                onFailure = { GeneratedPasswordResult.InvalidRequest(error = it) },
             )
 
     override suspend fun generatePassphrase(
@@ -149,7 +149,7 @@ class GeneratorRepositoryImpl(
                     }
                     GeneratedPassphraseResult.Success(generatedPassphrase)
                 },
-                onFailure = { GeneratedPassphraseResult.InvalidRequest },
+                onFailure = { GeneratedPassphraseResult.InvalidRequest(error = it) },
             )
 
     override suspend fun generatePlusAddressedEmail(
@@ -161,7 +161,7 @@ class GeneratorRepositoryImpl(
                     GeneratedPlusAddressedUsernameResult.Success(generatedEmail)
                 },
                 onFailure = {
-                    GeneratedPlusAddressedUsernameResult.InvalidRequest
+                    GeneratedPlusAddressedUsernameResult.InvalidRequest(error = it)
                 },
             )
 
@@ -174,7 +174,7 @@ class GeneratorRepositoryImpl(
                     GeneratedCatchAllUsernameResult.Success(generatedEmail)
                 },
                 onFailure = {
-                    GeneratedCatchAllUsernameResult.InvalidRequest
+                    GeneratedCatchAllUsernameResult.InvalidRequest(error = it)
                 },
             )
 
@@ -187,7 +187,7 @@ class GeneratorRepositoryImpl(
                     GeneratedRandomWordUsernameResult.Success(generatedUsername)
                 },
                 onFailure = {
-                    GeneratedRandomWordUsernameResult.InvalidRequest
+                    GeneratedRandomWordUsernameResult.InvalidRequest(error = it)
                 },
             )
 
@@ -200,7 +200,7 @@ class GeneratorRepositoryImpl(
                     GeneratedForwardedServiceUsernameResult.Success(generatedEmail)
                 },
                 onFailure = {
-                    GeneratedForwardedServiceUsernameResult.InvalidRequest(it.message)
+                    GeneratedForwardedServiceUsernameResult.InvalidRequest(it.message, error = it)
                 },
             )
     }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedCatchAllUsernameResult.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedCatchAllUsernameResult.kt
@@ -15,5 +15,5 @@ sealed class GeneratedCatchAllUsernameResult {
     /**
      * There was an error during the operation.
      */
-    data object InvalidRequest : GeneratedCatchAllUsernameResult()
+    data class InvalidRequest(val error: Throwable) : GeneratedCatchAllUsernameResult()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedForwardedServiceUsernameResult.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedForwardedServiceUsernameResult.kt
@@ -14,5 +14,8 @@ sealed class GeneratedForwardedServiceUsernameResult {
     /**
      * There was an error during the operation.
      */
-    data class InvalidRequest(val message: String?) : GeneratedForwardedServiceUsernameResult()
+    data class InvalidRequest(
+        val message: String?,
+        val error: Throwable,
+    ) : GeneratedForwardedServiceUsernameResult()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedPassphraseResult.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedPassphraseResult.kt
@@ -12,5 +12,5 @@ sealed class GeneratedPassphraseResult {
     /**
      * There was an error during the operation.
      */
-    data object InvalidRequest : GeneratedPassphraseResult()
+    data class InvalidRequest(val error: Throwable) : GeneratedPassphraseResult()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedPasswordResult.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedPasswordResult.kt
@@ -13,5 +13,5 @@ sealed class GeneratedPasswordResult {
     /**
      * There was an error during the operation.
      */
-    data object InvalidRequest : GeneratedPasswordResult()
+    data class InvalidRequest(val error: Throwable) : GeneratedPasswordResult()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedPlusAddressedUsernameResult.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedPlusAddressedUsernameResult.kt
@@ -14,5 +14,5 @@ sealed class GeneratedPlusAddressedUsernameResult {
     /**
      * There was an error during the operation.
      */
-    data object InvalidRequest : GeneratedPlusAddressedUsernameResult()
+    data class InvalidRequest(val error: Throwable) : GeneratedPlusAddressedUsernameResult()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedRandomWordUsernameResult.kt b/app/src/main/java/com/x8bit/bitwarden/data/tools/generator/repository/model/GeneratedRandomWordUsernameResult.kt
@@ -15,5 +15,5 @@ sealed class GeneratedRandomWordUsernameResult {
     /**
      * There was an error during the operation.
      */
-    data object InvalidRequest : GeneratedRandomWordUsernameResult()
+    data class InvalidRequest(val error: Throwable) : GeneratedRandomWordUsernameResult()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/auth/feature/masterpasswordgenerator/MasterPasswordGeneratorViewModel.kt b/app/src/main/java/com/x8bit/bitwarden/ui/auth/feature/masterpasswordgenerator/MasterPasswordGeneratorViewModel.kt
@@ -91,7 +91,7 @@ class MasterPasswordGeneratorViewModel @Inject constructor(
 
     private fun handleUpdatedPassphraseResult(passphraseResult: GeneratedPassphraseResult) {
         when (passphraseResult) {
-            GeneratedPassphraseResult.InvalidRequest -> {
+            is GeneratedPassphraseResult.InvalidRequest -> {
                 sendEvent(
                     MasterPasswordGeneratorEvent.ShowSnackbar(
                         R.string.an_error_has_occurred.asText(),
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/tools/feature/generator/GeneratorViewModel.kt b/app/src/main/java/com/x8bit/bitwarden/ui/tools/feature/generator/GeneratorViewModel.kt
@@ -736,7 +736,7 @@ class GeneratorViewModel @Inject constructor(
                 }
             }
 
-            GeneratedPasswordResult.InvalidRequest -> {
+            is GeneratedPasswordResult.InvalidRequest -> {
                 sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))
             }
         }
@@ -752,7 +752,7 @@ class GeneratorViewModel @Inject constructor(
                 }
             }
 
-            GeneratedPassphraseResult.InvalidRequest -> {
+            is GeneratedPassphraseResult.InvalidRequest -> {
                 sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))
             }
         }
@@ -768,7 +768,7 @@ class GeneratorViewModel @Inject constructor(
                 }
             }
 
-            GeneratedPlusAddressedUsernameResult.InvalidRequest -> {
+            is GeneratedPlusAddressedUsernameResult.InvalidRequest -> {
                 sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))
             }
         }
@@ -784,7 +784,7 @@ class GeneratorViewModel @Inject constructor(
                 }
             }
 
-            GeneratedCatchAllUsernameResult.InvalidRequest -> {
+            is GeneratedCatchAllUsernameResult.InvalidRequest -> {
                 sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))
             }
         }
@@ -800,7 +800,7 @@ class GeneratorViewModel @Inject constructor(
                 }
             }
 
-            GeneratedRandomWordUsernameResult.InvalidRequest -> {
+            is GeneratedRandomWordUsernameResult.InvalidRequest -> {
                 sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))
             }
         }
diff --git a/app/src/test/java/com/x8bit/bitwarden/data/tools/generator/repository/GeneratorRepositoryTest.kt b/app/src/test/java/com/x8bit/bitwarden/data/tools/generator/repository/GeneratorRepositoryTest.kt
@@ -199,7 +199,9 @@ class GeneratorRepositoryTest {
 
         val result = repository.generatePassword(request, true)
 
-        assertEquals(GeneratedPasswordResult.InvalidRequest, result)
+        assertEquals(
+            GeneratedPasswordResult.InvalidRequest(error = exception), result,
+        )
         coVerify { generatorSdkSource.generatePassword(request) }
     }
 
@@ -257,7 +259,9 @@ class GeneratorRepositoryTest {
 
             val result = repository.generatePassphrase(request)
 
-            assertEquals(GeneratedPassphraseResult.InvalidRequest, result)
+            assertEquals(
+                GeneratedPassphraseResult.InvalidRequest(error = exception), result,
+            )
             coVerify { generatorSdkSource.generatePassphrase(request) }
         }
 
@@ -296,7 +300,9 @@ class GeneratorRepositoryTest {
 
         val result = repository.generatePlusAddressedEmail(request)
 
-        assertEquals(GeneratedPlusAddressedUsernameResult.InvalidRequest, result)
+        assertEquals(
+            GeneratedPlusAddressedUsernameResult.InvalidRequest(error = exception), result,
+        )
         coVerify { generatorSdkSource.generatePlusAddressedEmail(request) }
     }
 
@@ -331,7 +337,9 @@ class GeneratorRepositoryTest {
 
         val result = repository.generateCatchAllEmail(request)
 
-        assertEquals(GeneratedCatchAllUsernameResult.InvalidRequest, result)
+        assertEquals(
+            GeneratedCatchAllUsernameResult.InvalidRequest(error = exception), result,
+        )
         coVerify { generatorSdkSource.generateCatchAllEmail(request) }
     }
 
@@ -366,7 +374,9 @@ class GeneratorRepositoryTest {
 
         val result = repository.generateRandomWordUsername(request)
 
-        assertEquals(GeneratedRandomWordUsernameResult.InvalidRequest, result)
+        assertEquals(
+            GeneratedRandomWordUsernameResult.InvalidRequest(error = exception), result,
+        )
         coVerify { generatorSdkSource.generateRandomWord(request) }
     }
 
@@ -409,7 +419,10 @@ class GeneratorRepositoryTest {
             val result = repository.generateForwardedServiceUsername(request)
 
             assertEquals(
-                GeneratedForwardedServiceUsernameResult.InvalidRequest(exception.message),
+                GeneratedForwardedServiceUsernameResult.InvalidRequest(
+                    message = exception.message,
+                    error = exception,
+                ),
                 result,
             )
             coVerify { generatorSdkSource.generateForwardedServiceEmail(request) }
diff --git a/app/src/test/java/com/x8bit/bitwarden/ui/auth/feature/masterpasswordgenerator/MasterPasswordGeneratorViewModelTest.kt b/app/src/test/java/com/x8bit/bitwarden/ui/auth/feature/masterpasswordgenerator/MasterPasswordGeneratorViewModelTest.kt
@@ -37,7 +37,7 @@ class MasterPasswordGeneratorViewModelTest : BaseViewModelTest() {
     @Suppress("MaxLineLength")
     fun `With no saved state and failed generator result, initial password state is default value`() {
         fakeGeneratorRepository.setMockGeneratePassphraseResult(
-            result = GeneratedPassphraseResult.InvalidRequest,
+            result = GeneratedPassphraseResult.InvalidRequest(error = Throwable("Fail")),
         )
         val viewModel = createViewModel()
 
@@ -91,7 +91,7 @@ class MasterPasswordGeneratorViewModelTest : BaseViewModelTest() {
         val viewModel = createViewModel()
 
         fakeGeneratorRepository.setMockGeneratePassphraseResult(
-            GeneratedPassphraseResult.InvalidRequest,
+            GeneratedPassphraseResult.InvalidRequest(error = Throwable("Fail")),
         )
 
         viewModel.eventFlow.test {
diff --git a/app/src/test/java/com/x8bit/bitwarden/ui/tools/feature/generator/GeneratorViewModelTest.kt b/app/src/test/java/com/x8bit/bitwarden/ui/tools/feature/generator/GeneratorViewModelTest.kt
@@ -403,7 +403,7 @@ class GeneratorViewModelTest : BaseViewModelTest() {
             val viewModel = createViewModel()
 
             fakeGeneratorRepository.setMockGeneratePasswordResult(
-                GeneratedPasswordResult.InvalidRequest,
+                GeneratedPasswordResult.InvalidRequest(error = Throwable("Fail")),
             )
 
             viewModel.trySendAction(GeneratorAction.RegenerateClick)
@@ -465,7 +465,7 @@ class GeneratorViewModelTest : BaseViewModelTest() {
             val viewModel = createViewModel(initialPassphraseState)
 
             fakeGeneratorRepository.setMockGeneratePassphraseResult(
-                GeneratedPassphraseResult.InvalidRequest,
+                GeneratedPassphraseResult.InvalidRequest(error = Throwable("Fail")),
             )
 
             viewModel.trySendAction(GeneratorAction.RegenerateClick)

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ class GeneratorRepositoryImpl(`
`130`	`130`	`}`
`131`	`131`	`GeneratedPasswordResult.Success(generatedPassword)`
`132`	`132`	`},`
`133`		`- onFailure = { GeneratedPasswordResult.InvalidRequest },`
	`133`	`+ onFailure = { GeneratedPasswordResult.InvalidRequest(error = it) },`
`134`	`134`	`)`
`135`	`135`
`136`	`136`	`override suspend fun generatePassphrase(`
`@@ -149,7 +149,7 @@ class GeneratorRepositoryImpl(`
`149`	`149`	`}`
`150`	`150`	`GeneratedPassphraseResult.Success(generatedPassphrase)`
`151`	`151`	`},`
`152`		`- onFailure = { GeneratedPassphraseResult.InvalidRequest },`
	`152`	`+ onFailure = { GeneratedPassphraseResult.InvalidRequest(error = it) },`
`153`	`153`	`)`
`154`	`154`
`155`	`155`	`override suspend fun generatePlusAddressedEmail(`
`@@ -161,7 +161,7 @@ class GeneratorRepositoryImpl(`
`161`	`161`	`GeneratedPlusAddressedUsernameResult.Success(generatedEmail)`
`162`	`162`	`},`
`163`	`163`	`onFailure = {`
`164`		`- GeneratedPlusAddressedUsernameResult.InvalidRequest`
	`164`	`+ GeneratedPlusAddressedUsernameResult.InvalidRequest(error = it)`
`165`	`165`	`},`
`166`	`166`	`)`
`167`	`167`
`@@ -174,7 +174,7 @@ class GeneratorRepositoryImpl(`
`174`	`174`	`GeneratedCatchAllUsernameResult.Success(generatedEmail)`
`175`	`175`	`},`
`176`	`176`	`onFailure = {`
`177`		`- GeneratedCatchAllUsernameResult.InvalidRequest`
	`177`	`+ GeneratedCatchAllUsernameResult.InvalidRequest(error = it)`
`178`	`178`	`},`
`179`	`179`	`)`
`180`	`180`
`@@ -187,7 +187,7 @@ class GeneratorRepositoryImpl(`
`187`	`187`	`GeneratedRandomWordUsernameResult.Success(generatedUsername)`
`188`	`188`	`},`
`189`	`189`	`onFailure = {`
`190`		`- GeneratedRandomWordUsernameResult.InvalidRequest`
	`190`	`+ GeneratedRandomWordUsernameResult.InvalidRequest(error = it)`
`191`	`191`	`},`
`192`	`192`	`)`
`193`	`193`
`@@ -200,7 +200,7 @@ class GeneratorRepositoryImpl(`
`200`	`200`	`GeneratedForwardedServiceUsernameResult.Success(generatedEmail)`
`201`	`201`	`},`
`202`	`202`	`onFailure = {`
`203`		`- GeneratedForwardedServiceUsernameResult.InvalidRequest(it.message)`
	`203`	`+ GeneratedForwardedServiceUsernameResult.InvalidRequest(it.message, error = it)`
`204`	`204`	`},`
`205`	`205`	`)`
`206`	`206`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ sealed class GeneratedCatchAllUsernameResult {`
`15`	`15`	`/**`
`16`	`16`	`* There was an error during the operation.`
`17`	`17`	`*/`
`18`		`- data object InvalidRequest : GeneratedCatchAllUsernameResult()`
	`18`	`+ data class InvalidRequest(val error: Throwable) : GeneratedCatchAllUsernameResult()`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,5 @@ sealed class GeneratedPassphraseResult {`
`12`	`12`	`/**`
`13`	`13`	`* There was an error during the operation.`
`14`	`14`	`*/`
`15`		`- data object InvalidRequest : GeneratedPassphraseResult()`
	`15`	`+ data class InvalidRequest(val error: Throwable) : GeneratedPassphraseResult()`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@ sealed class GeneratedPasswordResult {`
`13`	`13`	`/**`
`14`	`14`	`* There was an error during the operation.`
`15`	`15`	`*/`
`16`		`- data object InvalidRequest : GeneratedPasswordResult()`
	`16`	`+ data class InvalidRequest(val error: Throwable) : GeneratedPasswordResult()`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,5 @@ sealed class GeneratedPlusAddressedUsernameResult {`
`14`	`14`	`/**`
`15`	`15`	`* There was an error during the operation.`
`16`	`16`	`*/`
`17`		`- data object InvalidRequest : GeneratedPlusAddressedUsernameResult()`
	`17`	`+ data class InvalidRequest(val error: Throwable) : GeneratedPlusAddressedUsernameResult()`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -736,7 +736,7 @@ class GeneratorViewModel @Inject constructor(`
`736`	`736`	`}`
`737`	`737`	`}`
`738`	`738`
`739`		`- GeneratedPasswordResult.InvalidRequest -> {`
	`739`	`+ is GeneratedPasswordResult.InvalidRequest -> {`
`740`	`740`	`sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))`
`741`	`741`	`}`
`742`	`742`	`}`
`@@ -752,7 +752,7 @@ class GeneratorViewModel @Inject constructor(`
`752`	`752`	`}`
`753`	`753`	`}`
`754`	`754`
`755`		`- GeneratedPassphraseResult.InvalidRequest -> {`
	`755`	`+ is GeneratedPassphraseResult.InvalidRequest -> {`
`756`	`756`	`sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))`
`757`	`757`	`}`
`758`	`758`	`}`
`@@ -768,7 +768,7 @@ class GeneratorViewModel @Inject constructor(`
`768`	`768`	`}`
`769`	`769`	`}`
`770`	`770`
`771`		`- GeneratedPlusAddressedUsernameResult.InvalidRequest -> {`
	`771`	`+ is GeneratedPlusAddressedUsernameResult.InvalidRequest -> {`
`772`	`772`	`sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))`
`773`	`773`	`}`
`774`	`774`	`}`
`@@ -784,7 +784,7 @@ class GeneratorViewModel @Inject constructor(`
`784`	`784`	`}`
`785`	`785`	`}`
`786`	`786`
`787`		`- GeneratedCatchAllUsernameResult.InvalidRequest -> {`
	`787`	`+ is GeneratedCatchAllUsernameResult.InvalidRequest -> {`
`788`	`788`	`sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))`
`789`	`789`	`}`
`790`	`790`	`}`
`@@ -800,7 +800,7 @@ class GeneratorViewModel @Inject constructor(`
`800`	`800`	`}`
`801`	`801`	`}`
`802`	`802`
`803`		`- GeneratedRandomWordUsernameResult.InvalidRequest -> {`
	`803`	`+ is GeneratedRandomWordUsernameResult.InvalidRequest -> {`
`804`	`804`	`sendEvent(GeneratorEvent.ShowSnackbar(R.string.an_error_has_occurred.asText()))`
`805`	`805`	`}`
`806`	`806`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class MasterPasswordGeneratorViewModelTest : BaseViewModelTest() {`
`37`	`37`	`@Suppress("MaxLineLength")`
`38`	`38`	fun `With no saved state and failed generator result, initial password state is default value`() {
`39`	`39`	`fakeGeneratorRepository.setMockGeneratePassphraseResult(`
`40`		`- result = GeneratedPassphraseResult.InvalidRequest,`
	`40`	`+ result = GeneratedPassphraseResult.InvalidRequest(error = Throwable("Fail")),`
`41`	`41`	`)`
`42`	`42`	`val viewModel = createViewModel()`
`43`	`43`
`@@ -91,7 +91,7 @@ class MasterPasswordGeneratorViewModelTest : BaseViewModelTest() {`
`91`	`91`	`val viewModel = createViewModel()`
`92`	`92`
`93`	`93`	`fakeGeneratorRepository.setMockGeneratePassphraseResult(`
`94`		`- GeneratedPassphraseResult.InvalidRequest,`
	`94`	`+ GeneratedPassphraseResult.InvalidRequest(error = Throwable("Fail")),`
`95`	`95`	`)`
`96`	`96`
`97`	`97`	`viewModel.eventFlow.test {`
Original file line number	Diff line number	Diff line change
`@@ -403,7 +403,7 @@ class GeneratorViewModelTest : BaseViewModelTest() {`
`403`	`403`	`val viewModel = createViewModel()`
`404`	`404`
`405`	`405`	`fakeGeneratorRepository.setMockGeneratePasswordResult(`
`406`		`- GeneratedPasswordResult.InvalidRequest,`
	`406`	`+ GeneratedPasswordResult.InvalidRequest(error = Throwable("Fail")),`
`407`	`407`	`)`
`408`	`408`
`409`	`409`	`viewModel.trySendAction(GeneratorAction.RegenerateClick)`
`@@ -465,7 +465,7 @@ class GeneratorViewModelTest : BaseViewModelTest() {`
`465`	`465`	`val viewModel = createViewModel(initialPassphraseState)`
`466`	`466`
`467`	`467`	`fakeGeneratorRepository.setMockGeneratePassphraseResult(`
`468`		`- GeneratedPassphraseResult.InvalidRequest,`
	`468`	`+ GeneratedPassphraseResult.InvalidRequest(error = Throwable("Fail")),`
`469`	`469`	`)`
`470`	`470`
`471`	`471`	`viewModel.trySendAction(GeneratorAction.RegenerateClick)`