1713393 - Remove version number from DisplayName in the Uninstall data for Firefox

Status: VERIFIED FIXED

(Firefox :: Installer, enhancement, P3)

Description

[Mike Kaply [:mkaply]]

When we install a new version of Firefox, we include the version in DisplayName:

DisplayName = Mozilla Firefox 68.7.0 ESR (x86 en-US)

But the uninstall data already has a version:

DisplayVersion = 68.7.0

This is making it difficult for admins have a generic way to locate Firefox for uninstall.

Since the version in the DisplayName is extraneous (you see it when you click on it in Add/Remove programs), can we remove it?

Comment 1

[Nick Alexander :nalexander [he/him]]

I took a quick peek at this. We do bump the relevant registry keys each update as part of post update, so making the change at https://searchfox.org/mozilla-central/rev/1ba472c91bbde4b127f6e614ae72888ab59611cf/browser/installer/windows/nsis/shared.nsh#868 should achieve what @mkaply suggests and migrate existing users to the new DisplayName.

@mkaply: is it enough to make this change and tell admins to either use the new DisplayName or to update their scripts to use the existing Comments field, which will include the version?

Comment 2

[Mike Kaply [:mkaply]]

@mkaply: is it enough to make this change and tell admins to either use the new DisplayName or to update their scripts to use the existing Comments field, which will include the version?

It should be.

Comment 3

[Nick Alexander :nalexander [he/him]]

Attachment: Bug 1713393 - Remove version number from `DisplayName` in Firefox uninstall data on Windows. r?agashlin

The goal is to make it easier for admins to have a generic way to
locate Firefox for uninstall, without needing to know the target
version to uninstall. The version in the DisplayName is extraneous:
it's in the DisplayVersion field, and users can see it when you
click on it in "Add/Remove Programs". Automated consumers may prefer
to read the Comments field of the Firefox uninstall data instead,
which remains identical to the DisplayName before this change.

Comment 4

[Nick Alexander :nalexander [he/him]]

mkaply: is this something that you'd like to see uplifted? Is this something we should consider for ESR? Presumably the minor version bump for ESR is as difficult to manage as a major version bump for Release. I don't think this warrants a relnote, but correct me if you think otherwise.

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/43c9920f57c9
Remove version number from `DisplayName` in Firefox uninstall data on Windows. r=agashlin

Comment 6

[Mike Kaply [:mkaply]]

Let's uplift and then I can just document in the enterprise release notes.

Comment 7

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/43c9920f57c9

Comment 8

[Nick Alexander :nalexander [he/him]]

Comment on attachment 9224820 [details]
Bug 1713393 - Remove version number from DisplayName in Firefox uninstall data on Windows. r?agashlin

Beta/Release Uplift Approval Request

• User impact if declined: No impact on end users. Enterprise admins (not users) will continue to have a slightly harder time identifying Firefox in the list of installed programs.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce: Install Firefox on Windows. Go to Start Menu > Add/Remove Programs, verify that Firefox Nightly is listed without 90.0a1 in its name.
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This is a minor change in the Windows installer's metadata. There's just not a lot that can happen if this is incorrect.
• String changes made/needed:

ESR Uplift Approval Request

• If this is not a sec:{high,crit} bug, please state case for ESR consideration: This is a convenience for enterprise admins, not users. Enterprise admins (not users) will have a slightly easier time identifying Firefox in the list of installed programs if this patch is uplifted to ESR.
• User impact if declined: No impact on end users.
• Fix Landed on Version: firefox-91
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This is a minor change in the Windows installer's metadata. There's just not a lot that can happen if this is incorrect.
• String or UUID changes made by this patch:

Comment 9

[Nick Alexander :nalexander [he/him]]

To answer "Has the fix been verified in Nightly", I just:

• fetched https://cdn.stubdownloader.services.mozilla.com/builds/firefox-nightly-stub/en-CA/win/48a2248f8f840c11757de98f2aa0c24e5a9ecc1e0ca4b535cf5dbc277e6a8605/Firefox%20Installer.en-CA.exe
• which installed build ID 20210607094749
• went to Start Menu > Add and remove programs and witnessed "Nightly (x64 en-CA)" installed on 6/7/2021

Comment 10

[Julien Cristau [:jcristau]]

Comment on attachment 9224820 [details]
Bug 1713393 - Remove version number from DisplayName in Firefox uninstall data on Windows. r?agashlin

approved for 90.0b5

Comment 11

[Julien Cristau [:jcristau]]

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

Comment 12

[Marcela (Please NI request to Brindusa Tot)]

This issue is verified as fixed on our latest Beta 90.0b5 and latest Nightly 91.0a1 on Windows 10.
On latest ESR 78.11.0 on Windows 10 is still reproducible.

Comment 13

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9224820 [details]
Bug 1713393 - Remove version number from DisplayName in Firefox uninstall data on Windows. r?agashlin

Approved for 78.12esr.

Comment 14

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-esr78/rev/5168d5e45d32

Comment 15

[Nick Alexander :nalexander [he/him]]

agashlin: did I just footgun myself by not updating the registry key at https://searchfox.org/mozilla-central/rev/c1523815561396f7abd3036bd80326d993612a74/browser/installer/windows/nsis/shared.nsh#839?

Comment 16

[Adam Gashlin (he/him) [:agashlin] (ex-moco)]

I don't think so, the key name doesn't relate to DisplayName, and as far as I know it isn't used anywhere. Its supposed to be a UUID for an MSI but we've never stuck to that.

Comment 17

[Marcela (Please NI request to Brindusa Tot)]

This issue is verified as fixed on latest ESR 78.12.0 on Windows 10. I've used this URL: https://treeherder.mozilla.org/jobs?repo=mozilla-esr78&revision=5168d5e45d327edff35eef73a58907b24e0ec9f8&selectedTaskRun=QZke1G5WQF6TTJrfSUB_Ug.0.
I'll change flags accordingly.