Merge branch 'trunk' into fix/remove-new-draft-checkout-status-from-get-related-order-ids

Author: wjrosa

build/index.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('wc-blocks-checkout', 'wc-price-format', 'wc-settings', 'wp-element', 'wp-i18n', 'wp-plugins'), 'version' => 'b74144542a686437daa06d7e57f2567f');
+<?php return array('dependencies' => array('wc-blocks-checkout', 'wc-price-format', 'wc-settings', 'wp-element', 'wp-i18n', 'wp-plugins'), 'version' => '7e9abfc482fe190e29673f828b33f482');

build/index.js

@@ -1,8 +1,14 @@
 *** WooCommerce Subscriptions Core Changelog ***
 
-= 7.2.0 - 2024-xx-xx =
+= 7.3.0 - 2024-xx-xx =
 * Fix - Removing the new "wc-checkout-draft" status from the method used to retrieve related orders.
+* Fix - Fixed an issue with subscriptions containing multiple renewal orders to mark a random item as processing, instead of the last order.
+
+= 7.2.0 - 2024-06-13 =
+* Fix - label improvement on my subscription page template.
+* Fix - Regenerate subscriptions related order caches (renewal, resubscribe, switch) if it's stored as an invalid value to prevent fatal errors.
 * Update - Show "FREE" instead of 0 when there is no shipping cost in the recurring totals section of the Cart and Checkout blocks (requires WooCommerce 9.0+).
+* Dev - New function wcs_set_recurring_item_total() to set line item totals that have been copied from an initial order to their proper recurring totals (i.e. remove sign-up fees).
 
 = 7.1.1 - 2024-05-09 =
 * Fix - Resolved an issue that caused "WC_DateTime could not be converted to int" warnings to occur on non-hpos sites while editing a subscription.

changelog.txt

