Integrate TipKit #23470

kean · 2024-08-02T19:42:51Z

TipKit

In #23469, we removed the LoginEpilogue screen, and the app now automatically selects one of your sites after login, defaulting to your primary site. To make sure the users learn how to switch to a different site, this PR integrate Apple's TipKit.

The first time you log in with an existing account with two or more sites, the app will show the "Your Sites" tip. The tip is shown only once. If you log in on a different device with the same Apple ID, the previously shown tips are not shown again.

Resources

Quick Start

TipKit will also be used as a replacement for the existing Quick Start tours.

This PR removes the "What would you like to focus on first?" screen. It was added for the following reasons:

[**] We'll now ask users logging in which area of the app they'd like to focus on to build towards a more personalized experience. [#18385]"

There was no follow-up, and this screen does nothing other than simply opening one of the selected primary areas in the app, but only after showing the "Enable Notifications?" screen.

This screen is also the entry point for the "existing site" Quick Start tour – the "Not sure, show me around" option. By removing it, you can no longer initiate this tour.

The next step would be to consider if there are any good candidates for being replaced with TipKit.

Debug Options

I added the following launch arguments to the schemes.

The same options are also added to the Debug Menu.

Testing

Verify that the "Enable Notifications" screen is shown on the first login. Noting that in the production version, if you tapped "Skip" on the "Onboarding Questions" screen, the app would never prompt you to enable notifications 😨

Regression Notes

Potential unintended areas of impact
What I did to test those areas of impact (or what existing automated tests I relied on)
What automated tests I added (or what prevented me from doing so)

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.

Testing checklist:

wpmobilebot · 2024-08-02T19:54:20Z

📲 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	pr23470-f83dfeb
	Version	25.2
	Bundle ID	org.wordpress.alpha
	Commit	`f83dfeb`
	App Center Build	WPiOS - One-Offs #10472

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

wpmobilebot · 2024-08-02T19:54:58Z

📲 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	pr23470-f83dfeb
	Version	25.2
	Bundle ID	com.jetpack.alpha
	Commit	`f83dfeb`
	App Center Build	jetpack-installable-builds #9512

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

kean · 2024-08-12T19:57:06Z

WordPress/Classes/ViewRelated/Tips/AppTips.swift

+extension UIViewController {
+    /// Registers a popover to be displayed for the given tip.
+    @available(iOS 17, *)
+    func registerTipPopover(


TipKit API for showing popovers was a bit too low-level, so I decided to add this convenience API on top of it.

The term "register" gives of nothing will actually happen after this function is called. However, if I understand correctly, the function shows a tip if it certain criteria match. What do you think changing the name to something like presentTipPopoverIfNeeded?

I'm open to suggestions, but presentTipPopoverIfNeeded sounds like a one-shot method. This method subscribes to a tip.shouldDisplayUpdates async sequence and shows/hides the popover as needed. So, yeah, nothing happens unless it fires an event.

The SwiftUI method with the same functionality is called popoverTip(_:arrowEdge:action:).

I misunderstood how the tip.shouldDisplayUpdates API works. The function name makes more sense to me now.

kean · 2024-08-12T19:57:40Z

WordPress/WordPress.xcodeproj/xcshareddata/xcschemes/Jetpack.xcscheme

@@ -102,6 +102,18 @@
            argument = "-debugJetpackConnectionFlow"
            isEnabled = "NO">
         </CommandLineArgument>
+         <CommandLineArgument
+            argument = "-com.apple.TipKit.ShowAllTips 1"
+            isEnabled = "NO">


These options are all disabled by default.

kean · 2024-08-12T19:58:42Z

Here's an example of a complete flow:

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-08-12.at.15.53.34.mp4

crazytonyli · 2024-08-12T23:30:11Z

WordPress/Classes/ViewRelated/Tips/AppTips.swift

+                } else {
+                    if self?.presentedViewController is TipUIPopoverViewController {
+                        self?.dismiss(animated: true)
+                    }


Do you need to break out of the for loop when present or dismiss is called?

crazytonyli · 2024-08-12T23:34:50Z

WordPress/Classes/ViewRelated/Tips/AppTips.swift

+extension UIViewController {
+    /// Registers a popover to be displayed for the given tip.
+    @available(iOS 17, *)
+    func registerTipPopover(


The term "register" gives of nothing will actually happen after this function is called. However, if I understand correctly, the function shows a tip if it certain criteria match. What do you think changing the name to something like presentTipPopoverIfNeeded?

crazytonyli · 2024-08-12T23:41:03Z

WordPress/Classes/ViewRelated/Tips/AppTips.swift

+    static func initialize() {
+        guard Feature.enabled(.tipKit), #available(iOS 17, *) else { return }
+        do {
+            try Tips.configure([.displayFrequency(.daily)])


If there are many Tips, does this daily frequency configuration mean other tips won't be displayed today if one of them has been displayed?

I forgot to remove it after testing – done.
It might be something we go for in the future, but there is no need for it now.

crazytonyli · 2024-08-13T01:56:42Z

WordPress/Classes/ViewRelated/Tips/AppTips.swift

+            return nil
+        }
+        let task = Task { @MainActor [weak self] in
+            for await shouldDisplay in tip.shouldDisplayUpdates {


I think you'll need a if Task.isCancelled { break } in this for-loop? task.cancel() alone probably won't stop the loop.

This code is from the Apple sample code. I'm not sure if it's clearly documented anywhere, but tip.shouldDisplayUpdates async sequence (AsyncMapSequence) receives cancellation from the task, aka cooperative cancellation.

Ah okay. That's quite possible. Ignore my comments then, if the task can be properly cancelled. 🙂

kean mentioned this pull request Aug 2, 2024

Remove LoginEpilogue #23469

Merged

14 tasks

kean force-pushed the task/remove-login-epiloguevc branch 4 times, most recently from 30cb2bc to 2f220ec Compare August 8, 2024 17:42

kean changed the base branch from task/remove-login-epiloguevc to trunk August 8, 2024 20:28

kean force-pushed the task/integrate-tipkit branch from a167ff9 to 09c408f Compare August 8, 2024 20:28

kean added 9 commits August 12, 2024 09:04

Integrate TipKit

ed01795

Add TipKit launch arguments

58b97fd

Change display freqnecy

c7bd4b5

Add convenience API for showing tips

5b4e868

Invalidate SitePickerTip when Site Picker is displayed

f99742c

Add actionHandler

b03b6d1

Show tip only if the user has one more more blogs

0faae7a

Remove create post notice

f7ab344

Add TipKit to debug menu

eff029d

kean force-pushed the task/integrate-tipkit branch 2 times, most recently from aaf8eff to 7e99347 Compare August 12, 2024 19:54

kean marked this pull request as ready for review August 12, 2024 19:55

kean commented Aug 12, 2024

View reviewed changes

kean changed the title ~~Integrate TipKit (Experimental)~~ Integrate TipKit Aug 12, 2024

kean requested a review from crazytonyli August 12, 2024 19:57

kean added the General label Aug 12, 2024

kean added this to the Pending milestone Aug 12, 2024

Fix an issue with Enable Notifications screen not being shown

d866a00

kean force-pushed the task/integrate-tipkit branch from 7e99347 to d866a00 Compare August 12, 2024 20:00

Disable TipKit in UI tests for now

0bb6624

crazytonyli reviewed Aug 12, 2024

View reviewed changes

crazytonyli reviewed Aug 13, 2024

View reviewed changes

Remove daily frequency limit

f83dfeb

kean requested a review from crazytonyli August 13, 2024 15:53

crazytonyli approved these changes Aug 13, 2024

View reviewed changes

kean added this pull request to the merge queue Aug 13, 2024

Merged via the queue into trunk with commit 25909ec Aug 13, 2024
24 checks passed

kean deleted the task/integrate-tipkit branch August 13, 2024 22:47

crazytonyli mentioned this pull request Aug 13, 2024

Remove Quick Start #23498

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate TipKit #23470

Integrate TipKit #23470

kean commented Aug 2, 2024 •

edited

Loading

wpmobilebot commented Aug 2, 2024 •

edited

Loading

wpmobilebot commented Aug 2, 2024 •

edited

Loading

kean Aug 12, 2024

crazytonyli Aug 12, 2024

kean Aug 13, 2024 •

edited

Loading

crazytonyli Aug 13, 2024

kean Aug 12, 2024

kean commented Aug 12, 2024

crazytonyli Aug 12, 2024

crazytonyli Aug 12, 2024

crazytonyli Aug 12, 2024

kean Aug 13, 2024

crazytonyli Aug 13, 2024

kean Aug 13, 2024

crazytonyli Aug 13, 2024

Integrate TipKit #23470

Integrate TipKit #23470

Conversation

kean commented Aug 2, 2024 • edited Loading

TipKit

Resources

Quick Start

Debug Options

Testing

Regression Notes

wpmobilebot commented Aug 2, 2024 • edited Loading

wpmobilebot commented Aug 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kean Aug 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kean commented Aug 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kean commented Aug 2, 2024 •

edited

Loading

wpmobilebot commented Aug 2, 2024 •

edited

Loading

wpmobilebot commented Aug 2, 2024 •

edited

Loading

kean Aug 13, 2024 •

edited

Loading