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.

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

Error on approved refund request when empty Commission _dokan_additional_fee #4018 #2485

Conversation

osmansufy
Copy link
Contributor

@osmansufy osmansufy commented Dec 17, 2024

All Submissions:

  • My code follow the WordPress' coding standards
  • My code satisfies feature requirements
  • My code is tested
  • My code passes the PHPCS tests
  • My code has proper inline documentation
  • I've included related pull request(s) (optional)
  • I've included developer documentation (optional)
  • I've added proper labels to this pull request

Changes proposed in this Pull Request:

Related Pull Request(s)

  • Full PR Link

Closes

How to test the changes in this Pull Request:

  • Steps or issue link
  • Do a refund request specially from admin end
  • try to approved
  • Check in both case (HPOS enable / disable)

Changelog entry

bug fixed for empty admin commission additional fee

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:

  • Code is not following code style guidelines
  • Bad naming: make sure you would understand your code if you read it a few months from now.
  • KISS: Keep it simple, Sweetie (not stupid!).
  • DRY: Don't Repeat Yourself.
  • Code that is not readable: too many nested 'if's are a bad sign.
  • Performance issues
  • Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
  • Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

  • Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
  • Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
  • Readable — Will your future self be able to understand this change months down the road?
  • Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes
    • Improved safety of calculations to prevent potential division by zero errors in order item settings.
    • Enhanced retrieval of item totals to ensure consistent data handling.

Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request modifies the get method in the OrderItem class of the Dokan plugin to improve the handling of commission calculations. The logic for retrieving the $item_total variable has been simplified, and both $item_total and $additional_flat are now consistently treated as floats. This adjustment aims to prevent division by zero errors, particularly during refund processing.

Changes

File Change Summary
includes/Commission/Settings/OrderItem.php Modified get() method to safely handle $item_total and $additional_flat by converting them to float and adding checks for division safety.

Assessment against linked issues

Objective Addressed Explanation
Fix error on approved refund request with empty Commission _dokan_additional_fee [#4018]
Prevent fatal error when approving refund requests [#4021]
Resolve unsupported operand types error [#2491]

Possibly related PRs

  • Fix admin fixed commission setting validation #2437: This PR modifies the validation logic for commission settings, which is related to the changes in the OrderItem class where commission calculations are handled.
  • Fix commission upgrader #2463: This PR addresses the commission handling in the upgrader, which is relevant as it deals with commission values similar to the changes made in the OrderItem class.

Suggested labels

QA approved

Suggested reviewers

  • mrabbani

Poem

🐰 A rabbit's tale of code so neat,
Where zero division meets its defeat.
With careful checks and gentle care,
Commission math now has no scare.
Safe calculations hop along! 🧮✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3758043 and a66507d.

📒 Files selected for processing (1)
  • includes/Commission/Settings/OrderItem.php (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • includes/Commission/Settings/OrderItem.php

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@osmansufy osmansufy self-assigned this Dec 17, 2024
@osmansufy osmansufy requested a review from mrabbani December 17, 2024 06:42
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
includes/Commission/Settings/OrderItem.php (2)

74-75: The empty check fix looks good, but consider additional safety measures.

The introduction of $empty_safe_additional_flat effectively prevents the division by zero error when $additional_flat is empty. However, we should also guard against $item_total being zero.

Consider applying this enhanced version with additional safety checks:

-            $empty_safe_additional_flat = empty( $additional_flat ) ? 0 : $additional_flat;
-            $additional_flat = ( $empty_safe_additional_flat / $item_total ) * $product_price;
+            $empty_safe_additional_flat = empty( $additional_flat ) ? 0 : (float) $additional_flat;
+            $additional_flat = $item_total > 0 
+                ? ( $empty_safe_additional_flat / $item_total ) * $product_price 
+                : 0;

74-75: Consider extracting the calculation logic into a separate method.

The commission calculation logic could be more maintainable if moved to a dedicated method.

Consider this refactor:

+    /**
+     * Calculate proportional additional fee for refund
+     *
+     * @param float|string $additional_flat
+     * @param float $item_total
+     * @param float $product_price
+     *
+     * @return float
+     */
+    private function calculate_proportional_additional_fee($additional_flat, float $item_total, float $product_price): float {
+        if (empty($additional_flat) || $item_total <= 0) {
+            return 0.0;
+        }
+        return ((float) $additional_flat / $item_total) * $product_price;
+    }

     // In the get() method:
-    $empty_safe_additional_flat = empty( $additional_flat ) ? 0 : $additional_flat;
-    $additional_flat = ( $empty_safe_additional_flat / $item_total ) * $product_price;
+    $additional_flat = $this->calculate_proportional_additional_fee($additional_flat, (float) $item_total, $product_price);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 02d4fe1 and 8f18519.

📒 Files selected for processing (1)
  • includes/Commission/Settings/OrderItem.php (1 hunks)
🔇 Additional comments (1)
includes/Commission/Settings/OrderItem.php (1)

74-75: Verify the fix across different refund scenarios.

While the fix addresses the empty commission fee case, we should verify it works correctly across various refund scenarios.

@osmansufy osmansufy added Needs: Dev Review It requires a developer review and approval and removed Needs: Author Reply labels Dec 19, 2024
@mrabbani mrabbani added 👍 Dev Review Done Needs: Testing This requires further testing and removed Needs: Dev Review It requires a developer review and approval labels Dec 19, 2024
@Aunshon Aunshon merged commit 2e2adeb into develop Dec 27, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unsupported operand types at dokan-lite/includes/Commission/Settings/OrderItem.php:74
4 participants