1789974 - The "Private Window" shortcut is no longer pinned to the taskbar

Status: VERIFIED FIXED

(Firefox :: Shell Integration, defect, P1)

Description

[Marius Coman [:mcoman], Ecosystem QA]

[Notes]:

• This issue is reproducible if the "Pin Private Window" action is taken from the existing Onboarding modals.

[Affected versions]:

• Firefox Nightly 106.0a1 - Build ID: 20220908213354

[Affected Platforms]:

• Windows 10 x64

[Prerequisites]:

• The "Private Window" shortcut is not pinned to the taskbar.

[Steps to reproduce]:

1. Open the browser with the profile from the prerequisites.
2. Open a new "Private Window".
3. Click the "Pin to taskbar" button and observe the behavior.

[Expected result]:

• The "Private Window" shortcut is pinned to the taskbar.

[Actual result]:

• The "Private Window" shortcut is NOT pinned to the taskbar and the following error is displayed in the "Browser Console":

[Exception... "Failure" nsresult: "0x80004005 (NS_ERROR_FAILURE)" location: "<unknown>" data: no] ShellService.jsm:460 pinToTaskbar resource:///modules/ShellService.jsm:460 AsyncFunctionThrow self-hosted:885

[Regression Window]:

• Considering that this issue is not reproducible with the Firefox Nightly build from 09/07/2022 using the Mozregression tool I have managed to find the following regression window:
  Last good revision: bea1e1ba4a14e676e4ebefa371d8fb5fea9d6001
  First bad revision: b1462bbc7934f45eff16184644a1eaca75b044c0
  Pushlog:
  https://hg.mozilla.org/integration/autoland/pushloghtml?fromchange=bea1e1ba4a14e676e4ebefa371d8fb5fea9d6001&tochange=b1462bbc7934f45eff16184644a1eaca75b044c0

From the pushlog it seems that Bug 1782295 may have caused this regression.

@Ben, could you please take a look over this issue?

[Additional Notes]:

• This issue is not reproducible with the regular "Firefox" shortcut.
• Attached a screen recording of the issue.

Comment 1

[Marius Coman [:mcoman], Ecosystem QA]

Attachment: rec of the issue.gif

Comment 2

[BugBot [:suhaib / :marco/ :calixte]]

Set release status flags based on info from the regressing bug 1782295

Comment 3

[[e-mail] (:bhearsum)]

It looks like this is rooted in the same thing as https://bugzilla.mozilla.org/show_bug.cgi?id=1789991, which I will have a fix up for shortly. I did notice a minor secondary issue while testing and verifying this though - I'll provide a patch to fix that as well.

Comment 4

[[e-mail] (:bhearsum)]

Attachment: Bug 1789974: Fix shortcut creation when pinning to taskbar r?bytesized!

In the recent refactor of this (https://bugzilla.mozilla.org/show_bug.cgi?id=1782295) I managed to break our ability to create shortcuts if they don't already existed. This was caused by two things:

1. An errant NS_SUCCEEDED call remained after the call it was checking moved elsewhere (oops)
2. The taskbar pinning code was not updated to set the shortcut file path (required after the refactor).

This patches fixes both of those issues. Note that all the directory service interaction is done on the main thread, because the actual function doing the work is on a background thread, and the directory service does not work there.

Depends on D156992

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/63d129263a05
Fix shortcut creation when pinning to taskbar r=bytesized

Comment 6

[Cristina Cozmuta (:CrissCozmuta)]

https://hg.mozilla.org/mozilla-central/rev/63d129263a05

Comment 7

[Marius Coman [:mcoman], Ecosystem QA]

I have verified that this issue is no longer reproducible with the latest Firefox Nightly (106.0a1 Build ID - 20220914213649) installed on Windows 10 x64. Now, I can confirm that the "Private Window" shortcut is successfully pinned to the taskbar.