1821106 - SearchEngine.getResultDomain's responseType parameter is never used and the function needs renaming

Status: RESOLVED FIXED

(Firefox :: Search, task, P3)

Description

[Mark Banner (:standard8)]

SearchEngine.getResultDomain takes a responseType parameter, however, that is never used except for in a test specific for testing getResultDomain.

I don't see us needing it, so I think we should drop it and replace it with a simple getter.

I think we should also rename it to searchUrlDomain.

I'm happy to mentor this, but please note this is not a good first bug, but might be a better second or later bug. You'll also need a full build, otherwise you won't be able to test it properly.

The steps here would be approximately:

• In nsISearchService.idl, replace the getResultDomain line with readonly attribute AString searchUrlDomain. Update the documentation next to it.
• In SearchEngine.sys.mjs, change the function signature to get searchUrlDomain(), and simplify the use of the fallback to pass lazy.SearchUtils.URL_TYPE.SEARCH directly to _getURLOfType
• Update all the existing instances to change from getResultDomain() to searchUrlDomain (note: drop the brackets, as it is now a getter.
• toolkit/components/search/tests/xpcshell/test_resultDomain.js will need simplifying, and could have the name updated.
• Check the main search tests pass, fix failures if not.
  • ./mach xpcshell-test toolkit/components/search/
• Also check ESLint passes (this may take a few minutes to run):
  • ./mach eslint toolkit/components/search/ browser/components/urlbar/

Comment 1

[Abhishek[: unavailable till 11 May]]

I am giving it a try

Comment 2

[Abhishek[: unavailable till 11 May]]

Attachment: Bug 1821106 - SearchEngine.getResultDomain's responseType parameter is never used and the function needs renaming r=standard8

Comment 3

[Abhishek[: unavailable till 11 May]]

Attachment: Bug 1821106 - SearchEngine.getResultDomain's responseType parameter is never used and the function needs renaming , this is a initial commit failing in test r=standard8

Depends on D172293

Comment 4

[Abhishek[: unavailable till 11 May]]

Sir, Please have a look at the changes that I made, I am successful in making a commit, but it is still failing the test, please guide me. Thanks

Comment 5

[Lata]

Hey! I can see there is no activity on this bug for two weeks. I am interested in solving this bug. Can I take it now? Otherwise, if there are any open bugs that need attention, I would be happy to take a look and see if I can help.

Comment 6

[Abhishek[: unavailable till 11 May]]

I apologise for the delay. The delay happened because of my exam ( mentioned in another bug ). Around four bugs are pending, and I have almost completed this bug and will try to finish the rest task before the contribution deadline.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4fe91edc1ec6
SearchEngine.getResultDomain's responseType parameter is never used and the function needs renaming r=Standard8

Comment 8

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/4fe91edc1ec6