Promotions Feature Branch

.changeset/funny-scissors-share.md

@@ -0,0 +1,5 @@
+---
+"@reactioncommerce/api-plugin-promotions": minor
+---
+
+filter feature for promotions

.circleci/config.yml

@@ -102,6 +102,9 @@ jobs:
         command: mongod --oplogSize 128 --replSet rs0 --storageEngine=wiredTiger
         ports:
           - "27017:27017"
+      - image: redis
+        ports:
+          - "6379:6379"
     steps:
       - checkout
       - restore_cache:
@@ -129,6 +132,9 @@ jobs:
         command: mongod --oplogSize 128 --replSet rs0 --storageEngine=wiredTiger
         ports:
           - "27017:27017"
+      - image: redis
+        ports:
+          - "6379:6379"
     steps:
       - checkout
       - restore_cache:
@@ -189,6 +195,7 @@ jobs:
             echo "ROOT_URL=http://localhost:3000" >> .env
             echo "STORE_URL=http://localhost:4000" >> .env
             echo "STRIPE_API_KEY=YOUR_PRIVATE_STRIPE_API_KEY" >> .env
+            echo "REDIS_SERVER=redis://127.0.0.1:6379" >> .env
       - run:
           name: Create reaction.localhost network
           command: docker network create "reaction.localhost" || true

.gitignore

@@ -79,4 +79,7 @@ yalc-packages
 
 # Build
 dist
+
+# Editor
+.vscode
 .idea

apps/reaction/.env.example

@@ -1,3 +1,5 @@
 MONGO_URL=mongodb://mongo.reaction.localhost:27017/reaction
 ROOT_URL=http://localhost:3000
 STRIPE_API_KEY=YOUR_PRIVATE_STRIPE_API_KEY
+REDIS_SERVER=redis://127.0.0.1:6379
+MAIL_URL=smtp://localhost:1025

apps/reaction/package.json

@@ -29,10 +29,9 @@
     "@reactioncommerce/api-plugin-address-validation-test": "1.0.3",
     "@reactioncommerce/api-plugin-authentication": "2.2.5",
     "@reactioncommerce/api-plugin-authorization-simple": "1.3.2",
+    "@reactioncommerce/api-plugin-bull-queue": "0.0.0",
     "@reactioncommerce/api-plugin-carts": "1.3.5",
     "@reactioncommerce/api-plugin-catalogs": "1.1.2",
-    "@reactioncommerce/api-plugin-discounts": "1.0.4",
-    "@reactioncommerce/api-plugin-discounts-codes": "1.2.4",
     "@reactioncommerce/api-plugin-email": "1.1.5",
     "@reactioncommerce/api-plugin-email-smtp": "1.0.8",
     "@reactioncommerce/api-plugin-email-templates": "1.1.7",
@@ -49,6 +48,11 @@
     "@reactioncommerce/api-plugin-payments-stripe-sca": "1.0.2",
     "@reactioncommerce/api-plugin-pricing-simple": "1.0.7",
     "@reactioncommerce/api-plugin-products": "1.3.1",
+    "@reactioncommerce/api-plugin-promotions": "0.0.0",
+    "@reactioncommerce/api-plugin-promotions-coupons": "0.0.0",
+    "@reactioncommerce/api-plugin-promotions-discounts": "0.0.0",
+    "@reactioncommerce/api-plugin-promotions-offers": ".0.0",
+    "@reactioncommerce/api-plugin-sequences": "0.0.0",
     "@reactioncommerce/api-plugin-settings": "1.0.7",
     "@reactioncommerce/api-plugin-shipments": "1.0.3",
     "@reactioncommerce/api-plugin-shipments-flat-rate": "1.0.10",
@@ -66,9 +70,9 @@
     "@reactioncommerce/file-collections": "0.9.3",
     "@reactioncommerce/file-collections-sa-gridfs": "0.1.5",
     "@reactioncommerce/logger": "1.1.5",
-    "@reactioncommerce/nodemailer": "5.0.5",
     "@reactioncommerce/random": "1.0.2",
     "@snyk/protect": "latest",