@@ -16,7 +16,7 @@ class WC_Subscriptions_Core_Plugin {
 	 * The version of subscriptions-core library.
 	 * @var string
 	 */
-	protected $library_version = '7.1.1'; // WRCS: DEFINED_VERSION.
+	protected $library_version = '7.2.0'; // WRCS: DEFINED_VERSION.
 
 	/**
 	 * The subscription scheduler instance.

includes/class-wc-subscriptions-core-plugin.php

@@ -130,7 +130,8 @@ public static function maybe_record_subscription_payment( $order_id, $orders_old
 				$is_failed_renewal_order = 'failed' === $orders_old_status || wc_string_to_bool( $order->get_meta( WC_Subscription::RENEWAL_FAILED_META_KEY, true ) );
 				$is_failed_renewal_order = apply_filters( 'woocommerce_subscriptions_is_failed_renewal_order', $is_failed_renewal_order, $order_id, $orders_old_status );
 
-				if ( $order_needed_payment ) {
+				// Subscription will be activated only if this is the last renewal order of the subscription.
+				if ( $order_needed_payment && wcs_is_order_last_renewal_of_subscription( $order, $subscription ) ) {
 					$subscription->payment_complete();
 					$was_activated = true;
 				}

includes/class-wc-subscriptions-renewal-order.php

@@ -210,7 +210,9 @@ public function get_related_order_ids_from_cache( $subscription, $relation_type
 
 		$meta_data = $this->get_related_order_metadata( $subscription, $relation_type );
 
-		return $meta_data ? maybe_unserialize( $meta_data->meta_value ) : '';
+		$related_orders = $meta_data ? maybe_unserialize( $meta_data->meta_value ) : '';
+
+		return is_array( $related_orders ) ? $related_orders : '';
 	}
 
 	/**

includes/data-stores/class-wcs-related-order-store-cached-cpt.php

@@ -1003,3 +1003,55 @@ function wcs_order_contains_early_renewal( $order ) {
 function wcs_get_subscription_item_grouping_key( $item, $renewal_time = '' ) {
 	return apply_filters( 'woocommerce_subscriptions_item_grouping_key', wcs_get_subscription_grouping_key( $item->get_product(), $renewal_time ), $item );
 }
+
+/**
+ * Sets the order item total to its recurring product price.
+ *
+ * This function takes an order item and checks if its totals have been modified to account for free trials or sign-up fees (i.e. parent orders).
+ * If the totals have been adjusted, the function sets the item's total back to their recurring total.
+ *
+ * Note: If the line item has a custom total that doesn't match the expected price, don't override it.
+ *
+ * @param WC_Order_Item $item Subscription line item.
+ */
+function wcs_set_recurring_item_total( &$item ) {
+	$product = $item->get_product();
+
+	if ( ! $product || ! WC_Subscriptions_Product::is_subscription( $product ) ) {
+		return;
+	}
+
+	$sign_up_fee  = WC_Subscriptions_Product::get_sign_up_fee( $product );
+	$sign_up_fee  = is_numeric( $sign_up_fee ) ? (float) $sign_up_fee : 0;
+	$trial_length = WC_Subscriptions_Product::get_trial_length( $product );
+
+	$recurring_price = (float) $product->get_price();
+	$initial_price   = $trial_length > 0 ? $sign_up_fee : $recurring_price + $sign_up_fee;
+	$initial_total   = wc_get_price_excluding_tax(
+		$product,
+		[
+			'qty'   => $item->get_quantity(),
+			'price' => $initial_price,
+		]
+	);
+
+	// Check if a custom item total was set on the order. If so, don't override it.
+	if ( (float) $item->get_subtotal() !== $initial_total ) {
+		return;
+	}
+
+	$recurring_total = wc_get_price_excluding_tax(
+		$product,
+		[
+			'qty'   => $item->get_quantity(),
+			'price' => $recurring_price,
+		]
+	);
+
+	$item->set_props(
+		[
+			'subtotal' => $recurring_total,
+			'total'    => $recurring_total,
+		]
+	);
+}

includes/wcs-order-functions.php

@@ -62,6 +62,18 @@ function wcs_order_contains_renewal( $order ) {
 	return apply_filters( 'woocommerce_subscriptions_is_renewal_order', $is_renewal, $order );
 }
 
+/**
+ * Determines if a given order is the subscription's latest renewal order.
+ *
+ * @param $order WC_Order The order object.
+ * @param $subscription WC_Subscription The subscription object.
+ * @return bool Whether the order is the latest renewal order of the provided subscription.
+ */
+function wcs_is_order_last_renewal_of_subscription( $order, $subscription ) {
+	$last_renewal_order = wcs_get_last_renewal_order( $subscription );
+	return $last_renewal_order && $last_renewal_order->get_id() === $order->get_id();
+}
+
 /**
  * Checks the cart to see if it contains a subscription product renewal.
  *
@@ -128,10 +140,7 @@ function wcs_get_subscriptions_for_renewal_order( $order ) {
  */
 function wcs_get_last_non_early_renewal_order( $subscription ) {
 	$last_non_early_renewal = false;
-	$renewal_orders         = $subscription->get_related_orders( 'all', 'renewal' );
-
-	// We need the orders sorted by the date they were created, with the newest first.
-	wcs_sort_objects( $renewal_orders, 'date_created', 'descending' );
+	$renewal_orders         = wcs_get_renewal_orders_sorted_by( $subscription, 'date_created' );
 
 	foreach ( $renewal_orders as $renewal_order ) {
 		if ( ! wcs_order_contains_early_renewal( $renewal_order ) ) {
@@ -143,6 +152,34 @@ function wcs_get_last_non_early_renewal_order( $subscription ) {
 	return $last_non_early_renewal;
 }
 
+/**
+ * Get the last renewal order (early renewals included).
+ *
+ * @param WC_Subscription $subscription The subscription object.
+ * @return WC_Order|bool The last non-early renewal order, otherwise false.
+ */
+function wcs_get_last_renewal_order( $subscription ) {
+	$renewal_orders = wcs_get_renewal_orders_sorted_by( $subscription, 'date_created' );
+	return $renewal_orders ? reset( $renewal_orders ) : false;
+}
+
+/**
+ * Gets the renewal orders for a subscription, sorted by the specified property.
+ *
+ * @param WC_Subscription $subscription The subscription object.
+ * @param string          $sort_by      The subscription property to sort by.
+ * @param string          $order        Optional. The sort order to sort by. Default is 'descending'.
+ *
+ * @return WC_Order[] The subscriptions renewal orders sorted.
+ */
+function wcs_get_renewal_orders_sorted_by( $subscription, $sort_by, $order = 'descending' ) {
+	$renewal_orders = $subscription->get_related_orders( 'all', 'renewal' );
+
+	wcs_sort_objects( $renewal_orders, $sort_by, $order );
+
+	return $renewal_orders;
+}
+
 /**
  * Checks if manual renewals are required - automatic renewals are disabled.
  *

includes/wcs-renewal-functions.php

@@ -3,7 +3,7 @@
 	"title": "WooCommerce Subscriptions Core",
 	"author": "Automattic",
 	"license": "GPL-3.0-or-later",
-	"version": "7.1.1",
+	"version": "7.2.0",
 	"description": "",
 	"homepage": "https://github.com/Automattic/woocommerce-subscriptions-core",
 	"main": "Gruntfile.js",

package-lock.json

@@ -4,7 +4,7 @@
  *
  * @author   Prospress
  * @category WooCommerce Subscriptions/Templates
- * @version  1.0.0 - Migrated from WooCommerce Subscriptions v2.6.4
+ * @version  7.2.0 - Migrated from WooCommerce Subscriptions v2.6.4
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
@@ -31,7 +31,9 @@
 	<?php foreach ( $subscriptions as $subscription_id => $subscription ) : ?>
 		<tr class="order woocommerce-orders-table__row woocommerce-orders-table__row--status-<?php echo esc_attr( $subscription->get_status() ); ?>">
 			<td class="subscription-id order-number woocommerce-orders-table__cell woocommerce-orders-table__cell-subscription-id woocommerce-orders-table__cell-order-number" data-title="<?php esc_attr_e( 'ID', 'woocommerce-subscriptions' ); ?>">
-				<a href="<?php echo esc_url( $subscription->get_view_order_url() ); ?>"><?php echo esc_html( sprintf( _x( '#%s', 'hash before order number', 'woocommerce-subscriptions' ), $subscription->get_order_number() ) ); ?></a>
+				<a href="<?php echo esc_url( $subscription->get_view_order_url() ); ?>" aria-label="<?php echo esc_attr( sprintf( __( 'View subscription number %s', 'woocommerce' ), $subscription->get_order_number() ) ) ?>">
+					<?php echo esc_html( sprintf( _x( '#%s', 'hash before order number', 'woocommerce-subscriptions' ), $subscription->get_order_number() ) ); ?>
+				</a>
 				<?php do_action( 'woocommerce_my_subscriptions_after_subscription_id', $subscription ); ?>
 			</td>
 			<td class="subscription-status order-status woocommerce-orders-table__cell woocommerce-orders-table__cell-subscription-status woocommerce-orders-table__cell-order-status" data-title="<?php esc_attr_e( 'Status', 'woocommerce-subscriptions' ); ?>">

package.json

@@ -304,6 +304,122 @@ public function test_wcs_get_orders_with_meta_query() {
 			$this->assertIsArray( $subscriptions );
 			$this->assertEmpty( $subscriptions );
 		}
+	}
+
+	public function test_wcs_set_recurring_item_total() {
+		/**
+		 * Regular subscription item.
+		 */
+		$product = WCS_Helper_Product::create_simple_subscription_product( [ 'price' => 10 ] );
+
+		$line_item = new WC_Order_Item_Product();
+		$line_item->set_product( $product );
+		$line_item->set_quantity( 1 );
+		$line_item->set_total( 10 );
+		$line_item->set_subtotal( 10 );
+
+		wcs_set_recurring_item_total( $line_item );
+
+		$this->assertEquals( 10, $line_item->get_total() );
+		$this->assertEquals( 10, $line_item->get_subtotal() );
+
+		/**
+		 * Subscription item with trial.
+		 */
+		$trial_product = WCS_Helper_Product::create_simple_subscription_product(
+			[
+				'price'                     => 20,
+				'subscription_trial_length' => 10,
+			]
+		);
+
+		$line_item = new WC_Order_Item_Product();
+		$line_item->set_product( $trial_product );
+		$line_item->set_quantity( 1 );
+		$line_item->set_total( 0 ); // Trial product's are free initially.
+		$line_item->set_subtotal( 0 );
+
+		wcs_set_recurring_item_total( $line_item );
+
+		$this->assertEquals( 20, $line_item->get_total() );
+		$this->assertEquals( 20, $line_item->get_subtotal() );
+
+		/**
+		 * Subscription item with sign-up fee.
+		 */
+		$sign_up_fee_product = WCS_Helper_Product::create_simple_subscription_product(
+			[
+				'price'                    => 30,
+				'subscription_sign_up_fee' => 50,
+			]
+		);
+
+		$line_item = new WC_Order_Item_Product();
+		$line_item->set_product( $sign_up_fee_product );
+		$line_item->set_quantity( 1 );
+		$line_item->set_total( 80 ); // Initial total is the sum of the product price and sign-up fee.
+		$line_item->set_subtotal( 80 );
+
+		wcs_set_recurring_item_total( $line_item );
+
+		$this->assertEquals( 30, $line_item->get_total() );
+		$this->assertEquals( 30, $line_item->get_subtotal() );
+
+		/**
+		 * Subscription item with sign-up fee and trial.
+		 */
+		$sign_up_fee_trial_product = WCS_Helper_Product::create_simple_subscription_product(
+			[
+				'price'                     => 40,
+				'subscription_sign_up_fee'  => 60,
+				'subscription_trial_length' => 10,
+			]
+		);
+
+		$line_item->set_product( $sign_up_fee_trial_product );
+		$line_item->set_quantity( 1 );
+		$line_item->set_total( 60 ); // Initial total is just the sign-up fee.
+		$line_item->set_subtotal( 60 );
+
+		wcs_set_recurring_item_total( $line_item );
+
+		$this->assertEquals( 40, $line_item->get_total() );
+		$this->assertEquals( 40, $line_item->get_subtotal() );
+
+		/**
+		 * Simple product
+		 */
+		$simple_product = WC_Helper_Product::create_simple_product();
+
+		$line_item->set_product( $simple_product );
+		$line_item->set_quantity( 1 );
+		$line_item->set_total( 50 ); // Default price is $10.00. We set it to $50 here to confirm it's not changed.
+		$line_item->set_subtotal( 50 );
+
+		wcs_set_recurring_item_total( $line_item );
+
+		$this->assertEquals( 50, $line_item->get_total() );
+		$this->assertEquals( 50, $line_item->get_subtotal() );
+
+		/**
+		 * Subscription item with quantity.
+		 */
+		$sign_up_fee_trial_product = WCS_Helper_Product::create_simple_subscription_product(
+			[
+				'price'                     => 40,
+				'subscription_sign_up_fee'  => 60,
+				'subscription_trial_length' => 10,
+			]
+		);
+
+		$line_item->set_product( $sign_up_fee_trial_product );
+		$line_item->set_quantity( 2 );
+		$line_item->set_total( 120 ); // Initial total is just the sign-up fee.
+		$line_item->set_subtotal( 120 );
+
+		wcs_set_recurring_item_total( $line_item );
 
+		$this->assertEquals( 80, $line_item->get_total() );
+		$this->assertEquals( 80, $line_item->get_subtotal() );
 	}
 }

templates/myaccount/my-subscriptions.php

@@ -6,5 +6,5 @@
  * Author: Automattic
  * Author URI: https://woocommerce.com/
  * Requires WP: 5.6
- * Version: 7.1.1
+ * Version: 7.2.0
  */