Merge pull request #1325 from Automattic/add/1156-wc-st-integration

Added integration with WooCommerce Shipment Tracking

Author: marcinbot

classes/class-wc-connect-extension-compatibility.php

@@ -0,0 +1,41 @@
+<?php
+
+if ( ! class_exists( 'WC_Connect_Extension_Compatibility' ) ) {
+	class WC_Connect_Extension_Compatibility {
+		/**
+		 * Function called when a new tracking number is added to the order
+		 *
+		 * @param $order_id - order ID
+		 * @param $carrier_id - carrier ID, as returned on the label objects returned by the server
+		 * @param $tracking_number - tracking number string
+		 */
+		public static function on_new_tracking_number( $order_id, $carrier_id, $tracking_number ) {
+			//call WooCommerce Shipment Tracking if it's installed
+			if ( function_exists( 'wc_st_add_tracking_number' ) ) {
+				//note: the only carrier ID we use at the moment is 'usps', which is the same in WC_ST, but this might require a mapping
+				wc_st_add_tracking_number( $order_id, $tracking_number, $carrier_id );
+			}
+		}
+
+		/**
+		 * Checks if WooCommerce Services should email the tracking details, or if another extension is taking care of that already
+		 *
+		 * @param $order_id - order ID
+		 * @return boolean true if WCS should send the tracking info, false otherwise
+		 */
+		public static function should_email_tracking_details( $order_id ) {
+			if ( function_exists( 'wc_shipment_tracking' ) ) {
+				$shipment_tracking = wc_shipment_tracking();
+				if ( property_exists( $shipment_tracking, 'actions' )
+					&& method_exists( $shipment_tracking->actions, 'get_tracking_items' ) ) {
+					$shipment_tracking_items = $shipment_tracking->actions->get_tracking_items( $order_id );
+					if ( ! empty( $shipment_tracking_items ) ) {
+						return false;
+					}
+				}
+			}
+
+			return true;
+		}
+	}
+}

classes/class-wc-connect-service-settings-store.php

@@ -248,6 +248,11 @@ public function update_label_order_meta_data( $order_id, $new_label_data ) {
 				if ( $label_data['label_id'] === $new_label_data->label_id ) {
 					$result = array_merge( $label_data, (array) $new_label_data );
 					$labels_data[ $index ] = $result;
+
+					if ( ! isset( $label_data['tracking'] )
+						&& isset( $result['tracking'] ) ) {
+							WC_Connect_Extension_Compatibility::on_new_tracking_number( $order_id, $result['carrier_id'], $result['tracking'] );
+					}
 				}
 			}
 			update_post_meta( $order_id, 'wc_connect_labels', $labels_data );

client/apps/shipping-label/index.js

@@ -12,6 +12,7 @@ import notices from 'state/notices/reducer';
 import reducer from 'woocommerce/woocommerce-services/state/shipping-label/reducer';
 import packagesReducer from 'woocommerce/woocommerce-services/state/packages/reducer';
 import labelSettingsReducer from 'woocommerce/woocommerce-services/state/label-settings/reducer';
+import reduxMiddleware from './redux-middleware';
 import { combineReducers } from 'state/utils';
 
 export default ( { orderId } ) => ( {
@@ -57,6 +58,10 @@ export default ( { orderId } ) => ( {
 		return `wcs-label-${ orderId }`;
 	},
 
+	getMiddleware() {
+		return reduxMiddleware;
+	},
+
 	View: () => (
 		<ShippingLabelViewWrapper orderId={ orderId } />
 	),

client/apps/shipping-label/redux-middleware.js

@@ -0,0 +1,29 @@
+/**
+ * Internal dependencies
+ */
+//from calypso
+import {
+	WOOCOMMERCE_SERVICES_SHIPPING_LABEL_PURCHASE_RESPONSE,
+} from 'woocommerce/woocommerce-services/state/action-types';
+
+const middlewareActions = {
+	[  WOOCOMMERCE_SERVICES_SHIPPING_LABEL_PURCHASE_RESPONSE ]: ( { error } ) => {
+		if ( error ) {
+			return;
+		}
+		window.wc_shipment_tracking_refresh && window.wc_shipment_tracking_refresh();
+	},
+};
+
+export default () => ( next ) => ( action ) => {
+	// let the action go to the reducers
+	next( action );
+
+	const middlewareAction = middlewareActions[ action.type ];
+	if ( ! middlewareAction ) {
+		return;
+	}
+
+	// perform the action
+	middlewareAction( action );
+};

client/main.js

@@ -66,7 +66,10 @@ Array.from( document.getElementsByClassName( 'wcc-root' ) ).forEach( ( container
 		Route.getReducer(),
 		{ ...serverState, ...persistedState },
 		compose(
-			applyMiddleware( thunk.withExtraArgument( args ) ),
+			applyMiddleware(
+				thunk.withExtraArgument( args ),
+				Route.getMiddleware ? Route.getMiddleware() : () => ( next ) => ( action ) => next( action ),
+			),
 			window.devToolsExtension ? window.devToolsExtension() : f => f
 		)
 	);

woocommerce-services.php

@@ -36,6 +36,7 @@
 
 require_once( plugin_basename( 'classes/class-wc-connect-options.php' ) );
 require_once( plugin_basename( 'classes/class-wc-connect-jetpack.php' ) );
+require_once( plugin_basename( 'classes/class-wc-connect-extension-compatibility.php' ) );
 
 if ( ! class_exists( 'WC_Connect_Loader' ) ) {
 
@@ -879,8 +880,10 @@ public function localize_and_enqueue_service_script( $method_id, $instance_id =
 		public function add_tracking_info_to_emails( $order, $sent_to_admin, $plain_text ) {
 			$id = WC_Connect_Compatibility::instance()->get_order_id( $order );
 
-			// Abort if no id was passed or if the order is not marked as 'completed'
-			if ( ! $id || ! $order->has_status( 'completed' ) ) {
+			// Abort if no id was passed, if the order is not marked as 'completed' or if another extension is handling the emailing
+			if ( ! $id
+				|| ! $order->has_status( 'completed' )
+				|| ! WC_Connect_Extension_Compatibility::should_email_tracking_details( $id ) ) {
 				return;
 			}