[Dynamic Dashboard] Fix issue of not updating the orders count in some scenarios #11530

hichamboushaba · 2024-05-16T11:02:58Z

Description

In some cases, and given the fact that order status options are fetched only on app launch and when switching sites, it could happen that the app shows the performance card for stores with no orders or vice versa.

This PR fixes this by making two changes:

It updates the logic of ObserveProcessingOrdersCount to always use the order status API for infering the number of processing orders, instead of using the /wc-analytics/reports/totals endpoint, this update will allow us to refresh the cache whenever any changes happen.
It updates the logic of ObserveSiteOrdersState to observe the changes of order status options instead of retrieving a single snapshot.

With these two changes, the dashboard will always observe the updated state.

Testing instructions

Use a store with a single order.
Open the app.
Notice the performance card is shown.
Switch to the order list screen.
Delete the order.
Go back to the dashboard screen.
Notice the performance card was disabled (there could be a small delay for this, and it's because of the delay of the undo action that we use before trashing the order).
Repeat the test with "adding a new order"
Notice the performance card was enabled.

Images/gif

Screen_recording_20240516_115549.mp4

I have considered if this change warrants release notes and have added them to RELEASE-NOTES.txt if necessary. Use the "[Internal]" label for non-user-facing changes.

This is done by updating the logic to fetch the order status options instead of the `/wc-analytics/reports/orders/totals`

We already do a fetch when the app starts in the SiteObserver, so here we should just use the cached value initially, and then observe changes

dangermattic · 2024-05-16T11:03:35Z

	1 Message
📖	This PR contains changes to Tracks-related logic. Please ensure (author and reviewer) the following are completed: The tracks events must be validated in the Tracks system. Verify the internal Tracks spreadsheet has also been updated. Please consider registering any new events. The PR must be assigned the category: tracks label.

Generated by 🚫 Danger

hichamboushaba · 2024-05-16T11:04:05Z

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/main/ObserveProcessingOrdersCount.kt

-        // emit updated value
-        fetchOrdersCount(site)?.let { emit(it) }


Since we fetch the order status options on app launch in SiteObserver, making another fetch here is redundant, so I removed it.

Now we will start with the cached value, then observe changes and fetch when needed.

wpmobilebot · 2024-05-16T11:23:00Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`53d9227`
	Direct Download	`woocommerce-prototype-build-pr11530-53d9227.apk`

codecov-commenter · 2024-05-16T11:40:37Z

Codecov Report

Attention: Patch coverage is 41.37931% with 17 lines in your changes are missing coverage. Please review.

Project coverage is 40.46%. Comparing base (e4cc452) to head (4be19ab).
Report is 54 commits behind head on trunk.

❗ Current head 4be19ab differs from pull request most recent head 73e7b31

Please upload reports for the commit 73e7b31 to get more accurate results.

Files	Patch %	Lines
...ce/android/ui/main/ObserveProcessingOrdersCount.kt	57.14%	7 Missing and 2 partials ⚠️
...ndroid/ui/dashboard/data/ObserveSiteOrdersState.kt	0.00%	8 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #11530      +/-   ##
============================================
- Coverage     40.47%   40.46%   -0.01%     
+ Complexity     5181     5180       -1     
============================================
  Files          1075     1075              
  Lines         62873    62872       -1     
  Branches       8612     8606       -6     
============================================
- Hits          25447    25444       -3     
- Misses        35138    35141       +3     
+ Partials       2288     2287       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

0nko

I started out with a store with no orders (there are some trashed orders) and the cards are still being shown, even after force-refreshing the orders and the dashboard. 🤔

Screen_recording_20240517_095857.webm

hichamboushaba · 2024-05-17T08:18:53Z

@0nko thanks for the test, can you invite me to your store to check this? This doesn't happen on my store, trash is not returned as a status option for me, which means the trashed orders are not counted.

We skip the initial orders count, with this we don't make a redundant API call to fetch the order status options, something that SiteObserver already handles.

The function checks only the local DB, and given how pagination works, we don't remove trashed orders from the API, so when a site has trashed orders, we keep thinking that they have valid orders, and we keep showing the stats cards.

0nko

Works well after the last change. Nice fix!

hichamboushaba added 6 commits May 16, 2024 09:43

A minor improvement to the logic

8a141f5

Always use order status options to infer the number of processing orders

aabdf6d

This is done by updating the logic to fetch the order status options instead of the `/wc-analytics/reports/orders/totals`

Update logic of ObserveSiteOrderState to observe status options changes

f7af83e

Remove redundant fetch

cf38b03

We already do a fetch when the app starts in the SiteObserver, so here we should just use the cached value initially, and then observe changes

Improve FakeDispatcher to allow executing a callback when dispatching

2e8a72f

Fix unit tests

4be19ab

hichamboushaba added type: enhancement A request for an enhancement. feature: dashboard Related to home screen project labels May 16, 2024

hichamboushaba added this to the 18.7 milestone May 16, 2024

hichamboushaba commented May 16, 2024

View reviewed changes

hichamboushaba requested a review from 0nko May 16, 2024 11:04

hichamboushaba marked this pull request as ready for review May 16, 2024 11:04

hichamboushaba added the category: tracks Related to analytics, including Tracks Events. label May 16, 2024

0nko self-assigned this May 16, 2024

0nko reviewed May 17, 2024

View reviewed changes

kidinov modified the milestones: 18.7, 18.8 May 17, 2024

hichamboushaba added 2 commits May 17, 2024 09:59

A minor improvement to avoid redundant API call

bdac596

We skip the initial orders count, with this we don't make a redundant API call to fetch the order status options, something that SiteObserver already handles.

0nko approved these changes May 17, 2024

View reviewed changes

0nko enabled auto-merge May 17, 2024 11:03

Merge branch 'trunk' into dashboard/improve-logic-of-has-orders

53d9227

0nko merged commit 2b56352 into trunk May 17, 2024
14 checks passed

0nko deleted the dashboard/improve-logic-of-has-orders branch May 17, 2024 15:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Dynamic Dashboard] Fix issue of not updating the orders count in some scenarios #11530

[Dynamic Dashboard] Fix issue of not updating the orders count in some scenarios #11530

Uh oh!

hichamboushaba commented May 16, 2024

Uh oh!

dangermattic commented May 16, 2024 •

edited

Loading

Uh oh!

hichamboushaba May 16, 2024 •

edited

Loading

Uh oh!

wpmobilebot commented May 16, 2024 •

edited

Loading

Uh oh!

codecov-commenter commented May 16, 2024 •

edited

Loading

Uh oh!

0nko left a comment •

edited

Loading

Uh oh!

hichamboushaba commented May 17, 2024

Uh oh!

0nko left a comment

Uh oh!

Uh oh!

Uh oh!

		// emit updated value
		fetchOrdersCount(site)?.let { emit(it) }

[Dynamic Dashboard] Fix issue of not updating the orders count in some scenarios #11530

[Dynamic Dashboard] Fix issue of not updating the orders count in some scenarios #11530

Uh oh!

Conversation

hichamboushaba commented May 16, 2024

Description

Testing instructions

Images/gif

Uh oh!

dangermattic commented May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hichamboushaba May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

0nko left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hichamboushaba commented May 17, 2024

Uh oh!

0nko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dangermattic commented May 16, 2024 •

edited

Loading

hichamboushaba May 16, 2024 •

edited

Loading

wpmobilebot commented May 16, 2024 •

edited

Loading

codecov-commenter commented May 16, 2024 •

edited

Loading

0nko left a comment •

edited

Loading