fix: re-enable the spellchecker when new language list set (electron#26119)

MarshallOfSound · web-flow · commit 9d18f9d54f86 · 2020-10-23T00:34:19.000-07:00
* fix: re-enable the spellchecker when new language list set

Chromium recently added prefs logic to disable the spellchecker if the list of languages is empty, but the logic to re-enable if the languages are provided again lives in another part of Chromium.  This change makes it so our API re-enables the spellchecker correctly when required.

* chore: fix lint
diff --git a/shell/browser/api/electron_api_session.cc b/shell/browser/api/electron_api_session.cc
@@ -957,6 +957,9 @@ void Session::SetSpellCheckerLanguages(
   }
   browser_context_->prefs()->Set(spellcheck::prefs::kSpellCheckDictionaries,
                                  language_codes);
+  // Enable spellcheck if > 0 languages, disable if no languages set
+  browser_context_->prefs()->SetBoolean(spellcheck::prefs::kSpellCheckEnable,
+                                        !languages.empty());
 }
 
 void SetSpellCheckerDictionaryDownloadURL(gin_helper::ErrorThrower thrower,
diff --git a/spec-main/spec-helpers.ts b/spec-main/spec-helpers.ts
@@ -2,9 +2,19 @@ import * as childProcess from 'child_process';
 import * as path from 'path';
 import * as http from 'http';
 import * as v8 from 'v8';
+import { SuiteFunction, TestFunction } from 'mocha';
 
-export const ifit = (condition: boolean) => (condition ? it : it.skip);
-export const ifdescribe = (condition: boolean) => (condition ? describe : describe.skip);
+const addOnly = <T>(fn: Function): T => {
+  const wrapped = (...args: any[]) => {
+    return fn(...args);
+  };
+  (wrapped as any).only = wrapped;
+  (wrapped as any).skip = wrapped;
+  return wrapped as any;
+};
+
+export const ifit = (condition: boolean) => (condition ? it : addOnly<TestFunction>(it.skip));
+export const ifdescribe = (condition: boolean) => (condition ? describe : addOnly<SuiteFunction>(describe.skip));
 
 export const delay = (time: number = 0) => new Promise(resolve => setTimeout(resolve, time));
 
diff --git a/spec-main/spellchecker-spec.ts b/spec-main/spellchecker-spec.ts
@@ -15,9 +15,11 @@ ifdescribe(features.isBuiltinSpellCheckerEnabled())('spellchecker', () => {
     w = new BrowserWindow({
       show: false,
       webPreferences: {
-        nodeIntegration: true
+        nodeIntegration: true,
+        partition: `unique-spell-${Date.now()}`
       }
     });
+    w.webContents.session.setSpellCheckerLanguages(['en-US']);
     await w.loadFile(path.resolve(__dirname, './fixtures/chromium/spellchecker.html'));
   });
 
@@ -65,6 +67,26 @@ ifdescribe(features.isBuiltinSpellCheckerEnabled())('spellchecker', () => {
     expect(contextMenuParams.dictionarySuggestions).to.have.length.of.at.least(1);
   });
 
+  ifit(shouldRun)('should detect incorrectly spelled words as incorrect after disabling all languages and re-enabling', async () => {
+    w.webContents.session.setSpellCheckerLanguages([]);
+    await delay(500);
+    w.webContents.session.setSpellCheckerLanguages(['en-US']);
+    await w.webContents.executeJavaScript('document.body.querySelector("textarea").value = "Beautifulllll asd asd"');
+    await w.webContents.executeJavaScript('document.body.querySelector("textarea").focus()');
+    const contextMenuPromise = emittedOnce(w.webContents, 'context-menu');
+    // Wait for spellchecker to load
+    await delay(500);
+    w.webContents.sendInputEvent({
+      type: 'mouseDown',
+      button: 'right',
+      x: 43,
+      y: 42
+    });
+    const contextMenuParams: Electron.ContextMenuParams = (await contextMenuPromise)[1];
+    expect(contextMenuParams.misspelledWord).to.eq('Beautifulllll');
+    expect(contextMenuParams.dictionarySuggestions).to.have.length.of.at.least(1);
+  });
+
   ifit(shouldRun)('should expose webFrame spellchecker correctly', async () => {
     await w.webContents.executeJavaScript('document.body.querySelector("textarea").value = "Beautifulllll asd asd"');
     await w.webContents.executeJavaScript('document.body.querySelector("textarea").focus()');

Original file line number	Diff line number	Diff line change
`@@ -957,6 +957,9 @@ void Session::SetSpellCheckerLanguages(`
`957`	`957`	`}`
`958`	`958`	`browser_context_->prefs()->Set(spellcheck::prefs::kSpellCheckDictionaries,`
`959`	`959`	`language_codes);`
	`960`	`+ // Enable spellcheck if > 0 languages, disable if no languages set`
	`961`	`+ browser_context_->prefs()->SetBoolean(spellcheck::prefs::kSpellCheckEnable,`
	`962`	`+ !languages.empty());`
`960`	`963`	`}`
`961`	`964`
`962`	`965`	`void SetSpellCheckerDictionaryDownloadURL(gin_helper::ErrorThrower thrower,`