chore: clean-up tasks related to removing `appEvents` from all meteor code #5692

kieckhafer · 2019-10-07T20:48:42Z

Resolves #5691
Impact: minor
Type: feature|style|refactor|chore

Remove or refactor all code that calls appEvents from meteor code.

Refactored into mutations

Removed

updateShipmentStatus I don't believe this function is called anywhere in the app - it doesn't even seem to be attached to a meteor method anymore - so we can mostly likely just delete this file
workflow/pushItemWorkflow We want to remove coreItemWorkflow anyway, maybe this is the time? In addition, this is called from the checkout plugin, which I don't believe we don't use anymore, so maybe we remove this plugin?

TODO

shop/createShop I don't believe this is used anymore, we can most likely just delete this function, along with the Blaze Template where it's being called.

Testing

See that the app functions as expected
See that discount code applying and removing works with new mutations. We have no UI for this at the moment, so you need to do it by creating a Cart, then taking that cart data and using GraphiQL or another GQL interface to perform the action

mutation {
  applyDiscountCodeToCart(input: {
    cartId: "ENCODED_CART_ID",
    discountCode: "CODE",
    shopId: "SHOP_ID",
    token: null
  }) {
    clientMutationId
  }
}

A discount code is a payment, so the discount code id should be encoded with reaction/payment

mutation {
  removeDiscountCodeFROMCart(input: {
    cartId: "ENCODED_CART_ID",
    discountCodeID: "ENCODED_PAYMENT_ID",
    shopId: "SHOP_ID",
    token: null
  }) {
    clientMutationId
  }
}

Signed-off-by: Erik Kieckhafer <[email protected]>

…r-movePackageToNodeApp-cleanupTasks-appEvents

Signed-off-by: Erik Kieckhafer <[email protected]>

…eor methods Signed-off-by: Erik Kieckhafer <[email protected]>

…thods Signed-off-by: Erik Kieckhafer <[email protected]>

kieckhafer · 2019-10-08T05:07:30Z

@aldeed The following Meteor methods have been removed or refactored to no longer use appEvents:
discounts/codes/apply
discounts/codes/remove
updateShipmentStatus
workflow/pushItemWorkflow

I believe this only leaves shop/createShop as the last place where we use appEvents in Meteor. I forgot if we said that was being addressed in the accounts PR or not.

I think either way, this can be reviewed / merged to incorporate all the other changes, and we can handle shop/createShop separately, so I'd say this is ready for a review.

Signed-off-by: Erik Kieckhafer <[email protected]>

aldeed · 2019-10-08T15:27:51Z

imports/node-app/plugins/discount-codes/mutations/applyDiscountCodeToCart.js

+    // Should it be `discounts`, or `cart`?
+    if (!userHasPermission(["owner", "admin", "discounts"], shopId)) {
+      throw new ReactionError("access-denied", "Access Denied");
+    }


Since discounts is more for defining/editing discounts, I'd create a new role discounts/apply for here.

aldeed · 2019-10-08T15:29:56Z

imports/node-app/plugins/discount-codes/mutations/applyDiscountCodeToCart.js

+  // How do we determine this check if the user is the cart owner?
+  if (!userHasPermission(["admin", "owner", "discounts"], shopId)) {
+    throw new ReactionError("access-denied", "Access Denied");
+  }


This one seems unnecessary given that getCart will already limit to carts that belong to the account/token, and then you have a separate admin check below it.

aldeed · 2019-10-08T15:31:37Z

imports/node-app/plugins/discount-codes/mutations/applyDiscountCodeToCart.js

+
+  if (participatingShops.length > 1) {
+    throw new ReactionError("not-implemented", "discounts.multiShopError", "Discounts cannot be applied to a multi-shop cart or order");
+  }


Nothing from line 63 down to here is necessary. Carts can no longer contain items from multiple shops.

aldeed · 2019-10-08T15:32:59Z

imports/node-app/plugins/discount-codes/mutations/applyDiscountCodeToCart.js

