Reduce order status change delay in Orders Panel. #2659

jeffstieler · 2019-07-16T21:31:30Z

This PR seeks to reduce/eliminate the delay in order status transitions manifesting in the Orders Panel.

It does so by using the core WooCommerce Orders endpoint to determine if there are actionable orders, as well as trusting the core endpoint data over the reporting table data - both endpoints are hit and the data merged, with the core endpoint overriding the reporting endpoint. This hopefully ensures that we can catch order status (and date, etc) changes in any "direction" - processing to completed, or completed to pending, etc.

Additionally, this PR removes the default date range for the /reports/orders endpoint (since it's not present in the core endpoint, and we need parity). This solves #2309.

Detailed test instructions:

Have an order that has an "actionable" status and shows up in the activity panel.
Edit the order to a non-actionable status, i.e. mark it as complete.
Note after the POST of the edit order form is completed, the order is no longer in the panel.
Navigate to the wc-admin dashboard, verify the order is no longer in the panel.

Changelog Note:

Fix: completed orders lingering in activity panel.

Side steps the lookup table to catch order status transitions immediately.

joshuatf

This is looking pretty good, @jeffstieler! I'm having trouble seeing orders because of hasActionableOrders but I think moving your solution up to determine that prop will resolve this.

Also I noticed that orders seem to be in chronological order (with the oldest at top). This may be expected, but quick sanity check while we're here.

joshuatf · 2019-07-17T05:39:56Z

client/header/activity-panel/panels/orders.js

+		};
+		const actionableOrders = Array.from( getItems( 'orders', allOrdersQuery ).values() );
+
+		if ( hasActionableOrders && actionableOrders.length ) {


I'm unable to see orders here since hasActionableOrders is false. I'm thinking hasActionableOrders might not be needed here. Since we've already queried for actionableOrders we can just check its length.

On that same note, we may want to update the unread indicator to use the same test so those aren't out of sync.

Hmm.. I'm not seeing hasActionableOrders as false. It ultimate comes from the unread indicator function:

woocommerce-admin/client/header/activity-panel/index.js

Line 148 in 71e7e5c

return <OrdersPanel hasActionableOrders={ hasUnreadOrders } />;

,

woocommerce-admin/client/header/activity-panel/index.js

Line 283 in 71e7e5c

const hasUnreadOrders = getUnreadOrders( select );

joshuatf · 2019-07-17T05:40:18Z

includes/api/class-wc-admin-rest-reports-orders-controller.php

@@ -385,6 +387,24 @@ public function get_collection_params() {
 			'sanitize_callback' => 'wc_string_to_bool',
 			'validate_callback' => 'rest_validate_request_arg',
 		);
+		$params['order_includes']   = array(


Nice 👍 Thanks for adding these!

joshuatf · 2019-07-17T05:49:28Z

client/header/activity-panel/panels/orders.js

@@ -265,29 +274,37 @@ export default compose(
 			return { orders: [], isError: true, isRequesting: false, orderStatuses };
 		}

-		if ( hasActionableOrders ) {
+		// Query the core Orders endpoint for the most up-to-date statuses.
+		const allOrdersQuery = {


Out of scope for this PR, but would be awesome if we could just return the IDs here - https://developer.wordpress.org/reference/classes/wp_query/#return-fields-parameter

Done in 7a3f4fd.

joshuatf · 2019-07-17T05:51:31Z

includes/data-stores/class-wc-admin-reports-orders-data-store.php

@@ -151,8 +161,8 @@ public function get_data( $query_args ) {
 			'page'             => 1,
 			'order'            => 'DESC',
 			'orderby'          => 'date_created',
-			'before'           => WC_Admin_Reports_Interval::default_before(),
-			'after'            => WC_Admin_Reports_Interval::default_after(),
+			'before'           => '',


I like the idea of removing the default date limitations. Just want to make sure it matches up with what is done in #2636.

There might be an errant change in #2636, see: https://github.com/woocommerce/woocommerce-admin/pull/2636/files#r304572283.

I think this PR is going to do the trick without implementing #2636.

jeffstieler · 2019-07-17T16:14:18Z

Also I noticed that orders seem to be in chronological order (with the oldest at top). This may be expected, but quick sanity check while we're here.

Fixed in b5a47e1.

jeffstieler · 2019-07-17T18:37:59Z

I accidentally broke the "non actionable" order query - fixed in 9a0f74d. This is ready for another review.

joshuatf

Excellent work, @jeffstieler! Testing well for me. Added one tiny nitpick about todo format, but otherwise LGTM.

joshuatf · 2019-07-18T03:56:25Z

client/header/activity-panel/panels/orders.js

+				page: 1,
+				per_page: QUERY_DEFAULTS.pageSize,
+				status: orderStatuses,
+				_fields: [ 'id', 'date_created_gmt', 'status' ],


Awesome! Did not know the _fields property was an option here.

joshuatf · 2019-07-18T03:57:38Z

client/header/activity-panel/panels/orders.js


 			return { orders, isError, isRequesting, orderStatuses };
 		}

+		// Get a count of all orders for messaging purposes.
+		// @todo: add a property to wcSettings for this?


Minor nitpick: todos were update to format:

@todo Thing to do.

Amended the last commit to fix this. Thanks.

jeffstieler added 4 commits July 16, 2019 15:17

Add parameters for specifying order IDs for reporting.

6209507

Remove default date range for Orders report query.

2130883

Use core orders endpoint for "unread" order indicator.

b08a92b

Use core orders endpoint for initial orders panel query.

155a3fb

Side steps the lookup table to catch order status transitions immediately.

jeffstieler added [Status] Needs Review type: task The issue is an internally driven task (e.g. from another A8c team). focus: activity panel Issues about activity/task panels on the home screen. focus: wc rest api labels Jul 16, 2019

jeffstieler requested a review from a team July 16, 2019 21:31

jeffstieler added this to In Progress PRs (for automation purposes) in Isotope via automation Jul 16, 2019

joshuatf reviewed Jul 17, 2019

View reviewed changes

rrennick mentioned this pull request Jul 17, 2019

update order activity panel to check for all time orders #2636

Closed

jeffstieler added 2 commits July 17, 2019 09:56

Reduce unread orders API response fields.

7a3f4fd

Maintain query order when merging core Order data and lookup table data.

b5a47e1

joshuatf approved these changes Jul 18, 2019

View reviewed changes

Fix "non actionable" order query.

2a39ff3

jeffstieler force-pushed the fix/2592-orders-linger branch from 9a0f74d to 2a39ff3 Compare July 18, 2019 14:10

jeffstieler added [Status] Ready to Merge and removed [Status] Needs Review labels Jul 18, 2019

jeffstieler merged commit b44ac2d into master Jul 18, 2019

Isotope automation moved this from In Progress PRs (for automation purposes) to Done Sprint 21 (July 9 - July 23) Jul 18, 2019

jeffstieler deleted the fix/2592-orders-linger branch July 18, 2019 14:20

jeffstieler mentioned this pull request Jul 18, 2019

Orders panel shows no orders message when orders exist #2309

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reduce order status change delay in Orders Panel. #2659

Reduce order status change delay in Orders Panel. #2659

jeffstieler commented Jul 16, 2019 •

edited

joshuatf left a comment

joshuatf Jul 17, 2019

jeffstieler Jul 17, 2019

joshuatf Jul 17, 2019

joshuatf Jul 17, 2019

jeffstieler Jul 17, 2019

joshuatf Jul 17, 2019

jeffstieler Jul 17, 2019

rrennick Jul 17, 2019

jeffstieler commented Jul 17, 2019

jeffstieler commented Jul 17, 2019

joshuatf left a comment

joshuatf Jul 18, 2019

joshuatf Jul 18, 2019

jeffstieler Jul 18, 2019

Reduce order status change delay in Orders Panel. #2659

Reduce order status change delay in Orders Panel. #2659

Conversation

jeffstieler commented Jul 16, 2019 • edited

Detailed test instructions:

Changelog Note:

joshuatf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffstieler commented Jul 17, 2019

jeffstieler commented Jul 17, 2019

joshuatf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffstieler commented Jul 16, 2019 •

edited