scrabble-solver 2.17.0 → 2.18.0

package/e2e/features/solver-paths.spec.ts

@@ -0,0 +1,45 @@
+import { expect, type Page, test } from '@playwright/test';
+
+import * as Lib from '../lib';
+
+test.describe('Solver paths', () => {
+  test('solves through the server when no dictionary is available locally', async ({ page }) => {
+    await page.route('**/api/dictionary/*', (route) => route.fulfill({ status: 503 }));
+    const solveResponse = page.waitForResponse('**/api/solve');
+    await Lib.visitIndex(page);
+    await Lib.typeBoard(page, 'i', 'horizontal', { x: 7, y: 7 });
+    await Lib.typeRack(page, 'q');
+    await Lib.solve(page);
+    await solveResponse;
+
+    await expect(Lib.getResults(page)).toHaveCount(2);
+    await Lib.assertResult(page, 0, 'qi', 11);
+  });
+
+  test('solves locally once the dictionary is cached', async ({ page }) => {
+    await Lib.visitIndex(page);
+    await waitForCachedDictionary(page);
+
+    let solveRequestCount = 0;
+    await page.route('**/api/solve', (route) => {
+      solveRequestCount += 1;
+      return route.continue();
+    });
+    await Lib.typeBoard(page, 'i', 'horizontal', { x: 7, y: 7 });
+    await Lib.typeRack(page, 'q');
+    await Lib.solve(page);
+
+    await expect(Lib.getResults(page)).toHaveCount(2);
+    await Lib.assertResult(page, 0, 'qi', 11);
+    expect(solveRequestCount).toBe(0);
+  });
+});
+
+function waitForCachedDictionary(page: Page): Promise<void> {
+  return expect.poll(() => page.evaluate(isDictionaryCached), { timeout: 30000 }).toBe(true);
+}
+
+async function isDictionaryCached(): Promise<boolean> {
+  const cache = await caches.open('dictionary-api-cache');
+  return typeof (await cache.match('/api/dictionary/en-US')) !== 'undefined';
+}

package/e2e/lib/actions.ts

@@ -0,0 +1,119 @@
+import { expect, type Locator, type Page } from '@playwright/test';
+import { type Direction } from '@scrabble-solver/types';
+
+import {
+  getBoardTile,
+  getLoading,
+  getModal,
+  getOpenModal,
+  getRackTile,
+  getResult,
+  getResultsContainer,
+} from './selectors';
+
+interface BoardPosition {
+  x?: number;
+  y?: number;
+}
+
+export async function visitIndex(page: Page): Promise<void> {
+  await page.goto('/');
+}
+
+export async function closeModal(page: Page): Promise<void> {
+  await expect(getOpenModal(page)).toBeVisible();
+  await page.keyboard.press('Escape');
+  await expect(getModal(page)).toHaveCount(0);
+}
+
+export async function typeRack(page: Page, tiles: string, index = 0): Promise<void> {
+  await getRackTile(page, index).focus();
+  await page.keyboard.type(tiles);
+}
+
+export async function typeBoard(
+  page: Page,
+  tiles: string,
+  direction: Direction,
+  { x = 0, y = 0 }: BoardPosition = {},
+): Promise<void> {
+  await getBoardTile(page, x, y).focus();
+  await ensureDirection(page, direction);
+
+  for (let index = 0; index < tiles.length; ++index) {
+    const xOffset = direction === 'horizontal' ? index : 0;
+    const yOffset = direction === 'vertical' ? index : 0;
+
+    await getBoardTile(page, x + xOffset, y + yOffset).focus();
+    await page.keyboard.type(tiles[index]);
+  }
+}
+
+export async function paste(target: Locator, text: string): Promise<void> {
+  await target.focus();
+  await target.evaluate((element, value) => {
+    const pasteEvent = new ClipboardEvent('paste', {
+      bubbles: true,
+      clipboardData: new DataTransfer(),
+    });
+
+    pasteEvent.clipboardData?.setData('text/plain', value);
+    element.dispatchEvent(pasteEvent);
+  }, text);
+}
+
+export async function pasteBoard(
+  page: Page,
+  word: string,
+  direction: Direction,
+  { x = 0, y = 0 }: BoardPosition = {},
+): Promise<void> {
+  await getBoardTile(page, x, y).focus();
+  await ensureDirection(page, direction);
+  await paste(getBoardTile(page, x, y), word);
+}
+
+export async function solve(page: Page): Promise<void> {
+  await getRackTile(page).evaluate((input: HTMLInputElement) => input.form?.requestSubmit());
+  await expect(getResultsContainer(page)).toHaveAttribute('data-outdated', 'false', { timeout: 90_000 });
+  await expect(getLoading(page)).toHaveCount(0);
+}
+
+/**
+ * react-window remounts rows during its initial measure pass, and a row
+ * replaced under an already-hovered cursor never receives a new mouseenter -
+ * let the list settle before hovering.
+ */
+export async function hoverResult(page: Page, index = 0): Promise<void> {
+  await page.waitForTimeout(100);
+  await getResult(page, index).hover();
+}
+
+export async function assertResult(page: Page, index: number, word: string, points: number): Promise<void> {
+  const result = getResult(page, index);
+
+  await expect(result).toHaveAttribute('aria-label', word);
+  await expect(result).toContainText(word);
+  await expect(result.getByTestId('points')).toHaveText(String(points));
+}
+
+export async function expectTileHighlighted(tile: Locator): Promise<void> {
+  await expect(tile.locator('..')).toHaveAttribute('role', 'mark');
+}
+
+export async function expectTileNotHighlighted(tile: Locator): Promise<void> {
+  await expect(tile.locator('..')).not.toHaveAttribute('role', 'mark');
+}
+
+export async function moveMouseAway(page: Page): Promise<void> {
+  const viewport = page.viewportSize();
+  await page.mouse.move((viewport?.width ?? 0) / 2, 0);
+}
+
+async function ensureDirection(page: Page, direction: Direction): Promise<void> {
+  const toggleDirectionButton = page.getByTestId('toggle-direction-button');
+
+  if ((await toggleDirectionButton.getAttribute('data-direction')) !== direction) {
+    await toggleDirectionButton.click();
+  }
+}

