Barcode scanning - Handle failure case #9082

AnirudhBhat · 2023-05-22T10:25:27Z

Closes: #9073

Description

This PR handles failure when

The barcode scanning fails
The product search by SKU fails

We show a Snackbar with a "retry" action in both cases. Clicking on the "retry" action will trigger the scanning process.

More context: pecCkj-GT-p2

Testing instructions

Order listing screen

Navigate to the Orders tab
Click on the barcode icon present on the toolbar
Scan the barcode (Make sure to generate the barcode with an invalid SKU not present in your store - example: https://barcode.tec-it.com/en/?data=invalid_sku)
Ensure you see the snack bar
Ensure the retry action starts the scanning process again

Order detail screen

Navigate to the Order details screen (orders -> "+")
Click on the barcode icon present under the products section
Scan the barcode (Make sure to generate the barcode with an invalid SKU not present in your store - example: https://barcode.tec-it.com/en/?data=invalid_sku)
Ensure you see the snack bar
Ensure the retry action starts the scanning process again

Images/gif

screen-20230522-154828.mp4

I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

…with retry action.

…ing fails.

… fails.

…ng fails.

…is clicked.

…73-handle-error-case-barcode-scanning

…rrectly on scanned.

…arch by SKU returns empty result.

…le message when the product search by SKU fails.

…age when the product search by SKU fails.

… by SKU fails and retry clicked.

wpmobilebot · 2023-05-22T10:55:18Z

You can test the changes on this Pull Request by downloading an installable build, or scanning this QR code:

codecov-commenter · 2023-05-22T11:14:58Z

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.11 🎉

Comparison is base (debe810) 43.48% compared to head (b6dc535) 43.59%.

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk    #9082      +/-   ##
============================================
+ Coverage     43.48%   43.59%   +0.11%     
- Complexity     4032     4094      +62     
============================================
  Files           833      834       +1     
  Lines         43900    43985      +85     
  Branches       5734     5763      +29     
============================================
+ Hits          19088    19176      +88     
  Misses        23137    23137              
+ Partials       1675     1672       -3

Impacted Files	Coverage Δ
...commerce/android/ui/orders/creation/CodeScanner.kt	`100.00% <100.00%> (ø)`
...ui/orders/creation/GoogleCodeScannerErrorMapper.kt	`100.00% <100.00%> (ø)`
...oid/ui/orders/creation/OrderCreateEditViewModel.kt	`86.99% <100.00%> (+1.14%)`	⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

AnirudhBhat · 2023-05-22T12:40:32Z

...merce/src/main/kotlin/com/woocommerce/android/ui/orders/creation/OrderCreateEditViewModel.kt

    }
 }

+data class OnBarcodeScanningFailed(


Both these event models might look similar in code but their behavior might change in the near future. Also, the code can be confusing to understand when we merge both into one. Let me know your thoughts.

I'd go with 1 event at the beggining, e.g. OnAddingProductViaScaningFailed (we don't only support barcodes but other types of encoding of the data) and will pass 2 different messages there: Scanning failed with error: %s and Unable to find product with SKU: %s. That should give more information to a user

… to the MLKit barcode scanning.

…readyExists type returned

…fRange type returned

… PermissionDenied type returned

…n ResourceExhausted type returned

…nAuthenticated type returned

…ilable type returned

…mplemented type returned

…ype returned

…en Other type returned

kidinov

I left a few comments, please take a look

WooCommerce/src/main/res/values/strings.xml

kidinov · 2023-05-23T07:27:56Z

...merce/src/main/kotlin/com/woocommerce/android/ui/orders/creation/OrderCreateEditViewModel.kt

