1956447 - getRepresentativeSnippet doc is incorrect

Status: RESOLVED FIXED

(Firefox for Android :: Tooling, defect)

Description

[Michel Le Bihan]

The doc states that:

/**
 * Get the representative part of the URL. Usually this is the eTLD part of the host.
 *
 * For example this method will return "facebook.com" for "https://www.facebook.com/foobar".
 */
fun String.getRepresentativeSnippet(): String {
    val uri = this.toUri()

    val host = uri.hostWithoutCommonPrefixes
    if (!host.isNullOrEmpty()) {
        return host
    }

    val path = uri.path
    if (!path.isNullOrEmpty()) {
        return path
    }

    return this
}

However, that function does not return the eTLD (more commonly known as the public prefix). It usually returns the host/domain with common prefixes (exactly "www.", "mobile.", "m.") stripped.

Comment 1

[Michel Le Bihan]

Attachment: Bug 1956447 - Correct getRepresentativeSnippet ktx Android component doc. r=nalexander,tthibaud

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2e51a92620ab
Correct getRepresentativeSnippet ktx Android component doc. r=tthibaud,android-reviewers

Comment 3

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/2e51a92620ab