package/e2e/lib/selectors.ts

@@ -0,0 +1,71 @@
+import { type Locator, type Page } from '@playwright/test';
+
+export function getModal(page: Page): Locator {
+  return page.getByRole('dialog');
+}
+
+export function getOpenModal(page: Page): Locator {
+  return page.locator('.ReactModal__Overlay--after-open').getByRole('dialog');
+}
+
+export function getBoardContainer(page: Page): Locator {
+  return page.getByTestId('board');
+}
+
+export function getBoardTile(page: Page, x = 0, y = 0, boardWidth = 15): Locator {
+  const index = y * boardWidth + x;
+  return getBoardContainer(page).getByRole('textbox', { includeHidden: true }).nth(index);
+}
+
+export function getDictionary(page: Page): Locator {
+  return page.getByTestId('dictionary');
+}
+
+export function getDictionaryInput(page: Page): Locator {
+  return getDictionary(page).getByRole('textbox');
+}
+
+export function getDictionaryTitles(page: Page): Locator {
+  return getDictionary(page).locator('h2');
+}
+
+export function getLoading(page: Page): Locator {
+  return page.getByTestId('loading');
+}
+
+export function getRackContainer(page: Page): Locator {
+  return page.getByTestId('rack');
+}
+
+export function getRackTile(page: Page, index = 0): Locator {
+  // includeHidden: true so that rack can be interacted with while modal is opened
+  return getRackContainer(page).getByRole('textbox', { includeHidden: true }).nth(index);
+}
+
+export function getResultsContainer(page: Page): Locator {
+  return page.getByTestId('results');
+}
+
+export function getResults(page: Page): Locator {
+  return getResultsContainer(page).getByTestId('result');
+}
+
+export function getResultsFilterInput(page: Page): Locator {
+  return getResultsContainer(page).getByRole('textbox');
+}
+
+export function getResult(page: Page, index = 0): Locator {
+  return getResults(page).nth(index);
+}
+
+export function getSettingsButton(page: Page): Locator {
+  return page.getByTestId('settings-button');
+}
+
+export function getSettingOption(page: Page, section: string, option: string): Locator {
+  return getOpenModal(page).getByLabel(section, { exact: true }).getByLabel(option, { exact: true });
+}
+
+export function getTooltip(page: Page): Locator {
+  return page.getByRole('tooltip');
+}

package/e2e/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.json",
+
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node"]
+  },
+  "include": ["../playwright.config.ts", "./**/*.ts"],
+  "exclude": []
+}

package/lerna.json