+    private fun sendBarcodeScanningFailedEvent(error: Throwable?) {
+        triggerEvent(
+            OnBarcodeScanningFailed(
+                error,


Error property is never used in both events in the production code? In OnBarcodeScanningFailed and OnProductSearchBySKUFailed

Strange. I had already removed the error property from both events. In the latest file change, it's not shown.

kidinov · 2023-05-23T07:34:03Z

...merce/src/main/kotlin/com/woocommerce/android/ui/orders/creation/OrderCreateEditViewModel.kt

    }
 }

+data class OnBarcodeScanningFailed(


I'd go with 1 event at the beggining, e.g. OnAddingProductViaScaningFailed (we don't only support barcodes but other types of encoding of the data) and will pass 2 different messages there: Scanning failed with error: %s and Unable to find product with SKU: %s. That should give more information to a user

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/orders/creation/CodeScanner.kt

...e/src/main/kotlin/com/woocommerce/android/ui/orders/creation/GoogleCodeScannerErrorMapper.kt

...merce/src/main/kotlin/com/woocommerce/android/ui/orders/creation/OrderCreateEditViewModel.kt

… if it's not MLKitException

peril-woocommerce · 2023-05-23T11:15:25Z

	Warnings
⚠️	This PR is assigned to a milestone which is closing in less than 2 days Please, make sure to get it merged by then or assign it to a later expiring milestone

Generated by 🚫 dangerJS

…and merge them into one event OnAddingProductViaScanningFailed

kidinov · 2023-05-24T07:26:04Z

...merce/src/main/kotlin/com/woocommerce/android/ui/orders/creation/OrderCreateEditViewModel.kt

+    private fun sendAddingProductsViaScanningFailedEvent() {
+        triggerEvent(
+            OnAddingProductViaScanningFailed(
+                string.order_creation_barcode_scanning_unable_to_add_product


Now you show the same text Product not found. Unable to add to new order for both cases - when scanning failed (including when the scanning is not available at all) and when we could not find a product by SKU

Added a separate message for both failure events here: aaecceb

Right now, the messages are static without much information on what went wrong. This will be taken on priority and will be discussed with Ann and should be out by next week after the initial release.

kidinov

I left a comment regarding the text currently used for error indication - it may be missliding

kidinov

I left a comment regarding the text currently used for error indication - it may be missliding

… failure.

kidinov

LGTM!

AnirudhBhat added 16 commits May 19, 2023 12:54

Add a new string resource to display when the barcode scanning fails

aba90fb

Implement handling barcode scanning failure by displaying a snackbar …

82512b3

…with retry action.

Add test to verify that proper event is triggered when the code scann…

019d065

…ing fails.

Add test to verify that proper message is sent when the code scanning…

8fb3282

… fails.

Add test to verify that proper throwable is sent when the code scanni…

7223cd4

…ng fails.

Add test to verify that code scan is restarted when the retry action …

8ae677f

…is clicked.

Merge branch 'issue/9055-code-scanner-order-listing-ui' into issue/90…

e00bdf4

…73-handle-error-case-barcode-scanning

Add model class for handling product search by SKU failure

8a4fe4e

Add test to verify that the variable subscription product us added co…

57d5ed5

…rrectly on scanned.

Add logic to trigger an event when the product search by SKU fails.

d0ee509

Add test to verify that proper event is triggered when the product se…

ec57331

…arch by SKU returns empty result.

Add test to verify that proper event is triggered with proper throwab…

b273ec7

…le message when the product search by SKU fails.

Add test to verify that proper event is triggered with proper UI mess…

a13a19a

…age when the product search by SKU fails.

Add test to verify that scanning is restarted when the product search…

83d1584

… by SKU fails and retry clicked.

Make the snackbar "show"

407f826

Make the test pass.

5bfbe40

AnirudhBhat commented May 22, 2023

View reviewed changes

AnirudhBhat requested a review from kidinov May 22, 2023 12:41

AnirudhBhat added the feature: mobile payments Related to mobile payments / card present payments / Woo Payments. label May 22, 2023

AnirudhBhat added this to the 13.8 milestone May 22, 2023

AnirudhBhat marked this pull request as ready for review May 22, 2023 12:42

kidinov self-assigned this May 23, 2023

AnirudhBhat added 6 commits May 23, 2023 13:01

Add "GoogleCodeScannerErrorMapper" class to handle all errors related…

ef1df5b

… to the MLKit barcode scanning.

Add error mapper as dependency for the code scanner class.

9c22faa

Add a sealed class that displays errors from MLKit to the frontend.

df97f80

Add error mapper dependency in the code scanner test file.

315d04c

Remove unnecessary throwable parameter from the scan failure events

db22416

Add test to verify that when ALREADY_EXISTS exception thrown, then Al…

0fb093b

…readyExists type returned

AnirudhBhat added 11 commits May 23, 2023 13:34

Add test to verify that when OUT_OF_RANGE exception thrown, then OutO…

8a285e4

…fRange type returned

Add test to verify that when PERMISSION_DENIED exception thrown, then…

ad6a6bc

… PermissionDenied type returned

Add test to verify that when RESOURCE_EXHAUSTED exception thrown, the…

7c6e18f

…n ResourceExhausted type returned

Add test to verify that when UNAUTHENTICATED exception thrown, then U…

29b3f17

…nAuthenticated type returned

Add test to verify that when UNAVAILABLE exception thrown, then UnAva…

13973d5

…ilable type returned

Add test to verify that when UNIMPLEMENTED exception thrown, then UnI…

981a2f2

…mplemented type returned

Add test to verify that when UNKNOWN exception thrown, then Unknown t…

e66a02d

…ype returned

Add test to verify that when exception is null, then Other type returned

0f95fee

Add test to verify that when exception is null, then Other type returned

807713d

Add test to verify that when exception returns invalid error code, th…

b702212

…en Other type returned

Fix detekt errors.

212582f

AnirudhBhat marked this pull request as ready for review May 23, 2023 08:23

kidinov reviewed May 23, 2023

View reviewed changes

AnirudhBhat added 4 commits May 23, 2023 16:18

Fix test failures

830ede1

Use MLKitException constants instead of our own.

3007124

Refactor the error mapper to send the throwable to "Other" data class…

b3bf3e7

… if it's not MLKitException

Remove unimportant test

bd2d2c6

AnirudhBhat added 2 commits May 24, 2023 09:30

Fix test failures

4692d52

Remove OnBarcodeScanningFailed and OnProductSearchBySKUFailed events …

b6dc535

…and merge them into one event OnAddingProductViaScanningFailed

kidinov reviewed May 24, 2023

View reviewed changes

Add a separate message for scanning failure and product search by SKU…

aaecceb

… failure.

kidinov self-requested a review May 24, 2023 08:13

kidinov approved these changes May 24, 2023

View reviewed changes

kidinov enabled auto-merge May 24, 2023 08:14

kidinov merged commit a8d8116 into trunk May 24, 2023

kidinov deleted the issue/9073-handle-error-case-barcode-scanning branch May 24, 2023 08:32

AnirudhBhat mentioned this pull request May 25, 2023

Scanned and deliver final PR to turn off the feature flag #9125

Merged

1 task

Barcode scanning - Handle failure case #9082

Barcode scanning - Handle failure case #9082

Uh oh!

Conversation

AnirudhBhat commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Order listing screen

Order detail screen

Images/gif

Uh oh!

wpmobilebot commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

AnirudhBhat May 22, 2023

Choose a reason for hiding this comment

Uh oh!

kidinov May 23, 2023

Choose a reason for hiding this comment

Uh oh!

kidinov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kidinov May 23, 2023

Choose a reason for hiding this comment

Uh oh!

AnirudhBhat May 23, 2023

Choose a reason for hiding this comment

Uh oh!

kidinov May 23, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

peril-woocommerce bot commented May 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kidinov May 24, 2023

Choose a reason for hiding this comment

Uh oh!

AnirudhBhat May 24, 2023

Choose a reason for hiding this comment

Uh oh!

kidinov left a comment

Choose a reason for hiding this comment

Uh oh!

kidinov left a comment

Choose a reason for hiding this comment

Uh oh!

kidinov left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AnirudhBhat commented May 22, 2023 •

edited

Loading

wpmobilebot commented May 22, 2023 •

edited

Loading

codecov-commenter commented May 22, 2023 •

edited

Loading

peril-woocommerce bot commented May 23, 2023 •

edited

Loading