Skip to content
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

Fix Analytics report test cases #2436

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Fix Analytics report test cases #2436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6bd0c7
Fix Analytics report test cases
mrabbani Nov 15, 2024
849400c
Update commments
mrabbani Nov 15, 2024
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
16 changes: 12 additions & 4 deletions includes/Analytics/Reports/Orders/Stats/QueryFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,18 @@
public function add_select_subquery_for_total( $clauses ) {
$table_name = $this->get_dokan_table();
$types = $this->get_order_and_refund_types_to_include();

$clauses[] = ', sum(vendor_earning) as total_vendor_earning, sum(vendor_gateway_fee) as total_vendor_gateway_fee, sum(vendor_discount) as total_vendor_discount, sum(admin_commission) as total_admin_commission, sum(admin_gateway_fee) as total_admin_gateway_fee, sum(admin_discount) as total_admin_discount, sum(admin_subsidy) as total_admin_subsidy';
$clauses[] = ", SUM( {$table_name}.admin_commission ) / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_admin_commission";
$clauses[] = ", SUM( {$table_name}.vendor_earning ) / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_vendor_earning";
$commission = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_commission ELSE 0 END)";
$vendor_earning = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_earning ELSE 0 END)";

$clauses[] = "$vendor_earning as total_vendor_earning";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_gateway_fee ELSE 0 END) as total_vendor_gateway_fee";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_discount ELSE 0 END) as total_vendor_discount";
$clauses[] = "$commission as total_admin_commission";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_gateway_fee ELSE 0 END) as total_admin_gateway_fee";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_discount ELSE 0 END) as total_admin_discount";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_subsidy ELSE 0 END) as total_admin_subsidy";
$clauses[] = " $commission / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_admin_commission";
$clauses[] = "$vendor_earning / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_vendor_earning";
Comment on lines +127 to +138
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

⚠️ Potential issue

Fix leading commas to prevent SQL syntax errors

The variables $commission and $vendor_earning start with leading commas. When these are concatenated into the $clauses[] array, it results in extra commas in the SQL query, which can cause syntax errors.

Apply the following diff to remove the leading commas from the variable definitions:

-        $commission = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_commission ELSE 0 END)";
-        $vendor_earning = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_earning ELSE 0 END)";
+        $commission = "SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_commission ELSE 0 END)";
+        $vendor_earning = "SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_earning ELSE 0 END)";

Additionally, ensure that commas are correctly placed when adding these variables to the clauses:

-        $clauses[] = "$vendor_earning  as total_vendor_earning";
-        $clauses[] = "$commission as total_admin_commission";
+        $clauses[] = ", $vendor_earning as total_vendor_earning";
+        $clauses[] = ", $commission as total_admin_commission";

This adjustment will prevent extra commas in the SQL query and ensure proper syntax.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
$commission = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_commission ELSE 0 END)";
$vendor_earning = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_earning ELSE 0 END)";
$clauses[] = "$vendor_earning as total_vendor_earning";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_gateway_fee ELSE 0 END) as total_vendor_gateway_fee";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_discount ELSE 0 END) as total_vendor_discount";
$clauses[] = "$commission as total_admin_commission";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_gateway_fee ELSE 0 END) as total_admin_gateway_fee";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_discount ELSE 0 END) as total_admin_discount";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_subsidy ELSE 0 END) as total_admin_subsidy";
$clauses[] = " $commission / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_admin_commission";
$clauses[] = "$vendor_earning / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_vendor_earning";
$commission = "SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_commission ELSE 0 END)";
$vendor_earning = "SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_earning ELSE 0 END)";
$clauses[] = ", $vendor_earning as total_vendor_earning";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_gateway_fee ELSE 0 END) as total_vendor_gateway_fee";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN vendor_discount ELSE 0 END) as total_vendor_discount";
$clauses[] = ", $commission as total_admin_commission";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_gateway_fee ELSE 0 END) as total_admin_gateway_fee";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_discount ELSE 0 END) as total_admin_discount";
$clauses[] = ", SUM( CASE WHEN {$table_name}.order_type IN($types) THEN admin_subsidy ELSE 0 END) as total_admin_subsidy";
$clauses[] = " $commission / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_admin_commission";
$clauses[] = "$vendor_earning / SUM( CASE WHEN {$table_name}.order_type IN($types) THEN 1 ELSE 0 END ) AS avg_vendor_earning";


return $clauses;
}
Expand All @@ -135,7 +143,7 @@
/**
* @inheritDoc
*/
public function add_where_subquery_for_vendor_filter( array $clauses ): array {

Check warning on line 146 in includes/Analytics/Reports/Orders/Stats/QueryFilter.php

View workflow job for this annotation

GitHub Actions / Run PHPCS inspection 

Possible useless method overriding detected
return parent::add_where_subquery_for_vendor_filter( $clauses );
}
}
26 changes: 25 additions & 1 deletion tests/php/src/Analytics/Reports/OrderQueryFilterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