@@ -6,6 +6,6 @@
     "access": "public"
   },
   "tagVersionPrefix": "",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scrabble-solver",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Scrabble Solver 2 - Free, open-source, cross-platform, multi-language analysis tool for Scrabble, Scrabble Duel, Super Scrabble, Letter League, Crossplay, Literaki, and Kelimelik. Quickly find the top-scoring words using the given board and tiles.",
   "keywords": [
     "Scrabble",
@@ -53,18 +53,20 @@
     "dev": "bun run --filter @scrabble-solver/scrabble-solver dev",
     "format": "oxfmt --check './**/*.{js,ts,tsx,scss}'",
     "format:fix": "oxfmt './**/*.{js,ts,tsx,scss}'",
-    "lint": "oxlint cypress packages",
+    "lint": "oxlint e2e packages",
     "lint:fix": "bun run lint --fix",
     "reinstall": "bun run clean && bun install && bun run build",
     "release": "bun run release:prepare && bun run release:publish",
     "release:prepare": "bun run reinstall",
     "release:publish": "bun run version:bump && np --no-cleanup --package-manager bun && lerna publish from-package --yes",
+    "screencast": "start-server-and-test start:app http://localhost:3333 screencast:record",
+    "screencast:record": "bun scripts/record-screencast.ts",
     "start": "concurrently -n w: bun:start:*",
     "start:app": "bun run --cwd packages/scrabble-solver start",
     "start:browser": "wait-on http://localhost:3333 && open-cli http://localhost:3333",
-    "test": "bun run build && bun run test-unit && start-server-and-test start:app http://localhost:3333 test-cypress:run",
-    "test-cypress": "cypress open",
-    "test-cypress:run": "CYPRESS_BASE_URL=http://localhost:3333 cypress run",
+    "test": "bun run build && bun run test-unit && start-server-and-test start:app http://localhost:3333 test-playwright:run",
+    "test-playwright": "playwright test --ui",
+    "test-playwright:run": "PLAYWRIGHT_BASE_URL=http://localhost:3333 playwright test",
     "test-unit": "bun run --filter '*' test",
     "version:bump": "bun run version:bump-lerna && bun run version:commit",
     "version:bump-lerna": "lerna version --force-publish --no-git-tag-version --no-push",
@@ -96,28 +98,23 @@
     "packages/scrabble-solver"
   ],
   "dependencies": {
-    "@scrabble-solver/scrabble-solver": "^2.17.0",
-    "concurrently": "^10.0.4",
+    "@scrabble-solver/scrabble-solver": "^2.18.0",
+    "concurrently": "^10.0.5",
     "open-cli": "^9.0.0",
     "wait-on": "^9.1.0"
   },
   "devDependencies": {
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@cypress/webpack-batteries-included-preprocessor": "^4.2.0",
-    "@cypress/webpack-preprocessor": "^7.1.1",
-    "@testing-library/cypress": "^10.1.3",
+    "@playwright/test": "^1.62.1",
     "@types/bun": "^1.3.14",
-    "@types/node": "^26.1.2",
-    "cypress": "^15.20.0",
-    "cypress-real-events": "^1.15.0",
+    "@types/node": "^26.2.0",
     "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-mocha": "^12.0.2",
+    "eslint-plugin-playwright": "^2.11.0",
     "eslint-plugin-react": "^7.37.5",
     "lerna": "^10.0.0",
     "np": "^12.0.1",
-    "oxfmt": "^0.62.0",
-    "oxlint": "^1.77.0",
+    "oxfmt": "^0.63.0",
+    "oxlint": "^1.78.0",
     "oxlint-tsgolint": "^7.0.2001",
     "rimraf": "^6.1.3",
     "start-server-and-test": "^3.0.12",

package/packages/configs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/configs",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Scrabble Solver 2 - Configs",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -23,8 +23,8 @@
     "clean": "rimraf build/"
   },
   "dependencies": {
-    "@scrabble-solver/constants": "^2.17.0",
-    "@scrabble-solver/types": "^2.17.0"
+    "@scrabble-solver/constants": "^2.18.0",
+    "@scrabble-solver/types": "^2.18.0"
   },
   "gitHead": "1e2d1ad49a288d4a44196d8e3336740da132c637"
 }

package/packages/constants/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/constants",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Scrabble Solver 2 - Constants",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/packages/dictionaries/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/dictionaries",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Scrabble Solver 2 - Dictionaries",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -31,9 +31,9 @@
   },
   "dependencies": {
     "@kamilmielnik/gaddag": "^2.0.0",
-    "@scrabble-solver/logger": "^2.17.0",
-    "@scrabble-solver/types": "^2.17.0",
-    "@scrabble-solver/word-lists": "^2.17.0"
+    "@scrabble-solver/logger": "^2.18.0",
+    "@scrabble-solver/types": "^2.18.0",
+    "@scrabble-solver/word-lists": "^2.18.0"
   },
   "gitHead": "1e2d1ad49a288d4a44196d8e3336740da132c637"
 }

package/packages/logger/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrabble-solver/logger",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Scrabble Solver 2 - Logger",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/packages/scrabble-solver/.next/BUILD_ID

@@ -1 +1 @@
-OLE8_ZInlGH7ENU0NIOpf
+FL82obwzFHRzvV6z76I-U

