Add Brave Search as an alternative search

[bsclifton]

Security review https://github.com/brave/security/issues/486
Resolves brave/brave-browser#15663

Submitter Checklist:

• I confirm that no security/privacy review is needed, or that I have requested one
• There is a ticket for my issue
• Used Github auto-closing keywords in the PR description above
• Wrote a good PR/commit description
• Added appropriate labels (QA/Yes or QA/No; release-notes/include or release-notes/exclude; OS/...) to the associated issue
• Checked the PR locally: npm run test -- brave_browser_tests, npm run test -- brave_unit_tests, npm run lint, npm run gn_check, npm run tslint
• Ran git rebase master (if needed)

Reviewer Checklist:

• A security review is not needed, or a link to one is included in the PR description
• New files have MPL-2.0 license header
• Adequate test coverage exists to prevent regressions
• Major classes, functions and non-trivial code blocks are well-commented
• Changes in component dependencies are properly reflected in gn
• Code follows the style guide
• Test plan is specified in PR before merging

After-merge Checklist:

• The associated issue milestone is set to the smallest version that the
  changes has landed on
• All relevant documentation has been updated, for instance:
  • https://github.com/brave/brave-browser/wiki/Deviations-from-Chromium-(features-we-disable-or-remove)
  • https://github.com/brave/brave-browser/wiki/Proxy-redirected-URLs
  • https://github.com/brave/brave-browser/wiki/Fingerprinting-Protections
  • https://github.com/brave/brave-browser/wiki/Brave%E2%80%99s-Use-of-Referral-Codes
  • https://github.com/brave/brave-browser/wiki/Custom-Headers
  • https://github.com/brave/brave-browser/wiki/Web-Compatibility-Exceptions-in-Brave
  • https://github.com/brave/brave-browser/wiki/QA-Guide
  • https://github.com/brave/brave-browser/wiki/P3A

Test Plan:

TBD

[deeppandya]

@jamesmudgett can you provide icons for Brave search for onboarding ?

[bsclifton]

Ready for review 😄

[mariospr]

LGTM for chromium_src/

[simonhong]

++ with one nit(assert) 😄

[bsclifton]

Will fix above (thanks, @simonhong!)- looking at CI, I'm seeing this browser test failure on macOS / Linux / Windows:

[2021-06-16T20:30:13.282Z] 1 test failed:
[2021-06-16T20:30:13.282Z]     BraveSearchTestEnabled.DefaultAPIFalseNoOpenSearch (../../brave/browser/brave_search/brave_search_browsertest.cc:224)

Will check this out too...

[bsclifton]

I've got a lint fix and a JavaScript unit test fix (changing beforeAll to beforeEach to fix an issue w/ jest spy). But so far CI looking great - all platforms are passing (waiting on macOS). If macOS looks good too, I'll mark this PR with CI/Skip, push the fix I have, and merge 😄

[srirambv]

Verification passed on OnePlus 6T with Android 10 running 1.28.11 x64 Nightly build

Onboarding

• Verified Brave Search beta is listed on SE onboarding for supported countries (US & Canada)
• Verified Brave Search beta is not listed on SE onboarding for unsupported countries
• Verified selecting Brave Search beta during onboarding sets it as default on both normal and private tabs

Search engines screen

• Verified selecting Brave Search beta from the SE list sets it as default
• Verified performing a search via omnibox goes to search.brave.com SERP
• Verified selecting a text and selecting WebSearch from context menu opens a new tab with search.brave.com SERP
• Verified works on both normal and private tab

Autocomplete suggestions test

• Test failed. Logged Search suggestions don't show up for Brave Search brave-browser#16518

Also encountered the following issues

• Search auth fails on private tabs Search auth fails on private tabs brave-browser#16517
• Unable to set Brave as default SE - Unable to set Brave as default SE brave-browser#16516
• Recent search lists Brave as search engine whereas the built-in one reads Brave Search beta - Recent search lists Brave as search engine whereas the built-in one reads Brave Search beta brave-browser#16515
• Update search icon - Update search icon brave-browser#16514

[kjozwiak]

Verification PASSED on Win 10 x64 using the following build:

