Merge pull request #19 from brave/cookies

bbondy · web-flow · commit e98aed2614a6 · 2018-04-27T23:25:53.000-04:00
Add settings for cookies and referrer blocking
diff --git a/app/actions/shieldsPanelActions.ts b/app/actions/shieldsPanelActions.ts
@@ -58,3 +58,10 @@ export const blockFingerprinting: actions.BlockFingerprinting = (setting) => {
     setting
   }
 }
+
+export const blockCookies: actions.BlockCookies = (setting) => {
+  return {
+    type: types.BLOCK_COOKIES,
+    setting
+  }
+}
diff --git a/app/background/api/shieldsAPI.ts b/app/background/api/shieldsAPI.ts
@@ -26,10 +26,13 @@ export const getShieldSettingsForTabData = (tabData?: chrome.tabs.Tab) => {
     chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_TRACKERS } }),
     chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_HTTP_UPGRADABLE_RESOURCES } }),
     chrome.contentSettings.javascript.getAsync({ primaryUrl: origin }),
-    chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_FINGERPRINTING } }),
-    chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, secondaryUrl: 'https://firstParty/*', resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_FINGERPRINTING } })
+    chrome.contentSettings.plugins.getAsync({ primaryUrl: origin }),
+    chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, secondaryUrl: 'https://firstParty/*', resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_FINGERPRINTING } }),
+    chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_COOKIES } }),
+    chrome.contentSettings.plugins.getAsync({ primaryUrl: origin, secondaryUrl: 'https://firstParty/', resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_COOKIES } })
   ]).then((details) => {
     const fingerprinting = details[5].setting !== details[6].setting ? 'block_third_party' : details[5].setting
+    const cookies = details[7].setting !== details[8].setting ? 'block_third_party' : details[7].setting
     return {
       url: url.href,
       origin,
@@ -40,7 +43,8 @@ export const getShieldSettingsForTabData = (tabData?: chrome.tabs.Tab) => {
       trackers: details[2].setting,
       httpUpgradableResources: details[3].setting,
       javascript: details[4].setting,
-      fingerprinting
+      fingerprinting,
+      cookies
     }
   }).catch(() => {
     return {
@@ -171,6 +175,37 @@ export const setAllowFingerprinting = (origin: string, setting: string) => {
   return Promise.all([p1, p2])
 }
 
+/**
+ * Changes the cookie at origin to be allowed or blocked.
+ * @param {string} origin the origin of the site to change the setting for
+ * @return a promise which resolves with the setting is set
+ */
+export const setAllowCookies = (origin: string, setting: string) => {
+  const originSetting = setting === 'allow' ? 'allow' : 'block'
+  const firstPartySetting = setting === 'block' ? 'block' : 'allow'
+
+  const p1 = chrome.contentSettings.plugins.setAsync({
+    primaryPattern: origin + '/*',
+    resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_REFERRERS },
+    setting: originSetting
+  })
+
+  const p2 = chrome.contentSettings.plugins.setAsync({
+    primaryPattern: origin + '/*',
+    resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_COOKIES },
+    setting: originSetting
+  })
+
+  const p3 = chrome.contentSettings.plugins.setAsync({
+    primaryPattern: origin + '/*',
+    secondaryPattern: 'https://firstParty/*',
+    resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_COOKIES },
+    setting: firstPartySetting
+  })
+
+  return Promise.all([p1, p2, p3])
+}
+
 /**
  * Toggles the input value between allow and block
  * @return the toggled value
diff --git a/app/background/reducers/shieldsPanelReducer.ts b/app/background/reducers/shieldsPanelReducer.ts
@@ -13,6 +13,7 @@ import {
   setAllowHTTPUpgradableResources,
   setAllowJavaScript,
   setAllowFingerprinting,
+  setAllowCookies,
   toggleShieldsValue,
   requestShieldPanelData
 } from '../api/shieldsAPI'
@@ -226,6 +227,21 @@ export default function shieldsPanelReducer (state: State = { tabs: {}, windows:
           })
         break
       }
+    case shieldsPanelTypes.BLOCK_COOKIES:
+      {
+        const tabData: Tab = shieldsPanelState.getActiveTabData(state)
+        setAllowCookies(tabData.origin, action.setting)
+          .then(() => {
+            requestShieldPanelData(shieldsPanelState.getActiveTabId(state))
+            reloadTab(tabData.id, true).catch(() => {
+              console.error('Tab reload was not successful')
+            })
+          })
+          .catch(() => {
+            console.error('Could not set cookies setting')
+          })
+        break
+      }
   }
   return state
 }
diff --git a/app/components/braveShields/braveShields.tsx b/app/components/braveShields/braveShields.tsx
@@ -18,6 +18,7 @@ interface Props {
     httpsEverywhereToggled: shieldActions.HttpsEverywhereToggled
     javascriptToggled: shieldActions.JavascriptToggled
     blockFingerprinting: shieldActions.BlockFingerprinting
+    blockCookies: shieldActions.BlockCookies
   }
   shieldsPanelTabData: Tab
 }
@@ -58,6 +59,8 @@ export default class BraveShields extends React.Component<Props, object> {
           controlsOpen={shieldsPanelTabData.controlsOpen}
           fingerprinting={shieldsPanelTabData.fingerprinting}
           blockFingerprinting={actions.blockFingerprinting}
+          cookies={shieldsPanelTabData.cookies}
+          blockCookies={actions.blockCookies}
         />
         <BraveShieldsFooter />
       </div>
diff --git a/app/components/braveShields/braveShieldsControls.tsx b/app/components/braveShields/braveShieldsControls.tsx
@@ -5,7 +5,7 @@
 import * as React from 'react'
 import { Grid, Column, SwitchButton, BrowserSelect, ContentToggle } from 'brave-ui'
 import * as shieldActions from '../../types/actions/shieldsPanelActions'
-import { BlockOptions, BlockFPOptions } from '../../types/other/blockTypes'
+import { BlockOptions, BlockFPOptions, BlockCookiesOptions } from '../../types/other/blockTypes'
 import { getMessage } from '../../background/api/localeAPI'
 
 export interface Props {
@@ -16,32 +16,30 @@ export interface Props {
   trackers: BlockOptions
   javascript: BlockOptions
   fingerprinting: BlockFPOptions
+  cookies: BlockCookiesOptions
   blockAdsTrackers: shieldActions.BlockAdsTrackers
   controlsToggled: shieldActions.ControlsToggled
   httpsEverywhereToggled: shieldActions.HttpsEverywhereToggled
   javascriptToggled: shieldActions.JavascriptToggled
   blockFingerprinting: shieldActions.BlockFingerprinting
+  blockCookies: shieldActions.BlockCookies
 }
 
 export default class BraveShieldsControls extends React.Component<Props, object> {
   constructor (props: Props) {
     super(props)
     this.onChangeAdControl = this.onChangeAdControl.bind(this)
-    this.onChangeCookieControl = this.onChangeCookieControl.bind(this)
     this.onToggleControls = this.onToggleControls.bind(this)
     this.onToggleHTTPSEverywhere = this.onToggleHTTPSEverywhere.bind(this)
     this.onToggleJavaScript = this.onToggleJavaScript.bind(this)
     this.onChangeFingerprintingProtection = this.onChangeFingerprintingProtection.bind(this)
+    this.onChangeCookiesProtection = this.onChangeCookiesProtection.bind(this)
   }
 
   onChangeAdControl (e: HTMLSelectElement) {
     this.props.blockAdsTrackers(e.target.value)
   }
 
-  onChangeCookieControl (e: HTMLSelectElement) {
-    // TODO: @cezaraugusto
-  }
-
   onToggleControls () {
     this.props.controlsToggled(!this.props.controlsOpen)
   }
@@ -58,8 +56,12 @@ export default class BraveShieldsControls extends React.Component<Props, object>
     this.props.blockFingerprinting(e.target.value)
   }
 
+  onChangeCookiesProtection (e: HTMLSelectElement) {
+    this.props.blockCookies(e.target.value)
+  }
+
   render () {
-    const { braveShields, ads, trackers, controlsOpen, httpUpgradableResources, javascript, fingerprinting } = this.props
+    const { braveShields, ads, trackers, controlsOpen, httpUpgradableResources, javascript, fingerprinting, cookies } = this.props
     return (
       <Grid
         id='braveShieldsControls'
@@ -84,16 +86,16 @@ export default class BraveShieldsControls extends React.Component<Props, object>
               <option value='allow'>{getMessage('shieldsControlsAdControlOptionBlockAds')}</option>
               <option value='block'>{getMessage('shieldsControlsAdControlOptionAllowAdsTracking')}</option>
             </BrowserSelect>
-            {/* TODO @cezaraugusto */}
+
             <BrowserSelect
               disabled={braveShields === 'block'}
               titleName={getMessage('shieldsControlsCookieControl')}
