Using Chromium's spellchecker

fixes #9880

Auditors: @bridiver, @bbondy, @bsclifton

Test plan:
a. Suggestions

1. Go to `about:styles`
2. Type `braave` in textbox
3. There should be redline under `braave`
4. Open context menu on `braave`
5. You can see `bravo`, `brave`, `Brava`
6. Click on `brave`
7. The text should be replaced with `brave` with no redline

b. Learn Spelling
1. Go to `about:styles`
2. Type `braave` in textbox
3. There should be redline under `braave`
4. Open context menu on `braave`
5. Click `Learn Spelling`
6. `braave` will no longer be redlined
7.  Next time you type `braave`, you will not see redline

c. Forget Learned Spelling
1. Go to `about:styles`
2. Type `braave` in textbox
3. There should be redline under `braave`
4. Open context menu on `braave`
5. Click `Learn Spelling`
6. `braave` will no longer be redlined
7. Open context menu on `braave`
8. Click `Forget Learned Spelling`
9.  Next time you type `braave`, you will see redline under it

d. Legacy data migration
1. Use older Brave to `Learn Spelling` for `braave` and `Ignore
Spelling` for `braaave`
2. Update to the version with chromium spellchecker
3. There will be no `dictionary` structure in session store
4. You can see those two words will be added to `Custom Dictionary.txt`
under user folder
5. And try to type `braave` and `braaave` in `about:styles`
6. They should be valid words

app/browser/reducers/spellCheckerReducer.js

@@ -0,0 +1,66 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/. */
+
+'use strict'
+
+const appConstants = require('../../../js/constants/appConstants')
+const {makeImmutable} = require('../../common/state/immutableUtil')
+const {getWebContents} = require('../webContentsCache')
+const spellChecker = require('../../spellChecker')
+
+const migrate = (state) => {
+  if (state.get('dictionary')) {
+    const addedWords = state.getIn(['dictionary', 'addedWords'])
+    const ignoredWords = state.getIn(['dictionary', 'ignoredWords'])
+    if (addedWords.size) {
+      addedWords.forEach((word) => {
+        spellChecker.addWord(word)
+      })
+    }
+    if (ignoredWords.size) {
+      ignoredWords.forEach((word) => {
+        spellChecker.addWord(word)
+      })
+    }
+    state = state.delete('dictionary')
+  }
+  return state
+}
+
+const spellCheckerReducer = (state, action, immutableAction) => {
+  action = immutableAction || makeImmutable(action)
+  switch (action.get('actionType')) {
+    case appConstants.APP_SET_STATE:
+      state = migrate(state)
+      break
+    case appConstants.APP_SPELLING_SUGGESTED:
+      if (typeof action.get('suggestion') === 'string') {
+        const webContents = getWebContents(action.get('tabId'))
+        if (webContents && !webContents.isDestroyed()) {
+          webContents.replaceMisspelling(action.get('suggestion'))
+        }
+      }
+      break
+    case appConstants.APP_LEARN_SPELLING:
+      if (typeof action.get('word') === 'string') {
+        spellChecker.addWord(action.get('word'))
+        const webContents = getWebContents(action.get('tabId'))
+        if (webContents && !webContents.isDestroyed()) {
+          webContents.replaceMisspelling(action.get('word'))
+        }
+      }
+      break
+    case appConstants.APP_FORGET_LEARNED_SPELLING:
+      if (typeof action.get('word') === 'string') {
+        spellChecker.removeWord(action.get('word'))
+        const webContents = getWebContents(action.get('tabId'))
+        if (webContents && !webContents.isDestroyed()) {
+          webContents.replace(action.get('word'))
+        }
+      }
+  }
+  return state
+}
+
+module.exports = spellCheckerReducer

app/extensions.js

@@ -113,7 +113,6 @@ let generateBraveManifest = () => {
           getBraveExtUrl('about-blank.html') + '#*'
         ],
         js: [
-          'content/scripts/spellCheck.js',
           'content/scripts/themeColor.js'
         ]
       },

app/extensions/brave/locales/en-US/menu.properties

@@ -155,7 +155,7 @@ extensionsManager=Extensions…
 zoom=Zoom
 new=New
 learnSpelling=Learn Spelling
-ignoreSpelling=Ignore Spelling
+forgetLearnedSpelling=Forget Learned Spelling
 autoHideMenuBar=Menu Bar
 updateChannel=Update Channel
 licenseText=This software uses libraries from the FFmpeg project under the LGPLv2.1

app/index.js

@@ -67,7 +67,6 @@ const PDFJS = require('./pdfJS')
 const SiteHacks = require('./siteHacks')
 const CmdLine = require('./cmdLine')
 const urlParse = require('./common/urlParse')
