[Dynamic Dashboard] Coupons Card, part 1 #11531

hichamboushaba · 2024-05-16T12:31:24Z

Part of: #11508

Description

This PR is part of the work to add the coupons card, it adds the following:

It builds on top of Coupons/fetch reports wordpress-mobile/WordPress-FluxC-Android#3012 to add the needed logic to the repository.
It adds the ViewModel for the card with all the business logic.
It adds the logic of the range selection.
It adds a basic UI to test the logic.
Renaming and moving few classes around for a better organization.

The final UI will be added separately to keep the size of the PR manageable.

Testing instructions

Prepare some test data: create some coupons, and add them to some orders (you can do it from wp-admin even for old orders).
Open the app.
Enable the coupons card.
Confirm the coupons are loaded for the selected range.
Change the range and confirm the coupons are fetched for the new one.

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.

wpmobilebot · 2024-05-16T13:00:28Z

📲 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	`296306d`
	Direct Download	`woocommerce-prototype-build-pr11531-296306d.apk`

codecov-commenter · 2024-05-16T22:00:54Z

Codecov Report

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

Project coverage is 40.32%. Comparing base (2b56352) to head (d2eed91).

❗ Current head d2eed91 differs from pull request most recent head ce4a02e

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

Files	Patch %	Lines
.../ui/dashboard/coupons/DashboardCouponsViewModel.kt	0.00%	91 Missing ⚠️
...droid/ui/dashboard/coupons/DashboardCouponsCard.kt	0.00%	70 Missing ⚠️
...woocommerce/android/ui/coupons/CouponRepository.kt	0.00%	16 Missing ⚠️
...ui/dashboard/coupons/GetSelectedRangeForCoupons.kt	0.00%	6 Missing ⚠️
.../kotlin/com/woocommerce/android/AppPrefsWrapper.kt	0.00%	5 Missing ⚠️
...rc/main/kotlin/com/woocommerce/android/AppPrefs.kt	0.00%	4 Missing ⚠️
...ommerce/android/ui/dashboard/DashboardContainer.kt	0.00%	3 Missing ⚠️
...ce/android/ui/dashboard/data/DashboardDataStore.kt	0.00%	3 Missing ⚠️
.../dashboard/data/CouponsCustomDateRangeDataStore.kt	0.00%	2 Missing ⚠️
...e/android/ui/dashboard/stats/DashboardStatsCard.kt	0.00%	1 Missing ⚠️
... and 2 more

Additional details and impacted files

@@             Coverage Diff              @@
##              trunk   #11531      +/-   ##
============================================
- Coverage     40.44%   40.32%   -0.13%     
- Complexity     5196     5197       +1     
============================================
  Files          1083     1087       +4     
  Lines         62996    63198     +202     
  Branches       8628     8672      +44     
============================================
+ Hits          25479    25483       +4     
- Misses        35224    35421     +197     
- Partials       2293     2294       +1

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

dangermattic · 2024-05-17T07:52:33Z

	6 Warnings
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.
⚠️	Class `DashboardCouponsViewModel` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `Loaded` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `DateRangeState` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `OpenDatePicker` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `GetSelectedRangeForCoupons` is missing tests, but `unit-tests-exemption` label was set to ignore this.

Generated by 🚫 Danger

0nko

Nice work! I've observed a couple of things while testing the PR:

When I first selected the custom range, the range picker was shown but after specifying a range, the menu was not updated and I couldn't select the custom range after that

Screen_recording_20240520_145056.webm

I don't see coupons that were applied manually to older orders (for any data range)

hichamboushaba · 2024-05-20T17:05:01Z

Thanks @0nko for the review

When I first selected the custom range, the range picker was shown but after specifying a range, the menu was not updated and I couldn't select the custom range after that