package/packages/scrabble-solver/.next/build-manifest.json

@@ -4,37 +4,39 @@
   ],
   "devFiles": [],
   "lowPriorityFiles": [
-    "static/OLE8_ZInlGH7ENU0NIOpf/_buildManifest.js",
-    "static/OLE8_ZInlGH7ENU0NIOpf/_ssgManifest.js"
+    "static/FL82obwzFHRzvV6z76I-U/_buildManifest.js",
+    "static/FL82obwzFHRzvV6z76I-U/_ssgManifest.js"
   ],
   "rootMainFiles": [],
   "rootMainFilesTree": {},
   "pages": {
     "/": [
-      "static/chunks/webpack-3943d624bbb47a64.js",
-      "static/chunks/framework-3cf15b8041c59dd3.js",
-      "static/chunks/main-5b999f3f24ebfa84.js",
-      "static/css/a78e04fe95452380.css",
-      "static/chunks/pages/index-8b398b0a5d870773.js"
+      "static/chunks/webpack-e34c3ae12275e978.js",
+      "static/chunks/framework-626cbd48ac5aca57.js",
+      "static/chunks/main-b92e08f3fc96dd8d.js",
+      "static/chunks/101-829ab8a8d310e7a0.js",
+      "static/css/c403ce739a9c0d83.css",
+      "static/chunks/pages/index-5f9fa6ac3cd3d97b.js"
     ],
     "/_app": [
-      "static/chunks/webpack-3943d624bbb47a64.js",
-      "static/chunks/framework-3cf15b8041c59dd3.js",
-      "static/chunks/main-5b999f3f24ebfa84.js",
-      "static/css/aedeaada218d7280.css",
-      "static/chunks/pages/_app-7024e7a27ffbb2fa.js"
+      "static/chunks/webpack-e34c3ae12275e978.js",
+      "static/chunks/framework-626cbd48ac5aca57.js",
+      "static/chunks/main-b92e08f3fc96dd8d.js",
+      "static/css/abc2425d3ba607bc.css",
+      "static/chunks/pages/_app-ba5d628e81a15461.js"
     ],
     "/_error": [
-      "static/chunks/webpack-3943d624bbb47a64.js",
-      "static/chunks/framework-3cf15b8041c59dd3.js",
-      "static/chunks/main-5b999f3f24ebfa84.js",
-      "static/chunks/pages/_error-afeda7c5231b6c3c.js"
+      "static/chunks/webpack-e34c3ae12275e978.js",
+      "static/chunks/framework-626cbd48ac5aca57.js",
+      "static/chunks/main-b92e08f3fc96dd8d.js",
+      "static/chunks/pages/_error-f0290a98eb3ed0ec.js"
     ],
     "/not-found": [
-      "static/chunks/webpack-3943d624bbb47a64.js",
-      "static/chunks/framework-3cf15b8041c59dd3.js",
-      "static/chunks/main-5b999f3f24ebfa84.js",
-      "static/chunks/pages/not-found-9e076427bad69d90.js"
+      "static/chunks/webpack-e34c3ae12275e978.js",
+      "static/chunks/framework-626cbd48ac5aca57.js",
+      "static/chunks/main-b92e08f3fc96dd8d.js",
+      "static/css/dee878eb64099d92.css",
+      "static/chunks/pages/not-found-23d61fd3ed791cad.js"
     ]
   }
 }

package/packages/scrabble-solver/.next/cache/.previewinfo

@@ -1 +1 @@
-{"previewModeId":"c85e6f8a4ff2deaa95f42e5c117c8c9a","previewModeSigningKey":"2c028e3be2a3b39a4bf0159d5697d0494bd393ea48a70bf384e74ca981f58bb7","previewModeEncryptionKey":"bb45fb12938370f5852a51404a032a492598a3961a990d340d6915d7f259d198","expireAt":1787264687438}
+{"previewModeId":"2ed53eba09def2ca7c362be290389f60","previewModeSigningKey":"b9232917f8c299896855e0a45d606f6fe07ad0f8756d32749968f60ba611bfe7","previewModeEncryptionKey":"d88a7abb78c2d6ff4e10c0b65a6a97a1c8d5cda23bbf9b63aa2c551420cde905","expireAt":1788079930556}

package/packages/scrabble-solver/.next/cache/.rscinfo

@@ -1 +1 @@
-{"encryption.key":"/d/sez38cwQmbhvcO7v0mHeIc1/pH+xWoZ7JBA8xBbQ=","encryption.expire_at":1787264687435}
+{"encryption.key":"NWqdXk/9uSzI10ITMeyH24p7vLo6OsrRgdE+BzIApxw=","encryption.expire_at":1788079930553}