Merge pull request #3023 from wordpress-mobile/issue/11558-fetch-product-sales-reports

JorgeMucientes · web-flow · commit e26e2ba5206f · 2024-06-04T18:29:15.000+02:00
Issue/11558 fetch product sales reports
diff --git a/example/src/main/java/org/wordpress/android/fluxc/example/ui/products/WooProductsFragment.kt b/example/src/main/java/org/wordpress/android/fluxc/example/ui/products/WooProductsFragment.kt
@@ -31,7 +31,7 @@ import org.wordpress.android.fluxc.model.WCProductImageModel
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.product.CoreProductStockStatus
 import org.wordpress.android.fluxc.store.MediaStore
 import org.wordpress.android.fluxc.store.WCAddonsStore
-import org.wordpress.android.fluxc.store.WCProductStockReportStore
+import org.wordpress.android.fluxc.store.WCProductReportsStore
 import org.wordpress.android.fluxc.store.WCProductStore
 import org.wordpress.android.fluxc.store.WCProductStore.AddProductTagsPayload
 import org.wordpress.android.fluxc.store.WCProductStore.DeleteProductPayload
@@ -64,7 +64,7 @@ class WooProductsFragment : StoreSelectingFragment() {
     @Inject lateinit var addonsStore: WCAddonsStore
     @Inject internal lateinit var wooCommerceStore: WooCommerceStore
     @Inject internal lateinit var mediaStore: MediaStore
-    @Inject internal lateinit var productStockReportStore: WCProductStockReportStore
+    @Inject internal lateinit var productStockReportStore: WCProductReportsStore
 
     private var pendingFetchSingleProductShippingClassRemoteId: Long? = null
 
diff --git a/fluxc-processor/src/main/resources/wc-wp-api-endpoints.txt b/fluxc-processor/src/main/resources/wc-wp-api-endpoints.txt
@@ -117,6 +117,7 @@
 /subscriptions/<id>/
 
 /reports/products
+/reports/variations
 
 /options
 
diff --git a/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/reports/ReportsProductApiResponse.kt b/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/reports/ReportsProductApiResponse.kt
@@ -5,6 +5,8 @@ import com.google.gson.annotations.SerializedName
 data class ReportsProductApiResponse(
     @SerializedName("product_id")
     val productId: Long? = null,
+    @SerializedName("variation_id")
+    val variationId: Long? = null,
     @SerializedName("items_sold")
     val itemsSold: Int? = null,
     @SerializedName("net_revenue")
@@ -36,7 +38,7 @@ data class ProductStockItemApiResponse(
     @SerializedName("id")
     val productId: Long? = null,
     @SerializedName("parent_id")
-    val parentId: Int? = null, // When the product is a variation, this is the parent product ID
+    val parentId: Long? = null, // When the product is a variation, this is the parent product ID
     @SerializedName("name")
     val name: String? = null,
     @SerializedName("stock_status")
diff --git a/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/reports/ReportsRestClient.kt b/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/reports/ReportsRestClient.kt
@@ -2,6 +2,7 @@ package org.wordpress.android.fluxc.network.rest.wpcom.wc.reports
 
 import org.wordpress.android.fluxc.generated.endpoint.WOOCOMMERCE
 import org.wordpress.android.fluxc.model.SiteModel
+import org.wordpress.android.fluxc.network.rest.wpapi.WPAPIResponse
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooNetwork
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooPayload
 import org.wordpress.android.fluxc.utils.toWooPayload
@@ -63,4 +64,70 @@ class ReportsRestClient @Inject constructor(private val wooNetwork: WooNetwork)
 
         return response.toWooPayload()
     }
+
+    suspend fun fetchProductSalesReport(
+        site: SiteModel,
+        startDate: String,
+        endDate: String,
+        productIds: List<Long>
+    ): WooPayload<Array<ReportsProductApiResponse>> {
+        val url = WOOCOMMERCE.reports.products.pathV4Analytics
+        val response = fetchSales(
+            endDate = endDate,
+            startDate = startDate,
+            productIds = productIds,
+            site = site,
+            url = url,
+            quantity = productIds.size
+        )
+        return response.toWooPayload()
+    }
+
+    suspend fun fetchProductVariationsSalesReport(
+        site: SiteModel,
+        startDate: String,
+        endDate: String,
+        variationIds: List<Long>
+    ): WooPayload<Array<ReportsProductApiResponse>> {
+        val url = WOOCOMMERCE.reports.variations.pathV4Analytics
+        val response = fetchSales(
+            endDate = endDate,
+            startDate = startDate,
+            variationIds = variationIds,
+            site = site,
+            url = url,
+            quantity = variationIds.size
+        )
+        return response.toWooPayload()
+    }
+
+    private suspend fun fetchSales(
+        endDate: String,
+        startDate: String,
+        productIds: List<Long> = emptyList(),
+        variationIds: List<Long> = emptyList(),
+        site: SiteModel,
+        url: String,
+        quantity: Int
+    ): WPAPIResponse<Array<ReportsProductApiResponse>> {
+        val parameters = mapOf(
+            "before" to endDate,
+            "after" to startDate,
+            "products" to productIds.joinToString(","),
+            "variations" to variationIds.joinToString(","),
+            "extended_info" to "true",
+            "orderby" to "items_sold",
+            "order" to "desc",
+            "page" to "1",
+            "per_page" to quantity.toString()
+        )
+
+        val response = wooNetwork.executeGetGsonRequest(
+            site = site,
+            path = url,
+            clazz = Array<ReportsProductApiResponse>::class.java,
+            params = parameters
+        )
+        return response
+    }
 }
diff --git a/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCLeaderboardsStore.kt b/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCLeaderboardsStore.kt
@@ -156,7 +156,10 @@ class WCLeaderboardsStore @Inject constructor(
             val invalidatedTopPerformers =
                 topPerformersDao.getTopPerformerProductsForSite(site.localId())
                     .map { it.copy(millisSinceLastUpdated = 0) }
-            topPerformersDao.updateTopPerformerProductsForSite(site.localId(), invalidatedTopPerformers)
+            topPerformersDao.updateTopPerformerProductsForSite(
+                site.localId(),
+                invalidatedTopPerformers
+            )
         }
     }
 }
