Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
test(chrome-ext): e2e test for the Slate editor (#1281)
Elijah Potter0ee01d634fd4
diff --git a/biome.json b/biome.jsonindex 1d263a748..65aa60d07 100644--- a/biome.json+++ b/biome.json@@ -9,6 +9,7 @@"ignoreUnknown": true,"include": ["packages/**/*", "**/*.json"],"ignore": [+ "test-results","node_modules","dist","target",diff --git a/justfile b/justfileindex 3488907f7..64866c214 100644--- a/justfile+++ b/justfile@@ -13,12 +13,11 @@ build-harperjs: build-wasm#! /bin/bashset -eo pipefail- pnpm install-# Removes a duplicate copy of the WASM binary if Vite is left to its devices.perl -pi -e 's/new URL\(.*\)/new URL()/g' "{{justfile_directory()}}/harper-wasm/pkg/harper_wasm.js"cd "{{justfile_directory()}}/packages/harper.js"+ pnpm installpnpm build# Generate API reference@@ -105,6 +104,15 @@ build-chrome-plugin: build-harperjspnpm installpnpm zip+test-chrome-plugin: build-chrome-plugin+ #!/bin/bash+ set -eo pipefail++ pnpm install+ cd "{{justfile_directory()}}/packages/chrome-plugin"+ pnpm playwright install+ pnpm test+# Run VSCode plugin unit and integration tests.test-vscode:#! /bin/bash@@ -240,7 +248,7 @@ dogfood:done# Test everything.-test: test-vscode test-harperjs test-obsidian+test: test-harperjs test-vscode test-obsidian test-chrome-plugincargo test# Use `harper-cli` to parse a provided file and print out the resulting tokens.diff --git a/packages/chrome-plugin/.gitignore b/packages/chrome-plugin/.gitignoreindex 0a89e485c..38245233b 100644--- a/packages/chrome-plugin/.gitignore+++ b/packages/chrome-plugin/.gitignore@@ -23,3 +23,10 @@secrets.*.jspublic/wasm++# Playwright+node_modules/+/test-results/+/playwright-report/+/blob-report/+/playwright/.cache/diff --git a/packages/chrome-plugin/.prettierignore b/packages/chrome-plugin/.prettierignoredeleted file mode 100644index daa383443..000000000--- a/packages/chrome-plugin/.prettierignore+++ /dev/null@@ -1,6 +0,0 @@-# Ignore artifacts:-build-coverage-node_modules-pnpm-lock.yaml-pnpm-workspace.yamldiff --git a/packages/chrome-plugin/.prettierrc b/packages/chrome-plugin/.prettierrcdeleted file mode 100644index 9e086c3e4..000000000--- a/packages/chrome-plugin/.prettierrc+++ /dev/null@@ -1,10 +0,0 @@-{- "jsxSingleQuote": false,- "singleQuote": true,- "trailingComma": "all",- "endOfLine": "lf",- "printWidth": 100,- "semi": false,- "tabWidth": 2,- "useTabs": false-}diff --git a/packages/chrome-plugin/package.json b/packages/chrome-plugin/package.jsonindex 8d624619b..0416ef1bd 100644--- a/packages/chrome-plugin/package.json+++ b/packages/chrome-plugin/package.json@@ -15,14 +15,17 @@"build": "vite build","preview": "vite preview","fmt": "prettier --write '**/*.{svelte,ts,json,css,scss,md}'",- "zip": "npm run build && node src/zip.js"+ "zip": "npm run build && node src/zip.js",+ "test": "playwright test"},"devDependencies": {"@crxjs/vite-plugin": "^2.0.0-beta.26",+ "@playwright/test": "^1.52.0","@sveltejs/vite-plugin-svelte": "^4.0.0","@types/chrome": "^0.0.246","@types/jquery": "^3.5.32","@types/lodash-es": "^4.17.12",+ "@types/node": "catalog:","@types/virtual-dom": "^2.1.4","flowbite": "^3.1.2","flowbite-svelte": "^0.44.18",diff --git a/packages/chrome-plugin/playwright.config.ts b/packages/chrome-plugin/playwright.config.tsnew file mode 100644index 000000000..cea0e9461--- /dev/null+++ b/packages/chrome-plugin/playwright.config.ts@@ -0,0 +1,29 @@+import { defineConfig, devices } from '@playwright/test';++/**+ * See https://playwright.dev/docs/test-configuration.+ */+export default defineConfig({+ testDir: './tests',+ fullyParallel: true,+ /* Fail the build on CI if you accidentally left test.only in the source code. */+ forbidOnly: !!process.env.CI,+ /* Retry on CI only */+ retries: process.env.CI ? 2 : 0,+ /* Opt out of parallel tests on CI. */+ workers: process.env.CI ? 1 : undefined,+ /* Reporter to use. See https://playwright.dev/docs/test-reporters */+ reporter: 'html',+ use: {+ /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */+ trace: 'on-first-retry',+ },++ /* Configure projects for major browsers */+ projects: [+ {+ name: 'chromium',+ use: { ...devices['Desktop Chrome'] },+ },+ ],+});diff --git a/packages/chrome-plugin/src/Highlights.ts b/packages/chrome-plugin/src/Highlights.tsindex 37f08cff7..79f2d6b8b 100644--- a/packages/chrome-plugin/src/Highlights.ts+++ b/packages/chrome-plugin/src/Highlights.ts@@ -48,17 +48,22 @@ export default class Highlights {this.renderBoxes.set(source, renderBox);}+ const host = renderBox.getShadowHost();+ host.id = 'harper-highlight-host';+const rect = getInitialContainingRect(renderBox.getShadowHost());if (rect != null) {- renderBox.getShadowHost().style.contain = 'layout';- renderBox.getShadowHost().style.position = 'fixed';- renderBox.getShadowHost().style.left = `${-rect.x}px`;- renderBox.getShadowHost().style.top = `${-rect.y}px`;- renderBox.getShadowHost().style.width = '100vw';- renderBox.getShadowHost().style.height = '100vh';- renderBox.getShadowHost().style.zIndex = '100';- renderBox.getShadowHost().style.pointerEvents = 'none';+ const hostStyle = host.style;++ hostStyle.contain = 'layout';+ hostStyle.position = 'fixed';+ hostStyle.left = `${-rect.x}px`;+ hostStyle.top = `${-rect.y}px`;+ hostStyle.width = '100vw';+ hostStyle.height = '100vh';+ hostStyle.zIndex = '100';+ hostStyle.pointerEvents = 'none';}renderBox.render(this.renderTree(boxes));@@ -101,6 +106,7 @@ export default class Highlights {zIndex: 10,borderBottom: `2px solid ${lintKindColor(box.lint.lint_kind)}`,},+ id: 'harper-highlight',},[],);diff --git a/packages/chrome-plugin/src/LintFramework.ts b/packages/chrome-plugin/src/LintFramework.tsindex e0e6bb35b..2e55b40fe 100644--- a/packages/chrome-plugin/src/LintFramework.ts+++ b/packages/chrome-plugin/src/LintFramework.ts@@ -47,8 +47,6 @@ export default class LintFramework {let text: string | null = null;if (!document.contains(target)) {- console.log('Removing target because it has left the document.', target);- console.log(`There are ${this.targets.size} targets left.`);this.targets.delete(target);continue;}diff --git a/packages/chrome-plugin/src/RenderBox.ts b/packages/chrome-plugin/src/RenderBox.tsindex 5129daaa4..22b05711b 100644--- a/packages/chrome-plugin/src/RenderBox.ts+++ b/packages/chrome-plugin/src/RenderBox.ts@@ -22,7 +22,7 @@ export default class RenderBox {public render(node: VNode) {if (!this.virtualRoot || !this.virtualTree) {this.virtualRoot = createElement(node);- const shadow = this.shadowHost.attachShadow({ mode: 'closed' });+ const shadow = this.shadowHost.attachShadow({ mode: 'open' });shadow.appendChild(this.virtualRoot);} else {const patches = diff(this.virtualTree, node);diff --git a/packages/chrome-plugin/tests/fixtures.ts b/packages/chrome-plugin/tests/fixtures.tsnew file mode 100644index 000000000..00c319c64--- /dev/null+++ b/packages/chrome-plugin/tests/fixtures.ts@@ -0,0 +1,30 @@+import path from 'path';+import { type BrowserContext, test as base, chromium } from '@playwright/test';++export const test = base.extend<{+ context: BrowserContext;+ extensionId: string;+}>({+ // biome-ignore lint/correctness/noEmptyPattern: it's by Playwright. Explanation not provided.+ context: async ({}, use) => {+ const pathToExtension = path.join(import.meta.dirname, '../build');+ console.log(`Loading extension from ${pathToExtension}`);+ const context = await chromium.launchPersistentContext('', {+ channel: 'chromium',+ args: [+ `--disable-extensions-except=${pathToExtension}`,+ `--load-extension=${pathToExtension}`,+ ],+ });+ await use(context);+ await context.close();+ },+ extensionId: async ({ context }, use) => {+ let [background] = context.serviceWorkers();+ if (!background) background = await context.waitForEvent('serviceworker');++ const extensionId = background.url().split('/')[2];+ await use(extensionId);+ },+});+export const expect = test.expect;diff --git a/packages/chrome-plugin/tests/slate.spec.ts b/packages/chrome-plugin/tests/slate.spec.tsnew file mode 100644index 000000000..aaef61e71--- /dev/null+++ b/packages/chrome-plugin/tests/slate.spec.ts@@ -0,0 +1,75 @@+import type { Locator, Page } from '@playwright/test';+import { expect, test } from './fixtures';++/** Locates the first Harper highlight on the page and clicks it.+ * It should result in the popup opening.+ * Returns whether the highlight was found. */+async function clickHarperHighlight(page: Page): Promise<boolean> {+ const highlight = page.locator('#harper-highlight');++ if ((await highlight.count()) == 0) {+ return false;+ }++ const box = await highlight.boundingBox();++ if (box == null) {+ return false;+ }++ // Locate the center of the element.+ const cx = box.x + box.width / 2;+ const cy = box.y + box.height / 2;++ await page.mouse.click(cx, cy);+ return true;+}++function getSlateEditor(page: Page): Locator {+ return page.locator('[data-slate-editor="true"]');+}++async function replaceSlateContent(page: Page, text: string) {+ const slateEditor = getSlateEditor(page);++ await slateEditor.selectText();+ await slateEditor.press('Backspace');+ await slateEditor.pressSequentially(text);+}++test('Can apply basic suggestion.', async ({ page }) => {+ await page.goto('https://slatejs.org');++ await replaceSlateContent(page, 'This is an test');++ await page.waitForTimeout(3000);++ await clickHarperHighlight(page);+ await page.getByTitle('Replace with "a"').click();++ await page.waitForTimeout(3000);++ const slateEditor = getSlateEditor(page);+ expect(slateEditor).toContainText('This is a test');++ // Slate has be known to revert changes after typing some more.+ await slateEditor.pressSequentially(" of Harper's grammar checking.");+ expect(slateEditor).toContainText("This is a test of Harper's grammar checking.");+});++test('Can ignore suggestion.', async ({ page }) => {+ await page.goto('https://slatejs.org');++ await replaceSlateContent(page, 'This is an test.');++ await page.waitForTimeout(3000);++ await clickHarperHighlight(page);+ await page.getByTitle('Ignore this lint').click();++ await page.waitForTimeout(3000);++ // Nothing should change.+ expect(getSlateEditor(page)).toContainText('This is an test');+ expect(await clickHarperHighlight(page)).toBe(false);+});diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 701782dac..d59cc3a6f 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -68,6 +68,9 @@ importers:'@crxjs/vite-plugin':specifier: ^2.0.0-beta.26version: 2.0.0-beta.32+ '@playwright/test':+ specifier: ^1.52.0+ version: 1.52.0'@sveltejs/vite-plugin-svelte':specifier: ^4.0.0version: 4.0.4([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected]))@@ -80,6 +83,9 @@ importers:'@types/lodash-es':specifier: ^4.17.12version: 4.17.12+ '@types/node':+ specifier: 'catalog:'+ version: 22.13.10'@types/virtual-dom':specifier: ^2.1.4version: 2.1.4@@ -133,7 +139,7 @@ importers:version: 7.52.1(@types/[email protected])'@vitest/browser':specifier: ^3.0.6- version: 3.0.8(@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])+ version: 3.0.8(@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])harper-wasm:specifier: workspace:*version: link:../../harper-wasm/pkg@@ -145,7 +151,7 @@ importers:version: 7.1.1playwright:specifier: ^1.49.1- version: 1.51.0+ version: 1.52.0type-fest:specifier: ^4.37.0version: 4.37.0@@ -227,7 +233,7 @@ importers:version: 4.17.12'@vitest/browser':specifier: ^3.0.6- version: 3.0.8(@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])+ version: 3.0.8(@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])obsidian:specifier: ^1.7.2version: 1.8.7(@codemirror/[email protected])(@codemirror/[email protected])@@ -386,7 +392,7 @@ importers:devDependencies:'@wordpress/scripts':specifier: ^30.9.0- version: 30.13.0(@playwright/[email protected])(@types/[email protected])(@types/[email protected])(@types/[email protected])([email protected])([email protected]([email protected]))([email protected])([email protected])([email protected])+ version: 30.13.0(@playwright/[email protected])(@types/[email protected])(@types/[email protected])(@types/[email protected])([email protected])([email protected]([email protected]))([email protected])([email protected])([email protected])'@wp-now/wp-now':specifier: ^0.1.74version: 0.1.74@@ -2251,8 +2257,8 @@ packages:resolution: {integrity: sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA==}engines: {node: ^12.20.0 || ^14.18.0 || >=16.0.0}- '@playwright/[email protected]':- resolution: {integrity: sha512-dJ0dMbZeHhI+wb77+ljx/FeC8VBP6j/rj9OAojO08JI80wTZy6vRk9KvHKiDCUh4iMpEiseMgqRBIeW+eKX6RA==}+ '@playwright/[email protected]':+ resolution: {integrity: sha512-uh6W7sb55hl7D6vsAeA+V2p5JnlAqzhqFyF0VcJkKZXkgnFcVG9PziERRHQfPLfNGx1C292a4JqbWzhR8L4R1g==}engines: {node: '>=18'}hasBin: true@@ -8646,13 +8652,13 @@ packages:resolution: {integrity: sha512-wmJwA+8ihJixSoHKxZJRBQG1oY8Yr9pGLzRmSsNms0iNWyHHAlZCa7mmKiFR10YPZuz/2k169JiS/inOjBCZ2A==}- resolution: {integrity: sha512-x47yPE3Zwhlil7wlNU/iktF7t2r/URR3VLbH6EknJd/04Qc/PSJ0EY3CMXipmglLG+zyRxW6HNo2EGbKLHPWMg==}+ resolution: {integrity: sha512-l2osTgLXSMeuLZOML9qYODUQoPPnUsKsb5/P6LJ2e6uPKXUdPK5WYhN4z03G+YNbWmGDY4YENauNu4ZKczreHg==}engines: {node: '>=18'}hasBin: true- resolution: {integrity: sha512-442pTfGM0xxfCYxuBa/Pu6B2OqxqqaYq39JS8QDMGThUvIOCd6s0ANDog3uwA0cHavVlnTQzGCN7Id2YekDSXA==}+ resolution: {integrity: sha512-JAwMNMBlxJ2oD1kce4KPtMkDeKGHQstdpFPcPH3maElAXon/QZeTvtsfXmTMRyO9TslfoYOXkSsvao2nE1ilTw==}engines: {node: '>=18'}hasBin: true@@ -13998,9 +14004,9 @@ snapshots:'@pkgr/[email protected]': {}- '@playwright/[email protected]':+ '@playwright/[email protected]':dependencies:- playwright: 1.51.0+ playwright: 1.52.0'@pmmmwh/[email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])':dependencies:@@ -15557,7 +15563,7 @@ snapshots:tinyglobby: 0.2.12vite-plugin-pwa: 0.21.1([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected](@types/[email protected]))([email protected])- '@vitest/[email protected](@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])':+ '@vitest/[email protected](@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])':dependencies:'@testing-library/user-event': 14.6.1(@testing-library/[email protected])'@vitest/mocker': 3.0.8([email protected](@types/[email protected])([email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))@@ -15569,7 +15575,7 @@ snapshots:vitest: 3.0.8(@types/[email protected])(@types/[email protected])(@vitest/[email protected])([email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected]))([email protected])([email protected])([email protected])([email protected])ws: 8.18.1optionalDependencies:- playwright: 1.51.0+ playwright: 1.52.0transitivePeerDependencies:- '@testing-library/dom'- '@types/node'@@ -16261,9 +16267,9 @@ snapshots:'@babel/runtime': 7.25.7'@wordpress/deprecated': 4.20.0- '@wordpress/[email protected](@playwright/[email protected])':+ '@wordpress/[email protected](@playwright/[email protected])':dependencies:- '@playwright/test': 1.51.0+ '@playwright/test': 1.52.0change-case: 4.1.2form-data: 4.0.2get-port: 5.1.1@@ -16742,16 +16748,16 @@ snapshots:react: 18.3.1route-recognizer: 0.3.4- '@wordpress/[email protected](@playwright/[email protected])(@types/[email protected])(@types/[email protected])(@types/[email protected])([email protected])([email protected]([email protected]))([email protected])([email protected])([email protected])':+ '@wordpress/[email protected](@playwright/[email protected])(@types/[email protected])(@types/[email protected])(@types/[email protected])([email protected])([email protected]([email protected]))([email protected])([email protected])([email protected])':dependencies:'@babel/core': 7.25.7- '@playwright/test': 1.51.0+ '@playwright/test': 1.52.0'@pmmmwh/react-refresh-webpack-plugin': 0.5.15(@types/[email protected])([email protected])([email protected])([email protected])([email protected])'@svgr/webpack': 8.1.0([email protected])'@wordpress/babel-preset-default': 8.20.0'@wordpress/browserslist-config': 6.20.0'@wordpress/dependency-extraction-webpack-plugin': 6.20.0([email protected])- '@wordpress/e2e-test-utils-playwright': 1.20.0(@playwright/[email protected])+ '@wordpress/e2e-test-utils-playwright': 1.20.0(@playwright/[email protected])'@wordpress/eslint-plugin': 22.6.0(@babel/[email protected])(@types/[email protected])([email protected])([email protected](@types/[email protected])([email protected]))([email protected])([email protected])'@wordpress/jest-preset-default': 12.20.0(@babel/[email protected])([email protected](@types/[email protected])([email protected]))'@wordpress/npm-package-json-lint-config': 5.20.0([email protected]([email protected]))@@ -22288,11 +22294,11 @@ snapshots:exsolve: 1.0.4pathe: 2.0.3- [email protected]: {}+ [email protected]: {}dependencies:- playwright-core: 1.51.0+ playwright-core: 1.52.0optionalDependencies:fsevents: 2.3.2@@ -24734,7 +24740,7 @@ snapshots:optionalDependencies:'@types/debug': 4.1.12'@types/node': 22.13.10- '@vitest/browser': 3.0.8(@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])+ '@vitest/browser': 3.0.8(@testing-library/[email protected])(@types/[email protected])([email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])jsdom: 20.0.3transitivePeerDependencies:- jiti