feat: improve promotion validation

packages/api-plugin-promotions-discounts/src/actions/discountAction.js

@@ -4,6 +4,7 @@ import Logger from "@reactioncommerce/logger";
 import applyItemDiscountToCart from "../discountTypes/item/applyItemDiscountToCart.js";
 import applyShippingDiscountToCart from "../discountTypes/shipping/applyShippingDiscountToCart.js";
 import applyOrderDiscountToCart from "../discountTypes/order/applyOrderDiscountToCart.js";
+import { DiscountActionCondition } from "../simpleSchemas.js";
 
 const require = createRequire(import.meta.url);
 
@@ -22,13 +23,6 @@ const functionMap = {
   order: applyOrderDiscountToCart
 };
 
-export const Rules = new SimpleSchema({
-  conditions: {
-    type: Object,
-    blackbox: true
-  }
-});
-
 export const discountActionParameters = new SimpleSchema({
   discountType: {
     type: String,
@@ -50,10 +44,11 @@ export const discountActionParameters = new SimpleSchema({
     optional: true
   },
   inclusionRules: {
-    type: Rules
+    type: DiscountActionCondition,
+    optional: true
   },
   exclusionRules: {
-    type: Rules,
+    type: DiscountActionCondition,
     optional: true
   },
   neverStackWithOtherItemLevelDiscounts: {
@@ -101,7 +96,6 @@ export async function discountActionHandler(context, cart, params) {
 
   const { cart: updatedCart, affected, reason } = await functionMap[discountType](context, params, cart);
 
-
   Logger.info({ ...logCtx, ...params.actionParameters, cartId: cart._id, cartDiscount: cart.discount }, "Completed applying Discount to Cart");
   return { updatedCart, affected, reason };
 }

packages/api-plugin-promotions-discounts/src/preStartup.js

@@ -1,5 +1,5 @@
 import SimpleSchema from "simpl-schema";
-import { CartDiscount } from "./simpleSchemas.js";
+import { CartDiscount, ConditionRule } from "./simpleSchemas.js";
 
 const discountSchema = new SimpleSchema({
   // this is here for backwards compatibility with old discounts
@@ -180,4 +180,17 @@ async function extendOrderSchemas(context) {
 export default async function preStartupDiscounts(context) {
   await extendCartSchemas(context);
   await extendOrderSchemas(context);
+
+  const { promotionOfferFacts, promotions: { allowOperators } } = context;
+
+  const promotionFactKeys = Object.keys(promotionOfferFacts);
+
+  ConditionRule.extend({
+    fact: {
+      allowedValues: ConditionRule.getAllowedValuesForKey("fact").concat(promotionFactKeys)
+    },
+    operator: {
+      allowedValues: allowOperators
+    }
+  });
 }

packages/api-plugin-promotions-discounts/src/simpleSchemas.js

@@ -1,9 +1,64 @@
 import SimpleSchema from "simpl-schema";
 
-export const Rules = new SimpleSchema({
-  conditions: {
+const allowOperators = [
+  "equal",
+  "notEqual",
+  "lessThan",
+  "lessThanInclusive",
+  "greaterThan",
+  "greaterThanInclusive",
+  "in",
+  "notIn",
+  "contains",
+  "doesNotContain"
+];
+
+export const ConditionRule = new SimpleSchema({
+  "fact": {
+    type: String,
+    allowedValues: ["cart", "item"]
+  },
+  "operator": {
+    type: String,
+    allowedValues: allowOperators
+  },
+  "path": {
+    type: String,
+    optional: true
+  },
+  "value": {
+    type: SimpleSchema.oneOf(String, Number, Boolean, Array)
+  },
+  "value.$": {
+    type: SimpleSchema.oneOf(String, Number, Boolean)
+  },
+  "params": {
     type: Object,
-    blackbox: true
+    blackbox: true,
+    optional: true
+  }
+});
+
+export const RuleExpression = new SimpleSchema({
+  "all": {
+    type: Array,
+    optional: true
+  },
+  "all.$": {
+    type: ConditionRule
+  },
+  "any": {
+    type: Array,
+    optional: true
+  },
+  "any.$": {
+    type: ConditionRule
+  }
+});
+
+export const DiscountActionCondition = new SimpleSchema({
+  conditions: {
+    type: RuleExpression
   }
 });
 
@@ -40,10 +95,10 @@ export const Discount = new SimpleSchema({
     type: Number
   },
   inclusionRules: {
-    type: Rules
+    type: DiscountActionCondition
   },
   exclusionRules: {
-    type: Rules,
+    type: DiscountActionCondition,
     optional: true
   }
 });

packages/api-plugin-promotions-offers/src/index.js

@@ -3,6 +3,8 @@ import triggers from "./triggers/index.js";
 import enhancers from "./enhancers/index.js";
 import facts from "./facts/index.js";
 import { promotionOfferFacts, registerPromotionOfferFacts } from "./registration.js";
+import { ConditionRule } from "./simpleSchemas.js";
+import preStartupPromotionOffer from "./preStartup.js";
 
 const require = createRequire(import.meta.url);
 const pkg = require("../package.json");
@@ -18,6 +20,7 @@ export default async function register(app) {
     name: pkg.name,
     version: pkg.version,
     functionsByType: {
+      preStartup: [preStartupPromotionOffer],
       registerPluginHandler: [registerPromotionOfferFacts]
     },
     contextAdditions: {
@@ -27,6 +30,9 @@ export default async function register(app) {
       triggers,
       enhancers
     },
-    promotionOfferFacts: facts
+    promotionOfferFacts: facts,
+    simpleSchemas: {
+      ConditionRule
+    }
   });
 }

packages/api-plugin-promotions-offers/src/preStartup.js

@@ -0,0 +1,21 @@
+import { ConditionRule } from "./simpleSchemas.js";
+
+/**
+ * @summary Pre-startup function for api-plugin-promotions-offer
+ * @param {Object} context - Startup context
+ * @returns {Promise<void>} undefined
+ */
+export default async function preStartupPromotionOffer(context) {
+  const { promotionOfferFacts, promotions: { allowOperators } } = context;
+
+  const promotionFactKeys = Object.keys(promotionOfferFacts);
+
+  ConditionRule.extend({
+    fact: {
+      allowedValues: ConditionRule.getAllowedValuesForKey("fact").concat(promotionFactKeys)
+    },
+    operator: {
+      allowedValues: allowOperators
+    }
+  });
+}

packages/api-plugin-promotions-offers/src/simpleSchemas.js

@@ -1,24 +1,78 @@
 import SimpleSchema from "simpl-schema";
 
-const Rules = new SimpleSchema({
-  conditions: {
+const allowOperators = [
+  "equal",
+  "notEqual",
+  "lessThan",
+  "lessThanInclusive",
+  "greaterThan",
+  "greaterThanInclusive",
+  "in",
+  "notIn",
+  "contains",
+  "doesNotContain"
+];
+
+export const ConditionRule = new SimpleSchema({
+  "fact": {
+    type: String,
+    allowedValues: ["cart", "item"]
+  },
+  "operator": {
+    type: String,
+    allowedValues: allowOperators
+  },
+  "path": {
+    type: String,
+    optional: true
+  },
+  "value": {
+    type: SimpleSchema.oneOf(String, Number, Boolean, Array)
+  },
+  "value.$": {
+    type: SimpleSchema.oneOf(String, Number, Boolean)
+  },
+  "params": {
     type: Object,
-    blackbox: true
+    blackbox: true,
+    optional: true
+  }
+});
+
+export const RuleExpression = new SimpleSchema({
+  "all": {
+    type: Array,
+    optional: true
+  },
+  "all.$": {
+    type: ConditionRule
+  },
+  "any": {
+    type: Array,
+    optional: true
+  },
+  "any.$": {
+    type: ConditionRule
+  }
+});
+
+export const OfferTriggerCondition = new SimpleSchema({
+  conditions: {
+    type: RuleExpression
   }
 });
 
 export const OfferTriggerParameters = new SimpleSchema({
   name: String,
   conditions: {
-    type: Object,
-    blackbox: true
+    type: RuleExpression
   },
   inclusionRules: {
-    type: Rules,
+    type: OfferTriggerCondition,
     optional: true
   },
   exclusionRules: {
-    type: Rules,
+    type: OfferTriggerCondition,
     optional: true
   }
 });

packages/api-plugin-promotions/src/mutations/createPromotion.js

@@ -1,4 +1,5 @@
 import Random from "@reactioncommerce/random";
+import validateActionParams from "./validateActionParams.js";
 import validateTriggerParams from "./validateTriggerParams.js";
 
 /**
@@ -21,8 +22,11 @@ export default async function createPromotion(context, promotion) {
   promotion.createdAt = now;
   promotion.updatedAt = now;
   promotion.referenceId = await context.mutations.incrementSequence(context, promotion.shopId, "Promotions");
+
   PromotionSchema.validate(promotion);
   validateTriggerParams(context, promotion);
+  validateActionParams(context, promotion);
+
   const results = await Promotions.insertOne(promotion);
   const { insertedCount, insertedId } = results;
   promotion._id = insertedId;

packages/api-plugin-promotions/src/mutations/createPromotion.test.js

@@ -54,10 +54,56 @@ const offerTrigger = {
   type: "implicit"
 };
 
+const discountActionParameters = new SimpleSchema({
+  discountType: {
+    type: String,
+    allowedValues: ["item", "order", "shipping"]
+  },
+  discountCalculationType: {
+    type: String,
+    allowedValues: ["flat", "fixed", "percentage"]
+  },
+  discountValue: {
+    type: Number
+  },
+  discountMaxValue: {
+    type: Number,
+    optional: true
+  },
+  discountMaxUnits: {
+    type: Number,
+    optional: true
+  },
+  inclusionRules: {
+    type: Object,
+    blackbox: true,
+    optional: true
+  },
+  exclusionRules: {
+    type: Object,
+    blackbox: true,
+    optional: true
+  },
+  neverStackWithOtherItemLevelDiscounts: {
+    type: Boolean,
+    optional: true,
+    defaultValue: false
+  }
+});
+
+const discountAction = {
+  key: "discounts",
+  handler: () => {},
+  paramSchema: discountActionParameters
+};
+
 
 mockContext.promotions = {
   triggers: [
     offerTrigger
+  ],
+  actions: [
+    discountAction
   ]
 };
 

packages/api-plugin-promotions/src/mutations/fixtures/orderPromotion.js

@@ -28,8 +28,12 @@ export const CreateOrderPromotion = {
   ],
   actions: [
     {
-      actionKey: "noop",
-      actionParameters: {}
+      actionKey: "discounts",
+      actionParameters: {
+        discountType: "order",
+        discountCalculationType: "percentage",
+        discountValue: 5
+      }
     }
   ],
   startDate: now,

packages/api-plugin-promotions/src/mutations/validateActionParams.js

@@ -0,0 +1,14 @@
+/**
+ * @summary validate the parameters of the particular action
+ * @param {Object} context - The application context
+ * @param {Object} promotion - The promotion to validate
+ * @returns {undefined} throws error if invalid
+ */
+export default function validateActionParams(context, promotion) {
+  const { promotions } = context;
+  for (const action of promotion.actions) {
+    const actionData = promotions.actions.find((ac) => ac.key === action.actionKey);
+    const { paramSchema } = actionData;
+    paramSchema.validate(action.actionParameters);
+  }
+}