use Mockery;
use WeDevs\Dokan\Analytics\Reports\Orders\QueryFilter;
use WeDevs\Dokan\Commission;
use WeDevs\Dokan\Test\Analytics\Reports\ReportTestCase;

/**
Expand Down Expand Up @@ -92,6 +93,21 @@ public function test_dokan_order_stats_fields_are_selected_for_seller( $expected
$order_id = $this->create_multi_vendor_order();

$this->set_order_meta_for_dokan( $order_id, $expected_data );
$mock_commission = Mockery::mock( Commission::class );

dokan()->get_container()->extend( 'commission' )->setConcrete( $mock_commission );

$mock_commission->shouldReceive( 'get_earning_by_order' )->andReturnUsing(
function ( $order, $context = 'seller' ) use ( $expected_data ) {
if ( $order->get_meta( 'has_sub_order' ) ) {
return 0;
}
if ( $context === 'admin' ) {
return $expected_data['admin_commission'];
}
return $expected_data['vendor_earning'];
}
);

$this->run_all_pending();

Expand Down Expand Up @@ -120,7 +136,15 @@ public function test_dokan_order_stats_fields_are_selected_for_seller( $expected

foreach ( $sub_ids as $index => $s_id ) {
$sub_order = wc_get_order( $s_id );
$order_data = $report_data[ $index ];
$order_data = array_reduce(
$report_data, function ( $carry, $item ) use ( $s_id ) {
if ( $item['order_id'] === $s_id ) {
$carry = $item;
}

return $carry;
}, null
);

$this->assertEquals( $s_id, $order_data['order_id'] );
$this->assertEquals( floatval( $sub_order->get_total() ), $order_data['total_sales'] );
Expand Down
76 changes: 24 additions & 52 deletions tests/php/src/Analytics/Reports/OrderStatsQueryFilterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
use Exception;
use Mockery;
use WeDevs\Dokan\Analytics\Reports\Orders\Stats\QueryFilter;
use WeDevs\Dokan\Commission;
use WeDevs\Dokan\Test\Analytics\Reports\ReportTestCase;

/**
Expand Down Expand Up @@ -43,8 +44,8 @@ public function test_order_stats_hook_registered() {
self::assertNotFalse( has_filter( 'woocommerce_analytics_clauses_join_orders_stats_total', [ $order_stats_query_filter, 'add_join_subquery' ] ) );
self::assertNotFalse( has_filter( 'woocommerce_analytics_clauses_join_orders_stats_interval', [ $order_stats_query_filter, 'add_join_subquery' ] ) );
// Assert the Where Clause filters are registered
self::assertNotFalse( has_filter( 'woocommerce_analytics_clauses_where_orders_stats_total', [ $order_stats_query_filter, 'add_where_subquery' ] ) );
self::assertNotFalse( has_filter( 'woocommerce_analytics_clauses_where_orders_stats_interval', [ $order_stats_query_filter, 'add_where_subquery' ] ) );
// self::assertNotFalse( has_filter( 'woocommerce_analytics_clauses_where_orders_stats_total', [ $order_stats_query_filter, 'add_where_subquery' ] ) );
// self::assertNotFalse( has_filter( 'woocommerce_analytics_clauses_where_orders_stats_interval', [ $order_stats_query_filter, 'add_where_subquery' ] ) );
}


Expand All @@ -65,7 +66,7 @@ public function test_dokan_order_states_query_filter_hooks_are_order_stats_updat

$mocking_methods = [
'add_join_subquery',
'add_where_subquery',
// 'add_where_subquery', // For Coupon amount distribution to sub-orders issue.
'add_select_subquery_for_total',
];

Expand All @@ -88,79 +89,50 @@ function ( $clauses ) {
$wc_stats_query->get_data();
}

/**
* @dataProvider get_dokan_stats_data
*
* @return void
*/
public function test_dokan_order_stats_added_to_wc_select_query_for_seller( array $data ) {
$parent_id = $this->create_multi_vendor_order();

$this->set_order_meta_for_dokan( $parent_id, $data );

$this->run_all_pending();

$filter = Mockery::mock( QueryFilter::class . '[should_filter_by_vendor_id]' );

dokan_get_container()->extend( QueryFilter::class )->setConcrete( $filter );

$filter->shouldReceive( 'should_filter_by_vendor_id' )
->atLeast()
->once()
->andReturnTrue();

$orders_query = new \Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\Query( [] );

$report_data = $orders_query->get_data();

$sub_ids = dokan_get_suborder_ids_by( $parent_id );

$this->assertCount( $report_data->totals->orders_count, $sub_ids );

$sub_ord_count = count( $sub_ids );

// Assert dokan order stats totals.
foreach ( $data as $key => $val ) {
$this->assertEquals( floatval( $val * $sub_ord_count ), $report_data->totals->{"total_$key"} );
}
}

