Skip to content

add coupon code to totals model #32797

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

Closed

Conversation

SilinMykola
Copy link
Contributor

@SilinMykola SilinMykola commented Apr 20, 2021

Description (*)

I changed \Magento\Sales\Block\Order\Totals class to add Coupon Code to order.total block

Fixed Issues (if relevant)

  1. Fixes Magento 2.3.5-p1 - Discount Description, Coupon Codes on Invoices Broken #28432

Manual testing scenarios (*)

  1. Create new Cart Price Rule with long description and coupone code.
  2. Create order on storefront.
  3. Check coupon code in order view, invoice view, order print, invoice print

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Apr 20, 2021

Hi @SilinMykola. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@m2-community-project m2-community-project bot added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Apr 20, 2021
@magento-engcom-team magento-engcom-team added Component: Sales Release Line: 2.4 Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner labels Apr 20, 2021
@SilinMykola
Copy link
Contributor Author

@magento run all tests

1 similar comment
@atwixfirster
Copy link
Contributor

@magento run all tests

@m2-assistant
Copy link

m2-assistant bot commented Apr 20, 2021

Hi @SilinMykola, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@SilinMykola
Copy link
Contributor Author

@magento run all tests

@SilinMykola
Copy link
Contributor Author

@magento run Functional Tests CE, Functional Tests EE, Functional Tests B2B

@andrewbess
Copy link
Contributor

@magento run Integration Tests

@@ -6,7 +6,7 @@
namespace Magento\Sales\Block\Order;

use Magento\Sales\Model\Order;

use Magento\Sales\Model\Order\Invoice;
Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @SilinMykola
Thank you for your contribution;
Please don't forget to keep an empty string after imports

Suggested change
use Magento\Sales\Model\Order\Invoice;
use Magento\Sales\Model\Order\Invoice;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello @andrewbess
Thanks for your reviewing, I fixed your remark.

Copy link
Contributor

@coderimus coderimus left a comment

Choose a reason for hiding this comment

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

Hi @SilinMykola
Thank you for your work. Please, check my comment below.

Comment on lines +129 to +136
if ($this->getSource() instanceof Invoice) {
$discountSource = $this->getSource()->getOrder();
} else {
$discountSource = $this->getSource();
}
if ($this->getSource()->getCouponCode()) {
$discountLabel = __('Discount (%1)', $discountSource->getCouponCode());
Copy link
Contributor

Choose a reason for hiding this comment

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

As I see from the suggested solution, the coupon code description will not be shown anymore, but it was expected to be shown. In other words, this solution replaces coupon code description with its code. It is not correct from the user experience.
It is also impossible to change the $discountLabel text because this class is an @api (BIC change).

I can suggest to implement something like this:

            $discountLabel = $this->getSource()->getDiscountDescription()
                ? __('Discount (%1)', $source->getDiscountDescription())
                : __('Discount (%1)', $source->getCouponCode());

With this, we will have a coupon code or description in the Discount line. And not the BIC change.

@coderimus
Copy link
Contributor

Hi @SilinMykola,
Do you need assistance with this PR? :)

@SilinMykola
Copy link
Contributor Author

Hi @coderimus, yes, I need help with this issue. I think about where I should create the settings in admin panel to choose what to show in "totals" (coupon description, coupon code or both) and how to split description in a few strings.
If you have some ideas please tell and I continue with this issue.

@coderimus
Copy link
Contributor

Hi @sivaschenko
Can you please check this PR? We have two ways: add a simple adjustment to the code to fix the reported error or add a new setting for such a purpose. What is the right solution from your perspective?

@SilinMykola SilinMykola deleted the 28432-add-discount-code branch March 25, 2022 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Sales Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner Priority: P3 May be fixed according to the position in the backlog. Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Magento 2.3.5-p1 - Discount Description, Coupon Codes on Invoices Broken
5 participants