@evershop/evershop 1.1.0 → 1.2.1

package/src/modules/checkout/services/toPrice.js

@@ -10,7 +10,7 @@ exports.toPrice = function toPrice(value, forDisplay = false) {
   }
   const rounding = getConfig('pricing.rounding', 'round');
   const precision = getConfig('pricing.precision', 2);
-  const precisionFix = parseInt(`1${'0'.repeat(precision)}`, 10);
+  const precisionFix = 10**precision;
   switch (rounding) {
     case 'up':
       price = Math.ceil(price * precisionFix) / precisionFix;

package/src/modules/checkout/tests/basicSetup.js

@@ -0,0 +1,85 @@
+process.env.ALLOW_CONFIG_MUTATIONS = true;
+const {
+  addProcessor,
+  addFinalProcessor
+} = require('@evershop/evershop/src/lib/util/registry');
+const {
+  registerCartBaseFields
+} = require('../services/cart/registerCartBaseFields');
+const {
+  registerCartItemBaseFields
+} = require('../services/cart/registerCartItemBaseFields');
+const { sortFields } = require('../services/cart/sortFields');
+const { products } = require('./products');
+const { taxRates } = require('./taxRates');
+const {
+  registerCartPromotionFields
+} = require('../../promotion/services/registerCartPromotionFields');
+const {
+  registerCartItemPromotionFields
+} = require('../../promotion/services/registerCartItemPromotionFields');
+const { coupons } = require('./coupons');
+const {
+  registerDefaultValidators
+} = require('../../promotion/services/registerDefaultValidators');
+const {
+  registerDefaultCalculators
+} = require('../../promotion/services/registerDefaultCalculators');
+
+// Default tax configuration
+addProcessor('cartFields', registerCartBaseFields, 0);
+addProcessor('cartFields', registerCartPromotionFields, 0);
+addProcessor('cartItemFields', registerCartItemBaseFields, 0);
+addProcessor('cartItemFields', registerCartItemPromotionFields, 0);
+addProcessor(
+  'cartItemFields',
+  (fields) => {
+    fields.push({
+      key: 'tax_percent',
+      resolvers: [
+        function resolver() {
+          const classId = this.getData('tax_class_id');
+          return taxRates[classId] || 0;
+        }
+      ],
+      dependencies: ['tax_class_id']
+    });
+    return fields;
+  },
+  0
+);
+
+addFinalProcessor('cartFields', (fields) => {
+  try {
+    const sortedFields = sortFields(fields);
+    return sortedFields;
+  } catch (e) {
+    error(e);
+    throw e;
+  }
+});
+
+addFinalProcessor('cartItemFields', (fields) => {
+  try {
+    const sortedFields = sortFields(fields);
+    return sortedFields;
+  } catch (e) {
+    error(e);
+    throw e;
+  }
+});
+
+addProcessor('cartItemProductLoaderFunction', () => {
+  return (id) => {
+    return products.find((product) => product.product_id === id);
+  };
+});
+
+addProcessor('couponLoaderFunction', () => {
+  return (code) => {
+    return coupons.find((coupon) => coupon.coupon === code);
+  };
+});
+
+addProcessor('couponValidatorFunctions', registerDefaultValidators);
+addProcessor('discountCalculatorFunctions', registerDefaultCalculators);

package/src/modules/checkout/tests/coupons.js

@@ -0,0 +1,82 @@
+const coupons = [
+  {
+    coupon_id: 1,
+    uuid: '511b3def-bfe0-4cff-91ce-667586939bdb',
+    status: true,
+    description: 'percentage_discount_to_entire_order',
+    discount_amount: 10,
+    free_shipping: false,
+    discount_type: 'percentage_discount_to_entire_order',
+    coupon: 'ten_percent_discount_to_entire_order',
+    used_time: 0,
+    target_products: [],
+    condition: { order_qty: '', order_total: '' },
+    user_condition: { email: '', groups: [''], purchased: '' },
+    buyx_gety: [
+      {
+        sku: 'AT46 8703 9964 4659 4364',
+        max_y: 2,
+        buy_qty: 3,
+        get_qty: 1,
+        discount: 70
+      },
+      {
+        sku: 'LU72 5610 V9CD PSQH XZTE',
+        max_y: 3,
+        buy_qty: 2,
+        get_qty: 1,
+        discount: 100
+      }
+    ],
+    max_uses_time_per_coupon: null,
+    max_uses_time_per_customer: null,
+    start_date: null,
+    end_date: null,
+    created_at: '2020-04-23 23:22:33+07',
+    updated_at: '2020-04-24 00:45:33+07'
+  },
+  {
+    coupon_id: 1,
+    uuid: '511b3sef-bfe0-4cff-91ce-667586939bdb',
+    status: true,
+    description: '100_fixed_discount_to_entire_order',
+    discount_amount: 100,
+    free_shipping: false,
+    discount_type: 'fixed_discount_to_entire_order',
+    coupon: '100_fixed_discount_to_entire_order',
+    used_time: 0,
+    target_products: [],
+    condition: { order_qty: '', order_total: '' },
+    user_condition: { email: '', groups: [''], purchased: '' },
+    buyx_gety: [],
+    max_uses_time_per_coupon: null,
+    max_uses_time_per_customer: null,
+    start_date: null,
+    end_date: null,
+    created_at: '2020-04-23 23:22:33+07',
+    updated_at: '2020-04-24 00:45:33+07'
+  },
+  {
+    coupon_id: 1,
+    uuid: '511b3sef-bfe0-4cff-91ce-667586939bdb',
+    status: true,
+    description: '500_fixed_discount_to_entire_order',
+    discount_amount: 500,
+    free_shipping: false,
+    discount_type: 'fixed_discount_to_entire_order',
+    coupon: '500_fixed_discount_to_entire_order',
+    used_time: 0,
+    target_products: [],
+    condition: { order_qty: '', order_total: '' },
+    user_condition: { email: '', groups: [''], purchased: '' },
+    buyx_gety: [],
+    max_uses_time_per_coupon: null,
+    max_uses_time_per_customer: null,
+    start_date: null,
+    end_date: null,
+    created_at: '2020-04-23 23:22:33+07',
+    updated_at: '2020-04-24 00:45:33+07'
+  }
+];
+
+module.exports.coupons = coupons;

package/src/modules/checkout/tests/products.js

@@ -0,0 +1,67 @@
+const products = [
+  {
+    product_id: 1,
+    name: 'Product 1',
+    sku: 'SKU1',
+    price: 100,
+    status: true,
+    qty: 100,
+    tax_class: 1
+  },
+  {
+    product_id: 2,
+    name: 'Product 2',
+    sku: 'SKU2',
+    price: 200,
+    status: true,
+    qty: 100,
+    tax_class: 1
+  },
+  {
+    product_id: 3,
+    name: 'Product 3',
+    sku: 'SKU3',
+    price: 300,
+    status: true,
+    qty: 100,
+    tax_class: 1
+  },
+  {
+    product_id: 4,
+    name: 'No Tax',
+    sku: 'SKU4',
+    price: 300,
+    status: true,
+    qty: 100,
+    tax_class: null
+  },
+  {
+    product_id: 5,
+    name: 'Tax Exempt',
+    sku: 'SKU5',
+    price: 123.45,
+    status: true,
+    qty: 100,
+    tax_class: 3
+  },
+  {
+    product_id: 6,
+    name: 'Long decimal tax',
+    sku: 'SKU6',
+    price: 345.73,
+    status: true,
+    qty: 100,
+    tax_class: 4
+  },
+  {
+    product_id: 7,
+    name: 'Tax 10%',
+    sku: 'SKU7',
+    price: 819,
+    status: true,
+    qty: 100,
+    tax_class: 1
+  }
+];
+
+module.exports.products = products;

package/src/modules/checkout/tests/taxRates.js

@@ -0,0 +1,3 @@
+const rates = [0, 10, 15, 7.25, 5.37];
+
+module.exports.taxRates = rates;

package/src/modules/checkout/tests/unit/discountAmount.test.js

@@ -0,0 +1,60 @@
+/* eslint-disable no-undef, global-require */
+process.env.ALLOW_CONFIG_MUTATIONS = 'true';
+const config = require('config');
+require('../basicSetup');
+const { Cart } = require('../../services/cart/Cart');
+// Default tax configuration
+config.util.setModuleDefaults('pricing', {
+  tax: {
+    price_including_tax: false
+  }
+});
+
+describe('Test discount amount calculation', () => {
+  it('Percentage discount to entire order', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const pricingConfig = config.get('pricing');
+    pricingConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('discount_amount')).toEqual(0);
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(cart.getData('discount_amount')).toEqual(10);
+    pricingConfig.tax.price_including_tax = true;
+    await item.build();
+    await cart.build();
+    expect(cart.getData('discount_amount')).toEqual(10);
+    pricingConfig.tax.price_including_tax = false;
+    await item.build();
+    const item2 = await cart.addItem(2, 2);
+    expect(cart.getData('discount_amount')).toEqual(50);
+    await cart.setData('coupon', '100_fixed_discount_to_entire_order');
+    expect(cart.getData('discount_amount')).toEqual(100);
+    pricingConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(cart.getData('discount_amount')).toEqual(50);
+    await cart.setData('coupon', '100_fixed_discount_to_entire_order');
+    expect(cart.getData('discount_amount')).toEqual(100);
+  });
+
+  it('It should apply maximum discount amount when discount amount is greater than the total price', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const pricingConfig = config.get('pricing');
+    pricingConfig.tax.price_including_tax = false;
+    await cart.setData('coupon', '500_fixed_discount_to_entire_order');
+    const item = await cart.addItem(1, 1);
+    expect(cart.getData('discount_amount')).toEqual(100);
+    const item2 = await cart.addItem(2, 1);
+    expect(cart.getData('discount_amount')).toEqual(300);
+    pricingConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await cart.build();
+    expect(cart.getData('discount_amount')).toEqual(300);
+  });
+});

