iOS 16 Lock Screen Widgets: Today Views Widget #20435

staskus · 2023-03-30T14:19:04Z

Note:

All the work is done by @tzef,
Feature Flag Disabled (will be enabled once the feature is decided to be released)
All the PRs merged into this branch are reviewed

Description

This is the PR to merge the feature branch into the trunk. All commits are simply merging sub PR into this branch without introducing any new changes. All sub PR have been reviewed and are listed below for reference.

Testing Instructions

Feature flag protect

Given lockScreenWidget feature flag disabled, note that this needs to be programmatically changed. It can't be overwritten in the app setting because the widget list updates along with the app installation.

Long press the lock screen to turn on editor mode
The Jetpack application shouldn't be in the selection page

Enable lockScreenWidget feature flag the following testings

Only for Jetpack

Build WordPress target
Long press the lock screen to turn on editor mode
The WordPress application shouldn't be in the selection page

Build Jetpack target for the following testings

Widget Selection (Fresh install or Logged out)

The Jetpack application should be in the selection page
The widget data should display placeholder data (My WordPress Site with 649 views today)

Add to the lock screen

Tap the widget in the selction page
The widget should be added to the rectangular place (below the time)

Logged-Out status

The widget content should be LocalizableStrings.unconfiguredViewJetpackTodayTitle ("Log in to Jetpack to see today's stats.") as the same as home screen today widget

Redirection for unconfigured status

Tap the widget
The Jetpack app should open

No-Sites status

Log in with the account without any websites
The widget should change the content to LocalizableStrings.noSiteViewTodayTitle ("Create or add a site to see today's stats.") as the same as home screen today widget

Site-Selected status

Switch to the account with at least one website
The widget should change to success layout with stats data of the default website

Widget Selection (Logged in)

Go to widget selection add one more widget
The widget data should display the stats of the default website instead of placeholder

Switch Website

Given the logged-in account with more than one website

Tap widget in lock screen when editor mode
Select another website
The widget should be in rendering mode when fetching data
The widget should display the corresponding views in today

Redirection for success status

Tap the widget
The app should open and redirect to the Stats/Days for the widget-selected website.

Widget updated when stats data updated

Can temporarly change the LockScreenSingleStatView Text(viewModel.title) to Text(viewModel.updatedTime.mediumStringWithTime()) for easy verification of the update.

Tap the widget redirect to the insights page to trigger the API refresh
The widget in lock screen should update when the new data date compared to widget data date is larger than one minute
The another widget with different selected website shouldn't update

Widget autorefreshed per 30 mins

Changing system time is not working from my test, and the laptop can't be in sleep mode.

Wait for 30 mins (The mechanism is not very accurate, minutes of delay is acceptable)
The widget should be updated automatically

Regression Notes

Potential unintended areas of impact
Home Screen Widgets
What I did to test those areas of impact (or what existing automated tests I relied on)

Existing Widgets
Add today, this week, and all time widgets to the home screen, all won't be impacted after app updated
Adding Widgets
After app updated, still able to add today, this week, and all time widgets to the home screen
Shouldn't be impacted by lock screen widget feature flag
No matter if lockScreenWidget is enabled or disabled, the above two test cases should't be impacted

What automated tests I added (or what prevented me from doing so)

WidgetsViewModelMapperTests test the view model is correctly converted from the stats data.
WidgetDataReaderTests test the widget status is correctly converted based on the account and website status.
WidgetUrlSourceTests test the widget URL is correct, and the source can be mapped to the right deep link source type for event tracking.

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.

* 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

* 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 views in today localizable string for footer label * Remove dateRange and footer, only title is enough for existing feature

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

* 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

