Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix inconsistent customer Type parameter in REST endpoints (https://github.com/woocommerce/woocommerce-admin/pull/5823) 

The wc-analytics/reports/orders and /wc-analytics/reports/orders/stats endpoints have inconsistent parameter names for filtering the customer type: customer_type vs customer.

This was affecting the Customer Type filter in the orders analytics, reported in issue woocommerce/woocommerce-admin#5803, where the component expects the parameter names to be the same. This is because it uses a parameter name based on the key in the filter configuration (customer_type).

To resolve this, this PR updates /wc-analytics/reports/orders/stats to accept both customer_type and customer as parameter names for this filter. The customer parameter has however been deprecated in its description to discourage usage.

Co-authored-by: Sam Seay <samueljseay@gmail.com>
This commit is contained in:
Adrian Duffell 2020-12-07 06:39:29 +08:00 committed by GitHub
parent a476445788
commit 300504ea94
5 changed files with 29 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
plugins/woocommerce-admin/readme.txt
View File

@ -73,6 +73,7 @@ Release and roadmap notes are available on the [WooCommerce Developers Blog](htt
== Unreleased ==
- Tweak: Fix inconsistent REST API paramater name for customer type filtering.
- Enhancement: Tasks extensibility in Home Screen. #5794
- Enhancement: Add page parameter to override default wc-admin page in Navigation API. #5821
- Fix: Invalidate product count if the last product was updated in the list. #5790

6
plugins/woocommerce-admin/src/API/Reports/DataStore.php
View File

@ -1196,10 +1196,10 @@ class DataStore extends SqlQuery {
global $wpdb;
$customer_filter = '';
if ( isset( $query_args['customer'] ) ) {
if ( 'new' === strtolower( $query_args['customer'] ) ) {
if ( isset( $query_args['customer_type'] ) ) {
if ( 'new' === strtolower( $query_args['customer_type'] ) ) {
$customer_filter = " {$wpdb->prefix}wc_order_stats.returning_customer = 0";
} elseif ( 'returning' === strtolower( $query_args['customer'] ) ) {
} elseif ( 'returning' === strtolower( $query_args['customer_type'] ) ) {
$customer_filter = " {$wpdb->prefix}wc_order_stats.returning_customer = 1";
}
}

18
plugins/woocommerce-admin/src/API/Reports/Orders/Stats/Controller.php
View File

@ -59,13 +59,18 @@ class Controller extends \Automattic\WooCommerce\Admin\API\Reports\Controller {
$args['coupon_excludes'] = (array) $request['coupon_excludes'];
$args['tax_rate_includes'] = (array) $request['tax_rate_includes'];
$args['tax_rate_excludes'] = (array) $request['tax_rate_excludes'];
$args['customer'] = $request['customer'];
$args['customer_type'] = $request['customer_type'];
$args['refunds'] = $request['refunds'];
$args['attribute_is'] = (array) $request['attribute_is'];
$args['attribute_is_not'] = (array) $request['attribute_is_not'];
$args['category_includes'] = (array) $request['categories'];
$args['segmentby'] = $request['segmentby'];
// For backwards compatibility, `customer` is aliased to `customer_type`.
if ( empty( $request['customer_type'] ) && ! empty( $request['customer'] ) ) {
$args['customer_type'] = $request['customer'];
}
return $args;
}
@ -495,7 +500,16 @@ class Controller extends \Automattic\WooCommerce\Admin\API\Reports\Controller {
'sanitize_callback' => 'wp_parse_id_list',
);
$params['customer'] = array(
'description' => __( 'Limit result set to items that don\'t have the specified coupon(s) assigned.', 'woocommerce-admin' ),
'description' => __( 'Alias for customer_type (deprecated).', 'woocommerce-admin' ),
'type' => 'string',
'enum' => array(
'new',
'returning',
),
'validate_callback' => 'rest_validate_request_arg',
);
$params['customer_type'] = array(
'description' => __( 'Limit result set to orders that have the specified customer_type', 'woocommerce-admin' ),
'type' => 'string',
'enum' => array(
'new',

2
plugins/woocommerce-admin/src/API/Reports/Orders/Stats/DataStore.php
View File

@ -280,7 +280,7 @@ class DataStore extends ReportsDataStore implements DataStoreInterface {
'coupon_excludes' => array(),
'tax_rate_includes' => array(),
'tax_rate_excludes' => array(),
'customer' => '',
'customer_type' => '',
'category_includes' => array(),
);
$query_args = wp_parse_args( $query_args, $defaults );

16
plugins/woocommerce-admin/tests/reports/class-wc-tests-reports-orders-stats.php
View File

@ -2108,10 +2108,10 @@ class WC_Tests_Reports_Orders_Stats extends WC_Unit_Test_Case {
// * Customer filters
// ** Customer new
$query_args = array(
'after' => $current_hour_start->format( TimeInterval::$sql_datetime_format ),
'before' => $current_hour_end->format( TimeInterval::$sql_datetime_format ),
'interval' => 'hour',
'customer' => 'new',
'after' => $current_hour_start->format( TimeInterval::$sql_datetime_format ),
'before' => $current_hour_end->format( TimeInterval::$sql_datetime_format ),
'interval' => 'hour',
'customer_type' => 'new',
);
$orders_count = 2;
@ -2173,10 +2173,10 @@ class WC_Tests_Reports_Orders_Stats extends WC_Unit_Test_Case {
// ** Customer returning
$query_args = array(
'after' => $current_hour_start->format( TimeInterval::$sql_datetime_format ), // I don't think this makes sense.... gmdate( 'Y-m-d H:i:s', $orders[0]->get_date_created()->getOffsetTimestamp() + 1 ), // Date after initial order to get a returning customer.
'before' => $current_hour_end->format( TimeInterval::$sql_datetime_format ),
'interval' => 'hour',
'customer' => 'returning',
'after' => $current_hour_start->format( TimeInterval::$sql_datetime_format ), // I don't think this makes sense.... gmdate( 'Y-m-d H:i:s', $orders[0]->get_date_created()->getOffsetTimestamp() + 1 ), // Date after initial order to get a returning customer.
'before' => $current_hour_end->format( TimeInterval::$sql_datetime_format ),
'interval' => 'hour',
'customer_type' => 'returning',
);
$total_orders_count = 144;