-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add additional coupon validation #6771
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
packages/api-plugin-promotions-coupons/src/mutations/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
import applyCouponToCart from "./applyCouponToCart.js"; | ||
import createStandardCoupon from "./createStandardCoupon.js"; | ||
import updateStandardCoupon from "./updateStandardCoupon.js"; | ||
import removeCouponFromCart from "./removeCouponFromCart.js"; | ||
|
||
export default { | ||
applyCouponToCart, | ||
createStandardCoupon, | ||
updateStandardCoupon, | ||
removeCouponFromCart | ||
}; |
83 changes: 83 additions & 0 deletions
83
packages/api-plugin-promotions-coupons/src/mutations/updateStandardCoupon.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
import _ from "lodash"; | ||
import SimpleSchema from "simpl-schema"; | ||
import ReactionError from "@reactioncommerce/reaction-error"; | ||
import { Coupon } from "../simpleSchemas.js"; | ||
|
||
const inputSchema = new SimpleSchema({ | ||
_id: String, | ||
shopId: String, | ||
name: { | ||
type: String, | ||
optional: true | ||
}, | ||
code: { | ||
type: String, | ||
optional: true | ||
}, | ||
canUseInStore: { | ||
type: Boolean, | ||
optional: true | ||
}, | ||
maxUsageTimesPerUser: { | ||
type: Number, | ||
optional: true | ||
}, | ||
maxUsageTimes: { | ||
type: Number, | ||
optional: true | ||
} | ||
}); | ||
|
||
/** | ||
* @method updateStandardCoupon | ||
* @summary Update a standard coupon mutation | ||
* @param {Object} context - The application context | ||
* @param {Object} input - The coupon input to create | ||
* @returns {Promise<Object>} with updated coupon result | ||
*/ | ||
export default async function updateStandardCoupon(context, input) { | ||
inputSchema.validate(input); | ||
|
||
const { collections: { Coupons, Promotions } } = context; | ||
const { shopId, _id: couponId } = input; | ||
|
||
const coupon = await Coupons.findOne({ _id: couponId, shopId }); | ||
if (!coupon) throw new ReactionError("not-found", "Coupon not found"); | ||
|
||
const promotion = await Promotions.findOne({ _id: coupon.promotionId, shopId }); | ||
if (!promotion) throw new ReactionError("not-found", "Promotion not found"); | ||
|
||
const now = new Date(); | ||
if (promotion.startDate <= now) { | ||
throw new ReactionError("invalid-params", "This coupon cannot be edited because the promotion is on the window time"); | ||
} | ||
|
||
if (input.code && coupon.code !== input.code) { | ||
const existsCoupons = await Coupons.find({ code: input.code, shopId, _id: { $ne: coupon._id } }).toArray(); | ||
if (existsCoupons.length > 0) { | ||
const promotionIds = _.map(existsCoupons, "promotionId"); | ||
const promotions = await Promotions.find({ _id: { $in: promotionIds } }).toArray(); | ||
for (const existsPromotion of promotions) { | ||
if (existsPromotion.startDate <= promotion.startDate && existsPromotion.endDate >= promotion.endDate) { | ||
throw new ReactionError( | ||
"invalid-params", | ||
// eslint-disable-next-line max-len | ||
"A promotion with this coupon code is already set to be active during part of this promotion window. Please either adjust your coupon code or your Promotion Start and End Dates" | ||
); | ||
} | ||
} | ||
} | ||
} | ||
|
||
const modifiedCoupon = _.merge(coupon, input); | ||
modifiedCoupon.updatedAt = now; | ||
|
||
Coupon.clean(modifiedCoupon, { mutate: true }); | ||
Coupon.validate(modifiedCoupon); | ||
|
||
const modifier = { $set: modifiedCoupon }; | ||
const results = await Coupons.findOneAndUpdate({ _id: couponId, shopId }, modifier, { returnDocument: "after" }); | ||
|
||
const { modifiedCount, value } = results; | ||
return { success: !!modifiedCount, coupon: value }; | ||
} |
146 changes: 146 additions & 0 deletions
146
packages/api-plugin-promotions-coupons/src/mutations/updateStandardCoupon.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
import _ from "lodash"; | ||
import mockContext from "@reactioncommerce/api-utils/tests/mockContext.js"; | ||
import updateStandardCoupon from "./updateStandardCoupon.js"; | ||
|
||
const now = new Date(); | ||
const mockCoupon = { | ||
_id: "123", | ||
code: "CODE", | ||
promotionId: "123", | ||
shopId: "123", | ||
canUseInStore: false, | ||
usedCount: 0, | ||
createdAt: now, | ||
updatedAt: now, | ||
maxUsageTimes: 10, | ||
maxUsageTimesPerUser: 1 | ||
}; | ||
|
||
test("throws if validation check fails", async () => { | ||
const input = { code: "CODE" }; | ||
|
||
try { | ||
await updateStandardCoupon(mockContext, input); | ||
} catch (error) { | ||
expect(error.error).toEqual("validation-error"); | ||
} | ||
}); | ||
|
||
test("throws error when coupon does not exist", async () => { | ||
const input = { code: "CODE", _id: "123", shopId: "123", canUseInStore: true }; | ||
mockContext.collections = { | ||
Coupons: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(null)) | ||
} | ||
}; | ||
try { | ||
await updateStandardCoupon(mockContext, input); | ||
} catch (error) { | ||
expect(error.message).toEqual("Coupon not found"); | ||
} | ||
}); | ||
|
||
test("throws error when promotion does not exist", async () => { | ||
const input = { code: "CODE", shopId: "123", _id: "123" }; | ||
const coupon = _.cloneDeep(mockCoupon); | ||
mockContext.collections = { | ||
Coupons: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(coupon)) | ||
}, | ||
Promotions: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(null)) | ||
} | ||
}; | ||
|
||
try { | ||
await updateStandardCoupon(mockContext, input); | ||
} catch (error) { | ||
expect(error.message).toEqual("Promotion not found"); | ||
} | ||
}); | ||
|
||
test("throws error when the related promotion is in promotion window", async () => { | ||
const input = { code: "CODE", shopId: "123", _id: "123" }; | ||
const promotion = { _id: "123", startDate: now, endDate: now }; | ||
const coupon = _.cloneDeep(mockCoupon); | ||
mockContext.collections = { | ||
Coupons: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(coupon)) | ||
}, | ||
Promotions: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(promotion)) | ||
} | ||
}; | ||
|
||
try { | ||
await updateStandardCoupon(mockContext, input); | ||
} catch (error) { | ||
expect(error.message).toEqual("This coupon cannot be edited because the promotion is on the window time"); | ||
} | ||
}); | ||
|
||
test("throws error when coupon code already exists in promotion window", async () => { | ||
const input = { code: "NEW_CODE", shopId: "123", _id: "123" }; | ||
const promotion = { | ||
_id: "123", | ||
startDate: new Date(now.getTime() + 1000 * 60 * 60 * 24 * 1), | ||
endDate: new Date(now.getTime() + 1000 * 60 * 60 * 24 * 7) | ||
}; | ||
const existsPromotion = { | ||
_id: "1234", | ||
startDate: now, | ||
endDate: new Date(now.getTime() + 1000 * 60 * 60 * 24 * 10) | ||
}; | ||
const coupon = _.cloneDeep(mockCoupon); | ||
mockContext.collections = { | ||
Coupons: { | ||
find: jest.fn().mockReturnValue({ | ||
toArray: jest.fn().mockResolvedValueOnce(Promise.resolve([coupon])) | ||
}), | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(coupon)) | ||
}, | ||
Promotions: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(promotion)), | ||
find: jest.fn().mockReturnValue({ | ||
toArray: jest.fn().mockResolvedValueOnce(Promise.resolve([existsPromotion])) | ||
}) | ||
} | ||
}; | ||
|
||
try { | ||
await updateStandardCoupon(mockContext, input); | ||
} catch (error) { | ||
// eslint-disable-next-line max-len | ||
expect(error.message).toEqual("A promotion with this coupon code is already set to be active during part of this promotion window. Please either adjust your coupon code or your Promotion Start and End Dates"); | ||
} | ||
}); | ||
|
||
test("should update coupon and return the updated results", async () => { | ||
const input = { name: "test", code: "CODE", shopId: "123", _id: "123", canUseInStore: true }; | ||
const promotion = { _id: "123", endDate: now }; | ||
const coupon = _.cloneDeep(mockCoupon); | ||
mockContext.collections = { | ||
Coupons: { | ||
find: jest.fn().mockReturnValue({ | ||
toArray: jest.fn().mockResolvedValueOnce([]) | ||
}), | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(coupon)), | ||
findOneAndUpdate: jest.fn().mockResolvedValueOnce(Promise.resolve({ modifiedCount: 1, value: { _id: "123" } })) | ||
}, | ||
Promotions: { | ||
findOne: jest.fn().mockResolvedValueOnce(Promise.resolve(promotion)) | ||
} | ||
}; | ||
|
||
const result = await updateStandardCoupon(mockContext, input); | ||
|
||
expect(mockContext.collections.Coupons.findOneAndUpdate).toHaveBeenCalledTimes(1); | ||
expect(mockContext.collections.Coupons.findOne).toHaveBeenCalledTimes(1); | ||
|
||
expect(result).toEqual({ | ||
success: true, | ||
coupon: { | ||
_id: "123" | ||
} | ||
}); | ||
}); |
2 changes: 2 additions & 0 deletions
2
packages/api-plugin-promotions-coupons/src/resolvers/Mutation/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
import applyCouponToCart from "./applyCouponToCart.js"; | ||
import createStandardCoupon from "./createStandardCoupon.js"; | ||
import updateStandardCoupon from "./updateStandardCoupon.js"; | ||
import removeCouponFromCart from "./removeCouponFromCart.js"; | ||
|
||
export default { | ||
applyCouponToCart, | ||
createStandardCoupon, | ||
updateStandardCoupon, | ||
removeCouponFromCart | ||
}; |
19 changes: 19 additions & 0 deletions
19
packages/api-plugin-promotions-coupons/src/resolvers/Mutation/updateStandardCoupon.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
/** | ||
* @method updateStandardCoupon | ||
* @summary Update a standard coupon mutation | ||
* @param {Object} _ unused | ||
* @param {Object} args.input - The input arguments | ||
* @param {Object} args.input.shopId - The shop ID | ||
* @param {Object} args.input.couponId - The coupon ID | ||
* @param {Object} args.input.promotionId - The promotion ID | ||
* @param {Object} context - The application context | ||
* @returns {Promise<Object>} with updated coupon result | ||
*/ | ||
export default async function updateStandardCoupon(_, { input }, context) { | ||
const { shopId } = input; | ||
|
||
await context.validatePermissions("reaction:legacy:promotions", "update", { shopId }); | ||
|
||
const updatedCouponResult = await context.mutations.updateStandardCoupon(context, input); | ||
return updatedCouponResult; | ||
} |
26 changes: 26 additions & 0 deletions
26
packages/api-plugin-promotions-coupons/src/resolvers/Mutation/updateStandardCoupon.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
import mockContext from "@reactioncommerce/api-utils/tests/mockContext.js"; | ||
import updateStandardCoupon from "./updateStandardCoupon.js"; | ||
|
||
test("throws if permission check fails", async () => { | ||
const input = { name: "Test coupon", code: "CODE" }; | ||
mockContext.validatePermissions.mockResolvedValue(Promise.reject(new Error("Access Denied"))); | ||
|
||
try { | ||
await updateStandardCoupon(null, { input }, mockContext); | ||
} catch (error) { | ||
expect(error.message).toEqual("Access Denied"); | ||
} | ||
}); | ||
|
||
test("calls mutations.updateStandardCoupon and returns the result", async () => { | ||
const input = { name: "Test coupon", code: "CODE", couponId: "testId" }; | ||
const result = { _id: "123" }; | ||
mockContext.validatePermissions.mockResolvedValue(Promise.resolve()); | ||
mockContext.mutations = { | ||
updateStandardCoupon: jest.fn().mockName("mutations.updateStandardCoupon").mockReturnValueOnce(Promise.resolve(result)) | ||
}; | ||
|
||
const createdCoupon = await updateStandardCoupon(null, { input }, mockContext); | ||
|
||
expect(createdCoupon).toEqual(result); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to improve the wording of this since I can't tell what this means