I used the wrong function for setting the active tab (I'm not sure why I didn't notice this while testing, I'm quite sure I tested this scenario 😕), this now should be fixed.

I don't see coupons that were applied manually to older orders (for any data range)

All I can think of is that maybe the analytics weren't calculated on the backend yet when you tested (they take a short amount of time), can you please re-test it now?

0nko

The custom range works as expected now. I'm not sure why, but I don't see the coupons that were applied manually 🤷. Anyway, that's not really a problem.

Nice work! 🎖️

hichamboushaba · 2024-05-20T21:00:40Z

The custom range works as expected now. I'm not sure why, but I don't see the coupons that were applied manually 🤷. Anyway, that's not really a problem.

Can you see them in the Analytics section of wp-admin?

0nko · 2024-05-21T07:28:47Z

I can see it showed up now both on the web and the app 🤔, maybe I really just needed to wait..

# Conflicts: # build.gradle

wpmobilebot · 2024-05-21T11:40:47Z

Found 1 violations:

The PR caused the following dependency changes:

expand

-+--- org.wordpress:fluxc:2.79.2
-|    +--- org.wordpress:wellsql:2.0.0
-|    |    +--- androidx.annotation:annotation:1.2.0 -> 1.7.0 (*)
-|    |    \--- org.wordpress.wellsql:wellsql-annotations:2.0.0
-|    +--- org.wordpress.fluxc:fluxc-annotations:2.79.2
-|    +--- org.greenrobot:eventbus:3.3.1 (*)
-|    +--- com.squareup.okhttp3:okhttp:4.9.0 -> 4.12.0 (*)
-|    +--- com.android.volley:volley:1.1.1 -> 1.2.0
-|    +--- androidx.paging:paging-runtime:2.1.2
-|    |    +--- androidx.paging:paging-common:2.1.2
-|    |    |    +--- androidx.annotation:annotation:1.0.0 -> 1.7.0 (*)
-|    |    |    \--- androidx.arch.core:core-common:2.0.0 -> 2.2.0 (*)
-|    |    +--- androidx.arch.core:core-runtime:2.0.0 -> 2.2.0 (*)
-|    |    +--- androidx.lifecycle:lifecycle-runtime:2.0.0 -> 2.6.2 (*)
-|    |    +--- androidx.lifecycle:lifecycle-livedata:2.0.0 -> 2.6.2 (*)
-|    |    \--- androidx.recyclerview:recyclerview:1.0.0 -> 1.3.2 (*)
-|    +--- com.goterl:lazysodium-android:5.0.2
-|    +--- net.java.dev.jna:jna:5.5.0
-|    +--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.20 -> 1.9.10 (*)
-|    +--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.6.20 -> 1.9.22
-|    |    \--- org.jetbrains.kotlin:kotlin-stdlib:1.9.22 (*)
-|    +--- androidx.appcompat:appcompat:1.0.2 -> 1.6.1 (*)
-|    +--- androidx.recyclerview:recyclerview:1.0.0 -> 1.3.2 (*)
-|    +--- androidx.exifinterface:exifinterface:1.0.0 -> 1.3.6
-|    |    \--- androidx.annotation:annotation:1.2.0 -> 1.7.0 (*)
-|    +--- androidx.security:security-crypto:1.0.0 -> 1.1.0-alpha03
-|    |    +--- androidx.annotation:annotation:1.1.0 -> 1.7.0 (*)
-|    |    +--- com.google.crypto.tink:tink-android:1.5.0
-|    |    \--- androidx.collection:collection:1.1.0 -> 1.4.0 (*)
-|    +--- com.squareup.okhttp3:okhttp-urlconnection:4.9.0
-|    |    +--- com.squareup.okhttp3:okhttp:4.9.0 -> 4.12.0 (*)
-|    |    \--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.4.10 -> 1.9.10 (*)
-|    +--- com.google.code.gson:gson:2.8.5 -> 2.10.1
-|    +--- org.apache.commons:commons-text:1.10.0 (*)
-|    +--- androidx.room:room-runtime:2.4.2 -> 2.5.2 (*)
-|    +--- androidx.room:room-ktx:2.4.2 -> 2.5.2
-|    |    +--- androidx.room:room-common:2.5.2 (*)
-|    |    +--- androidx.room:room-runtime:2.5.2 (*)
-|    |    +--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
-|    |    \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4 -> 1.7.3 (*)
-|    +--- com.google.dagger:dagger:2.42 -> 2.50
-|    |    \--- javax.inject:javax.inject:1
-|    +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9 -> 1.7.3 (*)
-|    \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9 -> 1.7.3 (*)
++--- org.wordpress:fluxc:trunk-09a0d45d25140a4b50095b1555ef6f1b0f7c510c FAILED
-+--- org.wordpress.fluxc.plugins:woocommerce:2.79.2
-|    +--- org.wordpress:wellsql:2.0.0 (*)
-|    +--- org.wordpress.fluxc:fluxc-annotations:2.79.2
-|    +--- androidx.room:room-ktx:2.4.2 -> 2.5.2 (*)
-|    +--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.20 -> 1.9.10 (*)
-|    +--- org.wordpress:fluxc:2.79.2 (*)
-|    +--- com.google.code.gson:gson:2.8.5 -> 2.10.1
-|    +--- com.google.dagger:dagger:2.42 -> 2.50 (*)
-|    +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9 -> 1.7.3 (*)
-|    +--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9 -> 1.7.3 (*)
-|    \--- androidx.room:room-runtime:2.4.2 -> 2.5.2 (*)
++--- org.wordpress.fluxc.plugins:woocommerce:trunk-09a0d45d25140a4b50095b1555ef6f1b0f7c510c FAILED
 +--- org.wordpress:login:1.15.0
 |    +--- com.github.bumptech.glide:glide:4.12.0 -> 4.16.0
-|    |    \--- androidx.exifinterface:exifinterface:1.3.6 (*)
+|    |    \--- androidx.exifinterface:exifinterface:1.3.6
+|    |         \--- androidx.annotation:annotation:1.2.0 -> 1.7.0 (*)
-|    \--- com.google.dagger:dagger:2.47 -> 2.50 (*)
+|    \--- com.google.dagger:dagger:2.47 -> 2.50
+|         \--- javax.inject:javax.inject:1
 \--- project :libs:cardreader
      +--- com.stripe:stripeterminal-localmobile:3.1.1
      |    \--- org.jetbrains.kotlin:kotlin-parcelize-runtime:1.8.22 -> 1.9.22
-     |         \--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.9.22 (*)
+     |         \--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.9.22
+     |              \--- org.jetbrains.kotlin:kotlin-stdlib:1.9.22 (*)
      \--- com.stripe:stripeterminal-core:3.1.1
-          +--- androidx.security:security-crypto:1.1.0-alpha03 (*)
+          +--- androidx.security:security-crypto:1.1.0-alpha03
+          |    +--- androidx.annotation:annotation:1.1.0 -> 1.7.0 (*)
+          |    +--- com.google.crypto.tink:tink-android:1.5.0
+          |    \--- androidx.collection:collection:1.1.0 -> 1.4.0 (*)
-          \--- androidx.room:room-ktx:2.5.2 (*)
+          \--- androidx.room:room-ktx:2.5.2
+               +--- androidx.room:room-common:2.5.2 (*)
+               +--- androidx.room:room-runtime:2.5.2 (*)
+               +--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
+               \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4 -> 1.7.3 (*)

Please review and act accordingly

hichamboushaba added type: enhancement A request for an enhancement. status: do not merge Dependent on another PR, ready for review but not ready for merge. feature: dashboard Related to home screen project labels May 16, 2024

hichamboushaba mentioned this pull request May 16, 2024

Coupons/fetch reports wordpress-mobile/WordPress-FluxC-Android#3012

Merged

hichamboushaba requested a review from 0nko May 16, 2024 22:02

hichamboushaba marked this pull request as ready for review May 16, 2024 22:03

hichamboushaba force-pushed the issue/11508-coupons-card branch from b8fe836 to 18a88d8 Compare May 17, 2024 07:52

hichamboushaba added the unit-tests-exemption label May 17, 2024

hichamboushaba added this to the 18.8 milestone May 17, 2024

hichamboushaba force-pushed the issue/11508-coupons-card branch from 18a88d8 to e09b251 Compare May 17, 2024 11:55

hichamboushaba added 13 commits May 17, 2024 18:13

Bump fluxc

6e9260b

Add new widget type for coupons card

e478ba2

Add boilerplate of the new coupons card

f3421df

Add function to fetch most active coupons

f6c552d

Add business logic for fetching and observing coupons

659279d

Fix build

d18af45

Add a basic UI to test the logic

93b0aac

Cache the coupons performance report in memory

ba8798c

Emit a specific error when WCAdmin is not enabled

864a39a

Rename and move classes for better organization

90239e4

Add date range header to the coupons card

911d4ed

Handle changing date ranges

0ae2d85

Fix detekt issues

58d48aa

hichamboushaba force-pushed the issue/11508-coupons-card branch from d2eed91 to 58d48aa Compare May 17, 2024 17:14

Multiple fixes to the in-memory cache

ce4a02e

0nko self-assigned this May 20, 2024

0nko reviewed May 20, 2024

View reviewed changes

Use the correct function for setting the tab

43a8b29

0nko approved these changes May 20, 2024

View reviewed changes

hichamboushaba added 2 commits May 21, 2024 12:34

Bump fluxc

f890790

Merge branch 'trunk' into issue/11508-coupons-card

296306d

# Conflicts: # build.gradle

hichamboushaba enabled auto-merge May 21, 2024 11:35

hichamboushaba removed the status: do not merge Dependent on another PR, ready for review but not ready for merge. label May 21, 2024

hichamboushaba merged commit dd01fde into trunk May 21, 2024
13 of 15 checks passed

hichamboushaba deleted the issue/11508-coupons-card branch May 21, 2024 12:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Dynamic Dashboard] Coupons Card, part 1 #11531

