feat(): Add tiered prices sync support for product Import/Export #244

Babanila · 2019-03-13T14:45:41Z

Support reference number

Summary

Add tiered prices sync support for product Import/Export

Description

This PR adds tier to prices and allow the tiered prices to be synchronized with both the product import and export.
Tier is an array of priceTier.

To import tier with prices in csv, the tier is denoted from the base price by % symbol.

Example 1
Assuming the base price is EUR 50
For tier with single priceTier.

minimum quantity of 100, the price is EUR 45

EUR 50%EUR 45 @100

Example 2
For tier with multiple priceTier.

minimum quantity of 100, the price is EUR 45
minimum quantity of 200, the price is EUR 40
minimum quantity of 300, the price is EUR 35

EUR 50%EUR 45 @100%EUR 40 @200%EUR 35 @300

Tests
- Unit
- Integration
Documentation
Closes Use sphere product-csv-sync to sync tier prices #242

…uct-csv-sync-to-sync-tier-prices

…eTier

coveralls · 2019-03-13T15:02:41Z

Coverage increased (+0.08%) to 78.415% when pulling 7daae9c on 242-use-sphere-product-csv-sync-to-sync-tier-prices into 4c24c1d on master.

Babanila · 2019-03-15T14:53:48Z

README.md

 In the `prices` column you can define a list of prices for each variant separated by `;`:
 ```
-CH-EUR 999 B2B;EUR 899|745;USD 19900 #retailerA;DE-EUR 1000 B2C#wareHouse1;GB-GBP 999$2001-09-11T14:00:00.000Z~2015-10-12T14:00:00.000Z
+CH-EUR 999 B2B;EUR 899|745;USD 19900 #retailerA;DE-EUR 1000 B2C#wareHouse1;GB-GBP 999$2001-09-11T14:00:00.000Z~2015-10-12T14:00:00.000Z;EUR 500%EUR 450@1000


Add tiers example to docs.

Babanila · 2019-03-15T14:54:42Z

data/moneySetAttributeProduct.json

-    }],
+        "validFrom": "2001-09-11T14:00:00.000Z",
+        "validUntil": "2015-09-11T14:00:00.000Z",
+        "tiers": [


Add tiers to sample data.

Babanila · 2019-03-15T14:57:15Z

src/coffee/constants.coffee

  ATTRIBUTE_CONSTRAINT_SAME_FOR_ALL: 'SameForAll'

-  REGEX_PRICE: new RegExp /^(([A-Za-z]{2})-|)([A-Z]{3}) (-?\d+)(-?\|(\d+)|)( ([^~\$#]*)|)(#([^~\$]*)|)(\$([^~]*)|)(~(.*)|)$/
+  REGEX_PRICE: new RegExp /^(([A-Za-z]{2})-|)([A-Z]{3}) (-?\d+)(-?\|(\d+)|)( ([^~\$#%]*)|)(#([^~\$%]*)|)(\$([^~%]*)|)(~([^%]*)|)(%([A-Z]{3} -?\d+ @\d+(.*))|)$/


Add tiers format to the price regex and defined the symbol (%) to be used for tiers.

Woah, this is insane 😄

daern91

Code looks fine 👍 I just have one question

daern91 · 2019-03-19T17:30:01Z

src/coffee/exportmapping.coffee

+  _mapTiers: (tiers) ->
+    _.reduce(tiers, (acc, priceTier, index) ->
+      acc += GLOBALS.DELIM_TIERS_MULTI_VALUE unless index is 0
+      acc + "#{priceTier.value.currencyCode} #{priceTier.value.centAmount} @#{priceTier.minimumQuantity}"


Hmm, are we sure that priceTier.value only contains centAmount and currenctyCode? Can't it be both Money and HighPrecisionMoney? 🤔

https://docs.commercetools.com/http-api-projects-products#pricetier

The priceTier is always the same as the base price and by default, the base price is in centPrecision(Money).

PriceTier can either be centPrecision(Money) or highPrecision(HighPrecisionMoney) but not both at the same time.

For csv export and import for a price with tiers, only the centAmount and currenctyCode are needed. If highPrecision is required it can be set in the productType attributes of the price.

Hmm, ok. So what happens if I try to import or export a highPrecision price with highPrecision in priceTier?

Yes, it works once the base price type is set to highPrecision.

Hmm, this doesn't make sense to me. How can it work? Did you test it? HighPrecisionMoney got more fields, e.g. preciseAmount

It works for only the default price type which is centPrecision.

daern91

I had another look at the code now and it looks really good already 💯 I would just like to expand on the docs so it's easier to understand how to use it. Added some more comments and questions below.

Also, could we please add a test for the import as well? Just so we fully test both imports and exports of this feature 👍

daern91 · 2019-03-20T14:58:55Z

README.md

 In the `prices` column you can define a list of prices for each variant separated by `;`:
 ```
