feat(medusa): Tax-inclusive pricing (#2131)

* add feature flag for tax inclusive pricing

* update db model for TIP

* add migration

* set featureflag column decorators

* remove unused prop

* update tests to reflect feature_flags as any array

* fix types

* reference key from featureFlag file

* use feature flag key in models

* fix copy paste mistake

* unify spelling

* Create gorgeous-experts-guess.md

* feat(medusa): create/update endpoints of currency/region/price-lists/shipping-options should allow to pass includes_tax

* test(integration): continue to add some integration test

* test(integration): continue to add some integration test

* test(unit): Fix region service tests

* fix(medusa): API unit tests flags management

* feat(medusa): Minor cleanup

* style(medusa): Fix typo

* fix(medusa): rebase

* feat(medusa): Replace old tag with the new one

* feat(medusa): revert flag

* feat(medusa): Cleanup

* feat(medusa): feedback

* feat(medusa): Rename currency retrieve method

* test(medudsa): fix unit tests

* chore(medusa): fix oas

* feat(medusa): ShippingMethod should include tax setting from parent option (#2021)

* feat(medusa): Shipping method should includes tax from parent options

* feat(medusa): Condition the includes tax flag to the availability of the feature and add some other tests

* test(integration): Move cart/order ff test in separate files

* fix: snapshots folder

* fix(integration): snapshots

* Create calm-baboons-sit.md

* test(integration): file naming

Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>

* Feat/tax inclusive pricing extend price selection strategy (#2087)

* initial changes to price selection strategy including unit tests

* typing for tax calculation

* update types and remove region and currency from prices results

* fix casing

* include tax calculation in priceselectionstrategy

* integration tests for tax inclusive pricing price calculations

* fix build

* include tax inclusive considerations when calculating tax fields for variants

* include only "includes_tax" fields from currency and region joins

* test to see errors in pipelines

* conditionally join featureflagged fields

* add "includes_tax" to price list factory

* add tests for tax inclusive price list prices and currency prices

* fix unit tests

* refactor pricing array checks to expect arraycontaining

* undo error handler

* Feat/tax inclusive pricing flag on generated lineitems (#2108)

* include tax inclusive pricing flag on generated lineitems

* initial addition of tax inclusivity for lineitem service

* add generate test to ensure that includes_tax is set when returned from price selection strategy

* add integration test for generating lineitem including tax

* add test for negative tax inclusion

* add tests for mixed pricing

* add negative test for setting tax exclusivity

* restructure the setting of includes_tax on lineitems

* fix: update cwd to be correct in cart test

* feat(medusa): Line item totals calculations (#2123)

* feat(medusa): Update totals and tax calculation way to calculate the totals

* feat(medusa): remove region feetching from decorate total

* feat(medusa): cleanup

* test(medusa): fix tax calculation tests

* comment

* test(integration): cleanup

* test(integration): cleanup

* fix(medusa): return service missing await

* feat(medusa): cleanup

* feat(medusa): cleanup

* test(integration): fix data

* feat(medusa): improve tax calculation readability

* test(medusa): improve tax calculation structure case

Co-authored-by: Sebastian Rindom <skrindom@gmail.com>

* Feat(medusa): tax inclusive pricing in shipping method tax (#2125)

* initial implementation and test

* include tax inclusive calculations for getting shipping options

* remove inaccurate comment

* remove console log

* refactor how prices and taxes are set for shipping methods

* fix integration tests

* remove verbose flag

* fix integration tests

* remove console log

* format util

* use util in price service and tax strategy

* fix faulty integration test

* undo tax calculation strategy changes in favor or Carlos' pr

* undo changes to tax calculation strategy tests

* round tax amount

* feat(medusa): cleanup calculate tax amount utils and its usage (#2136)

* feat(medusa): Refund line totals calculation (#2139)

Rely on the update of the following pr https://github.com/medusajs/medusa/pull/2136

**WIP Missing integration tests**

**What**

Update the totals calculation on the refund line to include the notion of tax inclusive

**Test**

- Update and add new tests around the refund


Fixes CORE-482

* feat(medusa): Tax inclusive discounts calculations (#2137)

**What**

- Calculate line adjustments correctly taking into account the tax inclusivity
- fix totals getLineItemTotals by adjusting the sub total with the original tax amount instead of the tax amount when the unit price includes the taxes

**Tests**
- The tests create a cart with a percentage discount of 15%, the cart includes 2 items mixing the tax inclusive and validate the items on the result cart as well as the totals on each item. I ve based my calculation validation based on what we have done + some articles around discount apply on price without taxes to validate the output.,
FIXES CORE-477

* Chore: shipping methods tax inclusive total (#2130)

* chore: calculate tax inclusive shipping methods

* chore: additional tests and check undefined tax_rate (#2157)

* chore: additional tests and check undefined tax_rate

* fix: naming + correct price type check

* fix: remove price_includes_tax from type

* fix: remove price_includes_tax from type

Co-authored-by: Philip Korsholm <philip.korsholm@hotmail.com>
Co-authored-by: adrien2p <adrien.deperetti@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com>
Co-authored-by: Philip Korsholm <88927411+pKorsholm@users.noreply.github.com>
Co-authored-by: Sebastian Rindom <skrindom@gmail.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
This commit is contained in:
Oliver Windall Juhl
2022-09-07 10:21:29 +02:00
committed by GitHub
co-authored by Philip Korsholm adrien2p Carlos R. L. Rodrigues Philip Korsholm Sebastian Rindom Carlos R. L. Rodrigues
parent af80e0fd2e
commit cbb7dd9787
105 changed files with 6788 additions and 1040 deletions
@@ -9,29 +9,29 @@ const {
MoneyAmount,
} = require("@medusajs/medusa")
const setupServer = require("../../../helpers/setup-server")
const { useApi } = require("../../../helpers/use-api")
const { initDb, useDb } = require("../../../helpers/use-db")
const setupServer = require("../../../../helpers/setup-server")
const { useApi } = require("../../../../helpers/use-api")
const { initDb, useDb } = require("../../../../helpers/use-db")
const cartSeeder = require("../../helpers/cart-seeder")
const productSeeder = require("../../helpers/product-seeder")
const swapSeeder = require("../../helpers/swap-seeder")
const cartSeeder = require("../../../helpers/cart-seeder")
const productSeeder = require("../../../helpers/product-seeder")
const swapSeeder = require("../../../helpers/swap-seeder")
const {
simpleCartFactory,
simpleRegionFactory,
simpleProductFactory,
simpleShippingOptionFactory,
simpleLineItemFactory,
} = require("../../factories")
} = require("../../../factories")
const {
simpleDiscountFactory,
} = require("../../factories/simple-discount-factory")
} = require("../../../factories/simple-discount-factory")
const {
simpleCustomerFactory,
} = require("../../factories/simple-customer-factory")
} = require("../../../factories/simple-customer-factory")
const {
simpleCustomerGroupFactory,
} = require("../../factories/simple-customer-group-factory")
} = require("../../../factories/simple-customer-group-factory")
jest.setTimeout(30000)
@@ -45,7 +45,7 @@ describe("/store/carts", () => {
}
beforeAll(async () => {
const cwd = path.resolve(path.join(__dirname, "..", ".."))
const cwd = path.resolve(path.join(__dirname, "..", "..", ".."))
dbConnection = await initDb({ cwd })
medusaProcess = await setupServer({ cwd, verbose: false })
})
@@ -1813,7 +1813,7 @@ describe("/store/carts", () => {
type: "swap",
})
const cartWithCustomSo = await manager.save(_cart)
await manager.save(_cart)
await manager.insert(CustomShippingOption, {
id: "another-cso-test",
@@ -0,0 +1,538 @@
const path = require("path")
const startServerWithEnvironment =
require("../../../../helpers/start-server-with-environment").default
const { useApi } = require("../../../../helpers/use-api")
const { useDb } = require("../../../../helpers/use-db")
const {
simpleCartFactory,
simpleRegionFactory,
simpleShippingOptionFactory,
simpleCustomShippingOptionFactory,
simpleProductFactory,
simplePriceListFactory,
simpleDiscountFactory,
} = require("../../../factories")
const { IdMap } = require("medusa-test-utils")
jest.setTimeout(30000)
describe("[MEDUSA_FF_TAX_INCLUSIVE_PRICING] /store/carts", () => {
let medusaProcess
let dbConnection
beforeAll(async () => {
const cwd = path.resolve(path.join(__dirname, "..", "..", ".."))
const [process, connection] = await startServerWithEnvironment({
cwd,
env: { MEDUSA_FF_TAX_INCLUSIVE_PRICING: true },
verbose: false,
})
dbConnection = connection
medusaProcess = process
})
afterAll(async () => {
const db = useDb()
await db.shutdown()
medusaProcess.kill()
})
describe("POST /store/carts/:id/shipping-methods", () => {
let includesTaxShippingOption
let cart
let customSoCart
beforeEach(async () => {
try {
const shippingAddress = {
id: "test-shipping-address",
first_name: "lebron",
country_code: "us",
}
const region = await simpleRegionFactory(dbConnection, {
id: "test-region",
})
cart = await simpleCartFactory(dbConnection, {
id: "test-cart",
email: "some-customer1@email.com",
region: region.id,
shipping_address: shippingAddress,
currency_code: "usd",
})
customSoCart = await simpleCartFactory(dbConnection, {
id: "test-cart-with-cso",
email: "some-customer2@email.com",
region: region.id,
shipping_address: shippingAddress,
currency_code: "usd",
})
includesTaxShippingOption = await simpleShippingOptionFactory(
dbConnection,
{
includes_tax: true,
region_id: region.id,
}
)
await simpleCustomShippingOptionFactory(dbConnection, {
id: "another-cso-test",
cart_id: customSoCart.id,
shipping_option_id: includesTaxShippingOption.id,
price: 5,
})
} catch (err) {
console.log(err)
}
})
afterEach(async () => {
const db = useDb()
return await db.teardown()
})
it("should add a normal shipping method to the cart", async () => {
const api = useApi()
const cartWithShippingMethodRes = await api.post(
`/store/carts/${cart.id}/shipping-methods`,
{
option_id: includesTaxShippingOption.id,
},
{ withCredentials: true }
)
expect(cartWithShippingMethodRes.status).toEqual(200)
expect(cartWithShippingMethodRes.data.cart.shipping_methods).toEqual(
expect.arrayContaining([
expect.objectContaining({
shipping_option_id: includesTaxShippingOption.id,
includes_tax: true,
}),
])
)
})
it("should add a custom shipping method to the cart", async () => {
const api = useApi()
const cartWithCustomShippingMethodRes = await api
.post(
`/store/carts/${customSoCart.id}/shipping-methods`,
{
option_id: includesTaxShippingOption.id,
},
{ withCredentials: true }
)
.catch((err) => err.response)
expect(cartWithCustomShippingMethodRes.status).toEqual(200)
expect(
cartWithCustomShippingMethodRes.data.cart.shipping_methods
).toEqual(
expect.arrayContaining([
expect.objectContaining({
shipping_option_id: includesTaxShippingOption.id,
includes_tax: true,
price: 5,
}),
])
)
})
})
describe("POST /store/carts/:id", () => {
const variantId1 = IdMap.getId("test-variant-1")
const variantId2 = IdMap.getId("test-variant-2")
const productId1 = IdMap.getId("test-product-1")
const productId2 = IdMap.getId("test-product-2")
const regionId = IdMap.getId("test-region")
const regionData = {
id: regionId,
includes_tax: false,
currency_code: "usd",
countries: ["us"],
tax_rate: 20,
name: "region test",
}
const buildProductData = (productId, variantId) => {
return {
id: productId,
variants: [
{
id: variantId,
prices: [],
},
],
}
}
const buildPriceListData = (variantId, price, includesTax) => {
return {
status: "active",
type: "sale",
prices: [
{
variant_id: variantId,
amount: price,
currency_code: "usd",
region_id: regionId,
},
],
includes_tax: includesTax,
}
}
const customnerPayload = {
email: "adrien@test.dk",
password: "adrientest",
first_name: "adrien",
last_name: "adrien",
}
const createCartPayload = {
region_id: regionId,
items: [
{
variant_id: variantId1,
quantity: 1,
},
{
variant_id: variantId2,
quantity: 1,
},
],
}
describe("with a cart with full tax exclusive variant pricing", () => {
beforeEach(async () => {
await simpleRegionFactory(dbConnection, regionData)
await simpleProductFactory(
dbConnection,
buildProductData(productId1, variantId1)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId1, 100, false)
)
await simpleProductFactory(
dbConnection,
buildProductData(productId2, variantId2)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId2, 100, false)
)
})
afterEach(async () => {
const db = useDb()
return await db.teardown()
})
it("should calculates correct payment totals on cart completion", async () => {
const api = useApi()
const customerRes = await api.post(
"/store/customers",
customnerPayload,
{ withCredentials: true }
)
const createCartRes = await api.post("/store/carts", createCartPayload)
const cart = createCartRes.data.cart
await api.post(`/store/carts/${cart.id}`, {
customer_id: customerRes.data.customer.id,
})
await api.post(`/store/carts/${cart.id}/payment-sessions`)
const createdOrder = await api.post(
`/store/carts/${cart.id}/complete-cart`
)
expect(createdOrder.data.type).toEqual("order")
expect(createdOrder.data.data.discount_total).toEqual(0)
expect(createdOrder.data.data.subtotal).toEqual(200)
expect(createdOrder.data.data.total).toEqual(240)
expect(createdOrder.status).toEqual(200)
})
})
describe("with a cart with full tax inclusive variant pricing", () => {
beforeEach(async () => {
await simpleRegionFactory(dbConnection, regionData)
await simpleProductFactory(
dbConnection,
buildProductData(productId1, variantId1)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId1, 120, true)
)
await simpleProductFactory(
dbConnection,
buildProductData(productId2, variantId2)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId2, 120, true)
)
})
afterEach(async () => {
const db = useDb()
return await db.teardown()
})
it("should calculates correct payment totals on cart completion", async () => {
const api = useApi()
const customerRes = await api.post(
"/store/customers",
customnerPayload,
{ withCredentials: true }
)
const createCartRes = await api.post("/store/carts", createCartPayload)
const cart = createCartRes.data.cart
await api.post(`/store/carts/${cart.id}`, {
customer_id: customerRes.data.customer.id,
})
await api.post(`/store/carts/${cart.id}/payment-sessions`)
const createdOrder = await api.post(
`/store/carts/${cart.id}/complete-cart`
)
expect(createdOrder.data.type).toEqual("order")
expect(createdOrder.data.data.discount_total).toEqual(0)
expect(createdOrder.data.data.subtotal).toEqual(200)
expect(createdOrder.data.data.total).toEqual(240)
expect(createdOrder.status).toEqual(200)
})
})
describe("with a cart mixing tax inclusive and exclusive variant pricing", () => {
beforeEach(async () => {
await simpleRegionFactory(dbConnection, regionData)
await simpleProductFactory(
dbConnection,
buildProductData(productId1, variantId1)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId1, 120, true)
)
await simpleProductFactory(
dbConnection,
buildProductData(productId2, variantId2)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId2, 100, false)
)
})
afterEach(async () => {
const db = useDb()
return await db.teardown()
})
it("should calculates correct payment totals on cart completion", async () => {
const api = useApi()
const customerRes = await api.post(
"/store/customers",
customnerPayload,
{ withCredentials: true }
)
const createCartRes = await api.post("/store/carts", createCartPayload)
const cart = createCartRes.data.cart
await api.post(`/store/carts/${cart.id}`, {
customer_id: customerRes.data.customer.id,
})
await api.post(`/store/carts/${cart.id}/payment-sessions`)
const createdOrder = await api.post(
`/store/carts/${cart.id}/complete-cart`
)
expect(createdOrder.data.type).toEqual("order")
expect(createdOrder.data.data.discount_total).toEqual(0)
expect(createdOrder.data.data.subtotal).toEqual(200)
expect(createdOrder.data.data.total).toEqual(240)
expect(createdOrder.status).toEqual(200)
})
})
})
describe("POST /store/carts/:id/line-items", () => {
const cartIdWithItemPercentageDiscount =
"test-cart-w-item-percentage-discount"
const percentage15discountId = IdMap.getId("percentage15discountId")
const variantId1 = IdMap.getId("test-variant-1")
const variantId2 = IdMap.getId("test-variant-2")
const productId1 = IdMap.getId("test-product-1")
const productId2 = IdMap.getId("test-product-2")
const regionId = IdMap.getId("test-region")
const regionData = {
id: regionId,
includes_tax: false,
currency_code: "usd",
countries: ["us"],
tax_rate: 20,
name: "region test",
}
const buildProductData = (productId, variantId) => {
return {
id: productId,
variants: [
{
id: variantId,
prices: [],
},
],
}
}
const buildPriceListData = (variantId, price, includesTax) => {
return {
status: "active",
type: "sale",
prices: [
{
variant_id: variantId,
amount: price,
currency_code: "usd",
region_id: regionId,
},
],
includes_tax: includesTax,
}
}
describe("with a cart mixing tax inclusive and exclusive variant pricing", () => {
beforeEach(async () => {
const region = await simpleRegionFactory(dbConnection, regionData)
await simpleCartFactory(dbConnection, {
id: cartIdWithItemPercentageDiscount,
region,
})
await simpleProductFactory(
dbConnection,
buildProductData(productId1, variantId1)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId1, 120, true)
)
await simpleProductFactory(
dbConnection,
buildProductData(productId2, variantId2)
)
await simplePriceListFactory(
dbConnection,
buildPriceListData(variantId2, 100, false)
)
const tenDaysAgo = ((today) =>
new Date(today.setDate(today.getDate() - 10)))(new Date())
const tenDaysFromToday = ((today) =>
new Date(today.setDate(today.getDate() + 10)))(new Date())
await simpleDiscountFactory(dbConnection, {
id: percentage15discountId,
code: percentage15discountId,
regions: [regionId],
rule: {
type: "percentage",
value: "15",
allocation: "item",
},
starts_at: tenDaysAgo,
ends_at: tenDaysFromToday,
})
})
afterEach(async () => {
const db = useDb()
return await db.teardown()
})
it("calculates correct item totals for percentage discount with mix of tax inclusive/exclusive items", async () => {
const api = useApi()
await api.post(`/store/carts/${cartIdWithItemPercentageDiscount}`, {
region_id: regionId,
discounts: [{ code: percentage15discountId }],
})
await api.post(
`/store/carts/${cartIdWithItemPercentageDiscount}/line-items`,
{
variant_id: variantId1,
quantity: 2,
},
{ withCredentials: true }
)
const response = await api.post(
`/store/carts/${cartIdWithItemPercentageDiscount}/line-items`,
{
variant_id: variantId2,
quantity: 2,
},
{ withCredentials: true }
)
const expectedItemTotals = {
subtotal: 200,
gift_card_total: 0,
discount_total: 30,
total: 204,
original_total: 240,
original_tax_total: 40,
tax_total: 34,
}
const expectedAdjustment = {
amount: 30,
discount_id: percentage15discountId,
description: "discount",
}
expect(response.data.cart.items).toHaveLength(2)
expect(response.data.cart.items).toEqual(
expect.arrayContaining([
expect.objectContaining({
includes_tax: true,
cart_id: cartIdWithItemPercentageDiscount,
unit_price: 120,
variant_id: variantId1,
quantity: 2,
adjustments: [expect.objectContaining(expectedAdjustment)],
...expectedItemTotals,
}),
expect.objectContaining({
includes_tax: false,
cart_id: cartIdWithItemPercentageDiscount,
unit_price: 100,
variant_id: variantId2,
quantity: 2,
adjustments: [expect.objectContaining(expectedAdjustment)],
...expectedItemTotals,
}),
])
)
})
})
})
})