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>
2022-09-07 10:21:29 +02:00
parent af80e0fd2e
commit cbb7dd9787
105 changed files with 6788 additions and 1040 deletions
@@ -0,0 +1,45 @@
+import { calculatePriceTaxAmount } from "../calculate-price-tax-amount"
+import { FlagRouter } from "../../utils/flag-router"
+
+describe("calculatePriceTaxAmount", () => {
+  describe("Calculate taxes from a given price", () => {
+    beforeAll(() => {
+      jest.spyOn(FlagRouter.prototype, "isFeatureEnabled").mockReturnValue(true)
+    })
+
+    it("Tax NOT included", () => {
+      const tax = calculatePriceTaxAmount({
+        price: 150,
+        taxRate: 0.19,
+        includesTax: false,
+      })
+
+      expect(tax).toBeCloseTo(28.5, 2)
+
+      const tax2 = calculatePriceTaxAmount({
+        price: 120,
+        taxRate: 0.17,
+      })
+
+      expect(tax2).toBeCloseTo(20.4, 2)
+    })
+
+    it("Tax included", () => {
+      const tax = calculatePriceTaxAmount({
+        price: 115,
+        taxRate: 0.15,
+        includesTax: true,
+      })
+
+      expect(tax).toBeCloseTo(15, 2)
+
+      const tax2 = calculatePriceTaxAmount({
+        price: 2150,
+        taxRate: 0.17,
+        includesTax: true,
+      })
+
+      expect(tax2).toBeCloseTo(312.39, 2)
+    })
+  })
+})
@@ -0,0 +1,23 @@
+/**
+ * Return the tax amount that
+ * - is includes in the price if it is tax inclusive
+ * - will be applied on to the price if it is tax exclusive
+ * @param price
+ * @param includesTax
+ * @param taxRate
+ */
+export function calculatePriceTaxAmount({
+  price,
+  includesTax,
+  taxRate,
+}: {
+  price: number
+  includesTax?: boolean
+  taxRate: number
+}): number {
+  if (includesTax) {
+    return (taxRate * price) / (1 + taxRate)
+  }
+
+  return price * taxRate
+}
@@ -1,9 +1,5 @@
- import { getConfigFile } from "medusa-core-utils"
 import { Column, ColumnOptions, Entity, EntityOptions } from "typeorm"
-import featureFlagsLoader from "../loaders/feature-flags"
-import path from "path"
-import { ConfigModule } from "../types/global"
-import { FlagRouter } from "./flag-router"
+import { featureFlagRouter } from "../loaders/feature-flags"

 /**
  * If that file is required in a non node environment then the setImmediate timer does not exists.
@@ -28,8 +24,6 @@ export function FeatureFlagColumn(
 ): PropertyDecorator {
  return function (target, propertyName) {
    setImmediate_((): any => {
-      const featureFlagRouter = getFeatureFlagRouter()
-
      if (!featureFlagRouter.isFeatureEnabled(featureFlag)) {
        return
      }
@@ -45,8 +39,6 @@ export function FeatureFlagDecorators(
 ): PropertyDecorator {
  return function (target, propertyName) {
    setImmediate_((): any => {
-      const featureFlagRouter = getFeatureFlagRouter()
-
      if (!featureFlagRouter.isFeatureEnabled(featureFlag)) {
        return
      }
@@ -65,19 +57,8 @@ export function FeatureFlagEntity(
 ): ClassDecorator {
  return function (target: Function): void {
    target["isFeatureEnabled"] = function (): boolean {
-      const featureFlagRouter = getFeatureFlagRouter()
-
      return featureFlagRouter.isFeatureEnabled(featureFlag)
    }
    Entity(name, options)(target)
  }
 }
-
-function getFeatureFlagRouter(): FlagRouter {
-  const { configModule } = getConfigFile(
-    path.resolve("."),
-    `medusa-config`
-  ) as { configModule: ConfigModule }
-
-  return featureFlagsLoader(configModule)
-}
@@ -1,7 +1,7 @@
 import { FeatureFlagsResponse, IFlagRouter } from "../types/feature-flags"

 export class FlagRouter implements IFlagRouter {
-  private flags: Record<string, boolean> = {}
+  private readonly flags: Record<string, boolean> = {}

  constructor(flags: Record<string, boolean>) {
    this.flags = flags
@@ -4,3 +4,4 @@ export * from "./validate-id"
 export * from "./generate-entity-id"
 export * from "./remove-undefined-properties"
 export * from "./is-defined"
+export * from "./calculate-price-tax-amount"