Rewrite placeOrder and support multiple payments for an order #4908

aldeed · 2019-01-09T20:26:24Z

Resolves #4860
Impact: breaking
Type: feature

Changes

The primary change is that when placing an order, you can now pay with multiple payment methods. A variety of other changes needed to be made as a result.

MongoDB schema changes:

There is no longer a payment property on each order fulfillment group. Rather there is a payments array on the order itself, and payments are not associated with any particular fulfillment group.
currencyCode property is added to invoice for use by that resolver
captureErrorCode and captureErrorMessage properties are added to payment so that the operator UI can display capture error messages
invoice was previously on each fulfillment group and also on each payment. It's no longer on payment because payments no longer correspond to just one group.
removed payment.data.billingAddress because it's already on payment.address

GraphQL schema changes:

A new placeOrder GraphQL mutation supports placing an order with multiple payments for it.
_id is now optional on Address type
shippingAddress and shop fields added to FulfillmentGroup type
payments field added to Order type
status field is added to Payment type and is defined by new PaymentStatus enum
[BREAKING] placeOrderWithExampleIOUPayment mutation is removed
[BREAKING] placeOrderWithStripeCardPayment mutation is removed
[BREAKING] Created captureOrderPayments mutation to replace the "orders/capturePayments" Meteor method. It has a similar API but allows you to pass an array of payment IDs to capture only certain payments.
Moved some IOU Example types from core payments schema to the included plugin's schema

Meteor method changes:

[BREAKING] orders/approvePayment method signature changed from (order) to (orderId, paymentId)

Refactoring:

registration of payment methods is now handled within the payments plugin rather than in the core plugin's startup code.
The "Currency exchange rates..." message that appears a bunch of times each time the operator UI loads a catalog listing page is change from "warn" level to "debug" level
[BREAKING] The createOrder internal mutation function is removed
Duplicate stripe functions into the marketplace plugin. That plugin should not require the stripe plugin.
Improved the Stripe payment capture function to better handle errors. The "charge_already_captured" will now mark the charge as captured in the system rather than resulting in an error, and other errors appear in the operator UI so that you know why the capture didn't work.

Operator UI:

The payment method settings for "supports" (capture, de-auth, etc.) are no longer respected and the check boxes have been removed from the operator UI
The order summary view is rearranged to accommodate showing multiple payments and to keep similar information together.
- Created a new OrderPayment React component
- Order cancel button remains with the invoice UI, but approving, capturing, and refunding UI now appears once for each payment. Canceling the order still refunds all of the captured payments.
- Some of the order info that was at the top has been moved to the shipping or payment sections based on what it is related to.
- The Print button is now always visible and isn't coupled with payment buttons.

Bug fixes:

One appEvent consumer throwing an error no longer prevents the remaining consumers from running
Fixed the permission check in "orders/refund/list" Meteor method

Breaking changes

All of the individual placeOrder* GraphQL mutations provided by the built-in payment plugins are removed and replaced with a single placeOrder mutation that supports multiple payments. The createOrder internal mutation that these used is also gone, so this will break any custom payment method plugins.

Testing

It's easiest to test this along with the starter kit changes. See the testing instructions in reactioncommerce/example-storefront#477

Switch from placeOrderWithStripeCardPayment mutation to placeOrder mutation

to captureOrderPayments GraphQL mutation

And use captureOrderPayments GraphQL mutation

when placing an order

supported methods" check boxes

kieckhafer

Order emails only display one paymenr, they should display all payments (this order had IOU and Credit Card on it):

kieckhafer · 2019-01-14T20:36:04Z

imports/plugins/core/orders/client/components/orderTable.js