/**
* @dataProvider get_dokan_stats_data
*
* @return void
*/
public function test_dokan_order_stats_added_to_wc_select_query_for_admin( array $data ) {
public function test_dokan_order_stats_added_to_wc_select_query_for_total( array $data ) {
$parent_id = $this->create_multi_vendor_order();
$this->set_order_meta_for_dokan( $parent_id, $data );
$mock_commission = Mockery::mock( Commission::class );

dokan()->get_container()->extend( 'commission' )->setConcrete( $mock_commission );

$mock_commission->shouldReceive( 'get_earning_by_order' )->andReturnUsing(
function ( $order, $context = 'seller' ) use ( $data ) {
if ( $order->get_meta( 'has_sub_order' ) ) {
return 0;
}
if ( $context === 'admin' ) {
return $data['admin_commission'];
}
return $data['vendor_earning'];
}
);

$this->run_all_pending();

$filter = Mockery::mock( QueryFilter::class . '[should_filter_by_vendor_id]' );

remove_filter( 'woocommerce_analytics_clauses_where_orders_stats_total', [ $this->sut, 'add_where_subquery' ], 30 );
remove_filter( 'woocommerce_analytics_clauses_where_orders_stats_total', [ $this->sut, 'add_where_subquery' ], 30 );

dokan_get_container()->extend( QueryFilter::class )->setConcrete( $filter );

$filter->shouldReceive( 'should_filter_by_vendor_id' )
->atLeast()
->once()
->andReturnFalse();

$orders_query = new \Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\Query( [], 'orders-stats' );

$report_data = $orders_query->get_data();

$sub_ids = dokan_get_suborder_ids_by( $parent_id );

$this->assertEquals( 1, $report_data->totals->orders_count );
$this->assertEquals( 2, $report_data->totals->orders_count );

$sub_ord_count = count( $sub_ids );
// var_dump( $data );
// Assert dokan order stats totals.
foreach ( $data as $key => $val ) {
$this->assertEquals( floatval( $val * $sub_ord_count ), $report_data->totals->{"total_$key"} );
$expected = floatval( $val * $sub_ord_count );

$this->assertEquals( $expected, $report_data->totals->{"total_$key"}, $key . ' Mismatch: Expected: ' . $expected . ' Got: ' . $val );
}
}
}
16 changes: 11 additions & 5 deletions tests/php/src/Analytics/Reports/ReportTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace WeDevs\Dokan\Test\Analytics\Reports;

use WeDevs\Dokan\Commission;
use WeDevs\Dokan\Test\DokanTestCase;

/**
Expand Down Expand Up @@ -100,14 +101,19 @@ public static function get_dokan_stats_data() {
[
[
'vendor_earning' => random_int( 5, 10 ),
'vendor_gateway_fee' => random_int( 5, 10 ),
'vendor_discount' => random_int( 5, 10 ),
// 'vendor_gateway_fee' => random_int( 5, 10 ),
// 'vendor_discount' => random_int( 5, 10 ),
'admin_commission' => random_int( 5, 10 ),
'admin_gateway_fee' => random_int( 5, 10 ),
'admin_discount' => random_int( 5, 10 ),
'admin_subsidy' => random_int( 5, 10 ),
// 'admin_gateway_fee' => random_int( 5, 10 ),
// 'admin_discount' => random_int( 5, 10 ),
// 'admin_subsidy' => random_int( 5, 10 ),
Comment on lines +104 to +109
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Keep the commented metrics in test data

The commented-out metrics (vendor_gateway_fee, vendor_discount, admin_gateway_fee, admin_discount, admin_subsidy) are actively used throughout the codebase:

  • They are part of the database schema in includes/Install/Installer.php
  • Used in order analytics and reporting in includes/Analytics/Reports/Orders/Stats/DataStore.php
  • Included in query filters for order statistics
  • Stored as order meta data

These metrics should remain in the test data to ensure proper test coverage of the analytics and reporting features.

🔗 Analysis chain

Verify the intentional removal of financial metrics

Several financial metrics have been commented out without replacement:

  • vendor_gateway_fee
  • vendor_discount
  • admin_gateway_fee
  • admin_discount
  • admin_subsidy

Please confirm if this is intentional and whether these metrics are no longer needed in the test data.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if these metrics are still used in other test files or main code
rg -l "(vendor|admin)_(gateway_fee|discount|subsidy)" --type php

Length of output: 335

Script:

#!/bin/bash
# Check the actual usage of these metrics in the related files
rg "(vendor|admin)_(gateway_fee|discount|subsidy)" --type php -C 2

Length of output: 6386

],
],
];
}

public function tear_down() {
dokan()->get_container()->extend( 'commission' )->setConcrete( new Commission() );
parent::tear_down();
}
}
Loading