[Dynamic Dashboard] Coupons Card, part 1 #11531

Uh oh!

hichamboushaba commented 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!

dangermattic commented May 17, 2024 •

edited

Loading

Uh oh!

0nko left a comment

Uh oh!

hichamboushaba commented May 20, 2024

Uh oh!

0nko left a comment

Uh oh!

hichamboushaba commented May 20, 2024

Uh oh!

0nko commented May 21, 2024

Uh oh!

wpmobilebot commented May 21, 2024

Uh oh!

Uh oh!

Uh oh!

[Dynamic Dashboard] Coupons Card, part 1 #11531

[Dynamic Dashboard] Coupons Card, part 1 #11531

Uh oh!

Conversation

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

Uh oh!

Description

Testing instructions

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!

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

Uh oh!

Uh oh!

0nko left a comment

Choose a reason for hiding this comment

Uh oh!

hichamboushaba commented May 20, 2024

Uh oh!

0nko left a comment

Choose a reason for hiding this comment

Uh oh!

hichamboushaba commented May 20, 2024

Uh oh!

0nko commented May 21, 2024

Uh oh!

wpmobilebot commented May 21, 2024

The PR caused the following dependency changes:

Uh oh!

Uh oh!

Uh oh!

hichamboushaba commented May 16, 2024 •

edited

Loading

wpmobilebot commented May 16, 2024 •

edited

Loading

codecov-commenter commented May 16, 2024 •

edited

Loading

dangermattic commented May 17, 2024 •

edited

Loading