+
+  // validate basic limit handling
+  if (accountLimitExceeded === true || discountLimitExceeded === true) {
+    return { i18nKeyLabel: "Code is expired", i18nKey: "discounts.codeIsExpired" };


I'd prefer to throw a ReactionError and let the client translate the error to the i18n key.

aldeed · 2019-10-08T15:36:10Z

imports/node-app/plugins/discount-codes/mutations/removeDiscountCodeFromCart.js

+  // How do we determine this check if the user is the cart owner?
+  if (!userHasPermission(["admin", "owner", "discounts"], shopId)) {
+    throw new ReactionError("access-denied", "Access Denied");
+  }


Same comment as other file. This check doesn't seem necessary, and the later check can use a new discounts/apply. Doesn't seem necessary to have a separate discounts/remove role. If you can apply, you should be able to remove, right?

I think that makes sense. Will keep discounts/apply

aldeed · 2019-10-08T15:37:14Z

imports/node-app/plugins/discount-codes/mutations/removeDiscountCodeFromCart.js

+    // Should it be `discounts`, or `cart`?
+    if (!userHasPermission(["owner", "admin", "discounts"], shopId)) {
+      throw new ReactionError("access-denied", "Access Denied");
+    }


Since you already have shopId, you can move this permission check above the Cart.findOne, but be sure to pass shopId into the findOne query.

aldeed · 2019-10-08T15:38:31Z

imports/node-app/plugins/discount-codes/mutations/removeDiscountCodeFromCart.js

+  // object from the existing cart, then pass to `saveCart`
+  // to re-run cart through all transforms and validations.
+  const updatedCartBilling = cart.billing.filter((doc) => doc._id !== discountCodeId);
+  cart.billing = updatedCartBilling;


You could add a check for whether cart.billing.length and updatedCartBilling.length are the same. If so, the discount code ID was invalid so throw an error.

aldeed · 2019-10-08T15:42:38Z

imports/node-app/plugins/discount-codes/resolvers/Mutation/removeDiscountCodeFromCart.js

+
+  const updatedCartWithRemovedDiscountCode = await context.mutations.removeDiscountCodeFromCart(context, {
+    cartId: decodeCartOpaqueId(cartId),
+    discountCodeId: decodePaymentOpaqueId(discountCodeId),


Even though we treat these as payments in the database, I'd make a separate namespace for it (reaction/discountCode) to keep it future-proof.

Signed-off-by: Erik Kieckhafer <[email protected]>

kieckhafer · 2019-10-08T17:23:00Z

@aldeed comments addressed.

and rename discountCodeId to discountId Signed-off-by: Eric Dobbertin <[email protected]>

kieckhafer added 7 commits October 7, 2019 11:30

refactor: remove unused updateShipmentStatus function

a45b635

Signed-off-by: Erik Kieckhafer <[email protected]>

refactor: remove unused server code for checkout package

d12f1c3

Signed-off-by: Erik Kieckhafer <[email protected]>

Merge remote-tracking branch 'origin/develop' into refactor-kieckhafe…

fcb748f

…r-movePackageToNodeApp-cleanupTasks-appEvents

feat: add applyDiscountCodeToCart mutation

72369f9

Signed-off-by: Erik Kieckhafer <[email protected]>

feat: add removeDiscountCodeFromCart mutation

10d012d

Signed-off-by: Erik Kieckhafer <[email protected]>

refactor: remove discounts/codes/apply and discounts/codes/remove met…

32b96fd

…eor methods Signed-off-by: Erik Kieckhafer <[email protected]>

refactor: remove unused client code that was calling unused meteor me…

6cb2014

…thods Signed-off-by: Erik Kieckhafer <[email protected]>

kieckhafer requested a review from aldeed October 8, 2019 05:05

kieckhafer marked this pull request as ready for review October 8, 2019 05:07

style: lint fixes

fd24bcb

Signed-off-by: Erik Kieckhafer <[email protected]>

aldeed requested changes Oct 8, 2019

View reviewed changes

refactor: permission fixes and namespace

f6b1d0a

Signed-off-by: Erik Kieckhafer <[email protected]>

fix: use correct ID logic

809b700

and rename discountCodeId to discountId Signed-off-by: Eric Dobbertin <[email protected]>

aldeed approved these changes Oct 8, 2019

View reviewed changes

aldeed merged commit 3edd291 into develop Oct 8, 2019

aldeed deleted the refactor-kieckhafer-movePackageToNodeApp-cleanupTasks-appEvents branch October 8, 2019 19:26

willopez mentioned this pull request Oct 9, 2019

Release v2.7.0 #5712

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: clean-up tasks related to removing `appEvents` from all meteor code #5692

chore: clean-up tasks related to removing `appEvents` from all meteor code #5692

Uh oh!

kieckhafer commented Oct 7, 2019 •

edited

Loading

Uh oh!

kieckhafer commented Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

kieckhafer Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

aldeed Oct 8, 2019

Uh oh!

kieckhafer commented Oct 8, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chore: clean-up tasks related to removing appEvents from all meteor code #5692

chore: clean-up tasks related to removing appEvents from all meteor code #5692

Uh oh!

Conversation

kieckhafer commented Oct 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Refactored into mutations

Removed

TODO

Testing

Uh oh!

kieckhafer commented Oct 8, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kieckhafer commented Oct 8, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chore: clean-up tasks related to removing `appEvents` from all meteor code #5692

chore: clean-up tasks related to removing `appEvents` from all meteor code #5692

kieckhafer commented Oct 7, 2019 •

edited

Loading