Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
fix(chrome-ext): Applying suggestions breaks cursor/keyboard in Draft.js and Slate editors (#2495)
David Raphi686adaf55e08
diff --git a/packages/chrome-plugin/src/background/index.ts b/packages/chrome-plugin/src/background/index.tsindex ac071d442..7ed326d46 100644--- a/packages/chrome-plugin/src/background/index.ts+++ b/packages/chrome-plugin/src/background/index.ts@@ -5,7 +5,6 @@ import {ActivationKey,type AddToUserDictionaryRequest,createUnitResponse,- type GetActivationKeyRequest,type GetActivationKeyResponse,type GetConfigRequest,type GetConfigResponse,diff --git a/packages/chrome-plugin/tests/draft.spec.ts b/packages/chrome-plugin/tests/draft.spec.tsnew file mode 100644index 000000000..178268668--- /dev/null+++ b/packages/chrome-plugin/tests/draft.spec.ts@@ -0,0 +1,63 @@+import { expect, test } from './fixtures';+import {+ clickHarperHighlight,+ getDraftEditor,+ getHarperHighlights,+ randomString,+ replaceEditorContent,+} from './testUtils';++const TEST_PAGE_URL = 'https://draftjs.org/';++test('Can apply basic suggestion.', async ({ page }) => {+ await page.goto(TEST_PAGE_URL);++ const draft = getDraftEditor(page);+ await draft.scrollIntoViewIfNeeded();+ await draft.click();+ await replaceEditorContent(draft, 'This is an test');++ await page.waitForTimeout(3000);++ await clickHarperHighlight(page);+ await page.getByTitle('Replace with "a"').click();++ await page.waitForTimeout(3000);++ expect(draft).toContainText('This is a test');++ // Verify editor state is preserved: arrow keys and backspace must work.+ // Position cursor before 's' in 'test', then backspace to delete 'e'.+ await draft.press('End');+ await draft.press('ArrowLeft');+ await draft.press('ArrowLeft');+ await draft.press('Backspace');+ expect(draft).toContainText('This is a tst');++ // Verify typing still works.+ await draft.pressSequentially('e');+ expect(draft).toContainText('This is a test');+});++test('Can ignore suggestion.', async ({ page }) => {+ await page.goto(TEST_PAGE_URL);+ const draft = getDraftEditor(page);++ await draft.scrollIntoViewIfNeeded();+ await draft.click();++ const cacheSalt = randomString(5);+ await replaceEditorContent(draft, cacheSalt);++ await page.waitForTimeout(3000);++ const opened = await clickHarperHighlight(page);+ expect(opened).toBe(true);+ await page.getByTitle('Ignore this lint').click();++ await expect(getHarperHighlights(page)).toHaveCount(0);++ // Nothing should change.+ expect(draft).toContainText(cacheSalt);+ expect(await clickHarperHighlight(page)).toBe(false);+});diff --git a/packages/chrome-plugin/tests/nested_elements.spec.ts b/packages/chrome-plugin/tests/nested_elements.spec.tsindex 3916ce3f5..dd672814b 100644--- a/packages/chrome-plugin/tests/nested_elements.spec.ts+++ b/packages/chrome-plugin/tests/nested_elements.spec.ts@@ -3,7 +3,7 @@ import { assertHarperHighlightBoxes, getTextarea, replaceEditorContent } from '.const TEST_PAGE_URL = 'http://localhost:8081/nested_elements.html';-test('Positions properly in oddly nested page.', async ({ page }, testInfo) => {+test('Positions properly in oddly nested page.', async ({ page }, _testInfo) => {await page.goto(TEST_PAGE_URL);const editor = getTextarea(page);diff --git a/packages/chrome-plugin/tests/slate.spec.ts b/packages/chrome-plugin/tests/slate.spec.tsindex d5587c8e9..b06377e4a 100644--- a/packages/chrome-plugin/tests/slate.spec.ts+++ b/packages/chrome-plugin/tests/slate.spec.ts@@ -24,10 +24,17 @@ test('Can apply basic suggestion.', async ({ page }) => {expect(slate).toContainText('This is a test');- // Slate has be known to revert changes after typing some more.+ // Verify editor state is preserved: arrow keys and backspace must work.+ // Position cursor before 's' in 'test', then backspace to delete 'e'.await slate.press('End');- await slate.pressSequentially(" of Harper's grammar checking.");- expect(slate).toContainText("This is a test of Harper's grammar checking.");+ await slate.press('ArrowLeft');+ await slate.press('ArrowLeft');+ await slate.press('Backspace');+ expect(slate).toContainText('This is a tst');++ // Verify typing still works.+ await slate.pressSequentially('e');+ expect(slate).toContainText('This is a test');});test('Can ignore suggestion.', async ({ page }) => {diff --git a/packages/chrome-plugin/tests/testUtils.ts b/packages/chrome-plugin/tests/testUtils.tsindex 7c9b895aa..7a240a1f6 100644--- a/packages/chrome-plugin/tests/testUtils.ts+++ b/packages/chrome-plugin/tests/testUtils.ts@@ -26,6 +26,11 @@ export function getProseMirrorEditor(page: Page): Locator {return page.locator('.ProseMirror');}+/** Locate the Draft.js editor on the page (targets #rich-example on draftjs.org). */+export function getDraftEditor(page: Page): Locator {+ return page.locator('#rich-example .public-DraftEditor-content');+}+/** Replace the content of a text editor. */export async function replaceEditorContent(editorEl: Locator, text: string) {await editorEl.selectText();diff --git a/packages/lint-framework/src/lint/computeLintBoxes.ts b/packages/lint-framework/src/lint/computeLintBoxes.tsindex 4ea907dd2..1c7d78747 100644--- a/packages/lint-framework/src/lint/computeLintBoxes.ts+++ b/packages/lint-framework/src/lint/computeLintBoxes.ts@@ -1,20 +1,16 @@import type { Span } from 'harper.js';import { domRectToBox, type IgnorableLintBox, isBottomEdgeInBox, shrinkBoxToFit } from './Box';import { getRangeForTextSpan } from './domUtils';-import { getCkEditorRoot, getLexicalRoot, getSlateRoot } from './editorUtils';+import {+ getCkEditorRoot,+ getDraftRoot,+ getLexicalRoot,+ getSlateRoot,+ isFormEl,+} from './editorUtils';import TextFieldRange from './TextFieldRange';import { applySuggestion, type UnpackedLint, type UnpackedSuggestion } from './unpackLint';-function isFormEl(el: HTMLElement): el is HTMLTextAreaElement | HTMLInputElement {- switch (el.tagName) {- case 'TEXTAREA':- case 'INPUT':- return true;- default:- return false;- }-}-export default function computeLintBoxes(el: HTMLElement,lint: UnpackedLint,@@ -74,7 +70,8 @@ export default function computeLintBoxes(const current = isFormEl(el)? (el as HTMLInputElement | HTMLTextAreaElement).value: (el.textContent ?? '');- replaceValue(el, applySuggestion(current, lint.span, sug));+ const newValue = applySuggestion(current, lint.span, sug);+ replaceValue(el, newValue, lint.span, sug.replacement_text);},ignoreLint: opts.ignoreLint ? () => opts.ignoreLint!(lint.context_hash) : undefined,});@@ -86,15 +83,22 @@ export default function computeLintBoxes(}}-function replaceValue(el: HTMLElement, value: string) {+function replaceValue(+ el: HTMLElement,+ value: string,+ span?: { start: number; end: number },+ replacementText?: string,+) {if (isFormEl(el)) {replaceFormElementValue(el as HTMLTextAreaElement | HTMLInputElement, value);} else if (getLexicalRoot(el) != null) {- replaceRichTextValue(el, value, { mode: 'lexical' });- } else if (getSlateRoot(el) != null) {- replaceRichTextValue(el, value, { mode: 'slate' });- } else if (getCkEditorRoot(el) != null) {- replaceRichTextValue(el, value, { mode: 'slate' });+ replaceLexicalValue(el, value);+ } else if (getSlateRoot(el) != null && span && replacementText !== undefined) {+ replaceSlateValue(el, span, replacementText);+ } else if (getCkEditorRoot(el) != null && span && replacementText !== undefined) {+ replaceSlateValue(el, span, replacementText);+ } else if (getDraftRoot(el) != null && span && replacementText !== undefined) {+ replaceDraftJsValue(el, span, replacementText);} else {replaceGenericContentEditable(el, value);}@@ -108,84 +112,121 @@ function replaceFormElementValue(el: HTMLTextAreaElement | HTMLInputElement, valel.dispatchEvent(new InputEvent('input', { bubbles: true }));}-function replaceRichTextValue(el: HTMLElement, value: string, opts: { mode: 'lexical' | 'slate' }) {- specialSelectAllText(el);- specialInsertText(el, value, opts);-}--function replaceGenericContentEditable(el: HTMLElement, value: string) {- el.textContent = value;- el.dispatchEvent(new InputEvent('beforeinput', { bubbles: true, data: value }));- el.dispatchEvent(new InputEvent('input', { bubbles: true }));-}--function specialSelectAllText(target: Node): Range {- const range = target.ownerDocument!.createRange();- if (target.nodeType === Node.TEXT_NODE) {- const len = (target as Text).data.length;- range.setStart(target, 0);- range.setEnd(target, len);+function replaceLexicalValue(el: HTMLElement, value: string) {+ // Select all text+ const range = el.ownerDocument!.createRange();+ if (el.nodeType === Node.TEXT_NODE) {+ const len = (el as unknown as Text).data.length;+ range.setStart(el, 0);+ range.setEnd(el, len);} else {- range.selectNodeContents(target);+ range.selectNodeContents(el);}- const sel = target.ownerDocument!.defaultView!.getSelection();+ const sel = el.ownerDocument!.defaultView!.getSelection();sel?.removeAllRanges();sel?.addRange(range);- return range;-}--function getEditorText(el: HTMLElement): string {- const text = el.textContent ?? '';- return normalizeEditorText(text);-}--function normalizeEditorText(text: string): string {- return text.replace(/\u200b/g, '').replace(/[\n\r]+$/g, '');-}--function specialInsertText(- el: HTMLElement,- raw: string,- opts: { mode: 'lexical' | 'slate' },-): void {- const inputType = 'insertText';+ // Insert new textconst evInit: InputEventInit = {bubbles: true,cancelable: true,- inputType,- data: raw,+ inputType: 'insertText',+ data: value,};if ('StaticRange' in self && 'getTargetRanges' in InputEvent.prototype) {- const sel = el.ownerDocument.defaultView!.getSelection();if (sel?.rangeCount) evInit.targetRanges = [new StaticRange(sel.getRangeAt(0))];}- const beforeEvt = new InputEvent('beforeinput', evInit);- const biSuccess = el.dispatchEvent(beforeEvt);- if (getEditorText(el) === raw) {+ el.dispatchEvent(new InputEvent('beforeinput', evInit));+ if (getEditorText(el) === value) {return;}- const textEvt = new InputEvent('textInput', evInit);- const teSuccess = el.dispatchEvent(textEvt);- if (getEditorText(el) === raw) {+ el.dispatchEvent(new InputEvent('textInput', evInit));+ if (getEditorText(el) === value) {return;}- const finalize = () => {- if (getEditorText(el) !== raw) {- el.textContent = raw;+ setTimeout(() => {+ if (getEditorText(el) !== value) {+ el.textContent = value;}+ }, 0);+}++function selectSpanInEditor(el: HTMLElement, span: { start: number; end: number }) {+ const doc = el.ownerDocument;+ const sel = doc.defaultView?.getSelection();++ if (!sel) {+ return null;+ }++ el.focus();++ const range = getRangeForTextSpan(el, span as Span);+ if (!range) {+ return null;+ }++ sel.removeAllRanges();+ sel.addRange(range);++ return { doc, range };+}++function replaceDraftJsValue(+ el: HTMLElement,+ span: { start: number; end: number },+ replacementText: string,+) {+ const setup = selectSpanInEditor(el, span);+ if (!setup) return;++ setup.doc.execCommand('insertText', false, replacementText);+}++function replaceSlateValue(+ el: HTMLElement,+ span: { start: number; end: number },+ replacementText: string,+) {+ const setup = selectSpanInEditor(el, span);+ if (!setup) return;++ const { doc, range } = setup;++ const evInit: InputEventInit = {+ bubbles: true,+ cancelable: true,+ inputType: 'insertText',+ data: replacementText,};- const shouldRunExecCommand = opts.mode !== 'lexical' && (!biSuccess || !teSuccess);- if (shouldRunExecCommand) {- el.ownerDocument.execCommand(inputType, false, raw);- finalize();- return;+ if ('StaticRange' in self) {+ evInit.targetRanges = [new StaticRange(range)];+ }++ const beforeEvt = new InputEvent('beforeinput', evInit);+ el.dispatchEvent(beforeEvt);++ if (!beforeEvt.defaultPrevented) {+ doc.execCommand('insertText', false, replacementText);}+}++function replaceGenericContentEditable(el: HTMLElement, value: string) {+ el.textContent = value;+ el.dispatchEvent(new InputEvent('beforeinput', { bubbles: true, data: value }));+ el.dispatchEvent(new InputEvent('input', { bubbles: true }));+}++function getEditorText(el: HTMLElement): string {+ const text = el.textContent ?? '';+ return normalizeEditorText(text);+}- setTimeout(finalize, 0);+function normalizeEditorText(text: string): string {+ return text.replace(/\u200b/g, '').replace(/[\n\r]+$/g, '');}diff --git a/packages/vscode-plugin/src/tests/suite/helper.ts b/packages/vscode-plugin/src/tests/suite/helper.tsindex a25874dcf..00ece08ab 100644--- a/packages/vscode-plugin/src/tests/suite/helper.ts+++ b/packages/vscode-plugin/src/tests/suite/helper.ts@@ -44,7 +44,7 @@ export async function openUntitled(text: string): Promise<Uri> {export async function setTextDocumentLanguage(uri: Uri, languageId: string): Promise<void> {const document = await workspace.openTextDocument(uri);- languages.setTextDocumentLanguage(document, languageId);+ await languages.setTextDocumentLanguage(document, languageId);}export function createExpectedDiagnostics(