Add tracks for Customer Search #7907

iamgabrielma · 2022-10-24T08:46:48Z

Closes: #7741

Description

This PR:

Adds tracking to the Customer Search project.
Removes the feature flag.

The Android tracks counterpart uses the same names:

order_creation_customer_search: Triggered each time a new query is performed.
order_creation_customer_added: Triggered when a Customer is selected.

Testing instructions

Go to Orders > + > Create new Order > + Add Customer details > Tap on the magnifying glass icon:
Search for a Customer name
Confirm that once the search completes, the following is logged in the console:

🔵 Tracked order_creation_customer_search, properties: [AnyHashable("is_wpcom_store"): false, AnyHashable("blog_id"): 121710041]

Tap on it:
Confirm that once tapped, the following is logged in the console:

🔵 Tracked order_creation_customer_added, properties: [AnyHashable("is_wpcom_store"): false, AnyHashable("blog_id"): 121710041]

The PR must be assigned the Tracks label. Not applicable.
The tracks events must be validated in the Tracks system.

Verify the internal tracks spreadsheet has also been updated.

wpmobilebot · 2022-10-24T09:03:51Z

You can test the changes from this Pull Request by:

Clicking here or scanning the QR code below to access App Center
Then installing the build number pr7907-169094d on your iPhone

If you need access to App Center, please ask a maintainer to add you.

# Conflicts: # WooCommerce/Classes/ViewRelated/Orders/Order Details/Address Edit/EditOrderAddressForm.swift

peril-woocommerce · 2022-11-01T11:27:35Z

	Warnings
⚠️	This PR is assigned to a milestone which is closing in less than 2 days Please, make sure to get it merged by then or assign it to a later expiring milestone

Generated by 🚫 dangerJS

iamgabrielma · 2022-11-01T12:06:50Z

Added unit tests for orderCreationCustomerAdded and orderCreationCustomerSearch track events on 1ed53af and f20e20f respectively.

order_creation_customer_added shows now without properties since I moved the tracking to the existing viewModel, and used its existing declaration of Analytics, as well as for coherence with all other track tests on EditOrderAddressFormViewModelTests.

At the moment we do not track any property in any of these two, so we can iterate as needed if we decide we'll pass something with tracks in the future. Ready for review @joshheald! 👍

joshheald

Looks good, and tests well! A few minor suggestions.

Also, registering tracks events is covered here: PCYsg-mUj-p2

joshheald · 2022-11-02T09:58:59Z

Experiments/Experiments/DefaultFeatureFlagService.swift

-        case .orderCreationSearchCustomers:
-            return buildConfig == .localDeveloper || buildConfig == .alpha


I checked a release build, and the feature is enabled there 👍

joshheald · 2022-11-02T09:59:11Z

Experiments/Experiments/FeatureFlag.swift

-    /// Enables the Search Customers functionality in the Order Creation screen
-    ///
-    case orderCreationSearchCustomers
-


Well remembered

joshheald · 2022-11-02T10:01:21Z