-              value='someVALUE'
-              onChange={this.onChangeCookieControl}
+              value={braveShields !== 'block' ? cookies : 'allow'}
+              onChange={this.onChangeCookiesProtection}
             >
-              <option value='SOME'>{getMessage('shieldsControlsCookieOptionBlock3p')}</option>
-              <option value='SOME'>{getMessage('shieldsControlsCookieOptionAllowAll')}</option>
-              <option value='SOME'>{getMessage('shieldsControlsCookieOptionBlockAll')}</option>
+              <option value='block_third_party'>{getMessage('shieldsControlsCookieOptionBlock3p')}</option>
+              <option value='block'>{getMessage('shieldsControlsCookieOptionBlockAll')}</option>
+              <option value='allow'>{getMessage('shieldsControlsCookieOptionAllowAll')}</option>
             </BrowserSelect>
 
             <BrowserSelect
diff --git a/app/constants/resourceIdentifiers.ts b/app/constants/resourceIdentifiers.ts
@@ -7,3 +7,5 @@ export const RESOURCE_IDENTIFIER_TRACKERS = 'trackers'
 export const RESOURCE_IDENTIFIER_HTTP_UPGRADABLE_RESOURCES = 'httpUpgradableResources'
 export const RESOURCE_IDENTIFIER_BRAVE_SHIELDS = 'braveShields'
 export const RESOURCE_IDENTIFIER_FINGERPRINTING = 'fingerprinting'
