Create a JS API for requesting ads enabled

[aseren]

API should ask the user for permission to enable ads.

[diracdeltas]

is this the work for https://bravesoftware.slack.com/archives/CELA35G5S/p1624627578005000?

please file a security review when the code is ready, thanks. https://github.com/brave/security/issues/new/choose

[aseren]

is this the work for https://bravesoftware.slack.com/archives/CELA35G5S/p1624627578005000?

Yes, it is.

please file a security review when the code is ready, thanks. https://github.com/brave/security/issues/new/choose

Okay, I will do, thank you!

[stephendonner]

Verified PASSED using

Brave	1.32.75 Chromium: 95.0.4638.54 (Official Build) beta (x86_64)
Revision	d31a821ec901f68d0d34ccdbaea45b4c86ce543e-refs/branch-heads/4638@{#871}
OS	macOS Version 11.6 (Build 20G165)

1. API not available on non-Brave Talk hosts

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a new-tab page
4. click on the Start using Rewards button
5. load www.brave.com
6. open Developer Tools and switch to the Console tab
7. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function
8. load brave://rewards/
9. toggle Ads to Off
10. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function

example	example

2a. Brave Talk, Rewards & Ads enabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. on a new-tab page, click on Start using Rewards (or via other methods)
4. load talk.brave.software
5. click on Start free 1:1 call
6. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example

2b. Brave Talk, Rewards enabled, Ads disabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. on a new-tab page, turn on Rewards (& Ads)
4. disable Ads via the brave://rewards page’s toggle; Rewards should still be on)
5. load talk.brave.software
6. click on Start free 1:1 call
7. confirm the doorhanger notification pops up and prompts you with a button to Turn on Brave Private Ads
8. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example	example

2c. Brave Talk, Rewards disabled (never enabled), Ads disabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. load talk.brave.software
4. click on Start free 1:1 call
5. confirm the doorhanger notification popups up and prompts you with a button to Turn on Rewards
6. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example

3a. Brave Talk, Private Window

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. click on Start using Rewards on the new-tab page
4. open a new Private Window
5. load talk.brave.software
6. click on the Start free 1:1 call button
7. confirm the Enable Rewards doorhanger dialog doesn't display
8. open Developer Tools and switch to the Console tab
9. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

3b. Brave Talk, Private Window with Tor

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a New Private Window with Tor
4. load talk.brave.software
5. click on the Start free 1:1 call button
6. confirm the Enable Rewards doorhanger dialog doesn't display
7. open Developer Tools and switch to the Console tab
8. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

3c. Guest window

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a Guest Window
4. load talk.brave.software
5. click on the Start free 1:1 call button
6. confirm the Enable Rewards doorhanger dialog doesn't display
7. open Developer Tools and switch to the Console tab
8. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

4. API called without user gesture

(Skipped)

5. Brave Talk, dark mode

1. on a new-tab page, click on Start using Rewards
2. open brave://settings/appearance and change to Dark mode
3. load talk.brave.software
4. click on the Start free 1:1 call button
5. ensure the popup dialogs are dark-themed

example	example

---

Verified PASSED using

Brave	1.32.84 Chromium: 95.0.4638.54 (Official Build) beta (64-bit)
Revision	d31a821ec901f68d0d34ccdbaea45b4c86ce543e-refs/branch-heads/4638@{#871}
OS	Windows 10 Version 20H2 (Build 19042.1288)

1. API not available on non-Brave Talk hosts

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a new-tab page
4. click on the Start using Rewards button
5. load www.brave.com
6. open Developer Tools and switch to the Console tab
7. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function
8. load brave://rewards/
9. toggle Ads to Off
10. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function

example	example

2a. Brave Talk, Rewards & Ads enabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. on a new-tab page, click on Start using Rewards (or via other methods)
4. load talk.brave.software
5. click on Start free 1:1 call
6. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example

2b. Brave Talk, Rewards enabled, Ads disabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. on a new-tab page, turn on Rewards (& Ads)
4. disable Ads via the brave://rewards page’s toggle; Rewards should still be on)
5. load talk.brave.software
6. click on Start free 1:1 call
7. confirm the doorhanger notification pops up and prompts you with a button to Turn on Brave Private Ads
8. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example	example

2c. Brave Talk, Rewards disabled (never enabled), Ads disabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. load talk.brave.software
4. click on Start free 1:1 call
5. confirm the doorhanger notification popups up and prompts you with a button to Turn on Rewards
6. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example

3a. Brave Talk, Private Window

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. click on Start using Rewards on the new-tab page
4. open a new Private Window
5. load talk.brave.software
6. click on the Start free 1:1 call button
7. confirm the Enable Rewards doorhanger dialog doesn't display
8. open Developer Tools and switch to the Console tab
9. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example

3b. Brave Talk, Private Window with Tor

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a New Private Window with Tor
4. load talk.brave.software
5. click on the Start free 1:1 call button
6. confirm the Enable Rewards doorhanger dialog doesn't display
7. open Developer Tools and switch to the Console tab
8. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example

3c. Guest window

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a Guest Window
4. load talk.brave.software
5. click on the Start free 1:1 call button
6. confirm the Enable Rewards doorhanger dialog doesn't display
7. open Developer Tools and switch to the Console tab
8. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example

4. API called without user gesture

(Skipped)

5. Brave Talk, dark mode

1. on a new-tab page, click on Start using Rewards
2. open brave://settings/appearance and change to Dark mode
3. load talk.brave.software
4. click on the Start free 1:1 call button
5. ensure the popup dialogs are dark-themed

example	example

---

Verified PASSED using

Brave	1.32.87 Chromium: 95.0.4638.69 (Official Build) beta (64-bit)
Revision	6a1600ed572fedecd573b6c2b90a22fe6392a410-refs/branch-heads/4638@{#984}
OS	Linux

1. API not available on non-Brave Talk hosts

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a new-tab page
4. click on the Start using Rewards button
5. load www.brave.com
6. open Developer Tools and switch to the Console tab
7. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function
8. load brave://rewards/
9. toggle Ads to Off
10. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function

example	example

2a. Brave Talk, Rewards & Ads enabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. on a new-tab page, click on Start using Rewards (or via other methods)
4. load talk.brave.software
5. click on Start free 1:1 call
6. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example

2b. Brave Talk, Rewards enabled, Ads disabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. on a new-tab page, turn on Rewards (& Ads)
4. disable Ads via the brave://rewards page’s toggle; Rewards should still be on)
5. load talk.brave.software
6. click on Start free 1:1 call
7. confirm the doorhanger notification pops up and prompts you with a button to Turn on Brave Private Ads
8. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example	example

2c. Brave Talk, Rewards disabled (never enabled), Ads disabled

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. load talk.brave.software
4. click on Start free 1:1 call
5. confirm the doorhanger notification popups up and prompts you with a button to Turn on Rewards
6. confirm after clicking the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example

3a. Brave Talk, Private Window

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. click on Start using Rewards on the new-tab page
4. open a new Private Window
5. load talk.brave.software
6. click on the Start free 1:1 call button
7. confirm the Enable Rewards doorhanger dialog doesn't display
8. open Developer Tools and switch to the Console tab
9. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example

3b. Brave Talk, Private Window with Tor

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a New Private Window with Tor
4. load talk.brave.software
5. click on the Start free 1:1 call button
6. confirm the Enable Rewards doorhanger dialog doesn't display
7. open Developer Tools and switch to the Console tab
8. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example

3c. Guest window

1. new profile
2. launch Brave using --enable-logging=stderr --vmodule="*/variations/*"=6,"*/bat-native-ledger/*"=6,"*/brave_rewards/*"=6,"*/bat-native-ads/*"=6,"*/bat-native-confirmations/*"=6,"*/brave_ads/*"=9,"*/brave_user_model/*"=6 --brave-ads-staging --brave-ads-debug --rewards=staging=true,reconcile-interval=3 --enable-features=RequestAdsEnabledApi
3. open a Guest Window
4. load talk.brave.software
5. click on the Start free 1:1 call button
6. confirm the Enable Rewards doorhanger dialog doesn't display
7. open Developer Tools and switch to the Console tab
8. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example

4. API called without user gesture

(Skipped)

5. Brave Talk, dark mode

1. on a new-tab page, click on Start using Rewards
2. open brave://settings/appearance and change to Dark mode
3. load talk.brave.software
4. click on the Start free 1:1 call button
5. ensure the popup dialogs are dark-themed

example	example

[stephendonner]

Verified PASSED using Brave 1.32.81, Chromium 95.0.4638.54 on a Google Pixel XL, Android 9.

1. API not available on non-Brave Talk hosts

1. fresh install
2. launch Brave using --enable-features=RequestAdsEnabledApi
3. open a new-tab page
4. enable Rewards
5. load www.brave.com
6. connect Android device to desktop browser, and open Developer Tools and switch to the Console tab
7. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function
8. load brave://rewards/
9. toggle Ads to Off
10. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it throws Uncaught TypeError: chrome.braveRequestAdsEnabled is not a function

example	example

2a. Brave Talk, Rewards & Ads enabled

1. fresh install
2. launch Brave using --enable-features=RequestAdsEnabledApi
3. enable Rewards
4. load talk.brave.software
5. tap on Start free 1:1 call
6. confirm after tapping the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example

2b. Brave Talk, Rewards enabled, Ads disabled

1. fresh install
2. launch Brave using --enable-features=RequestAdsEnabledApi
3. turn on Rewards (& Ads)
4. disable Ads via the brave://rewards page’s toggle; Rewards should still be on)
5. load talk.brave.software
6. tap on Start free 1:1 call
7. confirm the doorhanger notification pops up and prompts you with a button to Turn on Brave Private Ads
8. confirm after tapping the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example	example	example

2c. Brave Talk, Rewards disabled (never enabled), Ads disabled

1. fresh install
2. launch Brave using --enable-features=RequestAdsEnabledApi
3. load talk.brave.software
4. tap on Start free 1:1 call
5. confirm the doorhanger notification popups up and prompts you with a button to Turn on Rewards
6. confirm after tapping the button the dialog is dismissed and you are able to Start a free 1:1 call without further prompts

example	example	example	example

3a. Brave Talk, Private Window

1. fresh install
2. launch Brave using --enable-features=RequestAdsEnabledApi
3. enable Rewards
4. open a new Private Window
5. load talk.brave.software
6. tap on the Start free 1:1 call button
7. confirm the Enable Rewards doorhanger dialog doesn't display
8. open Developer Tools and switch to the Console tab
9. enter chrome.braveRequestAdsEnabled().then(value => console.log(value)) and ensure it returns false

example	example	example	example

3b. Brave Talk, Private Window with Tor

(skipped; not available on Android)

4. API called without user gesture

(skipped)

5. Brave Talk, dark mode (via Experimental night mode option on Android, from Chrome)

1. open Settings -> Appearance
2. choose Dark in Themes
3. load talk.brave.software
4. tap on the Start free 1:1 call button
5. vet if chrome dialogs are dark-theme enabled (no; conferred with @aseren and we're OK for now, as Rewards doesn't dark-theme enable its dialog either)

example	example	example	example

---

Verification passed on Brave v1.32.95 on Samsung Galaxy Tab S5e (Android 10.0)

1. API not available on non-Brave Talk hosts

2a. Brave Talk, Rewards & Ads enabled

2b. Brave Talk, Rewards enabled, Ads disabled

2c. Brave Talk, Rewards disabled (never enabled), Ads disabled

3a. Brave Talk, Private Window

3b. Brave Talk, Private Window with Tor

(skipped; not available on Android)

4. API called without user gesture

(skipped)

5. Brave Talk, dark mode (via Experimental night mode option on Android, from Chrome)