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

fix: unsupported operand types: string in calculation #2534

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mralaminahamed
Copy link
Member

@mralaminahamed mralaminahamed commented Jan 27, 2025

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

Changelog entry

- **fix:* Resolve an issue unsupported operand types: string in calculation

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

  • Bug Fixes
    • Improved calculation precision for order earnings by ensuring proper float type handling for shipping fees and tax calculations.

@mralaminahamed mralaminahamed added Needs: Testing This requires further testing Needs: Dev Review It requires a developer review and approval labels Jan 27, 2025
@mralaminahamed mralaminahamed self-assigned this Jan 27, 2025
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request focuses on modifying the get_earning_by_order method in the Commission class within the includes/Commission.php file. The changes involve adding floatval() function calls to explicitly cast numeric values to floats during calculations of earnings, shipping fees, and tax-related computations. This modification aims to prevent potential type-related issues and ensure more robust numeric calculations by converting string values to floating-point numbers before performing arithmetic operations.

Changes

File Change Summary
includes/Commission.php Updated get_earning_by_order method to use floatval() for shipping total and tax calculations

Assessment against linked issues

Objective Addressed Explanation
Resolve TypeError in Commission.php
Prevent string-int operation errors

Possibly related PRs

Suggested labels

urgent, :+1: Dev Review Done

Suggested reviewers

  • Aunshon
  • mrabbani

Poem

🐰 Floating through code with grace and might,
Casting strings to numbers, making calculations right!
No more errors, no more strife,
Floatval saves the programmer's life!
A rabbit's fix, precise and neat,
Making math and code a perfect treat! 🧮✨


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.

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 (1)
includes/Commission.php (1)

Line range hint 267-269: Consider extracting tax calculations to improve readability.

While the floatval() additions correctly fix the type safety issues, the tax calculation logic is complex and hard to follow. Consider extracting this into a separate method for better maintainability.

-$earning_or_commission += ( ( floatval( $order->get_total_tax() ) - floatval( $order->get_total_tax_refunded() ) ) - ( floatval( $order->get_shipping_tax() ) - floatval( dokan()->fees->get_total_shipping_tax_refunded( $order ) ) ) );
+$earning_or_commission += $this->calculate_tax_earnings( $order );
+
+private function calculate_tax_earnings( $order ) {
+    $total_tax = floatval( $order->get_total_tax() );
+    $total_tax_refunded = floatval( $order->get_total_tax_refunded() );
+    $shipping_tax = floatval( $order->get_shipping_tax() );
+    $shipping_tax_refunded = floatval( dokan()->fees->get_total_shipping_tax_refunded( $order ) );
+
+    return ( $total_tax - $total_tax_refunded ) - ( $shipping_tax - $shipping_tax_refunded );
+}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e97ff28 and 3e6f69f.

📒 Files selected for processing (1)
  • includes/Commission.php (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: e2e tests (3, 3)
  • GitHub Check: e2e tests (2, 3)
  • GitHub Check: api tests (1, 1)
  • GitHub Check: e2e tests (1, 3)
🔇 Additional comments (3)
includes/Commission.php (3)

263-263: LGTM! Good fix for type safety.

The addition of floatval() ensures type safety when calculating shipping earnings by explicitly converting the shipping total to float before arithmetic operations.


Line range hint 272-272: LGTM! Good fix for type safety.

The addition of floatval() ensures type safety when calculating shipping tax earnings by explicitly converting values to float before arithmetic operations.


Line range hint 263-272: Verify the impact on existing orders.

The type conversion changes might affect the precision of calculations for existing orders. Please ensure:

  1. The changes don't affect historical commission calculations
  2. The precision of calculations remains consistent
  3. No rounding issues are introduced
✅ Verification successful

Type conversion changes maintain calculation precision

The floatval() changes are safe and won't affect historical commission calculations based on:

  • Extensive test coverage verifying exact commission values
  • Strict equality assertions in tests without rounding tolerance
  • Proper handling of edge cases including zero amounts and null values
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any existing test cases or code that might be affected by the precision changes
rg -A 5 "get_earning_by_order.*test" .

Length of output: 40


Script:

#!/bin/bash
# Search for Commission test files
fd -e php test.*Commission

# Search for commission calculation related tests
rg -l "class.*Commission.*Test" .

# Look for precision/rounding specifications in commission calculations
rg -A 3 "round|precision|decimal" includes/Commission.php

# Check for other commission calculation methods
ast-grep --pattern 'function calculate_commission($$$)'

Length of output: 338


Script:

#!/bin/bash
# Check commission test implementations
cat tests/php/src/Commission/CommissionTest.php
cat tests/php/src/Commission/CommissionModelTest.php

# Look for floating-point assertions or precision checks in tests
rg -A 3 "assertEquals|assertEqualsWithDelta|assertSame" tests/php/src/Commission/

Length of output: 66910

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs: Dev Review It requires a developer review and approval Needs: Testing This requires further testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant