1746459 - [Intermittent] The Firefox Suggest modal is not displayed at startup after upgrading to Firefox 95 using a profile enrolled in the online scenario from Firefox 94.0.1

Status: VERIFIED FIXED

(Firefox :: Address Bar, defect, P1)

Description

[Carmen Fat [:cfat] - Ecosystem QA]

Attachment: 84jpqbek.ghkghj.zip

[Notes]:

• This issue is intermittently reproducible only on a low performance Ubuntu 20.04 x64 machine.
• The modal is displayed after restarting the Firefox Release 95.0 browser.

[Affected Versions]:

• Firefox Release 95.0 (Build ID: 20211129150630)

[Affected Platforms]:

• Ubuntu 20.04 x64

[Prerequisites]:

• Have Firefox Release 94.0.1 and Firefox Release 95.0 downloaded on your computer.
• Have the "browser.search.region" set to "US".
• Have the “nimbus.debug” set to “true”.

[Steps to reproduce]:

1. Open Firefox Release 94.0.1.
2. Enroll in the online scenario.
3. Close Firefox Release 94.0.1.
4. Open Firefox Release 95.0.
5. Observe what happens at the start-up.

[Expected results]:

• The Firefox Suggest modal is displayed.

[Actual results]:

• The Firefox Suggest modal is not displayed.

[Additional Notes]:

• Here is a screen recording of the issue.

Comment 1

[Drew Willcoxon :adw]

Thanks Carmen. I'll investigate this but if it's a problem in 95, which it appears to be at first glance, there's probably not anything we can do about it.

See also bug 1746214 comment 4, where Carmen first reported this problem. I agree it's a bit of an edge case and probably doesn't affect too many users.

Comment 2

[Drew Willcoxon :adw]

Carmen, here's a 95 Linux build with a patch that I think should fix this. If you have time, could you try it please? We probably won't uplift it to 95 at this point, but we can get it in 96 at least.

Here's the Treeherder link in case you need it.

Comment 3

[Drew Willcoxon :adw]

[Tracking Requested - why for this release]:
This is a bug that can affect the planned Firefox Suggest rollout on 96.

Comment 4

[Drew Willcoxon :adw]

Attachment: Bug 1746459 - Wait for Firefox Suggest scenario initialization before trying to show the online opt-in dialog.

The problem is a race between scenario initialization and
maybeShowOnboardingDialog() on startup. If maybeShowOnboardingDialog() is
called before scenario initialization finishes, then the
quickSuggestShouldShowOnboardingDialog Nimbus variable will retain its false
default value, and the dialog will not be shown like it should be. Scenario
initialization depends on the Nimbus urlbar feature initialization, which
depends on loading the feature JSON from disk, so it's plausible this race is
more likely to happen on slow machines, as we've seen with QA's slow Ubuntu
machines in other bugs.

This revision fixes it by making a promise that's resolved when scenario
initialization finishes, and then maybeShowOnboardingDialog() awaits the
promise before starting.

I thought about adding an idle callback for maybeShowOnboardingDialog()
directly in UrlbarPrefs.updateFirefoxSuggestScenario(). However, that would
change the timing of each of these things more than I'm comfortable with, since
right now scenario initializaton happens before BrowserGlue adds its idle
callback for maybeShowOnboardingDialog(). We can maybe revisit startup and
initialization at some point to make this a little nicer.

Comment 5

[Drew Willcoxon :adw]

https://treeherder.mozilla.org/jobs?repo=try&revision=b8e8f3ee115bc58ea12f2d8219038cbf498e81af

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/44dfb9503777
Wait for Firefox Suggest scenario initialization before trying to show the online opt-in dialog. r=daisuke

Comment 7

[Drew Willcoxon :adw]

Comment on attachment 9256611 [details]
Bug 1746459 - Wait for Firefox Suggest scenario initialization before trying to show the online opt-in dialog.

Beta/Release Uplift Approval Request

• User impact if declined: This is necessary for the next Firefox Suggest rollout in 96.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: Should be clear from the bug comments
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): No user-facing changes, other than fixing the bug. This code path is well tested by existing Firefox Suggest tests. Small patch.
• String changes made/needed:

Comment 8

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/44dfb9503777

Comment 9

[Carmen Fat [:cfat] - Ecosystem QA]

• I have verified that this issue is no longer reproducible using the try-build from comment 2 (Firefox 95.0.3, Build ID: 20211220133917) on the low performance Ubuntu 20.04 x64 machine.
• Since the behavior is intermittent, I repeated the scenario from the Description on 12 new profiles.
• The modal is correctly displayed at startup of the Firefox 95.0.3 try-build after upgrading from Firefox 94.0.1, on all 12 profiles.

Comment 10

[Dianna Smith [:diannaS]]

Comment on attachment 9256611 [details]
Bug 1746459 - Wait for Firefox Suggest scenario initialization before trying to show the online opt-in dialog.

Approved for 96.0b9

Comment 11

[Dianna Smith [:diannaS]]

https://hg.mozilla.org/releases/mozilla-beta/rev/bdbc6bcf3d8c

Comment 12

[Dianna Smith [:diannaS]]

I would like to note that this was temporarily backed out during build failure investigation and reintroduced for 96.0b9.
Backout link

Reintroduced in:
https://hg.mozilla.org/releases/mozilla-beta/rev/26571da7c2aa

Comment 13

[Carmen Fat [:cfat] - Ecosystem QA]

• I have verified that this issue is no longer reproducible using latest Nightly 97.0a1 (Build ID: 20211223215735) and latest Beta 96.0b9 (Build ID 20211223202418) on the low performance Ubuntu 20.04 x64 machine.
• Since the behavior is intermittent, I repeated the scenario from the Description on 10 new profiles for each Firefox channel.
• The modal is correctly displayed at startup of the Firefox Nightly and Beta after upgrading from Firefox 94.0.1, on all the tested profiles.