…creen (#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

* 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 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

staskus · 2023-03-30T14:24:40Z

Note for reviewers:

This is the work done by @tzef. I'm creating the PR due to limited permissions. All the PRs that went into this branch are already reviewed.

This is the whole functionality for Today Views widget (see description).
For now the feature flag is disabled, although in my opinion this could be the candidate for a release without additional functionality

wpmobilebot · 2023-03-30T15:10:52Z

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

	App Name	WordPress Alpha
	Configuration	Release-Alpha
	Build Number	pr20435-3b8e679
	Version	23.1
	Bundle ID	org.wordpress.alpha
	Commit	`3b8e679`
	App Center Build	WPiOS - One-Offs #6948

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

wpmobilebot · 2023-03-30T15:13:09Z

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

	App Name	Jetpack Alpha
	Configuration	Release-Alpha
	Build Number	pr20435-3b8e679
	Version	23.1
	Bundle ID	com.jetpack.alpha
	Commit	`3b8e679`
	App Center Build	jetpack-installable-builds #5988

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

sla8c

All test instructions worked for me. @staskus I noticed that the test Jetpack Build for Testing still says expected and has not passed.

guarani · 2023-05-02T19:34:09Z

👋 @staskus, does this need a review?

staskus · 2023-05-03T06:59:19Z

👋 @staskus, does this need a review?

@guarani, thanks for checking.

Not now. Every single part of it is already reviewed. I will think if it makes sense to merge it now. It's under the disabled feature flag.

Regarding finishing the project. There's a lot of valuable functionality implemented, it could be a small project to add the missing pieces and release it.

guarani · 2023-05-04T22:47:48Z

Thanks @staskus! Let me know if I can help with anything.

peril-wordpress-mobile · 2023-08-25T15:04:34Z

	Warnings
⚠️	PR has more than 500 lines of code changing. Consider splitting into smaller PRs if possible.

Generated by 🚫 dangerJS

staskus · 2023-09-04T10:46:29Z

I retested and merged with trunk. This PR is safe to merge since it has a feature flag disabled.

No site	Site	Logged out

staskus · 2023-09-04T10:53:55Z

@guarani, I want to merge this PR but it looks like this PR requires another review, although this is already approved. Could you review it?

This functionality is behind the feature flag. I want to merge it, and build upon it to include a few more configurations before releasing.

guarani

Hey @staskus, if I understand correctly, I can approve this without reviewing it because it's already been reviewed. Is that correct?

I'm leaving an approval, but if you'd like me to review it (go through the code, test it, etc.) before merging, I'd be happy to do that/

staskus · 2023-09-04T17:05:11Z

@guarani thanks! Yes, I think it's appropriate. It's all been reviewed and approved. You can test it once the feature flag will be enabled.

tzef added 10 commits March 15, 2023 11:10

Add localizable string for "Views Today" title (#20353)

6b55e85

* 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)

fc1d6d6

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

Add reload timelines for lock screen widget (#20405)

688f921

Disable the feature flag (#20427)

0fce138

staskus added Stats Part of a WIP Feature labels Mar 30, 2023

staskus changed the title ~~iOS 16 Lock Screen Widgets: Today Views~~ iOS 16 Lock Screen Widgets: Today Views Widget Mar 30, 2023

staskus requested review from wargcm, guarani and sla8c March 30, 2023 14:21

sla8c approved these changes Apr 4, 2023

View reviewed changes

AliSoftware mentioned this pull request May 12, 2023

[Tooling] Use Buildkite emojis for Prototype Builds #20667

Merged

twstokes added the Widgets Anything related to Home Screen widgets label Aug 25, 2023

Merge branch 'trunk' into feature/19411-add-lock-screen-stats-widgets

3b8e679

staskus added this to the 23.3 milestone Sep 4, 2023

guarani approved these changes Sep 4, 2023

View reviewed changes

staskus merged commit d45f864 into trunk Sep 4, 2023

staskus deleted the feature/19411-add-lock-screen-stats-widgets branch September 4, 2023 17:05

staskus mentioned this pull request Sep 8, 2023

Lock Screen Widgets: Enable feature #21535

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

iOS 16 Lock Screen Widgets: Today Views Widget #20435

iOS 16 Lock Screen Widgets: Today Views Widget #20435

staskus commented Mar 30, 2023 •

edited

Loading

staskus commented Mar 30, 2023

wpmobilebot commented Mar 30, 2023 •

edited

Loading

wpmobilebot commented Mar 30, 2023 •

edited

Loading

sla8c left a comment

guarani commented May 2, 2023

staskus commented May 3, 2023

guarani commented May 4, 2023

peril-wordpress-mobile bot commented Aug 25, 2023

staskus commented Sep 4, 2023

staskus commented Sep 4, 2023

guarani left a comment

staskus commented Sep 4, 2023

iOS 16 Lock Screen Widgets: Today Views Widget #20435

iOS 16 Lock Screen Widgets: Today Views Widget #20435

Conversation

staskus commented Mar 30, 2023 • edited Loading

Description

Testing Instructions

Feature flag protect

Only for Jetpack

Widget Selection (Fresh install or Logged out)

Add to the lock screen

Logged-Out status

Redirection for unconfigured status

No-Sites status

Site-Selected status

Widget Selection (Logged in)

Switch Website

Redirection for success status

Widget updated when stats data updated

Widget autorefreshed per 30 mins

Regression Notes

staskus commented Mar 30, 2023

Note for reviewers:

wpmobilebot commented Mar 30, 2023 • edited Loading

wpmobilebot commented Mar 30, 2023 • edited Loading

sla8c left a comment

Choose a reason for hiding this comment

guarani commented May 2, 2023

staskus commented May 3, 2023

guarani commented May 4, 2023

peril-wordpress-mobile bot commented Aug 25, 2023

staskus commented Sep 4, 2023

staskus commented Sep 4, 2023

guarani left a comment

Choose a reason for hiding this comment

staskus commented Sep 4, 2023

staskus commented Mar 30, 2023 •

edited

Loading

wpmobilebot commented Mar 30, 2023 •

edited

Loading

wpmobilebot commented Mar 30, 2023 •

edited

Loading