Implement event tracking for the new lock screen widget by tzef · Pull Request #20422 · wordpress-mobile/WordPress-iOS

tzef · 2023-03-28T07:03:52Z

This is the PR for tracking the lockscreen widgets results.

Add new feature flag for lock screen widgets in Jetpack #20309 (✅ Approved)
Implement lock screen widgets UI #20312 (✅ Approved)
Add dynamic type support #20342 (TBD)
Add localizable string for "Views Today" title #20353 (✅ Approved)
[BugFix] Fix widget of home screen for WordPress disappeared #20371 (✅ Approved)
Extract content logic to config from lock screen widget #20317 (✅ Approved)
Create a standalone TimeLineProvider and TimelineEntry for the lock screen #20368 (✅ Approved)
Implement view for logged-out, no-site, and no-data status #20399 (✅ Approved)
Notify to reload the timelines for lock screen widget #20405 (✅ Approved)
(Confirm the data display on UI correctly in this phase)
Implement event tracking for the new lock screen widget #20422 (✅ Approved) 👈 you're here!
Disable lockScreenWidget feature flag #20427 (In Reviewing)

Description

Follow existing home screen widgets event, expand for lock screen widgets

Add lockScreenTodayViewsProperties for tracking events, and access the key through config
Add lockscreen_widget to deeplink source to separate the click from the home screen widget
Add rectangular_widgets for tracking new type of widget info
Add today_views_lockscreen_extension_widget_updated for tracking lock screen widget updated

Testing Instructions

Deep Link

Given user logged in and added today views widget to the lock screen with success status displayed

Click the widget
Redirect to insights page
Confirm the new type deeplink tracked

Tracked: deep_linked <section: stats, source: lockscreen_widget, source_info: , url: /stats/day/:domain>

Widget Info

I don't know how to verify the event tracking in widgets, probably need to setup the proxy or check from the event tracking dashboard

Regression Notes

Potential unintended areas of impact
Existing home screen widget tracking
What I did to test those areas of impact (or what existing automated tests I relied on)
Add widget to the home screen, tap to redirect to insights page, confirm the deep_linked event tracked

Tracked: deep_linked <section: stats, source: widget, source_info: , url: /stats/day/:domain>

What automated tests I added (or what prevented me from doing so)
WidgetsViewModelMapperTests/testTodayViewsStatsURL to test the source

PR submission checklist:

I have completed the Regression Notes.
I have considered adding unit tests for my changes.
I have considered adding accessibility improvements for my changes.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Expand tracks for lockscreen stats entry Add rectangular widgets count and widgets update of the new widget

Update statsUrl to widgetUrl for separating the url from homescreen widgets

tzef · 2023-03-28T07:14:47Z

@staskus please help to check the event key is ok or not, thanks

staskus · 2023-03-28T10:55:10Z

I don't know how to verify the event tracking in widgets, probably need to setup the proxy or check from the event tracking dashboard

You're correct. I can confirm today_views_lockscreen_extension_widget_updated works from the dashboard. You can also debug and see if the tracker code is called.

staskus

Thank you for the changes!

I'm leaving a comment to discuss the deep link.

