[Woo POS][Barcodes] Analytics for setup flow #15907

staskus · 2025-07-12T10:00:16Z

Description

Added analytics tracking for barcode scanner setup flow in POS. Implements a dozen new events to track user interaction with scanner selection, setup steps, test scanning, and dismissal behavior.

Registered events

TBD - events will be registered before the merge

Steps to reproduce

Launch the app and POS
Select Menu -> Barcode scanner
Navigate the flow in various ways to confirm the behavior

barcode_scanner_setup_flow_shown
barcode_scanner_setup_scanner_selected with scanner: [Star_BSH_20B, Socket_S720, TBC]
barcode_scanner_setup_next_tapped with scanner and step: [setup_barcode_hid, setup_barcode_pair, setup_information, setup_products, pairing,
test_barcode, test_scan_failed, test_scan_timed_out, setup_complete] (current step before the navigation)
barcode_scanner_setup_back_tapped with scanner and step
barcode_scanner_setup_open_system_settings_tapped with scanner
barcode_scanner_setup_test_scan_success with scanner
barcode_scanner_setup_test_scan_failed with scanner and scan_value
barcode_scanner_setup_test_scan_timed_out with scanner
barcode_scanner_setup_dismissed with scanner and step (tracked from tapping x, tapping outside the modal, and tapping any Close button in the flow). No properties in the initial scanner selection view.
barcode_scanner_setup_retry_tapped with scanner

Testing information

Tested on iPad Air 26.0 with Inateck scanner

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

- Add 11 new barcode scanner setup events to WooAnalyticsStat - Add events to POS event list in TracksProvider - Add factory methods in WooAnalyticsEvent+PointOfSale

- Add analyticsName to PointOfSaleBarcodeScannerType - Add PointOfSaleBarcodeScannerSetupStepType enum with analyticsValue - Update scan tester to use callbacks with scan value parameter

- Track scanner selection, navigation, and completion events - Track dismissals except on completion step - Track keyboard connection during setup - Track system settings button taps

- Add dismissal tracking via onDisappear in main setup view - Update Xcode project file for new test files

- Update ScanTester tests for new callback structure - Add FlowManager tests for analytics tracking and state management - Test dismissal tracking behavior and completion step logic

- Change Result<String, Error> to Result<String, HIDBarcodeParserError> throughout barcode scanning chain - Update GameControllerBarcodeParser.asResult to return specific error type - Update scan tester to handle specific error type with error.barcode property - Update tests to use HIDBarcodeParserError instead of generic TestError

dangermattic · 2025-07-12T10:01:29Z

	2 Warnings
⚠️	View files have been modified, but no screenshot or video is included in the pull request. Consider adding some for clarity.
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

	1 Message
📖	This PR contains changes to Tracks-related logic. Please ensure (author and reviewer) the following are completed: The tracks events must be validated in the Tracks system. Verify the internal Tracks spreadsheet has also been updated. Please consider registering any new events. The PR must be assigned the category: tracks label.

Generated by 🚫 Danger

wpmobilebot · 2025-07-12T10:09:57Z

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

	App Name	WooCommerce iOS Prototype
	Build Number	`pr15907-20bee21`
	Version	`22.8`
	Bundle ID	`com.automattic.alpha.woocommerce`
	Commit	`20bee21`
	Installation URL	1buhbqjt39f4g

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

staskus · 2025-07-14T09:18:19Z

@jaclync, @iamgabrielma not sure if anyone has a capability to test this with any barcode scanner?

staskus · 2025-07-14T09:34:15Z

I will review and integrate existing project PRs first #15903

iamgabrielma · 2025-07-14T09:37:50Z

My scanner has arrived today, I should be able to set it up/test between today and tomorrow 👍

…tup-flow

jaclync · 2025-07-14T14:03:55Z

not sure if anyone has a capability to test this with any barcode scanner?

