scrabble-solver 2.16.7 → 2.17.0

package/packages/scrabble-solver/src/solver-worker/index.worker.ts

@@ -0,0 +1,124 @@
+/// <reference lib="WebWorker" />
+
+import { getConfig } from '@scrabble-solver/configs';
+import { BLANK } from '@scrabble-solver/constants';
+import { solve } from '@scrabble-solver/solver';
+import { Board, type Locale, Tile } from '@scrabble-solver/types';
+
+import { type SolveRequestPayload, type VerifyRequestPayload } from '@/types';
+
+import { revalidateDictionary } from './dictionaries';
+import { getGaddag } from './getGaddag';
+import { type SolverWorkerRequest, type SolverWorkerResponse } from './messages';
+
+declare const self: DedicatedWorkerGlobalScope;
+
+/**
+ * Solves run synchronously on the single worker thread, so a burst of requests
+ * would queue stale solves ahead of the latest one.
+ */
+let latestSolveId = 0;
+
+self.addEventListener('message', ({ data }: MessageEvent<SolverWorkerRequest>) => {
+  if (data.type === 'solve') {
+    latestSolveId = data.id;
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    respond(data.id, () => handleSolve(data.id, data.payload));
+  } else if (data.type === 'verify') {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    respond(data.id, () => handleVerify(data.id, data.payload));
+  } else if (data.type === 'prefetch') {
+    prefetchDictionary(data.locale).catch(() => undefined);
+  }
+});
+
+async function handleSolve(id: number, payload: SolveRequestPayload): Promise<SolverWorkerResponse> {
+  const { board, characters, game, locale } = payload;
+  const gaddag = await getGaddag(locale);
+  revalidateInBackground(locale);
+
+  if (!gaddag) {
+    return { id, outcome: 'unavailable' };
+  }
+
+  await yieldToQueuedMessages();
+
+  if (latestSolveId !== id) {
+    return { id, outcome: 'superseded' };
+  }
+
+  const config = getConfig(game, locale);
+  const tiles = characters.map((character) => new Tile({ character, isBlank: character === BLANK }));
+  return { data: solve(gaddag, config, Board.fromJson(board), tiles), id, outcome: 'answered' };
+}
+
+async function handleVerify(
+  id: number,
+  { board: boardJson, locale }: VerifyRequestPayload,
+): Promise<SolverWorkerResponse> {
+  const gaddag = await getGaddag(locale);
+  revalidateInBackground(locale);
+
+  if (!gaddag) {
+    return { id, outcome: 'unavailable' };
+  }
+
+  const board = Board.fromJson(boardJson);
+  const words = board.getWords().sort((a, b) => a.localeCompare(b, locale));
+  const invalidWords: string[] = [];
+  const validWords: string[] = [];
+
+  for (const word of words) {
+    if (gaddag.has(word)) {
+      validWords.push(word);
+    } else {
+      invalidWords.push(word);
+    }
+  }
+
+  return { data: { invalidWords, validWords }, id, outcome: 'answered' };
+}
+
+/**
+ * Deserializes the dictionary ahead of the first solve, so it does not pay the
+ * cold-start cost. Warms even when revalidation fails (e.g. offline) - a
+ * previously cached dictionary can still be deserialized.
+ */
+async function prefetchDictionary(locale: Locale): Promise<void> {
+  try {
+    await revalidateDictionary(locale);
+  } catch {
+    // Solving falls back to the server until a later revalidation succeeds.
+  }
+
+  await getGaddag(locale);
+}
+
+/**
+ * Revalidation failures are expected (offline, server down) and must not
+ * surface as unhandled rejections - solving keeps using the cached dictionary
+ * until a later revalidation succeeds.
+ */
+function revalidateInBackground(locale: Locale): void {
+  revalidateDictionary(locale).catch(() => undefined);
+}
+
+async function respond(id: number, handle: () => Promise<SolverWorkerResponse>): Promise<void> {
+  try {
+    self.postMessage(await handle());
+  } catch {
+    self.postMessage({ id, outcome: 'unavailable' } satisfies SolverWorkerResponse);
+  }
+}
+
+/**
+ * Messages queued behind this handler dispatch only between macrotasks - a
+ * MessageChannel round-trip lets them register before an expensive solve.
+ */
+function yieldToQueuedMessages(): Promise<void> {
+  return new Promise((resolve) => {
+    const { port1, port2 } = new MessageChannel();
+    port1.onmessage = () => resolve();
+    port2.postMessage(null);
+  });
+}

package/packages/scrabble-solver/src/solver-worker/messages.ts

@@ -0,0 +1,20 @@
+import { type Locale, type ResultJson } from '@scrabble-solver/types';
+
+import { type SolveRequestPayload, type VerifyRequestPayload } from '@/types';
+
+export interface VerifyResult {
+  invalidWords: string[];
+  validWords: string[];
+}
+
+export type SolverWorkerRequest =
+  | { id: number; type: 'prefetch'; locale: Locale }
+  | { id: number; type: 'solve'; payload: SolveRequestPayload }
+  | { id: number; type: 'verify'; payload: VerifyRequestPayload };
+
+export type SolverWorkerResponse =
+  | { id: number; outcome: 'answered'; data: ResultJson[] | VerifyResult }
+  /** No cached dictionary, or an internal error - the caller falls back to the server. */
+  | { id: number; outcome: 'unavailable' }
+  /** A newer solve replaced this one - the newer answer is the one worth waiting for. */
+  | { id: number; outcome: 'superseded' };

