Skip to content

Add Avatax compatibility filters for Express Checkout #11204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mgascam wants to merge 4 commits into from
Closed

Add Avatax compatibility filters for Express Checkout #11204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14d73d4
Add Avatax compatibility filters for Express Checkout
mgascam Dec 12, 2025
7cec458
Add Avatax compatibility for Express Checkout and related tests
mgascam Dec 15, 2025
ec08e2f
Merge branch 'develop' into woopmnt-5494-express-payments-with-avatax…
mgascam Dec 22, 2025
2878127
Merge branch 'develop' into woopmnt-5494-express-payments-with-avatax…
mgascam Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions includes/class-wc-payments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,7 @@ public static function init() {
include_once __DIR__ . '/class-wc-payments-status.php';
include_once __DIR__ . '/class-wc-payments-token-service.php';
include_once __DIR__ . '/express-checkout/class-wc-payments-express-checkout-ajax-handler.php';
include_once __DIR__ . '/express-checkout/class-wc-payments-express-checkout-avatax-compatibility.php';
include_once __DIR__ . '/express-checkout/class-wc-payments-express-checkout-button-display-handler.php';
include_once __DIR__ . '/express-checkout/class-wc-payments-express-checkout-button-handler.php';
include_once __DIR__ . '/class-wc-payments-woopay-button-handler.php';
Expand Down
3 changes: 3 additions & 0 deletions includes/express-checkout/class-wc-payments-express-checkout-ajax-handler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ public function init() {
);
add_filter( 'rest_pre_dispatch', [ $this, 'tokenized_cart_store_api_address_normalization' ], 10, 3 );
add_filter( 'woocommerce_get_country_locale', [ $this, 'modify_country_locale_for_express_checkout' ], 20 );

// Initialize third-party plugin compatibility.
( new WC_Payments_Express_Checkout_Avatax_Compatibility() )->maybe_init();
}

/**
Expand Down
92 changes: 92 additions & 0 deletions includes/express-checkout/class-wc-payments-express-checkout-avatax-compatibility.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?php
/**
* Class WC_Payments_Express_Checkout_Avatax_Compatibility
*
* Handles Avatax plugin compatibility for Express Checkout (Apple Pay, Google Pay).
*
* @package WooCommerce\Payments
*/

if ( ! defined( 'ABSPATH' ) ) {
exit;
}

/**
* Avatax compatibility for Express Checkout.
*
* Avatax plugin's tax calculation may be skipped during Express Checkout because it doesn't
* recognize Store API requests as checkout context. This class forces Avatax to calculate
* taxes during Express Checkout by adding filters that return true for the readiness checks.
*/
class WC_Payments_Express_Checkout_Avatax_Compatibility {

/**
* Initialize hooks if Avatax plugin is active.
*
* @return void
*/
public function maybe_init() {
if ( ! $this->is_avatax_plugin_active() ) {
return;
}

add_filter( 'rest_pre_dispatch', [ $this, 'maybe_add_avatax_filters' ], 5, 3 );
}

/**
* Adds Avatax compatibility filters for Express Checkout.
*
* @param mixed $response Response to replace the requested version with.
* @param \WP_REST_Server $server Server instance.
* @param \WP_REST_Request $request Request used to generate the response.
*
* @return mixed
*/
public function maybe_add_avatax_filters( $response, $server, $request ) {
// Only add filters if we're in an Express Checkout context.
if ( ! $this->is_express_checkout_context() ) {
return $response;
}

// Force Avatax to calculate taxes during Express Checkout.
// These filters ensure Avatax recognizes the Store API checkout as a valid checkout context.
add_filter( 'wc_avatax_cart_needs_calculation', '__return_true' );
add_filter( 'wc_avatax_checkout_ready_for_calculation', '__return_true' );

return $response;
}

/**
* Check if Avatax plugin is active.
*
* @return bool True if Avatax is active, false otherwise.
*/
private function is_avatax_plugin_active() {
return class_exists( 'WC_AvaTax_Loader' ) || function_exists( 'wc_avatax' );
}

/**
* Check if we're in an express checkout context.
*
* @return bool True if we're in an express checkout context, false otherwise.
*/
private function is_express_checkout_context() {
// Only proceed if this is a Store API request.
if ( ! WC_Payments_Utils::is_store_api_request() ) {
return false;
}

// Check for the 'X-WooPayments-Tokenized-Cart' header using superglobals.
if ( 'true' !== sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART'] ?? '' ) ) ) {
return false;
}

// Verify the nonce from the 'X-WooPayments-Tokenized-Cart-Nonce' header using superglobals.
$nonce = sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART_NONCE'] ?? '' ) );
if ( ! wp_verify_nonce( $nonce, 'woopayments_tokenized_cart_nonce' ) ) {
return false;
}

return true;
}
}
154 changes: 154 additions & 0 deletions tests/unit/express-checkout/test-class-wc-payments-express-checkout-avatax-compatibility.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
<?php
/**
* These tests make assertions against class WC_Payments_Express_Checkout_Avatax_Compatibility.
*
* @package WooCommerce\Payments\Tests
*/