Brave | 1.28.13 Chromium: 91.0.4472.114 (Official Build) nightly (64-bit)
--- | ---
Revision | 4bb19460e8d88c3446b360b0df8fd991fee49c0b-refs/branch-heads/4472@{#1496}
OS | Windows 10 OS Version 2009 (Build 19042.1055)

Onboarding/Setting Test Cases

• ensured that Brave Search beta is only displayed under brave://welcome onboarding for Canada & USA
  • ensured that Japan, German & France weren't displaying Brave Search beta via search onboarding
• ensured that Brave Search beta appears via brave://settings/search & brave://settings/searchEngines for all regions
• ensured that the query URL appears as https://search.brave.com/search?q=%s&source=desktop under brave://settings/searchEngines

Japan Onboarding	Germany Onboarding	France Onboarding	USA & Canada Onboarding

Japan SE Settings	Germany SE Settings	France SE Settings	USA & Canada SE Settings

URL Query Test Cases

• ensured that the correct query URL is being used when Brave Search beta is the default search engine:
  • omnibox --> https://search.brave.com/search?q=brave&source=desktop
  • https://search.brave.com --> https://search.brave.com/search?q=basic+attention+token

Default Callback Test Cases

Note: used the cases that I ran through iOS via brave/brave-ios#3745 (comment) as a template for desktop. Also note that at the time of running through this case for uplift, we needed to use search-dev.brave.com to verify the default callback feature.

Test Case 1: (Setting as default via page)

• install 1.28.13 Chromium: 91.0.4472.114
• don't run through the search onboarding and leave Google as the default browser
• login into https://search-dev.brave.com
• search for Brave Browser via the text field
• click on the Set default button via the default modal within https://search-dev.brave.com
• you should see the button turn from Set default --> Done and disappear
• check and ensure https://search-dev.brave.com is set as the default via brave://settings/search

Example	Example	Example

Test Case 2: (Private Browsing)

• install 1.28.13 Chromium: 91.0.4472.114
• don't run through the search onboarding and leave Google as the default browser
• launch open * login into https://search-dev.brave.com via Private Browsing
• search for Basic Attention Token via the text field
• shouldn't see any Brave Search Default modals

Test Case 3: (Default modal retries per session)

• install 1.28.13 Chromium: 91.0.4472.114
• don't run through the search onboarding and leave Google as the default browser
• login into https://search-dev.brave.com
• search for Brave Browser via the text field
• the default modal should appear
• refresh the page two times (should see the default modal appear
• refresh again and you shouldn't see the default modal appear for this session
• open a new tab, open https://search-dev.brave.com and try another search (shouldn't see any more modals for this session)

As per the above, this checks to make sure that the Default modal only appears three times per session.

Test Case 4: (Maximum 10 retries)

• install 1.28.13 Chromium: 91.0.4472.114
• don't run through the search onboarding and leave Google as the default browser
• login into https://search-dev.brave.com
• search for Brave Browser via the text field
• the default modal should appear
• refresh the page two times (should see the default modal appear
• refresh again and you shouldn't see the default modal appear for this session
• open a new tab, open https://search-dev.brave.com and try another search (shouldn't see any more modals for this session)
• close Brave and move the time forward by 24hrs

Repeat the above. The basic logic for the above is that on desktop/android, we should only see 3 modals per session per day to a maximum of 10 in a span of four days.

Test Case 5: (Setting Brave Search as default via onboarding)

• install 1.28.13 Chromium: 91.0.4472.114
• Set Brave Search beta as the default SE via brave://welcome
• login into https://search-dev.brave.com
• search for Brave Browser via the text field
• ensure that the default modal isn't being displayed

Test Case 6: (Setting Brave Search as default via brave://settings/search)

• install 1.28.13 Chromium: 91.0.4472.114
• Set Brave Search beta as the default SE via brave://settings/search
• login into https://search-dev.brave.com
• search for Brave Browser via the text field
• ensure that the default modal isn't being displayed

Fallback Test Cases

• ensured that the Enable Google Fallback mixing appears when searching for terms like brave 123 456 789
• ensured that tapping on Dismiss correctly closes the Enable Google Fallback mixing card
  • ensured that it re-appears when another term that needs fallback is used
• ensured that Learn more. opens https://search.brave.com/help/google-fallback
• ensured that https://www.google.com isn't being contact when fallback is disabled
• ensured that https://www.google.com is being contact once fallback has been enabled

Example	Example	Example