+export const RESOURCE_IDENTIFIER_COOKIES = 'cookies'
+export const RESOURCE_IDENTIFIER_REFERRERS = 'referrers'
diff --git a/app/constants/shieldsPanelTypes.ts b/app/constants/shieldsPanelTypes.ts
@@ -10,3 +10,4 @@ export const CONTROLS_TOGGLED = 'CONTROLS_TOGGLED'
 export const HTTPS_EVERYWHERE_TOGGLED = 'HTTPS_EVERYWHERE_TOGGLED'
 export const JAVASCRIPT_TOGGLED = 'JAVASCRIPT_TOGGLED'
 export const BLOCK_FINGERPRINTING = 'BLOCK_FINGERPRINTING'
+export const BLOCK_COOKIES = 'BLOCK_COOKIES'
diff --git a/app/types/actions/shieldsPanelActions.ts b/app/types/actions/shieldsPanelActions.ts
@@ -3,7 +3,7 @@
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import * as types from '../constants/shieldsPanelTypes'
-import { BlockTypes, BlockOptions, BlockFPOptions } from '../other/blockTypes'
+import { BlockTypes, BlockOptions, BlockFPOptions, BlockCookiesOptions } from '../other/blockTypes'
 
 export interface ShieldDetails {
   id: number
@@ -12,6 +12,7 @@ export interface ShieldDetails {
   httpUpgradableResources: BlockOptions
   javascript: BlockOptions
   fingerprinting: BlockFPOptions
+  cookies: BlockCookiesOptions
   origin: string
   hostname: string
 }
@@ -66,6 +67,15 @@ export interface BlockFingerprinting {
   (setting: BlockFPOptions): BlockFingerprintingReturn
 }
 
+interface BlockCookiesReturn {
+  type: types.BLOCK_COOKIES
+  setting: BlockCookiesOptions
+}
+
+export interface BlockCookies {
+  (setting: BlockCookiesOptions): BlockCookiesReturn
+}
+
 interface ControlsToggledReturn {
   type: types.CONTROLS_TOGGLED
   setting: boolean
@@ -99,4 +109,5 @@ export type shieldPanelActions =
   ControlsToggledReturn |
   HttpsEverywhereToggledReturn |
   JavascriptToggledReturn |
-  BlockFingerprintingReturn
+  BlockFingerprintingReturn |
+  BlockCookiesReturn
diff --git a/app/types/constants/resourceIdentifiers.ts b/app/types/constants/resourceIdentifiers.ts
@@ -12,3 +12,4 @@ export type RESOURCE_IDENTIFIER_ADS = typeof types.RESOURCE_IDENTIFIER_ADS
 export type RESOURCE_IDENTIFIER_TRACKERS = typeof types.RESOURCE_IDENTIFIER_TRACKERS
 export type RESOURCE_IDENTIFIER_HTTP_UPGRADABLE_RESOURCES = typeof types.RESOURCE_IDENTIFIER_HTTP_UPGRADABLE_RESOURCES
 export type RESOURCE_IDENTIFIER_FINGERPRINTING = typeof types.RESOURCE_IDENTIFIER_FINGERPRINTING
+export type RESOURCE_IDENTIFIER_COOKIES = typeof types.RESOURCE_IDENTIFIER_COOKIES
diff --git a/app/types/constants/shieldsPanelTypes.ts b/app/types/constants/shieldsPanelTypes.ts
@@ -12,3 +12,4 @@ export type CONTROLS_TOGGLED = typeof types.CONTROLS_TOGGLED
 export type HTTPS_EVERYWHERE_TOGGLED = typeof types.HTTPS_EVERYWHERE_TOGGLED
 export type JAVASCRIPT_TOGGLED = typeof types.JAVASCRIPT_TOGGLED
 export type BLOCK_FINGERPRINTING = typeof types.BLOCK_FINGERPRINTING
+export type BLOCK_COOKIES = typeof types.BLOCK_COOKIES
diff --git a/app/types/other/blockTypes.ts b/app/types/other/blockTypes.ts
@@ -5,3 +5,4 @@
 export type BlockTypes = 'ads' | 'trackers' | 'httpUpgradableResources' | 'javascript' | 'fingerprinting'
 export type BlockOptions = 'allow' | 'block'
 export type BlockFPOptions = 'allow' | 'block' | 'block_third_party'
+export type BlockCookiesOptions = 'allow' | 'block' | 'block_third_party'
diff --git a/app/types/state/shieldsPannelState.ts b/app/types/state/shieldsPannelState.ts
@@ -2,7 +2,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import { BlockOptions, BlockTypes, BlockFPOptions } from '../other/blockTypes'
+import { BlockOptions, BlockTypes, BlockFPOptions, BlockCookiesOptions } from '../other/blockTypes'
 
 export interface Tab {
   ads: BlockOptions
@@ -21,6 +21,7 @@ export interface Tab {
   url: string
   fingerprinting: BlockFPOptions
   fingerprintingBlocked: number
+  cookies: BlockCookiesOptions
 }
 
 export interface Tabs {
diff --git a/test/app/actions/shieldsPanelActionsTest.ts b/test/app/actions/shieldsPanelActionsTest.ts
@@ -8,7 +8,7 @@ import * as assert from 'assert'
 import * as types from '../../../app/constants/shieldsPanelTypes'
 import * as actions from '../../../app/actions/shieldsPanelActions'
 import { ShieldDetails, BlockDetails } from '../../../app/types/actions/shieldsPanelActions';
-import { BlockOptions, BlockFPOptions } from '../../../app/types/other/blockTypes';
+import { BlockOptions, BlockFPOptions, BlockCookiesOptions } from '../../../app/types/other/blockTypes';
 
 describe('shieldsPanelActions', () => {
   it('shieldsPanelDataUpdated', () => {
@@ -20,7 +20,8 @@ describe('shieldsPanelActions', () => {
       hostname: 'www.brave.com',
       id: 1,
       javascript: 'allow',
-      fingerprinting: 'allow'
+      fingerprinting: 'allow',
+      cookies: 'allow'
     }
     assert.deepEqual(actions.shieldsPanelDataUpdated(details), {
       type: types.SHIELDS_PANEL_DATA_UPDATED,
@@ -82,4 +83,12 @@ describe('shieldsPanelActions', () => {
       setting
     })
   })
+
+  it('blockCookies action', () => {
+    const setting: BlockCookiesOptions = 'block_third_party'
+    assert.deepEqual(actions.blockCookies(setting), {
+      type: types.BLOCK_COOKIES,
+      setting
+    })
+  })
 })
diff --git a/test/app/background/api/shieldsAPITest.ts b/test/app/background/api/shieldsAPITest.ts
@@ -45,6 +45,7 @@ describe('Shields API', () => {
           javascript: 'block',
           braveShields: 'block',
           fingerprinting: 'block',
+          cookies: 'block',
           id: 5
         })
         cb()
@@ -99,7 +100,8 @@ describe('Shields API', () => {
         trackers: 'block',
         httpUpgradableResources: 'block',
         javascript: 'block',
-        fingerprinting: 'block'
+        fingerprinting: 'block',
+        cookies: 'block'
       }
 
       this.p
@@ -267,6 +269,50 @@ describe('Shields API', () => {
     })
   })
 
+  describe('setAllowCookies', function () {
+    before(function () {
+      this.spy = sinon.spy(chrome.contentSettings.plugins, 'setAsync')
+      this.p = shieldsAPI.setAllowCookies('https://www.brave.com', 'block')
+    })
+    after(function () {
+      this.spy.restore()
+    })
+    it('calls chrome.contentSettings.plugins with the correct args', function () {
+      const arg0 = this.spy.getCall(0).args[0]
+      assert.deepEqual(arg0, {
+        primaryPattern: 'https://www.brave.com/*',
+        resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_REFERRERS },
+        setting: 'block'
+      })
+      const arg1 = this.spy.getCall(1).args[0]
+      assert.deepEqual(arg1, {
+        primaryPattern: 'https://www.brave.com/*',
+        resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_COOKIES },
+        setting: 'block'
+      })
+      const arg2 = this.spy.getCall(2).args[0]
+      assert.deepEqual(arg2, {
+        primaryPattern: 'https://www.brave.com/*',
+        secondaryPattern: 'https://firstParty/*',
+        resourceIdentifier: { id: resourceIdentifiers.RESOURCE_IDENTIFIER_COOKIES },
+        setting: 'block'
+      })
+    })
+    it('passes only 1 arg to chrome.contentSettings.plugins', function () {
+      assert.equal(this.spy.getCall(0).args.length, 1)
+      assert.equal(this.spy.getCall(1).args.length, 1)
+    })
+    it('resolves the returned promise', function (cb) {
+      this.p
+      .then(function () {
+          cb()
+        })
+        .catch((e: Error) => {
+          console.error(e.toString())
+        })
+    })
+  })
+
   describe('toggleShieldsValue', function () {
     it('toggles \'allow\' to \'block\'', function () {
       assert.equal(shieldsAPI.toggleShieldsValue('allow'), 'block')
diff --git a/test/app/background/reducers/shieldsPanelReducerTest.ts b/test/app/background/reducers/shieldsPanelReducerTest.ts
diff --git a/test/app/components/braveShields/braveShieldsControlsTest.tsx b/test/app/components/braveShields/braveShieldsControlsTest.tsx
diff --git a/test/app/state/shieldsPanelStateTest.ts b/test/app/state/shieldsPanelStateTest.ts
diff --git a/test/testData.ts b/test/testData.ts

Original file line number	Diff line number	Diff line change
`@@ -58,3 +58,10 @@ export const blockFingerprinting: actions.BlockFingerprinting = (setting) => {`
`58`	`58`	`setting`
`59`	`59`	`}`
`60`	`60`	`}`
	`61`	`+`
	`62`	`+export const blockCookies: actions.BlockCookies = (setting) => {`
	`63`	`+ return {`
	`64`	`+ type: types.BLOCK_COOKIES,`
	`65`	`+ setting`
	`66`	`+ }`
	`67`	`+}`