Enhancement: Make analytics reports compatible with Dokan #2318
Conversation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
includes/Analytics/Reports/Customers/QueryFilter.php (1)
24-28: Consider removing or uncommenting code.There are several commented-out lines of code. If these are not needed, consider removing them for clarity.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (8)
- docs/analytics/reports.md (1 hunks)
- includes/Analytics/Reports/Coupons/QueryFilter.php (1 hunks)
- includes/Analytics/Reports/Coupons/Stats/QueryFilter.php (1 hunks)
- includes/Analytics/Reports/Customers/QueryFilter.php (1 hunks)
- includes/Analytics/Reports/Customers/Stats/QueryFilter.php (1 hunks)
- includes/Analytics/Reports/OrderType.php (1 hunks)
- includes/Analytics/Reports/Products/Stats/QueryFilter.php (1 hunks)
- includes/DependencyManagement/Providers/AnalyticsServiceProvider.php (1 hunks)
Files skipped from review as they are similar to previous changes (5)
- includes/Analytics/Reports/Coupons/QueryFilter.php
- includes/Analytics/Reports/Coupons/Stats/QueryFilter.php
- includes/Analytics/Reports/OrderType.php
- includes/Analytics/Reports/Products/Stats/QueryFilter.php
- includes/DependencyManagement/Providers/AnalyticsServiceProvider.php
Additional context used
Markdownlint
docs/analytics/reports.md
2-2: null
Link fragments should be valid(MD051, link-fragments)
Additional comments not posted (3)
docs/analytics/reports.md (1)
1-19: Well-structured documentation.The documentation provides a clear and concise guide for handling Dokan orders and customizing the WooCommerce analytics datastore.
Tools
Markdownlint
2-2: null
Link fragments should be valid(MD051, link-fragments)
includes/Analytics/Reports/Customers/QueryFilter.php (1)
12-64: LGTM!The implementation of the
QueryFilterclass is well-structured and correctly utilizes WordPress hooks to modify WooCommerce analytics queries.includes/Analytics/Reports/Customers/Stats/QueryFilter.php (1)
7-80: Well-implemented class for query filtering.The
QueryFilterclass effectively extends the functionality ofCustomersQueryFilterwith clear logic for modifying SQL clauses.
| @@ -0,0 +1,19 @@ | |||
| - [Introduction](#introduction) | |||
| - [Custom Products Stats Datastore](#custom-products-stats-datastore) | |||
There was a problem hiding this comment.
Fix the link fragment in the table of contents.
The link fragment for "Custom Products Stats Datastore" should match the section heading.
- [Custom Products Stats Datastore](#custom-products-stats-datastore)
+ [Custom Stats Datastore](#custom-stats-datastore)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.
| - [Custom Products Stats Datastore](#custom-products-stats-datastore) | |
| [Custom Stats Datastore](#custom-stats-datastore) |
Tools
Markdownlint
2-2: null
Link fragments should be valid(MD051, link-fragments)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- dokan-class.php (1 hunks)
- includes/DependencyManagement/Providers/CommonServiceProvider.php (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- dokan-class.php
- includes/DependencyManagement/Providers/CommonServiceProvider.php
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- includes/Analytics/Reports/BaseQueryFilter.php (1 hunks)
- tests/php/src/Analytics/Reports/Orders/QueryFilterTest.php (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- tests/php/src/Analytics/Reports/Orders/QueryFilterTest.php
Additional context used
GitHub Check: Run PHPCS inspection
includes/Analytics/Reports/BaseQueryFilter.php
[warning] 70-70:
Processing form data without nonce verification.
Additional comments not posted (2)
includes/Analytics/Reports/BaseQueryFilter.php (2)
14-24: Constructor and hook registration are well-implemented.The constructor method correctly initializes the class and registers hooks, adhering to good OOP practices and WordPress standards.
87-89: Method implementation is straightforward and clear.The
should_filter_by_seller_idmethod is implemented correctly and serves its purpose without any apparent issues.
| public function add_join_subquery( array $clauses ): array { | ||
| global $wpdb; | ||
|
|
||
| $dokan_order_state_table = $this->get_dokan_table(); | ||
|
|
||
| $clauses[] = "JOIN {$dokan_order_state_table} ON {$wpdb->prefix}{$this->wc_table}.order_id = {$dokan_order_state_table}.order_id"; | ||
|
|
||
| return array_unique( $clauses ); | ||
| } |
There was a problem hiding this comment.
Ensure SQL injection prevention in JOIN clause.
The method dynamically constructs a JOIN clause which could be vulnerable to SQL injection if not properly sanitized.
Consider using $wpdb->prepare to ensure that the table names are safely included in the query.
| public function add_where_subquery( array $clauses ): array { | ||
| $dokan_order_state_table = $this->get_dokan_table(); | ||
| $order_types = $this->get_order_and_refund_types_to_include(); | ||
|
|
||
| $clauses[] = "AND {$dokan_order_state_table}.order_type in ( $order_types ) "; | ||
|
|
||
| $clauses = $this->add_where_subquery_for_refund( $clauses ); | ||
| $clauses = $this->add_where_subquery_for_seller_filter( $clauses ); | ||
|
|
||
| return array_unique( $clauses ); | ||
| } |
There was a problem hiding this comment.
Security concern: Potential SQL injection in WHERE clause.
The method constructs SQL conditions using unescaped data. This could lead to SQL injection vulnerabilities.
Use parameterized queries or $wpdb->prepare to ensure data is safely included.
| protected function add_where_subquery_for_refund( array $clauses ): array { | ||
| if ( ! isset( $_GET['refunds'] ) ) { | ||
| return $clauses; | ||
| } | ||
|
|
||
| $dokan_order_state_table = $this->get_dokan_table(); | ||
| $order_types = $this->get_refund_types_to_include(); | ||
|
|
||
| $clauses[] = "AND {$dokan_order_state_table}.order_type in ( $order_types ) "; | ||
|
|
||
| return $clauses; |
There was a problem hiding this comment.
Address CSRF vulnerability by adding nonce verification.
The method uses a GET parameter to modify the database query, which should be accompanied by nonce verification to prevent CSRF attacks.
Implement nonce verification when processing the 'refunds' GET parameter.
Would you like me to generate a code snippet for nonce verification?
Tools
GitHub Check: Run PHPCS inspection
[warning] 70-70:
Processing form data without nonce verification.
| protected function get_seller_id() { | ||
| if ( ! is_user_logged_in() ) { | ||
| return 0; | ||
| } | ||
|
|
||
| if ( ! current_user_can( 'manage_options' ) ) { | ||
| return dokan_get_current_user_id(); | ||
| } | ||
|
|
||
| return (int) ( wp_unslash( $_GET['seller'] ?? 0 ) ); // phpcs:ignore | ||
| } |
There was a problem hiding this comment.
Ensure proper sanitization and validation of user input.
The method retrieves the seller ID from a GET parameter. Ensure that this value is properly sanitized and validated to prevent security issues.
Consider using more rigorous sanitization for the 'seller' GET parameter to ensure it is safe to use in queries.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- includes/Analytics/Reports/BaseQueryFilter.php (1 hunks)
- tests/php/src/Analytics/Reports/Orders/QueryFilterTest.php (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- tests/php/src/Analytics/Reports/Orders/QueryFilterTest.php
Additional context used
GitHub Check: Run PHPCS inspection
includes/Analytics/Reports/BaseQueryFilter.php
[warning] 70-70:
Processing form data without nonce verification.
Additional comments not posted (11)
includes/Analytics/Reports/BaseQueryFilter.php (11)
22-24: LGTM!The constructor is correctly implemented.
The code changes are approved.
33-41: Ensure SQL injection prevention in JOIN clause.The method dynamically constructs a JOIN clause which could be vulnerable to SQL injection if not properly sanitized.
Consider using
$wpdb->prepareto ensure that the table names are safely included in the query.
50-60: Security concern: Potential SQL injection in WHERE clause.The method constructs SQL conditions using unescaped data. This could lead to SQL injection vulnerabilities.
Use parameterized queries or
$wpdb->prepareto ensure data is safely included.
69-79: Address CSRF vulnerability by adding nonce verification.The method uses a GET parameter to modify the database query, which should be accompanied by nonce verification to prevent CSRF attacks.
Implement nonce verification when processing the 'refunds' GET parameter.
Would you like me to generate a code snippet for nonce verification?
Tools
GitHub Check: Run PHPCS inspection
[warning] 70-70:
Processing form data without nonce verification.
87-89: LGTM!The method is correctly implemented.
The code changes are approved.
96-104: LGTM!The method is correctly implemented.
The code changes are approved.
111-119: LGTM!The method is correctly implemented.
The code changes are approved.
121-123: LGTM!The method is correctly implemented.
The code changes are approved.
130-138: LGTM!The method is correctly implemented.
The code changes are approved.
147-161: Ensure SQL injection prevention in WHERE clause.The method dynamically constructs a WHERE clause which could be vulnerable to SQL injection if not properly sanitized.
Consider using
$wpdb->prepareto ensure that the data is safely included in the query.
168-178: Ensure proper sanitization and validation of user input.The method retrieves the seller ID from a GET parameter. Ensure that this value is properly sanitized and validated to prevent security issues.
Consider using more rigorous sanitization for the 'seller' GET parameter to ensure it is safe to use in queries.
mrabbani
added
Needs: Testing
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
tests/php/src/Analytics/Reports/Stock/ProductQueryFilterTest.php (2)
13-33: LGTM! Consider adding an assertion for the actual product IDs.The test method is correctly testing the scenario where the stock reports are fetched with a seller filter. However, consider adding an assertion to check that the response data contains the exact product IDs created for
seller_id1.foreach ( $data as $item ) { $prod = wc_get_product( $item['id'] ); } $this->assertCount( count( $seller1_prod_ids ), $data ); +$this->assertEqualsCanonicalizing( $seller1_prod_ids, array_column( $data, 'id' ) );
35-53: LGTM! Consider adding an assertion for the actual product IDs.The test method is correctly testing the scenario where the stock reports are fetched without a seller filter. However, consider adding an assertion to check that the response data contains the exact product IDs created for both sellers.
foreach ( $data as $item ) { $prod = wc_get_product( $item['id'] ); } $this->assertCount( count( $seller1_prod_ids ) + count( $seller2_prod_ids ), $data ); +$this->assertEqualsCanonicalizing( array_merge( $seller1_prod_ids, $seller2_prod_ids ), array_column( $data, 'id' ) );includes/Analytics/Reports/BaseQueryFilter.php (1)
168-178: Consider additional sanitization for the 'seller' GET parameter.The method retrieves the seller ID from the 'sellers' GET parameter and casts it to an integer, which is an improvement from the previous version. However, consider using more rigorous sanitization measures to ensure the value is safe to use in queries.
For example, you could use
absintto ensure the value is a non-negative integer:-return (int) ( wp_unslash( $_GET['sellers'] ?? 0 ) ); // phpcs:ignore +return absint( wp_unslash( $_GET['sellers'] ?? 0 ) ); // phpcs:ignore
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (8)
- includes/Analytics/Reports/BaseQueryFilter.php (1 hunks)
- includes/Analytics/Reports/DataStoreModifier.php (1 hunks)
- includes/Analytics/Reports/Products/Stats/WcDataStore.php (1 hunks)
- includes/Analytics/Reports/Stock/QueryFilter.php (1 hunks)
- includes/Analytics/Reports/Stock/Stats/WcDataStore.php (1 hunks)
- includes/DependencyManagement/Providers/AnalyticsServiceProvider.php (1 hunks)
- tests/php/src/Analytics/Reports/Stock/ProductQueryFilterTest.php (1 hunks)
- tests/php/src/Analytics/Reports/Stock/Stats/QueryFilterTest.php (1 hunks)
Additional comments not posted (24)
includes/Analytics/Reports/Products/Stats/WcDataStore.php (1)
18-26: LGTM! The method is well-structured and follows best practices.The
initialize_queries()method is overriding the parent class's method to customize the query behavior. The use of theWcSqlQueryclass instead of theSqlQueryclass is justified in the comments, explaining the need for applying specific filters to the queries.The method follows best practices by:
- Using the
get_db_table_name()method to get the database table name, which is good for maintainability.- Using the
add_sql_clause()method to add clauses to the queries, which is a clean and readable way of building the queries.- Using the
clear_all_clauses()method to clear all clauses before initializing the queries, which ensures that the queries are built from scratch.The method is well-structured and follows the Single Responsibility Principle (SRP) by focusing on initializing the queries.
includes/Analytics/Reports/Stock/QueryFilter.php (2)
12-14: LGTM!The
register_hooks()method is correctly registering thecheck_wc_analytics_reports_stock_pathfilter hook with the appropriate priority and number of arguments.
39-52: LGTM!The
add_author_clause()method is correctly modifying the SQL WHERE clause to filter by seller ID. It has proper documentation and the logic is sound.tests/php/src/Analytics/Reports/Stock/Stats/QueryFilterTest.php (2)
12-30: LGTM!The test method is well-structured, follows the AAA pattern, and correctly tests the stock stats report for all sellers. The test method name is descriptive and follows the naming convention.
32-52: LGTM!The test method is well-structured, follows the AAA pattern, and correctly tests the stock stats report filtered by a seller. The test method name is descriptive and follows the naming convention.
includes/Analytics/Reports/DataStoreModifier.php (3)
10-10: LGTM!The
DataStoreModifierclass follows SOLID principles and has a clear purpose.
19-21: LGTM!The
register_hooksmethod correctly registers the filter to modify WooCommerce data stores.
35-57: LGTM!The
modify_wc_products_stats_datastoremethod follows the Open-Closed Principle and has a clear purpose. The use ofissetto avoid undefined index notices is a good practice. The docblock provides a clear explanation of the modifications and their reason.includes/DependencyManagement/Providers/AnalyticsServiceProvider.php (4)
11-31: LGTM!The
AnalyticsServiceProviderclass is well-structured and follows the expected conventions for a service provider in a dependency injection system. The class definition,TAGSconstant, and$servicesproperty are all properly defined.
41-43: LGTM!The
providesmethod is implemented correctly. It checks if the given service alias exists in the$servicesproperty orTAGSconstant and returns a boolean accordingly. The use of strict comparison within_arrayis a good practice.
48-58: LGTM!The
registermethod is implemented correctly. It loops through the$servicesproperty and registers each service with the container using a shared definition. It also adds the tags defined in theTAGSconstant to each service definition. This approach is readable, maintainable, and allows for flexibility in retrieving services from the container.
60-64: LGTM!The
add_tagsmethod is a well-defined private helper method. It accepts aDefinitionInterfaceparameter and a$tagsparameter, ensuring type safety. The method correctly loops through the$tagsand adds each tag to the given service definition using theaddTagmethod. This implementation is clean and follows the expected behavior.includes/Analytics/Reports/BaseQueryFilter.php (6)
87-89: LGTM!The method correctly indicates that the query should always be filtered by seller ID.
96-104: LGTM!The method correctly retrieves the order types to include in WooCommerce analytics queries based on the user role.
111-119: LGTM!The method correctly retrieves the refund types to include in WooCommerce analytics queries based on the user role.
121-123: LGTM!The method correctly retrieves the name of the Dokan table.
130-138: LGTM!The method correctly retrieves the non-refund order types to include in WooCommerce analytics queries based on the user role.
147-161: LGTM!The method correctly adds a where clause to filter the query by the seller ID when available. The SQL condition is properly prepared using
$wpdb->prepareto prevent SQL injection.includes/Analytics/Reports/Stock/Stats/WcDataStore.php (6)
14-57: LGTM!The
get_datamethod is well-implemented and effectively uses transients for caching stock counts. The use of seller-specific transient keys ensures that the cached data is specific to each seller. The method handles the case when the transient is not set and retrieves the data from the database. The use of thewc_get_product_stock_status_optionsfunction ensures compatibility with WooCommerce.
64-101: LGTM!The
get_low_stock_countmethod is well-implemented and correctly retrieves the count of products with low stock. The method handles the case when the low stock amount meta value is not set by using the default low stock amount option. The SQL query is well-structured and uses prepared statements to prevent SQL injection vulnerabilities. The use of theget_seller_where_querymethod ensures that the low stock count is specific to each seller.
109-125: LGTM!The
get_countmethod is well-implemented and correctly retrieves the count of products with a specific stock status. The SQL query is simple and uses prepared statements to prevent SQL injection vulnerabilities. The use of theget_seller_where_querymethod ensures that the count is specific to each seller.
132-145: LGTM!The
get_product_countmethod is well-implemented and correctly retrieves the total count of products for the store. The method uses theWP_Queryclass, which is a standard WordPress approach. It correctly handles the case when a seller ID is available by adding the seller-specific condition to the query arguments. The use ofintvalensures that the returned count is an integer value.
147-149: LGTM!The
get_seller_idmethod is concise and well-implemented. It uses the Dokan container to retrieve the seller ID from theWeDevs\Dokan\Analytics\Reports\Stock\QueryFilterclass, which is a good practice for dependency injection. The method casts the seller ID to an integer using(int)to ensure that it returns an integer value.
151-165: LGTM!The
get_seller_where_querymethod is well-implemented and correctly generates the seller-specific WHERE clause for SQL queries. It retrieves the seller ID using theget_seller_idmethod and generates a prepared SQL statement to add the seller-specific condition to the WHERE clause. The use of prepared statements ensures that the SQL query is secure and prevents SQL injection vulnerabilities. The method returns an empty string if no seller ID is available, which allows the queries to work correctly without the seller-specific condition.
| /** | ||
| * Undocumented function | ||
| * | ||
| * @param [type] $result | ||
| * @param [type] $server | ||
| * @param WP_REST_Request $request | ||
| * @return mixed | ||
| */ |
There was a problem hiding this comment.
Add proper documentation for the check_wc_analytics_reports_stock_path() method.
The method is missing proper documentation. Please add a clear description of what the method does, the purpose of its parameters, and the expected return value.
| */ | ||
| public function register_hooks(): void { | ||
| add_action( 'woocommerce_analytics_update_order_stats', [ $this, 'sync_dokan_order' ] ); | ||
| add_action( 'woocommerce_before_delete_order', [ $this, 'delete_order' ] ); |
There was a problem hiding this comment.
Should we delete stats?
Yes
- Report will be mismatch with the
dokan_vendor_balance.
No
- Report will not be synced as per WC stats data.
| * @param string $handling Optional. The handling mode for the clause. Defaults to an empty string. | ||
| * @return string The SQL clause. | ||
| */ | ||
| protected function get_sql_clause( $type, $handling = '' ) { |
There was a problem hiding this comment.
Default params should be a valid value
includes/Install/Installer.php
Outdated
| @@ -536,4 +537,26 @@ private static function parse_update_notice( $content, $new_version ) { | |||
|
|
|||
| return wp_kses_post( $upgrade_notice ); | |||
| } | |||
|
|
|||
| protected function create_dokan_order_stats_table() { | |||
There was a problem hiding this comment.
What will be happened for exist Dokan User?
| $customer_id = absint( CustomersDataStore::get_existing_customer_id_from_order( $order ) ); | ||
|
|
||
| // Delete the order. | ||
| $wpdb->delete( self::get_db_table_name(), array( 'order_id' => $order_id ) ); |
There was a problem hiding this comment.
What will be happened if table does not exist for existing Dokan?
| ); | ||
|
|
||
| // Update or add the information to the DB. | ||
| $result = $wpdb->replace( $table_name, $data, $format ); |
There was a problem hiding this comment.
What will be happened if table does not exist for existing Dokan?
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Outside diff range and nitpick comments (3)
includes/Analytics/Reports/Orders/Stats/DataStore.php (1)
65-65: Remove commented-out code if not neededThe line setting
$this->date_column_nameis commented out. If this code is no longer necessary, consider removing it to keep the code clean. If it's required, please uncomment it and ensure it functions as intended.includes/Install/Installer.php (2)
542-542: Improve the clarity of the comment.The comment on line 542 has grammatical errors and could be clearer. Consider rephrasing it for better understanding:
-// Following imported here because this method could be called from the others file. +// The following is included here because this method could be called from other files.
548-549: Ensure consistent data type declarations forbigintcolumns.For consistency with other table definitions, consider specifying the display width for
bigintcolumns:-`order_id` bigint UNSIGNED NOT NULL, -`seller_id` bigint UNSIGNED NOT NULL DEFAULT '0', +`order_id` bigint(20) UNSIGNED NOT NULL, +`seller_id` bigint(20) UNSIGNED NOT NULL DEFAULT '0',
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- includes/Analytics/Reports/Orders/Stats/DataStore.php (1 hunks)
- includes/Analytics/Reports/WcSqlQuery.php (1 hunks)
- includes/Install/Installer.php (2 hunks)
- includes/Order/MiscHooks.php (0 hunks)
💤 Files with no reviewable changes (1)
- includes/Order/MiscHooks.php
🔇 Additional comments (4)
includes/Analytics/Reports/WcSqlQuery.php (4)
3-5: LGTM: Namespace and use statement are correctly defined.The namespace
WeDevs\Dokan\Analytics\Reportsis properly defined and follows PSR-4 autoloading standards. The use statement correctly imports the parent classSqlQueryfrom the WooCommerce Admin API Reports.
7-7: LGTM: Class definition and inheritance are correct.The
WcSqlQueryclass is properly defined and correctly extends theSqlQueryclass from WooCommerce Admin API Reports. The class name follows the appropriate naming convention.
8-15: LGTM: Method documentation is clear and follows PHPDoc standards.The documentation for the
get_sql_clausemethod is well-written and informative. It clearly explains the purpose of changing the default value of the$handlingparameter and provides accurate descriptions of the parameters and return value. The documentation follows the PHPDoc standard, which enhances code readability and maintainability.
16-18: LGTM: Method implementation is correct and addresses the previous review comment.The
get_sql_clausemethod is correctly overridden and implements the intended change in the default value of the$handlingparameter. The implementation is concise and properly delegates to the parent class's method.This change addresses the previous review comment about default parameters having valid values. The new default value 'filtered' is a valid and meaningful value for this context.
| * Max allowed Attemption to create table. | ||
| */ |
There was a problem hiding this comment.
Fix typo in comment: "Attemption" should be "Attempts"
In the comment, the word "Attemption" is incorrect. Please correct it to "Attempts" for proper grammar.
| * Attemption count to create order table if DB throws error. | ||
| * | ||
| * @var integer | ||
| */ |
There was a problem hiding this comment.
Fix typo in comment: "Attemption" should be "Attempt"
Similarly, in this comment, "Attemption" should be "Attempt" to correct the grammatical error.
| if ( $wpdb->last_error | ||
| && str_contains( (string) $wpdb->last_error, "{$table_name}' doesn't exist" ) | ||
| && self::MAX_ATTEMPT > self::$attempt_count |
There was a problem hiding this comment.
Replace str_contains with strpos for PHP compatibility
The str_contains function is only available in PHP 8 and above. To maintain compatibility with earlier PHP versions (e.g., PHP 7.x), consider using strpos instead.
Apply this diff to fix the compatibility issue:
-&& str_contains( (string) $wpdb->last_error, "{$table_name}' doesn't exist" )
+&& false !== strpos( (string) $wpdb->last_error, "{$table_name}' doesn't exist" )📝 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.
| if ( $wpdb->last_error | |
| && str_contains( (string) $wpdb->last_error, "{$table_name}' doesn't exist" ) | |
| && self::MAX_ATTEMPT > self::$attempt_count | |
| if ( $wpdb->last_error | |
| && false !== strpos( (string) $wpdb->last_error, "{$table_name}' doesn't exist" ) | |
| && self::MAX_ATTEMPT > self::$attempt_count |
includes/Install/Installer.php
Outdated
| $sql = "CREATE TABLE IF NOT EXISTS `{$wpdb->prefix}dokan_order_stats` ( | ||
| `order_id` bigint UNSIGNED NOT NULL, | ||
| `seller_id` bigint UNSIGNED NOT NULL DEFAULT '0', | ||
| `order_type` tinyint(1) NOT NULL DEFAULT '0' COMMENT '0 = WC Order, 1 = Dokan Single Vendor Order, 2 = Dokan Suborder, 3 = Refund of Dokan Parent Order, 4 = Refund of Dokan Suborder, 5 = 4 = Refund of Dokan Single Order', |
There was a problem hiding this comment.
Correct the typographical error in the order_type column comment.
The comment for the order_type column contains a duplicate numbering and should be corrected to accurately reflect the order types:
-`order_type` tinyint(1) NOT NULL DEFAULT '0' COMMENT '0 = WC Order, 1 = Dokan Single Vendor Order, 2 = Dokan Suborder, 3 = Refund of Dokan Parent Order, 4 = Refund of Dokan Suborder, 5 = 4 = Refund of Dokan Single Order',
+`order_type` tinyint(1) NOT NULL DEFAULT '0' COMMENT '0 = WC Order, 1 = Dokan Single Vendor Order, 2 = Dokan Suborder, 3 = Refund of Dokan Parent Order, 4 = Refund of Dokan Suborder, 5 = Refund of Dokan Single Order',📝 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.
| `order_type` tinyint(1) NOT NULL DEFAULT '0' COMMENT '0 = WC Order, 1 = Dokan Single Vendor Order, 2 = Dokan Suborder, 3 = Refund of Dokan Parent Order, 4 = Refund of Dokan Suborder, 5 = 4 = Refund of Dokan Single Order', | |
| `order_type` tinyint(1) NOT NULL DEFAULT '0' COMMENT '0 = WC Order, 1 = Dokan Single Vendor Order, 2 = Dokan Suborder, 3 = Refund of Dokan Parent Order, 4 = Refund of Dokan Suborder, 5 = Refund of Dokan Single Order', |
| `seller_earning` double NOT NULL DEFAULT '0', | ||
| `seller_gateway_fee` double NOT NULL DEFAULT '0', | ||
| `seller_shipping_fee` double NOT NULL DEFAULT '0', | ||
| `seller_discount` double NOT NULL DEFAULT '0', | ||
| `admin_commission` double NOT NULL DEFAULT '0', | ||
| `admin_gateway_fee` double NOT NULL DEFAULT '0', | ||
| `admin_shipping_fee` double NOT NULL DEFAULT '0', | ||
| `admin_discount` double NOT NULL DEFAULT '0', | ||
| `admin_subsidy` double NOT NULL DEFAULT '0', |
There was a problem hiding this comment.
Use DECIMAL data type for monetary values instead of double.
Storing monetary values as double can lead to precision and rounding errors due to floating-point representation. It's recommended to use DECIMAL(19,4) for monetary amounts to ensure accuracy and consistency.
Apply this diff to update the data types:
-`seller_earning` double NOT NULL DEFAULT '0',
-`seller_gateway_fee` double NOT NULL DEFAULT '0',
-`seller_shipping_fee` double NOT NULL DEFAULT '0',
-`seller_discount` double NOT NULL DEFAULT '0',
-`admin_commission` double NOT NULL DEFAULT '0',
-`admin_gateway_fee` double NOT NULL DEFAULT '0',
-`admin_shipping_fee` double NOT NULL DEFAULT '0',
-`admin_discount` double NOT NULL DEFAULT '0',
-`admin_subsidy` double NOT NULL DEFAULT '0',
+`seller_earning` decimal(19,4) NOT NULL DEFAULT '0',
+`seller_gateway_fee` decimal(19,4) NOT NULL DEFAULT '0',
+`seller_shipping_fee` decimal(19,4) NOT NULL DEFAULT '0',
+`seller_discount` decimal(19,4) NOT NULL DEFAULT '0',
+`admin_commission` decimal(19,4) NOT NULL DEFAULT '0',
+`admin_gateway_fee` decimal(19,4) NOT NULL DEFAULT '0',
+`admin_shipping_fee` decimal(19,4) NOT NULL DEFAULT '0',
+`admin_discount` decimal(19,4) NOT NULL DEFAULT '0',
+`admin_subsidy` decimal(19,4) NOT NULL DEFAULT '0',📝 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.
| `seller_earning` double NOT NULL DEFAULT '0', | |
| `seller_gateway_fee` double NOT NULL DEFAULT '0', | |
| `seller_shipping_fee` double NOT NULL DEFAULT '0', | |
| `seller_discount` double NOT NULL DEFAULT '0', | |
| `admin_commission` double NOT NULL DEFAULT '0', | |
| `admin_gateway_fee` double NOT NULL DEFAULT '0', | |
| `admin_shipping_fee` double NOT NULL DEFAULT '0', | |
| `admin_discount` double NOT NULL DEFAULT '0', | |
| `admin_subsidy` double NOT NULL DEFAULT '0', | |
| `seller_earning` decimal(19,4) NOT NULL DEFAULT '0', | |
| `seller_gateway_fee` decimal(19,4) NOT NULL DEFAULT '0', | |
| `seller_shipping_fee` decimal(19,4) NOT NULL DEFAULT '0', | |
| `seller_discount` decimal(19,4) NOT NULL DEFAULT '0', | |
| `admin_commission` decimal(19,4) NOT NULL DEFAULT '0', | |
| `admin_gateway_fee` decimal(19,4) NOT NULL DEFAULT '0', | |
| `admin_shipping_fee` decimal(19,4) NOT NULL DEFAULT '0', | |
| `admin_discount` decimal(19,4) NOT NULL DEFAULT '0', | |
| `admin_subsidy` decimal(19,4) NOT NULL DEFAULT '0', |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
includes/Upgrade/Upgrades/V_3_13_0.php (1)
10-16: Add method documentation for clarity.While the code style is good, adding documentation would improve readability and maintainability. Consider adding a PHPDoc block to explain the purpose of the method, any parameters it might accept in the future, and what it returns.
Here's a suggested documentation block:
/** * Resyncs WooCommerce order stats to synchronize Dokan stats. * * This method performs two main actions: * 1. Creates a Dokan order stats table. * 2. Synchronizes WooCommerce order statistics. * * @since 3.13.0 * * @return void */ public static function resync_wc_order_stats_to_sync_dokan_stats() { // ... (existing code) }includes/Upgrade/Manager.php (1)
35-35: Improved boolean conversion using explicit castThe change from
! !to(bool)is a good improvement. It makes the intention clearer and is more aligned with modern PHP coding practices. This modification enhances code readability without altering the function's behavior.Consider adding a brief comment explaining why we're casting to boolean here, e.g.:
// Ensure a boolean return value regardless of what get_option() returns return (bool) get_option( $this->is_upgrading_db_key, false );
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- includes/Upgrade/Manager.php (1 hunks)
- includes/Upgrade/Upgrades.php (1 hunks)
- includes/Upgrade/Upgrades/V_3_13_0.php (1 hunks)
🔇 Additional comments (3)
includes/Upgrade/Upgrades/V_3_13_0.php (2)
1-8: LGTM: File structure and namespace are well-defined.The file structure, namespace definition, and use statements are correctly implemented, adhering to PSR-4 autoloading standards.
9-9: Class definition looks good. Verify naming convention.The class
V_3_13_0is correctly defined and extendsDokanUpgrader. The naming convention seems to follow a version number format, which is likely used for upgrade scripts.To ensure consistency, let's verify if this naming convention is used for other upgrade classes:
✅ Verification successful
Naming convention is consistent.
The class
V_3_13_0follows the established version number format for upgrade scripts, consistent with other classes in theincludes/Upgrade/Upgradesdirectory.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for similar class naming patterns in the Upgrades directory # Test: Search for class definitions in the Upgrades directory rg --type php -g 'V_*.php' -g '!V_3_13_0.php' --no-filename -N '^class V_\d+_\d+_\d+ extends DokanUpgrader' includes/Upgrade/UpgradesLength of output: 1209
includes/Upgrade/Upgrades.php (1)
46-46: LGTM! Verify the existence of theV_3_13_0class.The new entry for version 3.13.0 is correctly added and follows the established pattern. This change will enable the upgrade process for users updating to version 3.13.0 of the Dokan Lite plugin.
To ensure the upgrade process will work as expected, please verify that the
V_3_13_0class exists:✅ Verification successful
Verification Successful:
V_3_13_0class exists and is properly implemented.The
V_3_13_0class has been successfully located inincludes/Upgrade/Upgrades/V_3_13_0.phpand contains the necessary implementation to handle the upgrade process for version 3.13.0. No issues found.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the V_3_13_0 class file # Test: Check if the V_3_13_0.php file exists in the expected directory fd -t f "V_3_13_0.php" includes/Upgrade/Upgrades # If the file exists, display its content for further verification if [ $? -eq 0 ]; then echo "File found. Displaying content:" cat $(fd -t f "V_3_13_0.php" includes/Upgrade/Upgrades) else echo "Error: V_3_13_0.php file not found in the expected directory." fiLength of output: 774
| public static function resync_wc_order_stats_to_sync_dokan_stats() { | ||
| // Create Dokan order stats table. | ||
| ( new Installer() )->create_dokan_order_stats_table(); | ||
|
|
||
| // Sync the WC order stats. | ||
| $import = ReportsSync::regenerate_report_data( null, false ); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider error handling, performance, and transactional integrity.
The resync_wc_order_stats_to_sync_dokan_stats method implementation is straightforward, but there are a few areas for improvement:
- Error Handling: Add try-catch blocks to handle potential exceptions and log errors.
- Performance: For large databases, this operation could be time-consuming. Consider adding a way to process this in batches or as a background job.
- Transactional Integrity: Wrap the operations in a database transaction to ensure atomicity.
Here's a suggested refactor to address these concerns:
public static function resync_wc_order_stats_to_sync_dokan_stats() {
global $wpdb;
try {
$wpdb->query('START TRANSACTION');
// Create Dokan order stats table.
(new Installer())->create_dokan_order_stats_table();
// Sync the WC order stats.
$import = ReportsSync::regenerate_report_data(null, false);
$wpdb->query('COMMIT');
error_log('Successfully resynced WC order stats to Dokan stats.');
} catch (\Exception $e) {
$wpdb->query('ROLLBACK');
error_log('Failed to resync WC order stats to Dokan stats: ' . $e->getMessage());
}
}Additionally, consider implementing a batching mechanism or background processing for better performance with large datasets.
All Submissions:
Changes proposed in this Pull Request:
Related Pull Request(s)
Closes
How to test the changes in this Pull Request:
Changelog entry
Title
Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.
Before Changes
Describe the issue before changes with screenshots(s).
After Changes
Describe the issue after changes with screenshot(s).
Feature Video (optional)
Link of detailed video if this PR is for a feature.
PR Self Review Checklist:
FOR PR REVIEWER ONLY:
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores