Bug 1861415 - Filter out sponsored URLs from other suggestion provide…

…rs in Fenix.

This commit:

* Adds an `AwesomeBarView.SearchResultFilter` type, with variants to
  only include results for the current search engine (`CurrentEngine`)
  and exclude results with a matching query parameter
  (`ExcludeSponsored`).
* Adds a `String.urlContainsQueryParameters` extension function for
  using the `ExcludeSponsored` filter with the synced tabs provider.
* Refactors the `AwesomeBarView.get*Provider` methods to take an
  optional `SearchResultFilter`.

android-components/components/support/ktx/src/main/java/mozilla/components/support/ktx/kotlin/String.kt

@@ -234,6 +234,15 @@ fun String.tryGetHostFromUrl(): String = try {
     this
 }
 
+/**
+ * Returns `true` if this string is a valid URL that contains [searchParameters] in its query parameters.
+ */
+fun String.urlContainsQueryParameters(searchParameters: String): Boolean = try {
+    URL(this).query?.split("&")?.any { it == searchParameters } ?: false
+} catch (e: MalformedURLException) {
+    false
+}
+
 /**
  * Compares 2 URLs and returns true if they have the same origin,
  * which means: same protocol, same host, same port.

android-components/components/support/ktx/src/test/java/mozilla/components/support/ktx/kotlin/StringTest.kt

@@ -568,6 +568,25 @@ class StringTest {
         assertNull(invalidBase64String2.extractBase6RawString())
     }
 
+    @Test
+    fun `GIVEN a URL with matching parameters WHEN testing if a URL contains query parameters THEN the result is true`() {
+        assertTrue("http://example.com?a".urlContainsQueryParameters("a"))
+        assertTrue("http://example.com?a&b&c".urlContainsQueryParameters("b"))
+        assertTrue("http://example.com?a=b".urlContainsQueryParameters("a=b"))
+        assertTrue("http://example.com?a=b&c=d&e=f".urlContainsQueryParameters("c=d"))
+        assertTrue("http://example.com?a=b&c=d&e=f#g=h".urlContainsQueryParameters("e=f"))
+    }
+
+    @Test
+    fun `GIVEN a URL without matching parameters WHEN testing if a URL contains query parameters THEN the result is false`() {
+        assertFalse("".urlContainsQueryParameters("a"))
+        assertFalse("!@#$%^&*()-+".urlContainsQueryParameters("a"))
+        assertFalse("http://example.com".urlContainsQueryParameters("a"))
+        assertFalse("http://example.com?a&b".urlContainsQueryParameters("c"))
+        assertFalse("http://example.com?a=b".urlContainsQueryParameters("a"))
+        assertFalse("http://example.com?a=b&c=d&e=f#g=h".urlContainsQueryParameters("g=h"))
+    }
+
     private infix fun String.shortenedShouldBecome(expect: String) {
         assertEquals(expect, this.shortened())
     }