1816939 - Search Engine list items are doubled after repeating the deletion and restore default action

Status: VERIFIED FIXED

(Firefox :: Search, defect, P3)

Description

[Timea Zsoldos [:zstimi/tzsoldos], Desktop QA]

Attachment: doubled-search-engine.png

Found in

• Firefox 111.0b1

Affected versions

• Firefox 111.0b1
• Firefox 112.0a1

Tested platforms

• Affected platforms: Windows 10, Ubuntu 22, macOS 12

Steps to reproduce

1. Launch Firefox.
2. Go to about:preferences#search, last item: Search Shortcuts.
3. Remove one or two search engines then click on Restore Default Search Engines.
4. Repeat the above step (delete search engine and restore default).

Expected result

• The Search Engine list appears correctly, each item appears only once.

Actual result

• In Search Engine list the items are doubled after repeating the deletion and restore default action, see the attached screenshot (doubled-search-engine.png).

Regression range

• It is a recent regression.
• First bad: 20230202172003
• Last good: 20230201215112
• Pushlog: https://hg.mozilla.org/integration/autoland/pushloghtml?fromchange=9a864bf574dbb3c108d053d439c23f00fe3887ca&tochange=f00c3546b0a5f36c6f201b35cb9d523cc25808da
• Potentially regressed by: Bug 1781768 - When live language switching ensure that search engines installed via add-ons also update. r=search-reviewers,settings-reviewers,mconley,daleharvey

Additional notes

• Must repeat several times the step 3, only in this way the issue appears.

Comment 1

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

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

:standard8, since you are the author of the regressor, bug 1781768, could you take a look?

For more information, please visit auto_nag documentation.

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1816939 - Use search engine ids rather than objects for updating the list in preferences. r?#preferences-reviewers!

Comparing objects may be unreliable, using search engine ids are guarenteed to be unique.

Comment 3

[Mark Banner (:standard8)]

I found the issue, patch attached. Note that it doesn't really have any significant effects - the list is reset after a reload or closing/opening, hence I think this is an S4 not S3.

Comment 4

[:Gijs (he/him)]

Comment on attachment 9318421 [details]
Bug 1816939 - Use search engine ids rather than objects for updating the list in preferences. r?#preferences-reviewers!

Beta/Release Uplift Approval Request

• User impact if declined: Confusing search engine list UI in the settings pages
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: comment 0
• List of other uplifts needed: n/a
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): 1 line JS change, good test coverage
• String changes made/needed: No
• Is Android affected?: No

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/82fe1346472e
Use search engine ids rather than objects for updating the list in preferences. r=settings-reviewers,Gijs

Comment 6

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/82fe1346472e

Comment 7

[Donal Meehan [:dmeehan]]

Comment on attachment 9318421 [details]
Bug 1816939 - Use search engine ids rather than objects for updating the list in preferences. r?#preferences-reviewers!

Approved for 111.0b4

Comment 8

[Donal Meehan [:dmeehan]]

https://hg.mozilla.org/releases/mozilla-beta/rev/7a7937c249e7

Comment 9

[Timea Zsoldos [:zstimi/tzsoldos], Desktop QA]

I can confirm this issue is fixed, I verified using latest nightly Firefox 112.0a1 and Firefox 111.0b4 on Win 10 x64, macOS 10.15 and Ubuntu 22 x64.