My Tera scanner is scheduled to arrive today (Monday), but not sure what time, and it might take some time for me to set up for the first time. If I receive it today, I can test it tomorrow/Tuesday for sure.

iamgabrielma · 2025-07-15T08:07:42Z

👋 @staskus I started to test the events with the Eyoyo model (Other). I'm not sure if I'm missing something here, is it possible that some events are not implemented yet, or need a specific scanner for testing the flow? Do I need to go through the pairing flow through the app somehow, rather than directly via iPad settings? Marked them below:

✅ barcode_scanner_setup_flow_shown
✅ barcode_scanner_setup_scanner_selected with scanner: [Star_BSH_20B, Socket_S720, TBC]
✅ barcode_scanner_setup_next_tapped with scanner and step: [setup_barcode_hid, setup_barcode_pair, setup_information, setup_products, pairing, test_barcode, test_scan_failed, test_scan_timed_out, setup_complete] (current step before the navigation)
✅ barcode_scanner_setup_back_tapped with scanner and step
❔ barcode_scanner_setup_open_system_settings_tapped with scanner
❔barcode_scanner_setup_test_scan_success with scanner
❔barcode_scanner_setup_test_scan_failed with scanner and scan_value
❔barcode_scanner_setup_test_scan_timed_out with scanner
✅ barcode_scanner_setup_dismissed with scanner and step (tracked from tapping x, tapping outside the modal, and tapping any Close button in the flow). No properties in the initial scanner selection view.
❔barcode_scanner_setup_retry_tapped with scanner
❔barcode_scanner_setup_complete with scanner

staskus · 2025-07-15T08:21:49Z

@iamgabrielma sorry for not providing more details.

So far, only Star scanner flow is implemented to test all the steps. But you can use Eyoyo to go through the steps as well, just don't scan the QR code.

Select Star
Click next to open the pairing screen
Tap the settings button, barcode_scanner_setup_open_system_settings_tapped with scanner should be tracked
Click next to open the test barcode screen
Wait 10 seconds, the timeout screen is shown, barcode_scanner_setup_test_scan_timed_out should be tracked
Scan some other barcode, error screen should be shown, barcode_scanner_setup_test_scan_failed should be tracked
Retry, barcode_scanner_setup_retry_tapped should be tracked
Come back to the test barcode and scan it, barcode_scanner_setup_test_scan_success should be tracked

barcode_scanner_setup_complete was removed, I'll update the test instructions.

iamgabrielma

LGTM! Seeing the success screen after scanning the test code was oddly satisfying 💯

✅ barcode_scanner_setup_flow_shown
✅ barcode_scanner_setup_scanner_selected with scanner: [Star_BSH_20B, Socket_S720, TBC]
✅ barcode_scanner_setup_next_tapped
✅ barcode_scanner_setup_back_tapped with scanner and step
✅ barcode_scanner_setup_open_system_settings_tapped with scanner
✅ barcode_scanner_setup_test_scan_success with scanner
✅ barcode_scanner_setup_test_scan_failed with scanner and scan_value
✅ barcode_scanner_setup_test_scan_timed_out with scanner
✅ barcode_scanner_setup_dismissed with scanner and step
✅ barcode_scanner_setup_retry_tapped with scanner

Also I saw an additional event being tracked: pos_barcode_scanning_explanation_dialog_shown 👍

iamgabrielma · 2025-07-15T10:15:07Z