package/src/modules/checkout/tests/unit/grandTotal.test.js

@@ -0,0 +1,83 @@
+/* eslint-disable no-undef, global-require */
+process.env.ALLOW_CONFIG_MUTATIONS = 'true';
+const config = require('config');
+require('../basicSetup');
+const { Cart } = require('../../services/cart/Cart');
+// Default tax configuration
+config.util.setModuleDefaults('pricing', {
+  tax: {
+    price_including_tax: false
+  }
+});
+
+// This test assumes there is no additional fee like shipping fee, etc.
+describe('Test grand total calculation', () => {
+  it('Grand total should equal to the sum of line total with discount including tax of all items when discount is not applied', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1); // Tax percent 10%
+    expect(cart.getData('grand_total')).toEqual(110);
+    const item2 = await cart.addItem(5, 1); // Tax percent 7.25%
+    expect(cart.getData('grand_total')).toEqual(242.4);
+    const item3 = await cart.addItem(2, 2); // Tax percent 10%
+    expect(cart.getData('grand_total')).toEqual(682.4);
+
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await item3.build();
+    await cart.build();
+    expect(cart.getData('grand_total')).toEqual(623.45);
+  });
+
+  it('Grand total should alway be equal to the sub total including tax when discount is not applied', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(cart.getData('grand_total')).toEqual(110);
+    expect(cart.getData('sub_total_incl_tax')).toEqual(110);
+    const item2 = await cart.addItem(5, 1);
+    expect(cart.getData('grand_total')).toEqual(242.4);
+    expect(cart.getData('sub_total_incl_tax')).toEqual(242.4);
+
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await cart.build();
+    expect(cart.getData('grand_total')).toEqual(223.45);
+    expect(cart.getData('sub_total_incl_tax')).toEqual(223.45);
+  });
+
+  it('Grand total should be calculated with discount amount deducted', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1); // Tax percent 10%
+    expect(cart.getData('grand_total')).toEqual(110);
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(cart.getData('grand_total')).toEqual(99);
+    const item2 = await cart.addItem(5, 1); // Tax percent 7.25%
+    // Tax rounding unit level, round to nearest with 2 decimal places
+    expect(cart.getData('grand_total')).toEqual(218.15);
+    const item3 = await cart.addItem(2, 2); // Tax percent 10%
+    expect(cart.getData('grand_total')).toEqual(614.15);
+
+    await cart.setData('coupon', '100_fixed_discount_to_entire_order');
+    expect(cart.getData('grand_total')).toEqual(572.94);
+
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await item3.build();
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(cart.getData('grand_total')).toEqual(561.1);
+  });
+});