diff --git a/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCProductReportsStore.kt b/plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCProductReportsStore.kt
@@ -4,14 +4,15 @@ import org.wordpress.android.fluxc.model.SiteModel
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooResult
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.product.CoreProductStockStatus
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.reports.ProductStockItemApiResponse
+import org.wordpress.android.fluxc.network.rest.wpcom.wc.reports.ReportsProductApiResponse
 import org.wordpress.android.fluxc.network.rest.wpcom.wc.reports.ReportsRestClient
 import org.wordpress.android.fluxc.tools.CoroutineEngine
 import org.wordpress.android.util.AppLog.T.API
 import javax.inject.Inject
 import javax.inject.Singleton
 
 @Singleton
-class WCProductStockReportStore @Inject constructor(
+class WCProductReportsStore @Inject constructor(
     private val reportsRestClient: ReportsRestClient,
     private val coroutineEngine: CoroutineEngine,
 ) {
@@ -34,6 +35,36 @@ class WCProductStockReportStore @Inject constructor(
                 quantity = quantity
             )
         }.asWooResult()
+
+    suspend fun fetchProductSalesReport(
+        site: SiteModel,
+        startDate: String,
+        endDate: String,
+        productIds: List<Long>
+    ): WooResult<Array<ReportsProductApiResponse>> =
+        coroutineEngine.withDefaultContext(API, this, "fetchProductSalesReport") {
+            reportsRestClient.fetchProductSalesReport(
+                site,
+                startDate,
+                endDate,
+                productIds
+            )
+        }.asWooResult()
+
+    suspend fun fetchProductVariationsSalesReport(
+        site: SiteModel,
+        startDate: String,
+        endDate: String,
+        productVariationIds: List<Long>
+    ): WooResult<Array<ReportsProductApiResponse>> =
+        coroutineEngine.withDefaultContext(API, this, "fetchProductVariationsSalesReport") {
+            reportsRestClient.fetchProductVariationsSalesReport(
+                site,
+                startDate,
+                endDate,
+                productVariationIds
+            )
+        }.asWooResult()
 }
 
 typealias ProductStockItems = Array<ProductStockItemApiResponse>

Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,10 @@ class WCLeaderboardsStore @Inject constructor(`
`156`	`156`	`val invalidatedTopPerformers =`
`157`	`157`	`topPerformersDao.getTopPerformerProductsForSite(site.localId())`
`158`	`158`	`.map { it.copy(millisSinceLastUpdated = 0) }`
`159`		`- topPerformersDao.updateTopPerformerProductsForSite(site.localId(), invalidatedTopPerformers)`
	`159`	`+ topPerformersDao.updateTopPerformerProductsForSite(`
	`160`	`+ site.localId(),`
	`161`	`+ invalidatedTopPerformers`
	`162`	`+ )`
`160`	`163`	`}`
`161`	`164`	`}`
`162`	`165`	`}`