...erce/Classes/POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupFlow.swift

        case .socketS720:
            return [
-                .start: createWelcomeStep(title: "Socket S720 Setup")
+                .setupBarcodeHID: createWelcomeStep(title: "Socket S720 Setup")


Not necessarily in this PR, but I'm guessing these will need localization?

Yes, we have WOOMOB-792 for localized strings.

createWelcomeStep also will be removed altogether when we make the setup steps for all the recommended scanners.

.../POS/Presentation/Barcode Scanner Setup/PointOfSaleBarcodeScannerSetupFlowManagerTests.swift

iamgabrielma · 2025-07-15T10:23:23Z

So far, only Star scanner flow is implemented to test all the steps

Ah, thanks! When I didn't see any steps I did tap on Socket, but this only showed the TODO, I didn't check other options.

Co-authored-by: Gabriel Maldonado <[email protected]>

staskus · 2025-07-15T10:32:54Z

pointOfSaleBarcodeScanningExplanationDialogShown

We can keep it for now. We may remove it when cleaning up the code after i2 🤔

staskus added 6 commits July 12, 2025 12:40

Add barcode scanner setup analytics events

124d8a0

- Add 11 new barcode scanner setup events to WooAnalyticsStat - Add events to POS event list in TracksProvider - Add factory methods in WooAnalyticsEvent+PointOfSale

Update barcode scanner setup models and scan tester

6ae110e

- Add analyticsName to PointOfSaleBarcodeScannerType - Add PointOfSaleBarcodeScannerSetupStepType enum with analyticsValue - Update scan tester to use callbacks with scan value parameter

Add analytics tracking to barcode scanner setup flow

1bb17df

- Track scanner selection, navigation, and completion events - Track dismissals except on completion step - Track keyboard connection during setup - Track system settings button taps

Update barcode scanner setup entry point and project

3b80b04

- Add dismissal tracking via onDisappear in main setup view - Update Xcode project file for new test files

Add and update tests for barcode scanner setup

eae2f57

- Update ScanTester tests for new callback structure - Add FlowManager tests for analytics tracking and state management - Test dismissal tracking behavior and completion step logic

staskus added this to the 22.9 milestone Jul 12, 2025

staskus added category: tracks Related to analytics, including Tracks Events. feature: POS labels Jul 12, 2025

staskus requested review from iamgabrielma and jaclync July 14, 2025 09:17

staskus marked this pull request as draft July 14, 2025 09:33

iamgabrielma self-assigned this Jul 14, 2025

staskus mentioned this pull request Jul 14, 2025

[Woo POS][Barcodes] Set up flow test failure screen #15903

Merged

1 task

Merge branch 'trunk' into woomob-788-woo-posbarcodes-analytics-for-se…

bced627

…tup-flow

staskus added 2 commits July 14, 2025 17:23

Updated tests after the merge

f6bc612

Disable barcode scanning if a modal is presented

2c85102

staskus marked this pull request as ready for review July 14, 2025 14:44

iamgabrielma approved these changes Jul 15, 2025

View reviewed changes

Remove unnecessary comments fro FlowManagerTests

20bee21

Co-authored-by: Gabriel Maldonado <[email protected]>

staskus enabled auto-merge July 15, 2025 10:31

staskus merged commit bf55b57 into trunk Jul 15, 2025
13 checks passed

staskus deleted the woomob-788-woo-posbarcodes-analytics-for-setup-flow branch July 15, 2025 10:51

[Woo POS][Barcodes] Analytics for setup flow #15907

[Woo POS][Barcodes] Analytics for setup flow #15907

Uh oh!

Conversation

staskus commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Registered events

Steps to reproduce

Testing information

Tested on iPad Air 26.0 with Inateck scanner

Uh oh!

dangermattic commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

staskus commented Jul 14, 2025

Uh oh!

staskus commented Jul 14, 2025

Uh oh!

iamgabrielma commented Jul 14, 2025

Uh oh!

jaclync commented Jul 14, 2025

Uh oh!

iamgabrielma commented Jul 15, 2025

Uh oh!

staskus commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iamgabrielma left a comment

Choose a reason for hiding this comment

Uh oh!

iamgabrielma Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

staskus Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iamgabrielma commented Jul 15, 2025

Uh oh!

staskus commented Jul 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

staskus commented Jul 12, 2025 •

edited

Loading

dangermattic commented Jul 12, 2025 •

edited

Loading

wpmobilebot commented Jul 12, 2025 •

edited

Loading

staskus commented Jul 15, 2025 •

edited

Loading