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

jaclync · 2024-11-21T05:37:52Z

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

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:

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.
Ensure Adequate Unit Test Coverage: The changes are reasonably covered by unit tests or an explanation is provided in the PR description.
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

…ses to differentiate POS and store management source.

wpmobilebot · 2024-11-21T05:47:17Z

📲 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-b601a7c
	Version	21.2
	Bundle ID	com.automattic.alpha.woocommerce
	Commit	`b601a7c`
	App Center Build	WooCommerce - Prototype Builds #11752

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

…o .pos.

staskus

✅ Thanks, works as described!

POS	Store Management

One note is that ipp_channel appears twice within payment details:

charges -> data -> metadata -> ipp_channel
metadata -> ipp_channel

On a technical note, I was thinking if passing a channel all around could be avoided. If POS and Store Management would rely on different instances of dependencies, then we could inject the channel through an initializer. However, that's not an option now so I don't have good suggestions. Given this code rarely has a new entry point maybe thats a non-issue.

staskus · 2024-11-21T06:27:06Z

Hardware/Hardware/CardReader/PaymentIntent.swift

@@ -106,7 +111,8 @@ public extension PaymentIntent {
                          siteURL: String? = nil,
                          orderID: Int64? = nil,
                          orderKey: String? = nil,
-                          paymentType: PaymentTypes? = nil
+                          paymentType: PaymentTypes? = nil,


nit;

There's broken alignment for the rest of the parameters

Updated the indentation of these misaligned parameters in b601a7c

@joshheald

* trunk: (132 commits) Update tests Make sure self is weakly captured Add a clarifiyng comment regarding the nullability of site customPackageViewModel as StateObject Simplify expression Add a release note Make sure to wait for site to be available before handling the magic link Rename to WooShippingAccountSettings Make bindings private Freeze strings for localization Update metadata strings Update release notes with @joshheald's thoughtful rewrite. Do not dismiss success modals automatically when email receipt action is selected Restructure presentBackendReceiptAlert to align implementation for success and failed alerts Use CardPresentModalBuiltIn modals for BuiltInCardReaderPaymentAlertsProvider Restructure the code to set paymentSuccessEmailSent when presentSendReceiptAfterPayment succeeds Add missing weak self when presentSendReceiptAfterPayment is called Update closure naming in CardPresentModalErrorTests Clarify closure naming for CardPresentModalNonRetryableError Clarify closure naming for CardPresentModalErrorEmailSent and Clarify closure naming for CardPresentModalErrorWithoutEmail ... # Conflicts: # WooCommerce/Classes/ViewRelated/Orders/Collect Payments/CollectOrderPaymentUseCase.swift # WooCommerce/WooCommerceTests/ViewModels/CardPresentPayments/CollectOrderPaymentUseCaseTests.swift

jaclync · 2024-11-26T05:32:55Z

On a technical note, I was thinking if passing a channel all around could be avoided. If POS and Store Management would rely on different instances of dependencies, then we could inject the channel through an initializer. However, that's not an option now so I don't have good suggestions. Given this code rarely has a new entry point maybe thats a non-issue.

Yea I agree that it's not pretty seeing a bunch of places where the channel is passed around. Initially, I tried DI'ing the channel to the initializers but decided to move it to the collectPayment function worrying that the dependencies could become a singleton in the app in the future. As the channel value isn't something we test normally, it might be worth making this parameter explicit in every payment collection use case.

jaclync · 2024-11-27T05:38:49Z

Merging this PR as it's approved to avoid merge conflicts, with the possibility of adding a feature flag or condition on the WooPayments version per decision pdfdoF-5UW-p2#comment-6983.

jaclync added 3 commits November 21, 2024 12:47

DI a new channel: PaymentChannel parameter to collectPayment use ca…

241b2ac

…ses to differentiate POS and store management source.

DI channel in unit tests.

3fafc22

Add new test cases for the channel parameter.

de43c57

jaclync added type: task An internally driven task. feature: mobile payments Related to mobile payments / card present payments / Woo Payments. feature: POS labels Nov 21, 2024

jaclync added this to the 21.2 milestone Nov 21, 2024

Fix lint errors from long line length.

84aff0c

Add a test case for POS collectPayment to ensure the channel is set t…

339f092

…o .pos.

jaclync marked this pull request as ready for review November 21, 2024 06:19

jaclync requested review from joshheald, iamgabrielma and staskus November 21, 2024 06:19

staskus approved these changes Nov 21, 2024

View reviewed changes

jaclync modified the milestones: 21.2, 21.3 Nov 22, 2024

This was referenced Nov 25, 2024

[POS TPV Tracking] Send ipp_channel metadata in payment intent for IPP/POS #14478

Open

[Mobile] Display 'In-Person (POS)' for transactions from mobile POS Automattic/woocommerce-payments#9802

Open

jaclync added 2 commits November 26, 2024 13:19

Update indentation for misaligned parameters.

b601a7c

jaclync mentioned this pull request Nov 26, 2024

[POS TPV Tracking] Send ipp_channel metadata in payment intent for IPP/POS woocommerce/woocommerce-android#13000

Open

jaclync merged commit 6024bea into trunk Nov 27, 2024
14 checks passed

jaclync deleted the feat/tpv-tracking-channel branch November 27, 2024 05:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

jaclync commented Nov 21, 2024 •

edited by staskus

Loading

wpmobilebot commented Nov 21, 2024 •

edited

Loading

staskus left a comment

staskus Nov 21, 2024

jaclync Nov 26, 2024

jaclync commented Nov 26, 2024

jaclync commented Nov 27, 2024

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

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

Conversation

jaclync commented Nov 21, 2024 • edited by staskus Loading

Why

How

Steps to reproduce

* How to check the transaction payment intent

Testing information

Screenshots

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

wpmobilebot commented Nov 21, 2024 • edited Loading

staskus left a comment

Choose a reason for hiding this comment

staskus Nov 21, 2024

Choose a reason for hiding this comment

jaclync Nov 26, 2024

Choose a reason for hiding this comment

jaclync commented Nov 26, 2024

jaclync commented Nov 27, 2024

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

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

jaclync commented Nov 21, 2024 •

edited by staskus

Loading

`*` How to check the transaction payment intent

wpmobilebot commented Nov 21, 2024 •

edited

Loading