Skip to content
This repository was archived by the owner on Feb 4, 2025. It is now read-only.

[Dynamic Dashboard] Fetch orders #3008

Merged
merged 2 commits into from
May 10, 2024
Merged

[Dynamic Dashboard] Fetch orders #3008

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3ff968
Add a way to fetch orders using coroutines without deleting existing …
0nko May 10, 2024
e4de4f0
Delete orders by default if the 1st page is requested
0nko May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 78 additions & 13 deletions ...rc/main/kotlin/org/wordpress/android/fluxc/network/rest/wpcom/wc/order/OrderRestClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,13 @@ class OrderRestClient @Inject constructor(
*/
fun fetchOrders(site: SiteModel, offset: Int, filterByStatus: String? = null) {
coroutineEngine.launch(T.API, this, "fetchOrders") {
// If null, set the filter to the api default value of "any", which will not apply any order status filters.
val statusFilter = filterByStatus.takeUnless { it.isNullOrBlank() }
?: WCOrderStore.DEFAULT_ORDER_STATUS

val url = WOOCOMMERCE.orders.pathV3
val params = mapOf(
val params = mutableMapOf(
"per_page" to WCOrderStore.NUM_ORDERS_PER_FETCH.toString(),
"offset" to offset.toString(),
"status" to statusFilter,
"_fields" to ORDER_FIELDS
).putIfNotEmpty(
"status" to filterByStatus
)

val response = wooNetwork.executeGetGsonRequest(
Expand Down Expand Up @@ -115,6 +112,66 @@ class OrderRestClient @Inject constructor(
}
}

/**
* Fetches orders from the API.
*
* Makes a GET call to `/wp-json/wc/v3/orders` retrieving a list of orders for the given site and parameters.
*
* @param site The WooCommerce [SiteModel] the orders belong to
* @param count The number of orders to fetch
* @param page The page number to fetch
* @param orderBy The field to order the results by
* @param sortOrder The order to sort the results by
* @param statusFilter The status to filter the results by
*/
@Suppress("LongParameterList")
suspend fun fetchOrders(
site: SiteModel,
count: Int,
page: Int,
orderBy: OrderBy,
sortOrder: SortOrder,
statusFilter: String?
): FetchOrdersResponsePayload {
val url = WOOCOMMERCE.orders.pathV3
val params = mutableMapOf(
"per_page" to count.toString(),
"page" to page.toString(),
"orderby" to orderBy.value,
"order" to sortOrder.value,
"_fields" to ORDER_FIELDS
).putIfNotEmpty(
"status" to statusFilter
)

val response = wooNetwork.executeGetGsonRequest(
site = site,
path = url,
params = params,
clazz = Array<OrderDto>::class.java
)

when (response) {
is WPAPIResponse.Success -> {
val orderModels = response.data?.map { orderDto ->
orderDtoMapper.toDatabaseEntity(orderDto, site.localId())
}.orEmpty()

val canLoadMore = orderModels.size == WCOrderStore.NUM_ORDERS_PER_FETCH
return FetchOrdersResponsePayload(
site = site,
ordersWithMeta = orderModels,
loadedMore = page > 1,
canLoadMore = canLoadMore
)
}
is WPAPIResponse.Error -> {
val orderError = wpAPINetworkErrorToOrderError(response.error)
return FetchOrdersResponsePayload(orderError, site)
}
}
}

/**
* Fetches orders from the API, but only requests `id` and `date_created_gmt` fields be returned. This is
* used to determine what orders should be fetched (either existing orders that have since changed or new
Expand All @@ -135,24 +192,20 @@ class OrderRestClient @Inject constructor(
requestStartTime: Calendar
) {
coroutineEngine.launch(T.API, this, "fetchOrderListSummaries") {
// If null, set the filter to the api default value of "any", which will not apply any order status filters.
val statusFilter = listDescriptor.statusFilter.takeUnless { it.isNullOrBlank() }
?: WCOrderStore.DEFAULT_ORDER_STATUS

val url = WOOCOMMERCE.orders.pathV3
val networkPageSize = listDescriptor.config.networkPageSize
val params = mutableMapOf(
"per_page" to networkPageSize.toString(),
"offset" to offset.toString(),
"status" to statusFilter,
"_fields" to "id,date_created_gmt,date_modified_gmt"
).putIfNotEmpty(
"search" to listDescriptor.searchQuery,
"before" to listDescriptor.beforeFilter,
"after" to listDescriptor.afterFilter,
"customer" to listDescriptor.customerId?.toString(),
"product" to listDescriptor.productId?.toString(),
"exclude" to listDescriptor.excludedIds?.joinToString()
"exclude" to listDescriptor.excludedIds?.joinToString(),
"status" to listDescriptor.statusFilter.takeUnless { it.isNullOrBlank() }
)

val response = wooNetwork.executeGetGsonRequest(
Expand Down Expand Up @@ -299,7 +352,6 @@ class OrderRestClient @Inject constructor(
val params = mutableMapOf(
"per_page" to WCOrderStore.NUM_ORDERS_PER_FETCH.toString(),
"offset" to offset.toString(),
"status" to WCOrderStore.DEFAULT_ORDER_STATUS,
"_fields" to ORDER_FIELDS
).putIfNotEmpty("search" to searchQuery)

Expand Down Expand Up @@ -1051,4 +1103,17 @@ class OrderRestClient @Inject constructor(
"tracking_provider"
).joinToString(separator = ",")
}

enum class SortOrder(val value: String) {
ASCENDING("asc"),
DESCENDING("desc");
}

enum class OrderBy(val value: String) {
DATE("date"),
ID("id"),
INCLUDE("include"),
TITLE("title"),
SLUG("slug");
}
}
32 changes: 31 additions & 1 deletion plugins/woocommerce/src/main/kotlin/org/wordpress/android/fluxc/store/WCOrderStore.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,13 @@ import org.wordpress.android.fluxc.model.WCOrderShipmentTrackingModel
import org.wordpress.android.fluxc.model.WCOrderStatusModel
import org.wordpress.android.fluxc.model.WCOrderSummaryModel
import org.wordpress.android.fluxc.network.BaseRequest.BaseNetworkError
import org.wordpress.android.fluxc.network.BaseRequest.GenericErrorType.SERVER_ERROR
import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooError
import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooErrorType.API_ERROR
import org.wordpress.android.fluxc.network.rest.wpcom.wc.WooResult
import org.wordpress.android.fluxc.network.rest.wpcom.wc.order.OrderRestClient
import org.wordpress.android.fluxc.network.rest.wpcom.wc.order.OrderRestClient.OrderBy
import org.wordpress.android.fluxc.network.rest.wpcom.wc.order.OrderRestClient.SortOrder
import org.wordpress.android.fluxc.persistence.OrderSqlUtils
import org.wordpress.android.fluxc.persistence.dao.OrderMetaDataDao
import org.wordpress.android.fluxc.persistence.dao.OrderNotesDao
Expand Down Expand Up @@ -59,7 +64,6 @@ class WCOrderStore @Inject constructor(
) : Store(dispatcher) {
companion object {
const val NUM_ORDERS_PER_FETCH = 15
const val DEFAULT_ORDER_STATUS = "any"
}

class FetchOrdersPayload(
Expand Down Expand Up @@ -598,6 +602,32 @@ class WCOrderStore @Inject constructor(
}
}

@Suppress("SpreadOperator")
suspend fun fetchOrders(
site: SiteModel,
count: Int = NUM_ORDERS_PER_FETCH,
page: Int = 1,
orderBy: OrderBy = OrderBy.DATE,
sortOrder: SortOrder = SortOrder.DESCENDING,
statusFilter: String? = null,
deleteOldData: Boolean = false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor np, I suggest setting this to be page == 1 just to make it more suitable for any pagination by default, it's not something we need, but it could be more clear for any other usages in the future, WDYT?

): WooResult<List<OrderEntity>> {
return coroutineEngine.withDefaultContext(API, this, "fetchOrders") {
val result = wcOrderRestClient.fetchOrders(site, count, page, orderBy, sortOrder, statusFilter)

return@withDefaultContext if (result.isError) {
WooResult(WooError(API_ERROR, SERVER_ERROR, result.error.message))
} else {
if (deleteOldData) {
ordersDaoDecorator.deleteOrdersForSite(site.localId())
}
insertOrder(site.localId(), *result.ordersWithMeta.toTypedArray())

WooResult(result.orders)
}
}
}

suspend fun updateOrderStatus(
orderId: Long,
site: SiteModel,
Expand Down
Loading