package/packages/scrabble-solver/src/state/index.ts

@@ -12,4 +12,5 @@ export * from './solve';
 export * from './store';
 export * from './useTranslate';
 export * from './useTypedSelector';
+export * from './useTypedStore';
 export * from './verify';

package/packages/scrabble-solver/src/state/sagas.ts

@@ -6,11 +6,12 @@
 import { type PayloadAction } from '@reduxjs/toolkit';
 import { hasConfig, languages } from '@scrabble-solver/configs';
 import { Board, type Locale, type Result } from '@scrabble-solver/types';
-import { call, delay, put, select, takeEvery, takeLatest } from 'redux-saga/effects';
+import { call, delay, put, select, spawn, takeEvery, takeLatest } from 'redux-saga/effects';
 
 import { LOCALE_FEATURES } from '@/i18n';
 import { memoize } from '@/lib';
 import { findWordDefinitions, solve, verify, visit } from '@/sdk';
+import { prefetchDictionary } from '@/solver-worker';
 
 import { initialize, reset } from './actions';
 import { boardSlice, selectBoard } from './board';
@@ -41,7 +42,7 @@ export function* rootSaga(): AnyGenerator {
   yield takeEvery(boardSlice.actions.changeCellValue.type, onCellValueChange);
   yield takeEvery([rackSlice.actions.changeCharacter.type, rackSlice.actions.changeCharacters.type], onRackValueChange);
   yield takeEvery(resultsSlice.actions.applyResult.type, onApplyResult);
-  yield takeEvery(resultsSlice.actions.changeResultCandidate.type, onResultCandidateChange);
+  yield takeLatest(resultsSlice.actions.changeResultCandidate.type, onResultCandidateChange);
   yield takeEvery(settingsSlice.actions.changeGame.type, onGameChange);
   yield takeEvery(settingsSlice.actions.changeLocale.type, onLocaleChange);
   yield takeLatest(dictionarySlice.actions.submit.type, onDictionarySubmit);
@@ -120,8 +121,11 @@ function* onDictionarySubmit(): AnyGenerator {
 
 function* onInitialize(): AnyGenerator {
   const board = yield select(selectBoard);
+  const locale = yield select(selectLocale);
 
-  yield call(visit);
+  yield spawn(prefetchDictionary, locale);
+  // Detached: offline, a failed visit would otherwise tear down the whole root saga.
+  yield spawn(visit);
 
   if (!board.isEmpty()) {
     yield* resetRack();
@@ -142,6 +146,8 @@ function* onReset(): AnyGenerator {
 }
 
 function* onLocaleChange({ payload: locale }: PayloadAction<Locale>): AnyGenerator {
+  yield spawn(prefetchDictionary, locale);
+
   const game = yield select(selectGame);
 
   if (!hasConfig(game, locale)) {
@@ -166,13 +172,17 @@ function* onLocaleChange({ payload: locale }: PayloadAction<Locale>): AnyGenerat
 }
 
 function* onResultCandidateChange({ payload: result }: PayloadAction<Result | null>): AnyGenerator {
-  if (result) {
-    const locale: Locale = yield select(selectLocale);
-    const uniqueWords = Array.from(new Set(result.words));
-    const input = uniqueWords.join(LOCALE_FEATURES[locale].separator);
-    yield put(dictionarySlice.actions.changeInput(input));
-    yield put(dictionarySlice.actions.submit());
+  if (!result) {
+    return;
   }
+
+  yield delay(SUBMIT_DELAY);
+
+  const locale: Locale = yield select(selectLocale);
+  const uniqueWords = Array.from(new Set(result.words));
+  const input = uniqueWords.join(LOCALE_FEATURES[locale].separator);
+  yield put(dictionarySlice.actions.changeInput(input));
+  yield put(dictionarySlice.actions.submit());
 }
 
 function* onSolve(): AnyGenerator {

package/packages/scrabble-solver/src/state/useTypedStore.ts

@@ -0,0 +1,6 @@
+import { type Store } from '@reduxjs/toolkit';
+import { useStore } from 'react-redux';
+
+import type { RootState } from './types';
+
+export const useTypedStore = (): Store<RootState> => useStore<RootState>();

package/packages/scrabble-solver/src/types/api.ts

@@ -1,9 +1,8 @@
-import { type BoardJson, type ConfigJson, type Game, type Locale } from '@scrabble-solver/types';
+import { type BoardJson, type Game, type Locale } from '@scrabble-solver/types';
 
 export interface SolveRequestPayload {
   board: BoardJson;
   characters: string[];
-  config: ConfigJson;
   game: Game;
   locale: Locale;
 }

package/packages/scrabble-solver/tsconfig.json

@@ -7,6 +7,10 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "lib": ["dom", "dom.iterable", "esnext"],
+    // Webpack bundles this package (import.meta worker URLs need an ES module
+    // target), unlike the nodenext library packages.
+    "module": "esnext",
+    "moduleResolution": "bundler",
     "noEmit": true,
     "paths": {
       "@/*": ["./src/*"]