Label campaigns for the web version and the WC Mobile app #2514

jorgemd24 · 2024-08-08T16:58:59Z

Changes proposed in this Pull Request:

Part of pcTzPl-2nS-p2

This PR will automatically label campaigns created via the WC Mobile App by checking the user agent headers. The labels used will be wc-android or wc-ios. If the campaign isn't created through the WC Mobile App, it will be labeled as wc-web.

Screenshots:

Detailed test instructions:

Download the WC Mobile App and connect it to one of your local sites. Then, navigate to WC Admin -> Google for WooCommerce and create a new campaign. Alternatively, simulate this process by sending a request to POST /wp-json/wc/gla/ads/campaigns with the User Agent header set to something like: Mozilla/5.0 (iPhone; CPU iPhone OS 17_5_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 wc-ios/19.7.1. Set the below body:

{
    "amount": 0.01,
    "targeted_locations": ["ES"],
}

Follow the steps mentioned in this PR to check if the label has been set: Enable labeling of Ads campaigns #2485. It has to be wc-ios or wc-android.
Repeat the process on a laptop, and the campaign label should be wc-web

Additional details:

Changelog entry

Tweak - Label campaigns for the web version and the WooCommerce Mobile app.

mikkamp

Thanks for getting this added, and including some unit tests.

I tested by alternating the user agent and can confirm it gets the right label when creating the campaign. I left a few smaller comments, but none of them are blocking so I'll go ahead and approve the PR.

mikkamp · 2024-08-09T13:45:07Z

js/src/data/actions.js

@@ -805,6 +805,7 @@ export function* createAdsCampaign( amount, countryCodes ) {
 			data: {
 				amount,
 				targeted_locations: countryCodes,
+				label: 'wc-web',


I'm assuming this means we are defaulting the label to wc-web even on mobile, and then only overwriting the value once we process the request in PHP. It also means that when testing for mobile if I view the requests it's sending a request with wc-web but the final campaign gets a different label.

Is that in preparation for the mobile eventually calling the API directly? I was imagining that in this implementation we'd fetch the user agent in JS and then populate this label accordingly. Fine either approach though if it's better to detect the user agent in PHP.

Thanks for the suggestion! My initial thought was to detect the header directly on the server, but I like the idea of moving the logic to the client. It keeps the API agnostic to the labels and lets the client handle setting them. If the mobile team wants to use the API to create campaigns, they can simply add the label parameter in the body.

mikkamp · 2024-08-09T13:52:59Z

src/API/Site/Controllers/Ads/CampaignController.php

+				if ( $this->is_wc_mobile_app( $request ) ) {
+					if ( $this->is_wc_ios( $request ) ) {
+						$fields['label'] = 'wc-ios';
+					} else {
+						$fields['label'] = 'wc-android';
+					}
+				}


PHP will do some optimization but if we follow the code path this will technically fetch the user agent header and then check if it contains the string wc-ios twice. If we aren't going to optimize it so it only needs to compare the header once, then wouldn't it look slightly cleaner to check it like this:

Suggested change

if ( $this->is_wc_mobile_app( $request ) ) {

if ( $this->is_wc_ios( $request ) ) {

$fields['label'] = 'wc-ios';

} else {

$fields['label'] = 'wc-android';

}

}

if ( $this->is_wc_ios( $request ) ) {

$fields['label'] = 'wc-ios';

} elseif ( $this->is_wc_android( $request ) ) {

$fields['label'] = 'wc-android';

}

mikkamp · 2024-08-09T13:56:35Z

tests/Unit/API/Site/Controllers/Ads/CampaignControllerTest.php

+					$invokation = $matcher->getInvocationCount();
+					if ( $invokation === 1 ) {


Not a big deal, but I would spell the variable with a c, or reduce the need for storing it in a variable.

Suggested change

$invokation = $matcher->getInvocationCount();

if ( $invokation === 1 ) {

if ( 1 === $matcher->getInvocationCount() ) {

jorgemd24 · 2024-08-09T19:21:58Z

Hi @mikkamp thanks for the review! I liked your suggestion about detecting the user agent in the client, (see my comment) so I went ahead and I moved the logic to the client. Can you have another look? Thanks.

codecov · 2024-08-09T19:22:17Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.7%. Comparing base (182b5dd) to head (aa6185e).
Report is 6 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff              @@
##             develop   #2514      +/-   ##
============================================
+ Coverage       63.5%   64.7%    +1.2%     
- Complexity         0    4580    +4580     
============================================
  Files            322     798     +476     
  Lines           5043   22940   +17897     
  Branches        1220    1222       +2     
============================================
+ Hits            3204   14844   +11640     
- Misses          1672    7930    +6258     
+ Partials         167     166       -1

Flag	Coverage Δ
js-unit-tests	`63.8% <100.0%> (+0.2%)`	⬆️
php-unit-tests	`65.0% <100.0%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
js/src/data/actions.js	`5.2% <100.0%> (+3.6%)`	⬆️
js/src/utils/isMobileApp.js	`100.0% <100.0%> (ø)`
...rc/API/Site/Controllers/Ads/CampaignController.php	`100.0% <100.0%> (ø)`

... and 475 files with indirect coverage changes

mikkamp

Thanks for the changes, it looks like a much simpler implementation, and continues to work as expected.

I just left a few comments / thoughts, but none of them are blocking.

mikkamp · 2024-08-12T09:12:17Z

js/src/data/test/createAdsCampaign.test.js

+		} );
+	} );
+
+	it( 'If the user agent is set to wc-ios the label should be wc-android', async () => {


This test title seems to have a copy paste error in it.

mikkamp · 2024-08-12T09:17:16Z

js/src/utils/isMobileApp.js

+ *
+ */
+const isWCIos = () => {
+	return window.navigator.userAgent.includes( 'wc-ios' );


Don't think this should be a problem, but in the PHP solution a non case sensitive solution was used, this one is case sensitive. If that's acceptable then ok to leave as is.

mikkamp · 2024-08-12T09:21:36Z

tests/Unit/API/Site/Controllers/Ads/CampaignControllerTest.php

+		$this->expect_track_event(
+			'created_campaign',
+			[
+				'id'                 => self::TEST_CAMPAIGN_ID,
+				'status'             => 'enabled',
+				'name'               => 'New Campaign',
+				'amount'             => 20,
+				'country'            => self::BASE_COUNTRY,
+				'targeted_locations' => 'US,GB,TW',
+			]
+		);


Just looking at this track here. Wouldn't it be useful to also pass the source? Or is it going to still include the user agent string so it can be extracted from there?

jorgemd24 · 2024-08-12T13:58:26Z

Thanks @mikkamp for the review! I've addressed all your comments.

Just looking at this track here. Wouldn't it be useful to also pass the source? Or is it going to still include the user agent string so it can be extracted from there?

I think it is good to add the source in the event tracking so I've added it here: aa6185e

jorgemd24 added 3 commits August 8, 2024 18:44

Detect if it is WC App

0eab6b5

Add label from the ui

34a4c32

Add tests

14f1070

jorgemd24 self-assigned this Aug 8, 2024

github-actions bot added the changelog: tweak Small change, that isn't actually very important. label Aug 8, 2024

jorgemd24 requested a review from a team August 8, 2024 17:14

jorgemd24 marked this pull request as ready for review August 8, 2024 17:15

mikkamp approved these changes Aug 9, 2024

View reviewed changes

jorgemd24 added 6 commits August 9, 2024 21:08

Move logic to the client

bdfbae5

Add tests

6fb9af7

Remove logic backend

7678e21

Remove unsused trait

959a0b1

Adjust campaign controller tests

4feded9

Add missing dependency comment

288b8b8

mikkamp approved these changes Aug 12, 2024

View reviewed changes

jorgemd24 added 3 commits August 12, 2024 13:50

Adjust test description

7ce5d62

Make detection of user agent case insensitive

9ccf440

Add source to the event tracker

aa6185e

jorgemd24 merged commit b80d149 into develop Aug 12, 2024
15 checks passed

jorgemd24 deleted the tweak/assign-campaign-labels branch August 12, 2024 13:58

eason9487 added a commit that referenced this pull request Aug 13, 2024

Fix eslinting errors for #2514

8e1905e

eason9487 mentioned this pull request Aug 14, 2024

Release 2.8.2 #2523

Merged

22 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Label campaigns for the web version and the WC Mobile app #2514

Label campaigns for the web version and the WC Mobile app #2514

jorgemd24 commented Aug 8, 2024 •

edited by eason9487

Loading

mikkamp left a comment

mikkamp Aug 9, 2024

jorgemd24 Aug 9, 2024

mikkamp Aug 9, 2024

mikkamp Aug 9, 2024

jorgemd24 commented Aug 9, 2024

codecov bot commented Aug 9, 2024 •

edited

Loading

mikkamp left a comment

mikkamp Aug 12, 2024

mikkamp Aug 12, 2024

mikkamp Aug 12, 2024

jorgemd24 commented Aug 12, 2024

		$invokation = $matcher->getInvocationCount();
		if ( $invokation === 1 ) {

	$invokation = $matcher->getInvocationCount();
	if ( $invokation === 1 ) {
	if ( 1 === $matcher->getInvocationCount() ) {

Label campaigns for the web version and the WC Mobile app #2514

Label campaigns for the web version and the WC Mobile app #2514

Conversation

jorgemd24 commented Aug 8, 2024 • edited by eason9487 Loading

Changes proposed in this Pull Request:

Screenshots:

Detailed test instructions:

Additional details:

Changelog entry

mikkamp left a comment

Choose a reason for hiding this comment

mikkamp Aug 9, 2024

Choose a reason for hiding this comment

jorgemd24 Aug 9, 2024

Choose a reason for hiding this comment

mikkamp Aug 9, 2024

Choose a reason for hiding this comment

mikkamp Aug 9, 2024

Choose a reason for hiding this comment

jorgemd24 commented Aug 9, 2024

codecov bot commented Aug 9, 2024 • edited Loading

Codecov Report

mikkamp left a comment

Choose a reason for hiding this comment

mikkamp Aug 12, 2024

Choose a reason for hiding this comment

mikkamp Aug 12, 2024

Choose a reason for hiding this comment

mikkamp Aug 12, 2024

Choose a reason for hiding this comment

jorgemd24 commented Aug 12, 2024

jorgemd24 commented Aug 8, 2024 •

edited by eason9487

Loading

codecov bot commented Aug 9, 2024 •

edited

Loading