Order wrapper class proposal

[wjrosa]

Changes proposed in this Pull Request:

This PR is a proposal for introducing a new children class (WC_Stripe_Order, extended from WC_Order) that wraps all our custom metadata and extension-specific business logic. This should make it easier to reference and change metas.

Testing instructions

• Take a look at the code. Do you think it makes sense to move forward?
• Check if the tests are still passing
• Perform some smoke tests:
  -- Connect your Stripe account
  -- Enable some payment methods
  -- As a shopper, make some purchases

* Unit tests for the new class will be added if this proposal gets approved

---

• Covered with tests (or have a good reason not to test in description ☝️)
• Added changelog entry in both changelog.txt and readme.txt (or does not apply)
• Tested on mobile (or does not apply)

Post merge

• Added testing instructions to the Release Testing Instructions wiki page (or does not apply)
• Added the needs docs label (or does not apply)
• Included this PR in the Release Thread scope (or does not apply)

[wjrosa]

Hey team! I would like to have your opinion on this proposal (@Mayisha , @diegocurbelo , @mattallan , @annemirasol ). What do you think?

[annemirasol]

I love that we're consolidating order metadata getters and setters, and abstracting specifics, like the actual key names.

I haven't looked at all the changes closely, but I think it's a refactor worth pursuing, @wjrosa. Thanks for making the effort.

[wjrosa]

I love that we're consolidating order metadata getters and setters, and abstracting specifics, like the actual key names.

I haven't looked at all the changes closely, but I think it's a refactor worth pursuing, @wjrosa. Thanks for making the effort.

Nice, Anne! I will update this PR and properly move this to review so everyone can have a better look at the idea.

[wjrosa]

Hey @woocommerce/quark! I have finished polishing my idea here. I'd appreciate it if you could at least tell me if it is OK to move this forward. I believe it is a great quality of life improvement. All possible meta keys, getters, setters, and retrieval methods are in one place. This also makes our WC_Stripe_Helper class smaller.

[Mayisha]

Smoke test results

Account connection
✅ Connect to Stripe account
✅ Reconfigure webhook

Simple product
✅ Card
✅ WeChat
✅ Multibanco
✅ klarna
✅ iDeal
⚠️ Sepa - The status remained on-hold forever. (check if you can reproduce it or it could be my local issue)

Subscription
✅ Card
✅ Cash App
⚠️ Sepa - The status remained on-hold (check if you can reproduce it or it could be my local issue)
🔴 Renewal - subscription renewal from subs edit page results in a fatal error

Refund
✅ Tested refund with a couple of payment methods for simple and subscription product.

Capture Later
✅ Tested with card.

Additional note

Changes needed

• Need to update the deprecation version from 9.1.0 to the latest one.
• Added a few comments.

Post merge action item

• Create a follow-up issue to remove deprecated functions in the future.
• Inform Quark and Fractal members to use this wrapper going forward.
• Include rigorous testing instructions for order related features for GS before the release.

[wjrosa]

Thanks @Mayisha for the additional review and notes!

⚠️ Sepa - The status remained on-hold forever. (check if you can reproduce it or it could be my local issue)

Fixed this issue in 8be7874

🔴 Renewal - subscription renewal from subs edit page results in a fatal error

Fixed in d64f154

[Mayisha]

Suggested change

	$order->delete_fee();
	$order->delete_meta_data( self::META_NAME_FEE );
	$order->delete_meta_data( self::LEGACY_META_NAME_FEE );

@wjrosa I am still getting the fatal error when I try to renew a subscription from the subscription edit page. The reason is , though it's calling this helper method now, the helper method itself tries to call the function from the new order wrapper class.

This helps to realize another problem, if any third party plugins are using these helper methods, they would send an instance of WC_Order here, not WC_Stripe_Order. So we should keep the previous code in these functions.

Similar changes (reverts) should be made for other functions here as well to avoid breaking plugin compaatibility.

[wjrosa]

Alright, sorry about that! I reverted the changes on the deprecated methods and added extra checks for the object class type on the latest commits.