Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Tax Report Pagination (#49562) 

* Parse limits and offsets

* Remove unsused variable

* Add tests for pagination

* Add changefile(s) from automation for the following project(s): woocommerce

* Add missing doc

* Use get_sql_clause limit

---------

Co-authored-by: github-actions <github-actions@github.com>
This commit is contained in:
Jorge M 2024-07-19 10:08:02 +02:00 committed by GitHub
parent 1a7619a4fa
commit 0240a50ec0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 229 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/49562-fix-tax-report-pagination Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: fix
Fix Analytics - Tax Report Pagination

3
plugins/woocommerce/src/Admin/API/Reports/Taxes/DataStore.php
View File

@ -146,8 +146,6 @@ class DataStore extends ReportsDataStore implements DataStoreInterface {
public function get_data( $query_args ) { public function get_data( $query_args ) {
global $wpdb; global $wpdb;
$table_name = self::get_db_table_name();
// These defaults are only partially applied when used via REST API, as that has its own defaults. // These defaults are only partially applied when used via REST API, as that has its own defaults.
$defaults = array( $defaults = array(
'per_page' => get_option( 'posts_per_page' ), 'per_page' => get_option( 'posts_per_page' ),
@ -204,6 +202,7 @@ class DataStore extends ReportsDataStore implements DataStoreInterface {
$this->subquery->add_sql_clause( 'select', $this->selected_columns( $query_args ) ); $this->subquery->add_sql_clause( 'select', $this->selected_columns( $query_args ) );
$this->subquery->add_sql_clause( 'group_by', ", {$wpdb->prefix}woocommerce_order_items.order_item_name, {$wpdb->prefix}woocommerce_order_itemmeta.meta_value" ); $this->subquery->add_sql_clause( 'group_by', ", {$wpdb->prefix}woocommerce_order_items.order_item_name, {$wpdb->prefix}woocommerce_order_itemmeta.meta_value" );
$this->subquery->add_sql_clause( 'order_by', $this->get_sql_clause( 'order_by' ) ); $this->subquery->add_sql_clause( 'order_by', $this->get_sql_clause( 'order_by' ) );
$this->subquery->add_sql_clause( 'limit', $this->get_sql_clause( 'limit' ) );
$taxes_query = $this->subquery->get_query_statement(); $taxes_query = $this->subquery->get_query_statement();

330
plugins/woocommerce/tests/legacy/unit-tests/woocommerce-admin/api/reports-taxes.php
View File

@ -141,98 +141,14 @@ class WC_Admin_Tests_API_Reports_Taxes extends WC_REST_Unit_Test_Case {
* @since 3.5.0 * @since 3.5.0
*/ */
public function test_get_reports_taxes_param() { public function test_get_reports_taxes_param() {
global $wpdb;
wp_set_current_user( $this->user );
WC_Helper_Reports::reset_stats_dbs();
// Populate all of the data. $this->create_sample_taxes();
$product = new WC_Product_Simple();
$product->set_name( 'Test Product' );
$product->set_regular_price( 25 );
$product->save();
$wpdb->insert( $request = new WP_REST_Request( 'GET', $this->endpoint );
$wpdb->prefix . 'woocommerce_tax_rates',
array(
'tax_rate_id' => 1,
'tax_rate' => '7',
'tax_rate_country' => 'US',
'tax_rate_state' => 'NY',
'tax_rate_name' => 'TestTax',
'tax_rate_priority' => 1,
'tax_rate_order' => 1,
)
);
$wpdb->insert(
$wpdb->prefix . 'woocommerce_tax_rates',
array(
'tax_rate_id' => 2,
'tax_rate' => '8',
'tax_rate_country' => 'CA',
'tax_rate_state' => 'ON',
'tax_rate_name' => 'TestTax 2',
'tax_rate_priority' => 1,
'tax_rate_order' => 1,
)
);
$tax_item = new WC_Order_Item_Tax();
$tax_item->set_rate( 1 );
$tax_item->set_tax_total( 5 );
$tax_item->set_shipping_tax_total( 2 );
$order = WC_Helper_Order::create_order( 1, $product );
$order->add_item( $tax_item );
$order->set_status( 'completed' );
$order->set_total( 100 ); // $25 x 4.
$order->save();
$tax_item_ca = new WC_Order_Item_Tax();
$tax_item_ca->set_rate( 2 );
$tax_item_ca->set_tax_total( 15 );
$tax_item_ca->set_shipping_tax_total( 0 );
$order_ca = WC_Helper_Order::create_order( 1, $product );
$order_ca->set_shipping_state( 'ON' );
$order_ca->set_shipping_country( 'CA' );
$order_ca->add_item( $tax_item_ca );
$order_ca->set_status( 'completed' );
$order_ca->set_total( 100 ); // $25 x 4.
$order_ca->save();
$order_ca->calculate_totals( true );
// @todo Remove this once order data is synced to wc_order_tax_lookup
$wpdb->insert(
$wpdb->prefix . 'wc_order_tax_lookup',
array(
'order_id' => $order->get_id(),
'tax_rate_id' => 1,
'date_created' => gmdate( 'Y-m-d H:i:s' ),
'shipping_tax' => 2,
'order_tax' => 5,
'total_tax' => 7,
)
);
$wpdb->insert(
$wpdb->prefix . 'wc_order_tax_lookup',
array(
'order_id' => $order_ca->get_id(),
'tax_rate_id' => 2,
'date_created' => gmdate( 'Y-m-d H:i:s' ),
'shipping_tax' => 2,
'order_tax' => 5,
'total_tax' => 7,
)
);
WC_Helper_Queue::run_all_pending();
$response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->endpoint ) );
$request = new WP_REST_Request( 'GET', $this->endpoint );
$request->set_query_params( $request->set_query_params(
array( array(
'taxes' => '1,2', 'taxes' => '1,2,3',
'per_page' => '2',
) )
); );
$response = $this->server->dispatch( $request ); $response = $this->server->dispatch( $request );
@ -241,29 +157,74 @@ class WC_Admin_Tests_API_Reports_Taxes extends WC_REST_Unit_Test_Case {
$this->assertEquals( 200, $response->get_status() ); $this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 2, count( $reports ) ); $this->assertEquals( 2, count( $reports ) );
$tax_report = reset( $reports ); // Results are ordered by tax_rate_id desc by default.
$expected = array(
3 => array(
'tax_rate_id' => 3,
'tax_rate' => 9.0,
'country' => 'ES',
'state' => 'B',
'total_tax' => 9.9 * 2,
'order_tax' => 9.0 * 2,
'shipping_tax' => 0.9 * 2,
'orders_count' => 2,
),
2 => array(
'tax_rate_id' => 2,
'tax_rate' => 8.0,
'country' => 'CA',
'state' => 'ON',
'total_tax' => 8.8,
'order_tax' => 8,
'shipping_tax' => 0.8,
'orders_count' => 1,
),
$this->assertEquals( 2, $tax_report['tax_rate_id'] ); );
$this->assertEquals( 8.0, $tax_report['tax_rate'] );
$this->assertEquals( 'CA', $tax_report['country'] );
$this->assertEquals( 'ON', $tax_report['state'] );
$this->assertEquals( 8.8, $tax_report['total_tax'] );
$this->assertEquals( 8, $tax_report['order_tax'] );
$this->assertEquals( 0.8, $tax_report['shipping_tax'] );
$this->assertEquals( 1, $tax_report['orders_count'] );
$tax_report = next( $reports ); foreach ( $reports as $tax_report ) {
$expected_report = $expected[ $tax_report['tax_rate_id'] ];
foreach ( array_keys( $expected_report ) as $key ) {
$this->assertEquals( $expected_report[ $key ], $tax_report[ $key ] );
}
}
$this->assertEquals( 1, $tax_report['tax_rate_id'] ); // Get next page.
$this->assertEquals( 7, $tax_report['tax_rate'] ); $request->set_query_params(
$this->assertEquals( 'US', $tax_report['country'] ); array(
$this->assertEquals( 'NY', $tax_report['state'] ); 'taxes' => '1,2,3',
$this->assertEquals( 7, $tax_report['total_tax'] ); 'per_page' => '2',
$this->assertEquals( 5, $tax_report['order_tax'] ); 'page' => '2',
$this->assertEquals( 2, $tax_report['shipping_tax'] ); )
$this->assertEquals( 1, $tax_report['orders_count'] ); );
$response = $this->server->dispatch( $request );
$reports = $response->get_data();
$this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 1, count( $reports ) );
$expected = array(
1 => array(
'tax_rate_id' => 1,
'tax_rate' => 7,
'country' => 'US',
'state' => 'NY',
'total_tax' => 7,
'order_tax' => 5,
'shipping_tax' => 2,
'orders_count' => 1,
),
);
foreach ( $reports as $tax_report ) {
$expected_report = $expected[ $tax_report['tax_rate_id'] ];
foreach ( array_keys( $expected_report ) as $key ) {
$this->assertEquals( $expected_report[ $key ], $tax_report[ $key ] );
}
}
} }
/** /**
* Test getting reports without valid permissions. * Test getting reports without valid permissions.
* *
@ -300,4 +261,161 @@ class WC_Admin_Tests_API_Reports_Taxes extends WC_REST_Unit_Test_Case {
$this->assertArrayHasKey( 'shipping_tax', $properties ); $this->assertArrayHasKey( 'shipping_tax', $properties );
$this->assertArrayHasKey( 'orders_count', $properties ); $this->assertArrayHasKey( 'orders_count', $properties );
} }
/**
* Create sample taxes.
*/
protected function create_sample_taxes() {
global $wpdb;
wp_set_current_user( $this->user );
WC_Helper_Reports::reset_stats_dbs();
// Populate all of the data.
$product = new WC_Product_Simple();
$product->set_name( 'Test Product' );
$product->set_regular_price( 25 );
$product->save();
$wpdb->insert(
$wpdb->prefix . 'woocommerce_tax_rates',
array(
'tax_rate_id' => 1,
'tax_rate' => '7',
'tax_rate_country' => 'US',
'tax_rate_state' => 'NY',
'tax_rate_name' => 'TestTax',
'tax_rate_priority' => 1,
'tax_rate_order' => 1,
)
);
$wpdb->insert(
$wpdb->prefix . 'woocommerce_tax_rates',
array(
'tax_rate_id' => 2,
'tax_rate' => '8',
'tax_rate_country' => 'CA',
'tax_rate_state' => 'ON',
'tax_rate_name' => 'TestTax 2',
'tax_rate_priority' => 1,
'tax_rate_order' => 1,
)
);
$wpdb->insert(
$wpdb->prefix . 'woocommerce_tax_rates',
array(
'tax_rate_id' => 3,
'tax_rate' => '9',
'tax_rate_country' => 'ES',
'tax_rate_state' => 'B',
'tax_rate_name' => 'TestTax 3',
'tax_rate_priority' => 1,
'tax_rate_order' => 1,
)
);
$tax_item = new WC_Order_Item_Tax();
$tax_item->set_rate( 1 );
$tax_item->set_tax_total( 5 );
$tax_item->set_shipping_tax_total( 2 );
$order = WC_Helper_Order::create_order( 1, $product );
$order->add_item( $tax_item );
$order->set_status( 'completed' );
$order->set_total( 100 ); // $25 x 4.
$order->save();
$tax_item_ca = new WC_Order_Item_Tax();
$tax_item_ca->set_rate( 2 );
$tax_item_ca->set_tax_total( 15 );
$tax_item_ca->set_shipping_tax_total( 0 );
$order_ca = WC_Helper_Order::create_order( 1, $product );
$order_ca->set_shipping_state( 'ON' );
$order_ca->set_shipping_country( 'CA' );
$order_ca->add_item( $tax_item_ca );
$order_ca->set_status( 'completed' );
$order_ca->set_total( 100 ); // $25 x 4.
$order_ca->save();
$order_ca->calculate_totals( true );
$tax_item_es = new WC_Order_Item_Tax();
$tax_item_es->set_rate( 3 );
$tax_item_es->set_tax_total( 15 );
$tax_item_es->set_shipping_tax_total( 0 );
$order_es = WC_Helper_Order::create_order( 1, $product );
$order_es->set_shipping_state( 'B' );
$order_es->set_shipping_country( 'ES' );
$order_es->add_item( $tax_item_es );
$order_es->set_status( 'completed' );
$order_es->set_total( 100 ); // $25 x 4.
$order_es->save();
$order_es->calculate_totals( true );
$tax_item_es_2 = new WC_Order_Item_Tax();
$tax_item_es_2->set_rate( 3 );
$tax_item_es_2->set_tax_total( 15 );
$tax_item_es_2->set_shipping_tax_total( 0 );
$order_es_2 = WC_Helper_Order::create_order( 1, $product );
$order_es_2->set_shipping_state( 'B' );
$order_es_2->set_shipping_country( 'ES' );
$order_es_2->add_item( $tax_item_es_2 );
$order_es_2->set_status( 'completed' );
$order_es_2->set_total( 100 ); // $25 x 4.
$order_es_2->save();
$order_es_2->calculate_totals( true );
// @todo Remove this once order data is synced to wc_order_tax_lookup
$wpdb->insert(
$wpdb->prefix . 'wc_order_tax_lookup',
array(
'order_id' => $order->get_id(),
'tax_rate_id' => 1,
'date_created' => gmdate( 'Y-m-d H:i:s' ),
'shipping_tax' => 2,
'order_tax' => 5,
'total_tax' => 7,
)
);
$wpdb->insert(
$wpdb->prefix . 'wc_order_tax_lookup',
array(
'order_id' => $order_ca->get_id(),
'tax_rate_id' => 2,
'date_created' => gmdate( 'Y-m-d H:i:s' ),
'shipping_tax' => 2,
'order_tax' => 5,
'total_tax' => 7,
)
);
$wpdb->insert(
$wpdb->prefix . 'wc_order_tax_lookup',
array(
'order_id' => $order_es->get_id(),
'tax_rate_id' => 3,
'date_created' => gmdate( 'Y-m-d H:i:s' ),
'shipping_tax' => 2,
'order_tax' => 5,
'total_tax' => 7,
)
);
$wpdb->insert(
$wpdb->prefix . 'wc_order_tax_lookup',
array(
'order_id' => $order_es_2->get_id(),
'tax_rate_id' => 3,
'date_created' => gmdate( 'Y-m-d H:i:s' ),
'shipping_tax' => 2,
'order_tax' => 5,
'total_tax' => 7,
)
);
WC_Helper_Queue::run_all_pending();
}
} }