+    "nodemailer": "^6.8.0",
     "graphql": "~16.6.0",
     "semver": "~6.3.0",
     "sharp": "^0.30.7"
@@ -84,6 +88,7 @@
   },
   "scripts": {
     "start": "node --experimental-modules --experimental-json-modules ./src/index.js",
+    "start:debug": "npm run check-node-version && NODE_ENV=development NODE_OPTIONS='--experimental-modules --experimental-json-modules' nodemon --inspect ./src/index.js",
     "start:dev": "npm run check-node-version && NODE_ENV=development NODE_OPTIONS='--experimental-modules --experimental-json-modules' nodemon ./src/index.js",
     "inspect": "NODE_ENV=development node --experimental-modules --experimental-json-modules --inspect ./src/index.js",
     "inspect-brk": "NODE_ENV=development node --experimental-modules --experimental-json-modules --inspect-brk ./src/index.js",

apps/reaction/plugins.json

@@ -4,6 +4,7 @@
   "files": "@reactioncommerce/api-plugin-files",
   "shops": "@reactioncommerce/api-plugin-shops",
   "settings": "@reactioncommerce/api-plugin-settings",
+  "sequences": "@reactioncommerce/api-plugin-sequences",
   "i18": "@reactioncommerce/api-plugin-i18n",
   "email": "@reactioncommerce/api-plugin-email",
   "addressValidation": "@reactioncommerce/api-plugin-address-validation",
@@ -25,8 +26,6 @@
   "payments": "@reactioncommerce/api-plugin-payments",
   "paymentsStripeSCA": "@reactioncommerce/api-plugin-payments-stripe-sca",
   "paymentsExample": "@reactioncommerce/api-plugin-payments-example",
-  "discounts": "@reactioncommerce/api-plugin-discounts",
-  "discountCodes": "@reactioncommerce/api-plugin-discounts-codes",
   "surcharges": "@reactioncommerce/api-plugin-surcharges",
   "shipments": "@reactioncommerce/api-plugin-shipments",
   "shipmentsFlatRate": "@reactioncommerce/api-plugin-shipments-flat-rate",
@@ -35,5 +34,10 @@
   "navigation": "@reactioncommerce/api-plugin-navigation",
   "sitemapGenerator": "@reactioncommerce/api-plugin-sitemap-generator",
   "notifications": "@reactioncommerce/api-plugin-notifications",
-  "addressValidationTest": "@reactioncommerce/api-plugin-address-validation-test"
+  "addressValidationTest": "@reactioncommerce/api-plugin-address-validation-test",
+  "promotions": "@reactioncommerce/api-plugin-promotions",
+  "promotionsCoupons": "@reactioncommerce/api-plugin-promotions-coupons",
+  "promotionsDiscounts": "@reactioncommerce/api-plugin-promotions-discounts",
+  "promotionsOffers": "@reactioncommerce/api-plugin-promotions-offers",
+  "bullJobQueue": "@reactioncommerce/api-plugin-bull-queue"
 }

apps/reaction/tests/integration/api/mutations/addCartItems/addCartItems.test.js