package/src/modules/checkout/tests/unit/lineTotal.test.js

@@ -0,0 +1,92 @@
+/* eslint-disable no-undef, global-require */
+process.env.ALLOW_CONFIG_MUTATIONS = 'true';
+const config = require('config');
+require('../basicSetup');
+const { Cart } = require('../../services/cart/Cart');
+// Default tax configuration
+config.util.setModuleDefaults('pricing', {
+  tax: {
+    price_including_tax: false
+  }
+});
+
+describe('Test line total calculation', () => {
+  it('Line total should equal to the product price multiplied by quantity when tax is not included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total')).toEqual(100);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total')).toEqual(400);
+  });
+
+  it('Line total including tax should be calculated with tax amount added', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_incl_tax')).toEqual(110);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_incl_tax')).toEqual(440);
+  });
+
+  it('Line total should be calculated with tax amount deducted when tax is included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = true;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total')).toEqual(90.91);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total')).toEqual(363.64);
+  });
+
+  it('Line total including tax should be equal to product price when tax is included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = true;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_incl_tax')).toEqual(100);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_incl_tax')).toEqual(400);
+  });
+
+  it('Line total should not be affected by discount amount', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total')).toEqual(100);
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(item.getData('line_total')).toEqual(100);
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    expect(item.getData('line_total')).toEqual(90.91);
+  });
+
+  it('Line total including tax should not be affected by discount amount', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_incl_tax')).toEqual(110);
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(item.getData('line_total_incl_tax')).toEqual(110);
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    expect(item.getData('final_price_incl_tax')).toEqual(100);
+    expect(item.getData('line_total_incl_tax')).toEqual(100);
+  });
+});