...rce/Classes/ViewRelated/Orders/Order Details/Address Edit/AddressFormViewModelProtocol.swift

    /// Fills Order AddressFormFields with Customer details
    ///
    func customerSelectedFromSearch(customer: Customer) {
+        analytics.analyticsProvider.track(WooAnalyticsStat.orderCreationCustomerAdded.rawValue)


Suggested change

analytics.analyticsProvider.track(WooAnalyticsStat.orderCreationCustomerAdded.rawValue)

analytics.track(.orderCreationCustomerAdded)

Fixed here: 6a326f7

joshheald · 2022-11-02T10:04:35Z

...rceTests/ViewRelated/Orders/Order Details/Addresses/EditOrderAddressFormViewModelTests.swift

+        viewModel.customerSelectedFromSearch(customer: customer)
+
+        // Then
+        assertEqual(analyticsProvider.receivedEvents, [WooAnalyticsStat.orderCreationCustomerAdded.rawValue])


This works fine, but is a little brittle.

It would be nice if tracking an extra analytics event in the course of selecting a customer from search didn't make this test fail, even though the expected event is still logged

You could see if there's anything you can do to make it a little more future proof?

I didn't thought about it, if some other event sneaks in while we're waiting from our customerSelectedFromSearch() to come back, the test would fail indeed. I changed the test to confirm if receivedEvents contains it instead.

// Then - assertEqual(analyticsProvider.receivedEvents, "order_creation_customer_added") + XCTAssert(analyticsProvider.receivedEvents.contains("order_creation_customer_added"))

Fixed here: 169094d

joshheald · 2022-11-02T10:06:09Z

WooCommerce/WooCommerceTests/ViewRelated/Search/Customer/CustomerSearchUICommandTests.swift

+        guard let eventIndex = analyticsProvider.receivedEvents.firstIndex(of: "order_creation_customer_search") else {
+            return XCTFail("Analytics not logged")
+        }
+        XCTAssertNotNil(eventIndex)


This test works well 👍 but this XCTAssertNotNil can't fail. It's a little more expressive like this:

Suggested change

guard let eventIndex = analyticsProvider.receivedEvents.firstIndex(of: "order_creation_customer_search") else {

return XCTFail("Analytics not logged")

}

XCTAssertNotNil(eventIndex)

XCTAssert(analyticsProvider.receivedEvents.contains("order_creation_customer_search"))

Oh! That's true, if passes the guard, it would never fail. Thanks for the suggestion! Changed at 2be5053

iamgabrielma · 2022-11-03T02:12:46Z

registering tracks events is covered here: PCYsg-mUj-p2

Thanks for the link, I was unaware of the registration process. It would seem the Android counterpart is not registered either so I'll take care of those as well 👍

Add tracks for customer search

bcb8d16

iamgabrielma added this to the 11.0 milestone Oct 24, 2022

iamgabrielma mentioned this pull request Oct 24, 2022

Order creation: Search Customers #7741

Closed

15 tasks

iamgabrielma added status: draft This is a draft, still need more work but can be reviewed and commented if asked. and removed status: do not merge Dependent on another PR, ready for review but not ready for merge. labels Oct 24, 2022

Base automatically changed from issue/741-implement-customer-search-ui to trunk October 26, 2022 07:45

iamgabrielma modified the milestones: 11.0, 11.1 Oct 28, 2022

Merge branch 'trunk' into issue/7741-add-customer-search-tracks

aed6852

iamgabrielma changed the base branch from trunk to issue/7741-fill-order-data-from-customer-search October 28, 2022 05:49

Base automatically changed from issue/7741-fill-order-data-from-customer-search to trunk November 1, 2022 03:01

iamgabrielma added 4 commits November 1, 2022 13:07

Merge branch 'trunk' into issue/7741-add-customer-search-tracks

d350d31

# Conflicts: # WooCommerce/Classes/ViewRelated/Orders/Order Details/Address Edit/EditOrderAddressForm.swift

Add tracks to customer search

bb884ed

Remove feature flag

6aace88

Update release notes

6670176

iamgabrielma force-pushed the issue/7741-add-customer-search-tracks branch from f2d7276 to 6670176 Compare November 1, 2022 04:19

iamgabrielma marked this pull request as ready for review November 1, 2022 04:19

iamgabrielma removed the status: draft This is a draft, still need more work but can be reviewed and commented if asked. label Nov 1, 2022

iamgabrielma requested review from ThomazFB and joshheald November 1, 2022 05:02

iamgabrielma added 3 commits November 1, 2022 19:15

Move orderCreationCustomerSearch track outside success case

56582c0

Add test for orderCreationCustomerSearch track

f20e20f

Add test for orderCreationCustomerAdded track

1ed53af

joshheald self-assigned this Nov 2, 2022

joshheald approved these changes Nov 2, 2022

View reviewed changes

iamgabrielma added 3 commits November 3, 2022 10:41

Simplify track event call

6a326f7

Make orderCreationCustomerSearch event test clearer

2be5053

Make orderCreationCustomerAdded track test more solid

169094d

iamgabrielma merged commit 30bc4e9 into trunk Nov 3, 2022

iamgabrielma deleted the issue/7741-add-customer-search-tracks branch November 3, 2022 02:35

		case .orderCreationSearchCustomers:
		return buildConfig == .localDeveloper \|\| buildConfig == .alpha

	analytics.analyticsProvider.track(WooAnalyticsStat.orderCreationCustomerAdded.rawValue)
	analytics.track(.orderCreationCustomerAdded)

Add tracks for Customer Search #7907

Add tracks for Customer Search #7907

Uh oh!

Conversation

iamgabrielma commented Oct 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

wpmobilebot commented Oct 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

peril-woocommerce bot commented Nov 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iamgabrielma commented Nov 1, 2022

Uh oh!

joshheald left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iamgabrielma commented Nov 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iamgabrielma commented Oct 24, 2022 •

edited

Loading

wpmobilebot commented Oct 24, 2022 •

edited

Loading

peril-woocommerce bot commented Nov 1, 2022 •

edited

Loading