1915416 - Clarify search-detection's getPublicSuffix

Status: NEW

(WebExtensions :: General, task, P3)

Description

[Chris H-C :chutten]

Per https://phabricator.services.mozilla.com/D218001#inline-1223211, getPublicSuffix has a name and a comment that are inaccurate and could be clarified:

This name and comment is misleading. The method returns the eTLD+1 for a given URL. "getBaseDomain" would have been a better name.

(In general this whole extension refers to eTLD in several places where eTLD+1 is meant)

Comment 1

[Mithun]

Hi William, Can I work on this?

Comment 2

[William Durand [:willdurand]]

Sure thing. I think we want to rename the getPublicSuffix method to getBaseDomain here.

Comment 3

[Mithun]

Thanks William, I'll make rename this getPublicSuffix method to getBaseDomain and create a PR.

Comment 4

[Scott Venkataraman]

I’m a new contributor, and I’ll be submitting a patch for this bug soon

Comment 5

[Scott Venkataraman]

Hi William, I'm working on this bug and could use a little guidance. I took a look at the Phabricator link and occurrences of getPublicSuffix in Searchfox: https://searchfox.org/firefox-main/search?q=getPublicSuffix+&path=&case=false&regexp=false

After changing getPublicSuffix to getBaseDomain in the api.js file and the background.js file I'm unsure if I need to make the change in any of the other locations listed in Searchfox. Is there a recommended way to figure that out?

Comment 6

[Scott Venkataraman]

Attachment: Bug 1915416 - Clarify search-detection's getPublicSuffix r?chutten

Comment 7

[Scott Venkataraman]

Attachment: Bug 1915416 - Clarify search-detection's getPublicSuffix r?valentin

Comment 8

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

This good-first-bug hasn't had any activity for 2 months, it is automatically unassigned.
For more information, please visit BugBot documentation.