-CH-EUR 999 B2B;EUR 899|745;USD 19900 #retailerA;DE-EUR 1000 B2C#wareHouse1;GB-GBP 999$2001-09-11T14:00:00.000Z~2015-10-12T14:00:00.000Z
+CH-EUR 999 B2B;EUR 899|745;USD 19900 #retailerA;DE-EUR 1000 B2C#wareHouse1;GB-GBP 999$2001-09-11T14:00:00.000Z~2015-10-12T14:00:00.000Z;EUR 500%EUR 450@1000


nitpick: according to your tests, like this one, there should be a space between the amount and the @:

~~EUR 500%EUR 450@1000~~
EUR 500%EUR 450 @1000

I had another look at the code now and it looks really good already 💯 I would just like to expand on the docs so it's easier to understand how to use it. Added some more comments and questions below.

Also, could we please add a test for the import as well? Just so we fully test both imports and exports of this feature 👍

Tiers import test added.

daern91 · 2019-03-20T15:00:13Z

README.md

+`<country>-<currenyCode> <centAmount>|<discountedCentAmount> <customerGroupName>#<channelKey>$<validFrom>~<validUntil>%<tiers>`

 Date values `validFrom` and `validUntils` has to be in [ISO 8601 format](http://dev.commercetools.com/http-api-types.html#datetime).



I think we should add a line here on how to structure <tiers>. It's not self-evident which fields are required and in what order they should be.

daern91 · 2019-03-20T15:00:50Z

src/coffee/constants.coffee

  ATTRIBUTE_CONSTRAINT_SAME_FOR_ALL: 'SameForAll'

-  REGEX_PRICE: new RegExp /^(([A-Za-z]{2})-|)([A-Z]{3}) (-?\d+)(-?\|(\d+)|)( ([^~\$#]*)|)(#([^~\$]*)|)(\$([^~]*)|)(~(.*)|)$/
+  REGEX_PRICE: new RegExp /^(([A-Za-z]{2})-|)([A-Z]{3}) (-?\d+)(-?\|(\d+)|)( ([^~\$#%]*)|)(#([^~\$%]*)|)(\$([^~%]*)|)(~([^%]*)|)(%([A-Z]{3} -?\d+ @\d+(.*))|)$/


Woah, this is insane 😄

Babanila · 2019-03-26T13:32:54Z

I had another look at the code now and it looks really good already 💯 I would just like to expand on the docs so it's easier to understand how to use it. Added some more comments and questions below.

Also, could we please add a test for the import as well? Just so we fully test both imports and exports of this feature 👍

Yes, tiers import test added.

daern91

Looks good to me now, thanks @Babanila! Let's also await review from @junajan before merging.

junajan

LGTM .. just added two nitpicks

junajan · 2019-04-02T21:13:58Z

src/coffee/mapping.coffee

+      formattedTier =
+        value:
+          currencyCode: matchedPriceTier[0]
+          centAmount: parseInt matchedPriceTier[1]


Suggested change

centAmount: parseInt matchedPriceTier[1]

centAmount: parseInt matchedPriceTier[1], 10

it is safer to use parseInt(number, 10) so it is always parsed with decimal number base

junajan · 2019-04-02T21:14:07Z

src/coffee/mapping.coffee

+        value:
+          currencyCode: matchedPriceTier[0]
+          centAmount: parseInt matchedPriceTier[1]
+        minimumQuantity: parseInt matchedPriceTier[3]


Suggested change

minimumQuantity: parseInt matchedPriceTier[3]

minimumQuantity: parseInt matchedPriceTier[3], 10

…umQuantity

Babanila added 27 commits February 19, 2019 17:02

feat(mapping.spec.coffee): add tiers test

50569c9

feat(mapping.coffee): add mapping tiers func

299549f

feat(exportmapping.spec.coffee): add tiers export mapping test

6f8e37c

feat(exportmapping.coffee): add tiers export mapping func

e0b52c7

refactor(): add spaces to the priceTier format

2ec13a3

test(mapping.spec.coffee): add tiers mapping test

3b7f129

test(exportmapping.spec.coffee): add tiers exportmapping test

1d289b3

feat(exportmapping.coffee): add tiers feature for export

9be5506

docs(moneySetAttributeProduct): add tiers to prices data

355f89e

feat(globals.coffee): add multi delimiter value for tiers

c468dc8

test(exportmapping.spec.coffee): add tiers multi delimiter value to test

cc45891

feat(exportmapping.coffee): add tiers multi delimiter

88e2eaf

feat(mapping.spec.coffee): add tiers mapping tests

a35f9ec

feat(constants.coffee): add tiers to price

e76b8ab

feat(mapping.coffee): add tiers mapping feature

ed19259

chore(deps): add package-lock.json file

9229a1c

docs(README.md): add tiers to prices attributes

9b7a4a8

docs(README.md): remove space from the tiers sample

7661e08

feat(export.spec.coffee): add tiers to prices export

8910416

Merge remote-tracking branch 'origin/master' into 242-use-sphere-prod…

23d15b2

…uct-csv-sync-to-sync-tier-prices

feat(constants.coffee): add space between priceTier

14ab695

test(mapping.spec.coffee): add space to priceTier

401d1af

feat(mapping.coffee): add global variable parameter and space to pric…

efb8bd4

…eTier

test(exportmapping.spec.coffee): add space to priceTier tests

9bf516c

feat(exportmapping.coffee): add space to priceTier

f3a3cd9

test(export.spec.coffee): add space to priceTier

5516de5

chore(deps): update package-lock.json file

3572da0

Babanila self-assigned this Mar 13, 2019

Babanila requested review from daern91 and junajan March 13, 2019 14:45

Babanila added the Status: Review label Mar 13, 2019

daern91 requested a review from butenkor March 13, 2019 15:28

Babanila commented Mar 15, 2019

View reviewed changes

daern91 reviewed Mar 19, 2019

View reviewed changes

daern91 suggested changes Mar 20, 2019

View reviewed changes

Babanila added 2 commits March 25, 2019 13:51

docs(README.md): add tiers examples to docs

ca7009c

test(import.spec.coffee): add tiers import test

9e4623a

daern91 removed the request for review from butenkor March 25, 2019 16:41

Babanila requested a review from daern91 March 26, 2019 14:03

daern91 approved these changes Mar 26, 2019

View reviewed changes

junajan approved these changes Apr 2, 2019

View reviewed changes

feat(mapping.coffee): add decimal number base to centAmount and minim…

7daae9c

…umQuantity

Babanila merged commit bd25263 into master Apr 3, 2019

stmeissner removed the Status: Review label Apr 3, 2019

Babanila deleted the 242-use-sphere-product-csv-sync-to-sync-tier-prices branch April 3, 2019 09:23

		`<country>-<currenyCode> <centAmount>\|<discountedCentAmount> <customerGroupName>#<channelKey>$<validFrom>~<validUntil>%<tiers>`

		Date values `validFrom` and `validUntils` has to be in [ISO 8601 format](http://dev.commercetools.com/http-api-types.html#datetime).

	centAmount: parseInt matchedPriceTier[1]
	centAmount: parseInt matchedPriceTier[1], 10

	minimumQuantity: parseInt matchedPriceTier[3]
	minimumQuantity: parseInt matchedPriceTier[3], 10

feat(): Add tiered prices sync support for product Import/Export #244

feat(): Add tiered prices sync support for product Import/Export #244

Uh oh!

Conversation

Babanila commented Mar 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Support reference number

Summary

Description

Uh oh!

coveralls commented Mar 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daern91 left a comment

Choose a reason for hiding this comment

Uh oh!

daern91 Mar 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Babanila Mar 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daern91 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Babanila commented Mar 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daern91 left a comment

Choose a reason for hiding this comment

Uh oh!

junajan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Babanila commented Mar 13, 2019 •

edited

Loading

coveralls commented Mar 13, 2019 •

edited

Loading

daern91 Mar 19, 2019 •

edited

Loading

Babanila Mar 25, 2019 •

edited

Loading

Babanila commented Mar 26, 2019 •

edited

Loading