@@ -97,7 +98,8 @@ class OrderTable extends Component {

  renderOrderInfo(order) {
    const { displayMedia, moment } = this.props;
-    const { invoice } = getPaymentForCurrentShop(order);
+    const [payment] = order.payments || [];
+    const { amount } = payment || {};


Can you explain how this is working to me? I think it's just a syntax I haven't seen before, but if this is a payment in an array, how are we extracting amount directly from payment?

const [payment] takes the first payment and saves it in the payment const (array destructuring). Then I destructure the amount property off payment.

Ideally we shouldn't be using only the first payment anywhere, but I was trying to avoid doing too many changes in this one PR.

aldeed · 2019-01-15T16:59:01Z

Migrations 24 and 32 both throw this error on startup

That is something unrelated that I fixed in RC8 branch. I'll merge the fix into develop and this branch.

Order cancellation is not available until all payments are approved and captured.

I thought this was always the case but maybe not. Either way, what you say makes sense. I should be able to update the cancellation method to skip refunding if the payment isn't captured yet.

Order emails only display one payment

Good catch. I'll fix.

Inventory is not being correctly tracked

I'll investigate

kieckhafer · 2019-01-15T18:46:01Z

I thought this was always the case but maybe not. Either way, what you say makes sense. I should be able to update the cancellation method to skip refunding if the payment isn't captured yet.

The cancellation button was hidden - you needed to click the down arrow next to the Approve button, but it was still available before the approval.

aldeed · 2019-01-15T21:18:59Z

The cancellation button was hidden

Right, but I seem to remember it didn't work for me until after capturing. It just did nothing when I clicked it.

and update to avoid rounding errors

aldeed · 2019-01-16T13:16:15Z

@kieckhafer All of the bugs you found should be fixed now.

@dancastellon I fixed sending the order emails when payments don't have a billing address, and I added a way for payment methods to indicate they don't support refunding. Add canRefund: false in the paymentMethods object in your register.js. The refund UI then will not appear. I think this was everything you had mentioned to me.

dancastellon

Code-wise this looks good to me. I did a quick bit of testing with my rewards payment method prototype and it still works.

…order-rewrite # Conflicts: # imports/plugins/core/versions/server/migrations/index.js

kieckhafer

On first start up, I'm seeing this message:

Exception from sub OrderImages id 9pSNCnMxnwNZXcecT TypeError: Cannot read property 'shipping' of undefined
    at Subscription.Meteor.publish.orderId [as _handler] (imports/plugins/core/core/server/publications/collections/orders.js:223:28)
    at currentArgumentChecker.withValue (packages/check/match.js:118:15)
    at Meteor.EnvironmentVariable.EVp.withValue (packages/meteor.js:1304:12)
    at Object._failIfArgumentsAreNotAllChecked (packages/check/match.js:116:43)
    at maybeAuditArgumentChecks (packages/ddp-server/livedata_server.js:1764:18)
    at DDP._CurrentPublicationInvocation.withValue (packages/ddp-server/livedata_server.js:1043:15)
    at Meteor.EnvironmentVariable.EVp.withValue (packages/meteor.js:1304:12)
    at Subscription._runHandler (packages/ddp-server/livedata_server.js:1041:51)
    at Session._startSubscription (packages/ddp-server/livedata_server.js:859:9)
    at Session.sub (packages/ddp-server/livedata_server.js:625:12)
    at packages/ddp-server/livedata_server.js:559:43

kieckhafer

All previously mentioned issues have been fixed.

Two new things:

The error message above on startup, I have not been able to reproduce though, I only saw it one time.
When I cancel an order via the operator UI, I get a rounding issue with the total (just a UI issue):

kieckhafer

All changes look good! Merging it! 👍

aldeed added 30 commits December 19, 2018 10:12

feat: support multiple payments, part 1

1e3d394

Switch from placeOrderWithStripeCardPayment mutation to placeOrder mutation

fix: catch errors in appEvents consumers

2695ed0

refactor: update marketplace checkout to use placeOrder mutation

71ac587

refactor: update example IOU checkout to use placeOrder mutation

c6f5cb9

refactor: adjustments for order payments schema changes

8ad5107

refactor: more adjustments for order payments schema changes

b334f5c

refactor: GraphQL updates for multiple payments

4b4dd12

fix: marketplace Stripe should have its own functions

13d9e85

fix: mark charge as captured if Stripe errors that it already is

d9eea3b

refactor: update cancelOrder method for multiple payment handling

10449cc

refactor: update "orders/refunds/create" method for multi payment

cd373d4

feat: port "orders/capturePayments" Meteor method

2fb30bd

to captureOrderPayments GraphQL mutation

refactor: operator orders UI cleanup for multi payments

bbcd3a1

And use captureOrderPayments GraphQL mutation

refactor: use OrderSummary component without Blaze wrapper

57e97fe

refactor: use OrderInvoice component without Blaze wrapper

7dd2d41

feat: move all shipping info to the order shipping panel

2cfc769

refactor: remove billingAddressId

78b033f

refactor: remove _id from order shipping address

c599c65

feat: display multiple payments in order summary

3870ba9

feat: show payment approval button for each payment

c1a2ecf

feat: show capture button for each payment

b0c4e02

feat: allow refunding per payment

28d2e6c

refactor: move and rewire "cancel order" button

35e2dff

refactor: remove createOrder mutation

93085a5

refactor: split out some placeOrder code to separate func

9fa0ac4

feat: throw if payment method isn't enabled for shop

d37a845

when placing an order

refactor: move payment method tracking to payments plugin

d6d5995

fix: Fix sendOrderEmail error listing refunds

82a6dd1

feat: require each order payment input to specify an amount

a1cdcc6

feat: remove unused "payment provider

7c579f1

supported methods" check boxes

kieckhafer requested changes Jan 14, 2019

View reviewed changes

kieckhafer reviewed Jan 14, 2019

View reviewed changes

spencern modified the milestones: 🏔 Shavano, 🏔 Torreys Jan 15, 2019

Merge branch 'develop' into feat-aldeed-place-order-rewrite

5f103a9

aldeed added 7 commits January 15, 2019 16:22

fix: pull out verifyPaymentsMatchOrderTotal func

7293bfa

and update to avoid rounding errors

fix: allow canceling order before capturing its payments

21a268a

fix: show all payments in order emails

c286c43

fix: fix error in sendOrderEmail when there is no address for a payment

9c7e40d

fix: correct inventory updating

ffe1f57

feat: update example IOU payment method to support refunds

ab36e55

feat: support non-refundable payment methods

6365ffd

dancastellon approved these changes Jan 16, 2019

View reviewed changes

Merge remote-tracking branch 'origin/develop' into feat-aldeed-place-…

f5528e0

…order-rewrite # Conflicts: # imports/plugins/core/versions/server/migrations/index.js

kieckhafer reviewed Jan 17, 2019

View reviewed changes

kieckhafer requested changes Jan 17, 2019

View reviewed changes

aldeed added 3 commits January 17, 2019 15:17

fix: fix minor error in Meteor publication

5fe0e26

test: update paymentMethods tests

54d918f

fix: properly format money in alerts

9402179

kieckhafer approved these changes Jan 18, 2019

View reviewed changes

kieckhafer merged commit 9f4bc33 into develop Jan 18, 2019

kieckhafer deleted the feat-aldeed-place-order-rewrite branch January 18, 2019 05:22

This was referenced Jan 18, 2019

feat: shipping surcharges #4829

Merged

Replace all Hooks with appEvents #4915

Merged

This was referenced Mar 1, 2019

Release v2.0.0 rc.10 #5016

Merged

Release v2.0.0 rc.10 reactioncommerce/example-storefront#512

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite placeOrder and support multiple payments for an order #4908

Rewrite placeOrder and support multiple payments for an order #4908

aldeed commented Jan 9, 2019 •

edited

Loading

kieckhafer left a comment

kieckhafer Jan 14, 2019

aldeed Jan 15, 2019

aldeed commented Jan 15, 2019 •

edited

Loading

kieckhafer commented Jan 15, 2019

aldeed commented Jan 15, 2019 •

edited

Loading

aldeed commented Jan 16, 2019

dancastellon left a comment •

edited

Loading

kieckhafer left a comment

kieckhafer left a comment

kieckhafer left a comment

Rewrite placeOrder and support multiple payments for an order #4908

Rewrite placeOrder and support multiple payments for an order #4908

Conversation

aldeed commented Jan 9, 2019 • edited Loading

Changes

Breaking changes

Testing

kieckhafer left a comment

Choose a reason for hiding this comment

kieckhafer Jan 14, 2019

Choose a reason for hiding this comment

aldeed Jan 15, 2019

Choose a reason for hiding this comment

aldeed commented Jan 15, 2019 • edited Loading

kieckhafer commented Jan 15, 2019

aldeed commented Jan 15, 2019 • edited Loading

aldeed commented Jan 16, 2019

dancastellon left a comment • edited Loading

Choose a reason for hiding this comment

kieckhafer left a comment

Choose a reason for hiding this comment

kieckhafer left a comment

Choose a reason for hiding this comment

kieckhafer left a comment

Choose a reason for hiding this comment

aldeed commented Jan 9, 2019 •

edited

Loading

aldeed commented Jan 15, 2019 •

edited

Loading

aldeed commented Jan 15, 2019 •

edited

Loading

dancastellon left a comment •

edited

Loading