@@ -36,6 +36,7 @@ beforeAll(async () => {
   catalogItem = Factory.Catalog.makeOne({
     isDeleted: false,
     product: Factory.CatalogProduct.makeOne({
+      title: "Test Product",
       isDeleted: false,
       isVisible: true,
       variants: Factory.CatalogProductVariant.makeMany(1, {
@@ -79,7 +80,8 @@ beforeAll(async () => {
     anonymousAccessToken: hashToken(cartToken),
     shipping: null,
     items: [],
-    workflow: null
+    workflow: null,
+    discounts: []
   });
   opaqueCartId = encodeOpaqueId("reaction/cart", mockCart._id);
   await testApp.collections.Cart.insertOne(mockCart);

apps/reaction/tests/integration/api/mutations/checkout/CreatePromotionMutation.graphql

@@ -0,0 +1,8 @@
+mutation CreatePromotion($input: PromotionCreateInput!) {
+    createPromotion(input: $input) {
+        success
+        promotion {
+            _id
+        }
+    }
+}

apps/reaction/tests/integration/api/mutations/checkout/checkoutTestsCommon.js

@@ -15,6 +15,7 @@ const SelectFulfillmentOptionForGroupMutation = importAsString("./SelectFulfillm
 const SetShippingAddressOnCartMutation = importAsString("./SetShippingAddressOnCartMutation.graphql");
 const UpdateCartItemsQuantityMutation = importAsString("./UpdateCartItemsQuantityMutation.graphql");
 const UpdateFulfillmentOptionsForGroupMutation = importAsString("./UpdateFulfillmentOptionsForGroupMutation.graphql");
+const CreatePromotionMutation = importAsString("./CreatePromotionMutation.graphql");
 
 jest.setTimeout(300000);
 
@@ -25,6 +26,10 @@ const opaqueProductId = encodeProductOpaqueId(999);
 const internalTagIds = ["923", "924"];
 const internalVariantIds = ["875", "874", "925"];
 
+const internalProductTwoId = "888";
+const opaqueProductTwoId = encodeProductOpaqueId(888);
+const internalVariantTwoIds = ["889", "890"];
+
 const shopName = "Test Shop";
 
 const mockProduct = {
@@ -65,6 +70,35 @@ const mockOptionTwo = {
   price: 29.99
 };
 
+const mockProductTwo = {
+  _id: internalProductTwoId,
+  ancestors: [],
+  title: "Fake Product two",
+  isDeleted: false,
+  isVisible: true,
+  supportedFulfillmentTypes: ["shipping"],
+  vendor: "Nike"
+};
+
+const mockVariantTwo = {
+  _id: internalVariantTwoIds[0],
+  ancestors: [internalProductTwoId],
+  attributeLabel: "Variant",
+  title: "Fake Product Two Variant",
+  isDeleted: false,
+  isVisible: true
+};
+
+const mockOptionTwoOne = {
+  _id: internalVariantTwoIds[1],
+  ancestors: [internalProductTwoId, internalVariantTwoIds[0]],
+  attributeLabel: "Option",
+  title: "Fake Product Two Option One",
+  isDeleted: false,
+  isVisible: true,
+  price: 19.99
+};
+
 const mockShippingMethod = {
   _id: "mockShippingMethod",
   name: "Default Shipping Provider",
@@ -76,9 +110,7 @@ const mockShippingMethod = {
   methods: [
     {
       cost: 2.5,
-      fulfillmentTypes: [
-        "shipping"
-      ],
+      fulfillmentTypes: ["shipping"],
       group: "Ground",
       handling: 1.5,
       label: "Standard mockMethod",
@@ -94,6 +126,7 @@ let addCartItems;
 let availablePaymentMethods;
 let createCart;
 let createShop;
+let createPromotion;
 let internalShopId;
 let opaqueShopId;
 let placeOrder;
@@ -127,6 +160,7 @@ beforeAll(async () => {
   setShippingAddressOnCart = testApp.mutate(SetShippingAddressOnCartMutation);
   updateCartItemsQuantity = testApp.mutate(UpdateCartItemsQuantityMutation);
   updateFulfillmentOptionsForGroup = testApp.mutate(UpdateFulfillmentOptionsForGroupMutation);
+  createPromotion = testApp.mutate(CreatePromotionMutation);
 
   const shopCreateGroup = Factory.Group.makeOne({
     _id: "shopCreateGroup",
@@ -149,29 +183,27 @@ beforeAll(async () => {
 
   const {
     createShop: {
-      shop: {
-        _id: newShopId
-      }
+      shop: { _id: newShopId }
     }
   } = await createShop({
     input: {
       name: shopName
     }
   });
 
+  opaqueShopId = newShopId;
+  internalShopId = decodeOpaqueIdForNamespace("reaction/shop", newShopId);
+
   const adminGroup = Factory.Group.makeOne({
     _id: "adminGroup",
     createdBy: null,
     name: "admin",
-    permissions: ["reaction:legacy:products/publish"],
+    permissions: ["reaction:legacy:products/publish", "reaction:legacy:promotions/create"],
     slug: "admin",
-    shopId: newShopId
+    shopId: internalShopId
   });
   await testApp.collections.Groups.insertOne(adminGroup);
 
-  opaqueShopId = newShopId;
-  internalShopId = decodeOpaqueIdForNamespace("reaction/shop", newShopId);
-
   // Set other shop settings
   await testApp.collections.Shops.updateOne(
     { _id: internalShopId },
@@ -193,14 +225,20 @@ beforeAll(async () => {
   mockVariant.shopId = internalShopId;
   mockOptionOne.shopId = internalShopId;
   mockOptionTwo.shopId = internalShopId;
+  mockProductTwo.shopId = internalShopId;
+  mockVariantTwo.shopId = internalShopId;
+  mockOptionTwoOne.shopId = internalShopId;
   await Promise.all(internalTagIds.map((_id) => testApp.collections.Tags.insertOne({ _id, shopId: internalShopId, slug: `slug${_id}` })));
   await testApp.collections.Products.insertOne(mockProduct);
   await testApp.collections.Products.insertOne(mockVariant);
   await testApp.collections.Products.insertOne(mockOptionOne);
   await testApp.collections.Products.insertOne(mockOptionTwo);
+  await testApp.collections.Products.insertOne(mockProductTwo);
+  await testApp.collections.Products.insertOne(mockVariantTwo);
+  await testApp.collections.Products.insertOne(mockOptionTwoOne);
 
   // Publish products to the catalog
-  await publishProducts({ productIds: [opaqueProductId] });
+  await publishProducts({ productIds: [opaqueProductId, opaqueProductTwoId] });
 });
 
 // eslint-disable-next-line require-jsdoc
@@ -210,10 +248,13 @@ export default function getCommonData() {
     availablePaymentMethods,
     createCart,
     createShop,
+    createPromotion,
     encodeProductOpaqueId,
     internalShopId,
     internalVariantIds,
+    internalVariantTwoIds,
     opaqueProductId,
+    opaqueProductTwoId,
     opaqueShopId,
     placeOrder,
     publishProducts,

apps/reaction/tests/integration/api/mutations/checkout/fixtures/promotions.js

@@ -0,0 +1,77 @@
+export const fixedDiscountPromotion = {
+  name: "$10 off when you spend more than $100",
+  label: "Order promotion",
+  description: "$10 off when you spend more than $100",
+  actions: [
+    {
+      actionKey: "discounts",
+      actionParameters: {
+        discountType: "order",
+        discountCalculationType: "fixed",
+        discountValue: 10
+      }
+    }
+  ],
+  triggers: [
+    {
+      triggerKey: "offers",
+      triggerParameters: {
+        name: "$10 off when you spend more than $100",
+        conditions: {
+          all: [
+            {
+              fact: "totalItemAmount",
+              operator: "greaterThanInclusive",
+              value: 100
+            }
+          ]
+        }
+      }
+    }
+  ],
+  promotionType: "order-discount",
+  enabled: true,
+  stackability: {
+    key: "all",
+    parameters: {}
+  }
+};
+
+export const percentagePromotion = {
+  name: "%10 off when you spend more than $100",
+  description: "%10 off when you spend more than $100",
+  actions: [
+    {
+      actionKey: "discounts",
+      actionParameters: {
+        discountType: "order",
+        discountCalculationType: "percentage",
+        discountValue: 10
+      }
+    }
+  ],
+  triggers: [
+    {
+      triggerKey: "offers",
+      triggerParameters: {
+        name: "%10 off when you spend more than $100",
+        conditions: {
+          all: [
+            {
+              fact: "totalItemAmount",
+              operator: "greaterThanInclusive",
+              value: 100
+            }
+          ]
+        }
+      }
+    }
+  ],
+  triggerType: "implicit",
+  promotionType: "order-discount",
+  enabled: true,
+  stackability: {
+    key: "all",
+    parameters: {}
+  }
+};