package/src/modules/checkout/tests/unit/lineTotalWithDiscount.test.js

@@ -0,0 +1,103 @@
+/* eslint-disable no-undef, global-require */
+process.env.ALLOW_CONFIG_MUTATIONS = 'true';
+const config = require('config');
+require('../basicSetup');
+const { Cart } = require('../../services/cart/Cart');
+// Default tax configuration
+config.util.setModuleDefaults('pricing', {
+  tax: {
+    price_including_tax: false
+  }
+});
+
+describe('Test line total with discount calculation', () => {
+  it('Line total with discount should equal to the product price multiplied by quantity when tax is not included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_with_discount')).toEqual(100);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_with_discount')).toEqual(400);
+  });
+
+  it('Line total with discount including tax should be calculated with tax amount added', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_with_discount_incl_tax')).toEqual(110);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_with_discount_incl_tax')).toEqual(440);
+  });
+
+  it('Line total with discount should be calculated with tax amount deducted when tax is included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = true;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_with_discount')).toEqual(90.91);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_with_discount')).toEqual(363.64);
+  });
+
+  it('Line total with discount including tax should be equal to product price when tax is included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = true;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_with_discount_incl_tax')).toEqual(100);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_with_discount_incl_tax')).toEqual(400);
+  });
+
+  it('Line total with discount should be affected by discount amount', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_with_discount')).toEqual(100);
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(cart.getData('discount_amount')).toEqual(10);
+    expect(item.getData('line_total_with_discount')).toEqual(90);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_with_discount')).toEqual(360);
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await cart.build();
+    expect(item.getData('line_total_with_discount')).toEqual(81.82);
+    expect(item2.getData('line_total_with_discount')).toEqual(327.28);
+  });
+
+  it('Line total with discount including tax should be affected by discount amount', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('line_total_with_discount_incl_tax')).toEqual(110);
+    await cart.setData('coupon', 'ten_percent_discount_to_entire_order');
+    expect(cart.getData('discount_amount')).toEqual(10);
+    expect(item.getData('line_total_with_discount_incl_tax')).toEqual(99);
+    const item2 = await cart.addItem(2, 2);
+    expect(item2.getData('line_total_with_discount_incl_tax')).toEqual(396);
+    priceConfig.tax.price_including_tax = true;
+    await item.build();
+    await item2.build();
+    await cart.build();
+    expect(item.getData('line_total_with_discount_incl_tax')).toEqual(90);
+    expect(item2.getData('line_total_with_discount_incl_tax')).toEqual(360);
+  });
+});

package/src/modules/checkout/tests/unit/productPrice.test.js

@@ -0,0 +1,69 @@
+/* eslint-disable no-undef, global-require */
+process.env.ALLOW_CONFIG_MUTATIONS = 'true';
+const config = require('config');
+require('../basicSetup');
+const { Cart } = require('../../services/cart/Cart');
+// Default tax configuration
+config.util.setModuleDefaults('pricing', {
+  tax: {
+    price_including_tax: false
+  }
+});
+
+describe('Test product price calculation', () => {
+  it('Price should equal to the product price when tax is not included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('product_price')).toEqual(100);
+    expect(item.getData('final_price')).toEqual(100);
+    const noTax = await cart.addItem(4, 1);
+    expect(noTax.getData('product_price')).toEqual(300);
+    expect(noTax.getData('final_price')).toEqual(300);
+  });
+
+  it('Price including tax should be calculated with tax amount added', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = false;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('product_price_incl_tax')).toEqual(110);
+    expect(item.getData('final_price_incl_tax')).toEqual(110);
+    const noTax = await cart.addItem(4, 1);
+    expect(noTax.getData('product_price')).toEqual(300);
+    expect(noTax.getData('final_price')).toEqual(300);
+  });
+
+  it('Price should be calculated with tax amount deducted when tax is included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = true;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('product_price')).toEqual(90.91);
+    expect(item.getData('final_price')).toEqual(90.91);
+    const noTax = await cart.addItem(4, 1);
+    expect(noTax.getData('product_price')).toEqual(300);
+    expect(noTax.getData('final_price')).toEqual(300);
+  });
+
+  it('Price including tax should be equal to product price when tax is included', async () => {
+    const cart = new Cart({
+      status: 1
+    });
+    const priceConfig = config.get('pricing');
+    priceConfig.tax.price_including_tax = true;
+    const item = await cart.addItem(1, 1);
+    expect(item.getData('product_price_incl_tax')).toEqual(100);
+    expect(item.getData('final_price_incl_tax')).toEqual(100);
+    const noTax = await cart.addItem(4, 1);
+    expect(noTax.getData('product_price')).toEqual(300);
+    expect(noTax.getData('final_price')).toEqual(300);
+  });
+});