Skip to content

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

Merged
staskus merged 1 commit into
wordpress-mobile:feature/19411-add-lock-screen-stats-widgetsfrom
tzef:feature/beemotrial/lockscreen-widgets-bugfix-featureflag
Mar 21, 2023
Merged

[BugFix] Fix widget of home screen for WordPress disappeared#20371
staskus merged 1 commit into
wordpress-mobile:feature/19411-add-lock-screen-stats-widgetsfrom
tzef:feature/beemotrial/lockscreen-widgets-bugfix-featureflag

Conversation

@tzef

@tzef tzef commented Mar 21, 2023

Copy link
Copy Markdown
Contributor

Fixes: The home screen widget under the WordPress target disappeared as a side effect of PR #20309

This is the first PR for fixing the side effect of PR #20309

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

Description

In the final commit of PR #20309, JETPACK_STATS_WIDGETS compilation flag was replaced with AppConfiguration.isJetpack.

However, the WidgetBundleBuilder body does not allow control flow statements. It works for the success block under Jetpack target, but when the condition fails under WordPress, it breaks the whole widget bundle body, causing WordPress home screen widgets not to be registered.

Solution:
To resolve this issue, I have to remove the control flow from the widget bundle by moving the app configuration checking to supportedFamilies of LockScreenStatsWidget, as same as the feature flag check for keeping the control logic in the same place.

Note: This supportedFamilies logic will move to LockScreenTodayViewsStatWidgetConfig once the PR #20317 is merged.

Testing Instruction

In WordPress target

  • Should be able to add today, all time, and this week widgets to the home screen

In Jetpack target

  • Should be able to add today, all time, and this week widgets to the home screen

When the FeatureFlag.lockScreenWidget enabled

  • Should be able to add today views widget to the lock screen

When the FeatureFlag.lockScreenWidget disabled

  • Shouldn't see the Jetpack in the widget selection on the lock screen widget editor page

Regression Notes

  1. Potential unintended areas of impact
    Home screen widget and lock screen widget

  2. What I did to test those areas of impact (or what existing automated tests I relied on)
    Refer to testing Instruction

  3. What automated tests I added (or what prevented me from doing so)
    N/A

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.

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
@tzef

tzef commented Mar 21, 2023

Copy link
Copy Markdown
Contributor Author

@staskus , I just found out one bug caused by adding the feature flag in PR #20309
please help to review, thanks

@staskus

staskus commented Mar 21, 2023

Copy link
Copy Markdown
Contributor

@tzef could catch! I'll merge it to unblock other tasks.

@peril-wordpress-mobile

Copy link
Copy Markdown
Warnings
⚠️ PR is not assigned to a milestone.

Generated by 🚫 dangerJS

staskus added a commit that referenced this pull request Sep 4, 2023
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants