Add tax costs into the list of available information when a purchase happens [#3040954]

Problem/Motivation

\Drupal\commerce_google_tag_manager\EventTrackerService::purchase is missing to calculate tax costs.

Proposed resolution

Calculate tax costs and submit it as part of purchase data.

Remaining tasks

~~Write a patch~~
Write a test to cover - shipping, taxes (included & excluded from price) and total price value

User interface changes

API changes

Data model changes

Release notes snippet

Comment	File	Size	Author
#12	3040954-12.patch	24.84 KB	wengerk
#12	8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 55 pass
#8	3040954-08.patch	12.35 KB	wengerk
#8	8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 52 pass
#7	3040954-07.patch	12.02 KB	wengerk
#7	8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 43 pass, 2 fail
#7	interdiff-3040954-06-07.txt	2.08 KB	wengerk
#6	interdiff-3040954-05-06.txt	11.56 KB	wengerk
#6	3040954-06.patch	14.22 KB	wengerk
#6	8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 44 pass, 2 fail
#5	interdiff-3040954-04-05.txt	3.48 KB	wengerk
#5	3040954-05.patch	2.97 KB	wengerk
#5	8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 Unable to generate test groups
#4	3040954-calculate-tax-costs-4-2-interdiff.txt	583 bytes	mbovan
#4	3040954-calculate-tax-costs-4.patch	2.15 KB	mbovan
#4	8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 Patch Failed to Apply
#2	3040954-calculate-tax-costs-2.patch	2.15 KB	mbovan
#2

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

18 March 2019 at 08:45

mbovan created an issue. See original summary.

Comment #2

mbovan CreditAttribution: mbovan at MD Systems GmbH for Unic commented 18 March 2019 at 08:47

Status:	Active	» Needs review
Issue tags:		+Needs tests

File	Size
3040954-calculate-tax-costs-2.patch	2.15 KB

I am submitting a patch that adds tax costs.

Comment #3

schtifu CreditAttribution: schtifu at Gridonic commented 2 April 2019 at 07:21

Status:

Needs review

» Needs work

Thanks for your contribution mbovan, looking good! Just two things:

1)
public function calculateTax(OrderInterface $order) {
Could you make this private since it is a helper method and not part of the public API of EventTrackerService.

2) Do you have time to extend the test cases to cover this feature? I can do it if you don't find the time :)

P.S. If you prefer, you can also send a pull request via GitHub: https://github.com/gridonic/commerce_google_tag_manager

Cheers

Comment #4

mbovan CreditAttribution: mbovan as a volunteer and at MD Systems GmbH for Unic commented 9 April 2019 at 22:38

Status:

Needs work

» Needs review

File	Size
3040954-calculate-tax-costs-4.patch	2.15 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 Patch Failed to Apply
3040954-calculate-tax-costs-4-2-interdiff.txt	583 bytes

Thanks for the feedback @schtifu.

Please find the attached patch that changes the method to private.

Unfortunately, I will not have time at the moment to write tests. Feel free to work on it.

Comment #5

wengerk

he/him

French

Lausanne

CreditAttribution: wengerk at Antistatique commented 29 October 2019 at 12:39

Issue summary:

View changes

File	Size
3040954-05.patch	2.97 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 Unable to generate test groups
interdiff-3040954-04-05.txt	3.48 KB

1 file was hidden/shown/deleted

File	Size
3040954-calculate-tax-costs-2.patch	2.15 KB

Many thanks for your contrib !!

Sorry it takes me ages to get into this issue ...
Here is a reroll patch, I will work on a functional tests asap.

Comment #6

wengerk

he/him

French

Lausanne

CreditAttribution: wengerk at Antistatique commented 29 October 2019 at 13:42

File	Size
3040954-06.patch	14.22 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 44 pass, 2 fail
interdiff-3040954-05-06.txt	11.56 KB

2 files were hidden/shown/deleted

File	Size
3040954-05.patch	2.97 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 Unable to generate test groups
interdiff-3040954-04-05.txt	3.48 KB

Here is the same patch with a tests ensuring \Drupal\commerce_google_tag_manager\EventTrackerService::purchase apply 'revenue' and 'taxes' properly when included or excluded from the unit_price of product

Comment #7

wengerk

he/him

French

Lausanne

CreditAttribution: wengerk at Antistatique commented 29 October 2019 at 13:47

File	Size
interdiff-3040954-06-07.txt	2.08 KB
3040954-07.patch	12.02 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 43 pass, 2 fail

2 files were hidden/shown/deleted

File	Size
3040954-06.patch	14.22 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 44 pass, 2 fail
interdiff-3040954-05-06.txt	11.56 KB

oupsy, I added the file tests/src/Functional/PurchaseTest.php which should not be part of those patches ...

Comment #8

wengerk

he/him

French

Lausanne

CreditAttribution: wengerk at Antistatique commented 29 October 2019 at 15:03

File	Size
3040954-08.patch	12.35 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 52 pass

here a fix, a Unit test was broken since we make a call to collectAdjustments and this call was not mocked

Comment #9

wengerk

he/him

French

Lausanne

CreditAttribution: wengerk at Antistatique commented 29 October 2019 at 15:10

3 files were hidden/shown/deleted

File	Size
3040954-calculate-tax-costs-4-2-interdiff.txt	583 bytes
interdiff-3040954-06-07.txt	2.08 KB
3040954-07.patch	12.02 KB
8.x-1.x: PHP 7.1 & MySQL 5.7, D8.7.8 43 pass, 2 fail

Comment #10

wengerk

he/him

French

Lausanne

CreditAttribution: wengerk at Antistatique commented 29 October 2019 at 15:10

Issue tags:

-Needs tests

Comment #11

mbovan CreditAttribution: mbovan as a volunteer and at MD Systems GmbH for Unic commented 30 October 2019 at 08:48

Thanks for taking the time to work on tests!

I am not sure if it is worth testing a case when there are 2 different tax rates applied to 2 different order items?

+++ b/src/EventTrackerService.php
@@ -279,8 +280,10 @@ public function purchase(OrderInterface $order) {
+            // The revenu should be the total value (incl. tax and shipping).

Small typo on "revenu".