Closed Bug 1397701 Opened 7 years ago Closed 7 years ago

Should clean up UITour after closing the onboarding overlay by clicking the Skip-Tour button

Categories

(Firefox :: Tours, defect, P1)

defect

Tracking

()

VERIFIED FIXED
Firefox 57
Tracking Status
firefox57 --- verified

People

(Reporter: Fischer, Assigned: Fischer)

References

Details

(Whiteboard: [photon-onboarding][photon-onboarding-newui])

Attachments

(1 file)

STR:
1. Open the onboarding tour overlay
2. Navigate to the Library tour
3. Click the Library tour action button to trigger the UITour highlight on the Library button
4. Click the Skip-Tour button on the onboarding overlay

p.s we could use any tour which would highlight button in the step 2 and 3.

Expected Result:
The overlay closes and the UITour highlight on the Library button closes as well

Actual Result:
The overlay closes but the UITour highlight on the Library button doesn't close

Root Cause:
The Onboarding cleans up UITour at [1] when seeing the overlay or the overlay-close button clicked to close the overlay. We should consider the case of the Skip-Tour button too. However, now there are 3 buttons which should be considered, in case of the future change, such as adding one more button, removing another button etc. We probably need a more general way to clean up UITour while the onboarding overlay closed, otherwise, it is very easy to forget the thing. And some test about this behaviour is needed too.

[1] http://searchfox.org/mozilla-central/rev/67f38de2443e6b613d874fcf4d2cd1f2fc3d5e97/browser/extensions/onboarding/content/onboarding-tour-agent.js#61
Assignee: nobody → fliu
Status: NEW → ASSIGNED
Flags: qe-verify+
Priority: -- → P2
QA Contact: jwilliams
Whiteboard: [photon-onboarding][photon-onboarding-newui]
The bug 1394730 would handle this bug together.
See Also: → 1394730
(In reply to Fischer [:Fischer] from comment #1)
> The bug 1394730 would handle this bug together.
Per bug 1394730 comment 6, move the patch back to this bug
Depends on: 1394730
Comment on attachment 8906486 [details]
Bug 1397701 - Should clean up UITour after closing the onboarding overlay by clicking the Skip-Tour button,

https://reviewboard.mozilla.org/r/178246/#review183192

::: browser/extensions/onboarding/content/onboarding-tour-agent.js:90
(Diff revision 1)
>    }
>  });
> +let overlayObserver = new MutationObserver(mutations => {
> +  // Clean up UITour if a user tries to close the dialog.
> +  if (!overlay.classList.contains("onboarding-opened")) {
> +    cleanupUITour();

same as comment in bug 1394730
Attachment #8906486 - Flags: review?(rexboy) → review+
Pushed by ryanvm@gmail.com:
https://hg.mozilla.org/integration/autoland/rev/5de9bbbefd90
Should clean up UITour after closing the onboarding overlay by clicking the Skip-Tour button, r=rexboy
Keywords: checkin-needed
https://hg.mozilla.org/mozilla-central/rev/5de9bbbefd90
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 57
Priority: P2 → P1
I have verified that this issue has been fixed on today's nightly.
Status: RESOLVED → VERIFIED
I reproduced this issue using Fx 57.0a1 (2017-09-07) on Windows 10 x64. I can confirm this issue is fixed, I verified using Fx 57.0b7, on Windows 10 x64, Ubuntu 14.04 LTS and mac OS X 10.12.6.
Flags: qe-verify+
You need to log in before you can comment on or make changes to this bug.