-const spellCheck = require('./spellCheck')
 const locale = require('./locale')
 const contentSettings = require('../js/state/contentSettings')
 const privacy = require('../js/state/privacy')
@@ -181,7 +180,6 @@ app.on('ready', () => {
     Autofill.init()
     Extensions.init()
     SiteHacks.init()
-    spellCheck.init()
     HttpsEverywhere.init()
     TrackingProtection.init()
     AdBlock.init()

app/locale.js

@@ -178,7 +178,7 @@ var rendererIdentifiers = function () {
     'braveryStartUsingPayments',
     'blockPopups',
     'learnSpelling',
-    'ignoreSpelling',
+    'forgetLearnedSpelling',
     'lookupSelection',
     // Other identifiers
     'aboutBlankTitle',

app/sessionStore.js

@@ -636,10 +636,6 @@ module.exports.defaultAppState = () => {
     passwords: [],
     notifications: [],
     temporarySiteSettings: {},
-    dictionary: {
-      addedWords: [],
-      ignoredWords: []
-    },
     autofill: {
       addresses: {
         guid: [],

app/spellChecker.js

@@ -0,0 +1,14 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * 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/. */
+
+const electron = require('electron')
+const session = electron.session
+
+module.exports.addWord = (word) => {
+  session.defaultSession.spellChecker.addWord(word)
+}
+
+module.exports.removeWord = (word) => {
+  session.defaultSession.spellChecker.removeWord(word)
+}

docs/appActions.md

@@ -450,28 +450,6 @@ Hides a message in the notification bar
 
 
 
-### addWord(word, learn) 
-
-Adds a word to the dictionary
-
-**Parameters**
-
-**word**: `string`, The word to add
-
-**learn**: `boolean`, true if the word should be learned, false if ignored
-
-
-
-### setDictionary(locale) 
-
-Adds a word to the dictionary
-
-**Parameters**
-
-**locale**: `string`, The locale to set for the dictionary
-
-
-
 ### setLoginRequiredDetail(tabId, detail) 
 
 Adds information about pending basic auth login requests

docs/state.md

@@ -79,11 +79,6 @@ AppStore
     y: number
   },
   defaultWindowWidth: number, // DEPRECATED (0.12.7); replaced w/ defaultWindowParams.width
-  dictionary: {
-    addedWords: Array<string>, // list of words to add to the dictionary
-    ignoredWords: Array<string>, // list of words to ignore
-    locale: string // en_US, en, or any other locale string
-  },
   downloads: [{
     [downloadId]: {
       filename: string,

js/actions/appActions.js

@@ -548,30 +548,6 @@ const appActions = {
     })
   },
 
-  /**
-   * Adds a word to the dictionary
-   * @param {string} word - The word to add
-   * @param {boolean} learn - true if the word should be learned, false if ignored
-   */
-  addWord: function (word, learn) {
-    dispatch({
-      actionType: appConstants.APP_ADD_WORD,
-      word,
-      learn
-    })
-  },
-
-  /**
-   * Adds a word to the dictionary
-   * @param {string} locale - The locale to set for the dictionary
-   */
-  setDictionary: function (locale) {
-    dispatch({
-      actionType: appConstants.APP_SET_DICTIONARY,
-      locale
-    })
-  },
-
   /**
    * Adds information about pending basic auth login requests
    * @param {number} tabId - The tabId that generated the request
@@ -1515,6 +1491,30 @@ const appActions = {
         windowId
       }
     })
+  },
+
+  spellingSuggested: function (suggestion, tabId) {
+    dispatch({
+      actionType: appConstants.APP_SPELLING_SUGGESTED,
+      suggestion,
+      tabId
+    })
+  },
+
+  learnSpelling: function (word, tabId) {
+    dispatch({
+      actionType: appConstants.APP_LEARN_SPELLING,
+      word,
+      tabId
+    })
+  },
+
+  forgetLearnedSpelling: function (word, tabId) {
+    dispatch({
+      actionType: appConstants.APP_FORGET_LEARNED_SPELLING,
+      word,
+      tabId
+    })
   }
 }
 

js/actions/webviewActions.js

@@ -32,17 +32,6 @@ const webviewActions = {
     }
   },
 
-  /**
-   * Replaces the selected text in an editable
-   * @param {string} text - The text to replace with
-   */
-  replace: function (text) {
-    const webview = getWebview()
-    if (webview) {
-      webview.replaceMisspelling(text)
-    }
-  },
-
   /**
    * Shows the certificate infomation
    */