Provide return URL with platform init request (#5315)

Author: reykjalin

changelog/add-dynamic-platform-checkout-return-url

@@ -0,0 +1,5 @@
+Significance: patch
+Type: add
+Comment: The change is for a feature that is not generally available at this moment
+
+

client/checkout/api/index.js

@@ -662,6 +662,7 @@ export default class WCPayAPI {
 				_wpnonce: nonce,
 				email: userEmail,
 				user_session: platformCheckoutUserSession,
+				return_url: window?.location?.href ?? '',
 			}
 		);
 	}

client/checkout/api/test/index.test.js

@@ -25,6 +25,7 @@ describe( 'WCPayAPI', () => {
 		expect( request ).toHaveBeenLastCalledWith( 'https://example.org/', {
 			_wpnonce: 'foo',
 			email: '[email protected]',
+			return_url: 'http://localhost/',
 			user_session: 'qwerty123',
 		} );
 	} );

includes/class-wc-payments.php

@@ -1088,8 +1088,9 @@ public static function ajax_init_platform_checkout() {
 
 		$session_cookie_name = apply_filters( 'woocommerce_cookie', 'wp_woocommerce_session_' . COOKIEHASH );
 
-		$email       = ! empty( $_POST['email'] ) ? wc_clean( wp_unslash( $_POST['email'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification
+		$email       = ! empty( $_POST['email'] ) ? wc_clean( wp_unslash( $_POST['email'] ) ) : '';
 		$user        = wp_get_current_user();
+		$return_url  = ! empty( $_POST['return_url'] ) ? wc_clean( wp_unslash( $_POST['return_url'] ) ) : '';
 		$customer_id = self::$customer_service->get_customer_id_by_user_id( $user->ID );
 		if ( null === $customer_id ) {
 			// create customer.
@@ -1127,6 +1128,7 @@ public static function ajax_init_platform_checkout() {
 				'is_subscriptions_plugin_active' => self::get_gateway()->is_subscriptions_plugin_active(),
 				'woocommerce_tax_display_cart'   => get_option( 'woocommerce_tax_display_cart' ),
 				'ship_to_billing_address_only'   => wc_ship_to_billing_address_only(),
+				'return_url'                     => $return_url,
 			],
 			'user_session'         => isset( $_REQUEST['user_session'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['user_session'] ) ) : null,
 		];