Send `ipp_channel` metadata in payment intent from store management/POS use cases

jaclync commented 1 day ago

Closes: #14478

Why

As we are launching POS to external merchants soon, we want to identify if a transaction is from POS or IPP in the mobile apps for data analysis purposes.

How

As shared in pdfdoF-5QB-p2 > Apps, we want to add a new metadata ipp_channel: mobile_store_management | mobile_pos to the payment intent from IPP and POS respectively.

I thought about giving the channel parameter a default value of .storeManagement, but I'm afraid that this parameter will be forgotten and be the wrong value if we add more use cases in the future. I'm open to adding a default value if you think it will simplify the code though.

Steps to reproduce

Create a new Jurassic Ninja site – include Jetpack, WooCommerce, WooPayments, and WooPayments Dev Tools
Set up Jetpack to link the site to WPCOM user in the app (or skip this if you're loggin in with site credentials)
Add a US address in WooCommerce settings
Activate WooPayments. Go through the onboarding steps in WP-Admin > Payments > Activate. Alternatively, you can go through the onboarding in the app
Launch the app and switch to your new site
Create a purchasable product
Go to the orders tab. Create an order and collect payment with a card reader --> the payment collection should succeed. after that, verify that the payment intent metadata includes ipp_channel: mobile_store_management in the Stripe account (* check instructions below)
Go to the menu tab > Point of Sale mode. Add product to the cart and pay for the order --> the payment collection should succeed. after that, verify that the payment intent metadata includes ipp_channel: mobile_pos in the Stripe account (* check instructions below)

`*` How to check the transaction payment intent

Prerequisite: you have access to the WooPayments Stripe account (ask in #payment-operations if not)

In wp-admin > WCPay Dev, tap MC WCPay to see the payments info for the site
Under Stripe account details > Account ID, tap on the link to open the Stripe account (make sure you're logged in to WooPayments in Stripe, with test mode enabled)
Tap Payments, find the payment that was just made
On the payment details page, search for ipp_channel and verify the value is as expected

Testing information

I also tested with local server-side changes.

Screenshots

[x] I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Reviewer (or Author, in the case of optional code reviews):

Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement:

[x] The PR is small and has a clear, single focus, or a valid explanation is provided in the description. If needed, please request to split it into smaller PRs.
[x] Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
[x] Manual Testing: The author listed all the tests they ran, including smoke tests when needed (e.g., for refactorings). The reviewer confirmed that the PR works as expected on all devices (phone/tablet) and no regressions are added

dangermattic commented 1 day ago

	1 Warning
:warning:	This PR is assigned to the milestone 21.2. This milestone is due in less than 2 days. Please make sure to get it merged by then or assign it to a milestone with a later deadline.

Generated by :no_entry_sign: Danger

wpmobilebot commented 1 day ago

📲 You can test the changes from this Pull Request in WooCommerce iOS by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce iOS
	Build Number	pr14479-339f092
	Version	21.1
	Bundle ID	com.automattic.alpha.woocommerce
	Commit	339f092f049a77d209efcff262889bc870988b80
	App Center Build	WooCommerce - Prototype Builds #11693

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

woocommerce / woocommerce-ios