/**
* WC_Payments_Express_Checkout_Avatax_Compatibility_Test class.
*/
class WC_Payments_Express_Checkout_Avatax_Compatibility_Test extends WCPAY_UnitTestCase {
/**
* The test subject.
*
* @var WC_Payments_Express_Checkout_Avatax_Compatibility
*/
private $avatax_compatibility;

/**
* Sets up things all tests need.
*/
public function set_up() {
parent::set_up();

$this->avatax_compatibility = new WC_Payments_Express_Checkout_Avatax_Compatibility();
}

/**
* Test that Avatax compatibility filters are added during Express Checkout when Avatax is active.
*/
public function test_avatax_compatibility_filters_added_when_avatax_active_and_express_checkout() {
// Remove any existing filters first.
remove_all_filters( 'wc_avatax_cart_needs_calculation' );
remove_all_filters( 'wc_avatax_checkout_ready_for_calculation' );

// Simulate Avatax being active by defining the function.
if ( ! function_exists( 'wc_avatax' ) ) {
function wc_avatax() {
return new stdClass();
}
}

// Initialize the compatibility class (this checks if Avatax is active).
$this->avatax_compatibility->maybe_init();

// Create a valid Express Checkout request.
$request = new WP_REST_Request();
$request->set_header( 'X-WooPayments-Tokenized-Cart', 'true' );
$request->set_header( 'X-WooPayments-Tokenized-Cart-Nonce', wp_create_nonce( 'woopayments_tokenized_cart_nonce' ) );

// Simulate being in a Store API context.
$_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART'] = 'true';
$_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART_NONCE'] = wp_create_nonce( 'woopayments_tokenized_cart_nonce' );
$_REQUEST['rest_route'] = '/wc/store/v1/checkout';

// Call the method that should add Avatax compatibility filters.
$this->avatax_compatibility->maybe_add_avatax_filters( null, null, $request );

// Verify the filters were added and return true.
$this->assertTrue(
apply_filters( 'wc_avatax_cart_needs_calculation', false ),
'wc_avatax_cart_needs_calculation filter should return true during Express Checkout'
);
$this->assertTrue(
apply_filters( 'wc_avatax_checkout_ready_for_calculation', false ),
'wc_avatax_checkout_ready_for_calculation filter should return true during Express Checkout'
);

// Clean up.
unset( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART'] );
unset( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART_NONCE'] );
unset( $_REQUEST['rest_route'] );
}

/**
* Test that Avatax compatibility filters are NOT added when not in Express Checkout context.
*/
public function test_avatax_compatibility_filters_not_added_when_not_express_checkout() {
// Remove any existing filters first.
remove_all_filters( 'wc_avatax_cart_needs_calculation' );
remove_all_filters( 'wc_avatax_checkout_ready_for_calculation' );

// Simulate Avatax being active.
if ( ! function_exists( 'wc_avatax' ) ) {
function wc_avatax() {
return new stdClass();
}
}

// Initialize the compatibility class (this checks if Avatax is active).
$this->avatax_compatibility->maybe_init();

// Create a request WITHOUT Express Checkout headers.
$request = new WP_REST_Request();

// Clear any Express Checkout context.
unset( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART'] );
unset( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART_NONCE'] );

// Call the method.
$this->avatax_compatibility->maybe_add_avatax_filters( null, null, $request );

// Verify the filters were NOT added (should return the original false value).
$this->assertFalse(
apply_filters( 'wc_avatax_cart_needs_calculation', false ),
'wc_avatax_cart_needs_calculation filter should NOT be modified when not in Express Checkout'
);
$this->assertFalse(
apply_filters( 'wc_avatax_checkout_ready_for_calculation', false ),
'wc_avatax_checkout_ready_for_calculation filter should NOT be modified when not in Express Checkout'
);
}

/**
* Test that Avatax compatibility filters are NOT added when Avatax is not active.
*/
public function test_avatax_compatibility_filters_not_added_when_avatax_not_active() {
// Remove any existing filters first.
remove_all_filters( 'wc_avatax_cart_needs_calculation' );
remove_all_filters( 'wc_avatax_checkout_ready_for_calculation' );

// Note: wc_avatax function should not exist in a clean test environment,
// but we can't undefine functions in PHP. This test assumes a fresh environment
// or we test by checking the class doesn't exist.

// Create a valid Express Checkout request.
$request = new WP_REST_Request();
$request->set_header( 'X-WooPayments-Tokenized-Cart', 'true' );
$request->set_header( 'X-WooPayments-Tokenized-Cart-Nonce', wp_create_nonce( 'woopayments_tokenized_cart_nonce' ) );

$_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART'] = 'true';
$_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART_NONCE'] = wp_create_nonce( 'woopayments_tokenized_cart_nonce' );

// The method should check for WC_AvaTax_Loader class which won't exist.
// We test that when the class doesn't exist, filters are not added.

// For this test, we'll verify that filters aren't blindly added
// by checking that if we had a condition for Avatax not existing, it would work.
// Since we can't undefine wc_avatax(), we'll check the WC_AvaTax_Loader class.
// If Avatax was just defined in previous test, skip this assertion
// In real scenarios, Avatax would be detected by class_exists('WC_AvaTax_Loader').
if ( ! class_exists( 'WC_AvaTax_Loader' ) ) {
// The implementation should check for the class, not just the function.
$this->assertFalse(
class_exists( 'WC_AvaTax_Loader' ),
'WC_AvaTax_Loader class should not exist in test environment'
);
}

// Clean up.
unset( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART'] );
unset( $_SERVER['HTTP_X_WOOPAYMENTS_TOKENIZED_CART_NONCE'] );
}
}
Loading