staskus · 2023-03-28T10:42:50Z

 protocol LockScreenStatsWidgetData {
    var siteName: String { get }
-    var statsURL: URL? { get }
+    var widgetURL: URL? { get }


First of all, I'm thinking if we know the value of differentiating between source=widget and source=lockscreen_widget, otherwise, we may not need this change at all.

Second of all, if we want to keep this separate source, I wonder if we could somehow keep data.statsURL for both types of widgets? For example, passing the source instead of having 2 separate URL variables?

What are your thoughts?

My original thought is to separate the url that can fully control the content, in the case if the lock screen wants to change the destination in the future, but that might be a bit confusing between statsURL and widgetURL, and for now, the link are the same, so I think its good to update with your first suggestions.

We can know the differentiating in the view side, I update to move the source appending from the widget data extension to let the view assign the source type.

And I add an improvement to extract the string to enum, and add the test to make sure the source can convert to DeepLinkSource correctly.

My original thought is to separate the url that can fully control the content, in the case if the lock screen wants to change the destination in the future

Okay, got it. That makes sense 👍

And I add an improvement to extract the string to enum, and add the test to make sure the source can convert to DeepLinkSource correctly.

I appreciate that, the solution looks good!

…sion Add widget source type, assign the type in widgetURL in the view

peril-wordpress-mobile · 2023-03-28T11:57:07Z

	Warnings
⚠️	PR is not assigned to a milestone.

Generated by 🚫 dangerJS

staskus

👍 Tested again, works well.

I'll merge after CI builds.

staskus · 2023-03-29T10:32:24Z

@tzef merged!

* Add new feature flag for lock screen widgets in Jetpack (#20309) * Add new feature flag for widget in lock screen * Add new widget kind to widget configuration * Add empty lock screen widget * Add JETPACK_STATS_WIDGETS compilation condition To prevent lock screen widgets from displaying on WordPress target * Move LockScreenStatsWidgetsView to views folder group * Revert compilation condition, change to isJetpack of AppCondiguration * Implement lock screen widgets UI (#20312) * Extract statsUrl from private to extension for reusable with lock screen widget * Implement single stat view for today views widget Add view provider for handling building view for site selected status Add ViewModelMapper for converting viewModel from home widget data * Update LockScreenStatsWidgetsView body to get the view from view provider * Add mapper test to verify the viewModel converting from widget data correctly Add mapper and viewModel to WordPress target because app extension is not able to run unitTest * Fix getStatsURL typo * Add localizable string for "Views Today" title (#20353) * Add views in today localizable string for footer label * Remove dateRange and footer, only title is enough for existing feature * Fix home screen widget for WordPress target disappeared. (#20371) The root cause is the WidgetBundleBuilder body doesn't allow control flow statements, move it to supportedFamilies with feature flag to keep all control logic in the same place * Extract content logic to config from lock screen widget (#20317) * Update title of view provider from hardcoded to pass from config * Add lock screen stats widget config and implementation to include required information * Pass config to LockScreenStatsWidget Replaced the hardcoded data with config properties * Add associated type view for other status and TODO comments * Extract app configuration and feature flag check into config * Create a standalone TimeLineProvider and TimelineEntry for the lock screen (#20368) * Add widget data and timeline entry for lock screen to separate concerns * Add lock screen time line provider for lock screen stats widget entry Update stats widgets service result type to consist of home widget and lock screen widget for reusable * Update to use LockScreenSiteListProvider in LockScreenStatsWidget Update associated type widget data to conform `LockScreenStatsWidgetData` more Update model mapper and view provider to based on lock screen widget data Remove unnecessary `disabled` status from `LockScreenStatsWidgetsView` Remove unnecessary `widgetKind` parameter from `LockScreenStatsWidget` Remove unused statsURL converter from the view model mapper Add home widget data conform lock screen widget data extension to WordPress target for unitTest * Extract widget load data to loader for sharing with lock screen time line provider * Update widget reader to extract the cache read from getSnapshot * Extract noData, noSite, loggedOut, disabled status checking logic to data reader with status callback * Add unitTest for widget data reader Extract cache reading to `HomeWidgetDataFileReader` for mocking the testing object Extract app configuration is jetpack to parameter for mocking the config * Remove multiple space lines * Update multiple callback to Result and enum Error * Implement view for logged-out, no-site, and no-data status (#20399) * Add unconfigured view for lockscreen widget * Add unconfigured view model to view provider and model mapper * Add unconfigured view model unit test * Add background to unconfigured view align with success status widget appearance * Remove todo comments * Add reload timelines for lock screen widget (#20405) * Implement event tracking for the new lock screen widget (#20422) * Add event key to configuration and pass to trackers in lockscreen widget Expand tracks for lockscreen stats entry Add rectangular widgets count and widgets update of the new widget * Add lockscreen_widget source to deeplink tracked Update statsUrl to widgetUrl for separating the url from homescreen widgets * Update unitTests * Remove separate widget url, move widget source from widget data extension Add widget source type, assign the type in widgetURL in the view * Add widget url source test to verify the converting with DeepLinkSource * Disable the feature flag (#20427) --------- Co-authored-by: Beemo Lee <tzef8220@gmail.com>

tzef added 2 commits March 28, 2023 14:25

Add event key to configuration and pass to trackers in lockscreen widget

d34b387

Expand tracks for lockscreen stats entry Add rectangular widgets count and widgets update of the new widget

Add lockscreen_widget source to deeplink tracked

25f230a

Update statsUrl to widgetUrl for separating the url from homescreen widgets

Update unitTests

c06d35b

staskus added Stats iOS 16 Widgets [Type] Task labels Mar 28, 2023

staskus self-requested a review March 28, 2023 10:14

staskus reviewed Mar 28, 2023

View reviewed changes

tzef added 2 commits March 28, 2023 19:43

Remove separate widget url, move widget source from widget data exten…

fb193e3

…sion Add widget source type, assign the type in widgetURL in the view

Add widget url source test to verify the converting with DeepLinkSource

eab43a6

staskus approved these changes Mar 28, 2023

View reviewed changes

staskus merged commit ed4ab98 into wordpress-mobile:feature/19411-add-lock-screen-stats-widgets Mar 29, 2023

This was referenced Mar 29, 2023

Disable lockScreenWidget feature flag #20427

Merged

[BugFix] Fix widget of home screen for WordPress disappeared #20371

Merged

staskus mentioned this pull request Mar 30, 2023

iOS 16 Lock Screen Widgets: Today Views Widget #20435

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement event tracking for the new lock screen widget - #20422

Implement event tracking for the new lock screen widget #20422
staskus merged 5 commits into
wordpress-mobile:feature/19411-add-lock-screen-stats-widgetsfrom
tzef:feature/beemotrial/lockscreen-widget-eventtracking

tzef commented Mar 28, 2023 •

edited

Loading

Uh oh!

tzef commented Mar 28, 2023

Uh oh!

staskus commented Mar 28, 2023

Uh oh!

staskus left a comment

Uh oh!

staskus Mar 28, 2023

Uh oh!

tzef Mar 28, 2023 •

edited

Loading

Uh oh!

staskus Mar 28, 2023

Uh oh!

peril-wordpress-mobile Bot commented Mar 28, 2023

Uh oh!

staskus left a comment

Uh oh!

staskus commented Mar 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

tzef commented Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing Instructions

Deep Link

Widget Info

Regression Notes

Uh oh!

tzef commented Mar 28, 2023

Uh oh!

staskus commented Mar 28, 2023

Uh oh!

staskus left a comment

Choose a reason for hiding this comment

Uh oh!

staskus Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

tzef Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

staskus Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

peril-wordpress-mobile Bot commented Mar 28, 2023

Uh oh!

staskus left a comment

Choose a reason for hiding this comment

Uh oh!

staskus commented Mar 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tzef commented Mar 28, 2023 •

edited

Loading

tzef Mar 28, 2023 •

edited

Loading