Expose some fixture abstractions

packages/common/src/index.ts

@@ -50,6 +50,7 @@ export * from "./types/ScopeProvider";
 export * from "./types/SpokenForm";
 export * from "./types/commandHistory";
 export * from "./util/textFormatters";
+export * from "./util/serializedMarksToTokenHats";
 export * from "./types/snippet.types";
 export * from "./testUtil/fromPlainObject";
 export * from "./testUtil/spyToPlainObject";
@@ -68,6 +69,7 @@ export * from "./testUtil/serialize";
 export * from "./testUtil/shouldUpdateFixtures";
 export * from "./testUtil/TestCaseSnapshot";
 export * from "./testUtil/serializeTestFixture";
+export * from "./testUtil/getResultStateForComparison";
 export * from "./testUtil/asyncSafety";
 export * from "./testUtil/getScopeTestPathsRecursively";
 export * from "./util/typeUtils";

packages/common/src/testUtil/getFixturePaths.ts

@@ -1,6 +1,9 @@
+import * as yaml from "js-yaml";
 import * as path from "path";
 import { walkFilesSync } from "../util/walkSync";
 import { getCursorlessRepoRoot } from "./getCursorlessRepoRoot";
+import { TestCaseFixtureLegacy } from "../types/TestCaseFixture";
+import { readFile } from "node:fs/promises";
 
 export function getFixturesPath() {
   return path.join(getCursorlessRepoRoot(), "data", "fixtures");
@@ -67,3 +70,10 @@ function pathToName(relativeDir: string, filePath: string) {
     .relative(relativeDir, filePath.substring(0, filePath.lastIndexOf(".")))
     .replaceAll("\\", "/");
 }
+
+export async function loadFixture(
+  path: string,
+): Promise<TestCaseFixtureLegacy> {
+  const buffer = await readFile(path);
+  return yaml.load(buffer.toString()) as TestCaseFixtureLegacy;
+}

packages/common/src/testUtil/getResultStateForComparison.ts

@@ -0,0 +1,46 @@
+import { storedTargetKeys } from "../StoredTargetKey";
+import SpyIDE from "../ide/spy/SpyIDE";
+import { ReadOnlyHatMap } from "../types/HatTokenMap";
+import { marksToPlainObject } from "../util/toPlainObject";
+import { ExcludableSnapshotField, TestCaseSnapshot } from "./TestCaseSnapshot";
+import { extractTargetedMarks } from "./extractTargetedMarks";
+import { TestHelpers } from "./runRecordedTest";
+
+export async function getResultStateForComparison(
+  finalState: TestCaseSnapshot | undefined,
+  readableHatMap: ReadOnlyHatMap,
+  spyIde: SpyIDE,
+  takeSnapshot: TestHelpers["takeSnapshot"],
+) {
+  const excludeFields: ExcludableSnapshotField[] = [];
+
+  const marks =
+    finalState?.marks == null
+      ? undefined
+      : marksToPlainObject(
+          extractTargetedMarks(Object.keys(finalState.marks), readableHatMap),
+        );
+
+  if (finalState?.clipboard == null) {
+    excludeFields.push("clipboard");
+  }
+
+  for (const storedTargetKey of storedTargetKeys) {
+    const key = `${storedTargetKey}Mark` as const;
+    if (finalState?.[key] == null) {
+      excludeFields.push(key);
+    }
+  }
+
+  // FIXME Visible ranges are not asserted, see:
+  // https://github.com/cursorless-dev/cursorless/issues/160
+  const { visibleRanges, ...resultState } = await takeSnapshot(
+    excludeFields,
+    [],
+    spyIde.activeTextEditor!,
+    spyIde,
+    marks,
+  );
+
+  return resultState;
+}

packages/common/src/testUtil/runRecordedTest.ts

@@ -18,23 +18,21 @@ import {
   TestCaseFixtureLegacy,
   TestCaseSnapshot,
   TextEditor,
-  TokenHat,
   clientSupportsFallback,
-  extractTargetedMarks,
-  marksToPlainObject,
+  loadFixture,
   omitByDeep,
-  plainObjectToRange,
   rangeToPlainObject,
   serializeTestFixture,
+  serializedMarksToTokenHats,
   shouldUpdateFixtures,
   splitKey,
   spyIDERecordedValuesToPlainObject,
   storedTargetKeys,
 } from "@cursorless/common";
 import { assert } from "chai";
-import * as yaml from "js-yaml";
 import { isUndefined } from "lodash";
 import { promises as fsp } from "node:fs";
+import { getResultStateForComparison } from "./getResultStateForComparison";
 
 function createPosition(position: PositionPlainObject) {
   return new Position(position.line, position.character);
@@ -123,9 +121,7 @@ export async function runRecordedTest({
   testHelpers,
   runCursorlessCommand,
 }: RunRecordedTestOpts) {
-  const buffer = await fsp.readFile(path);
-  const fixture = yaml.load(buffer.toString()) as TestCaseFixtureLegacy;
-  const excludeFields: ExcludableSnapshotField[] = [];
+  const fixture = await loadFixture(path);
 
   // FIXME The snapshot gets messed up with timing issues when running the recorded tests
   // "Couldn't find token default.a"
@@ -162,7 +158,10 @@ export async function runRecordedTest({
 
   // Ensure that the expected hats are present
   await hatTokenMap.allocateHats(
-    getTokenHats(fixture.initialState.marks, spyIde.activeTextEditor!),
+    serializedMarksToTokenHats(
+      fixture.initialState.marks,
+      spyIde.activeTextEditor!,
+    ),
   );
 
   const readableHatMap = await hatTokenMap.getReadableMap(usePrePhraseSnapshot);
@@ -217,35 +216,11 @@ export async function runRecordedTest({
     await sleepWithBackoff(fixture.postCommandSleepTimeMs);
   }
 
-  const marks =
-    fixture.finalState?.marks == null
-      ? undefined
-      : marksToPlainObject(
-          extractTargetedMarks(
-            Object.keys(fixture.finalState.marks),
-            readableHatMap,
-          ),
-        );
-
-  if (fixture.finalState?.clipboard == null) {
-    excludeFields.push("clipboard");
-  }
-
-  for (const storedTargetKey of storedTargetKeys) {
-    const key = `${storedTargetKey}Mark` as const;
-    if (fixture.finalState?.[key] == null) {
-      excludeFields.push(key);
-    }
-  }
-
-  // FIXME Visible ranges are not asserted, see:
-  // https://github.com/cursorless-dev/cursorless/issues/160
-  const { visibleRanges, ...resultState } = await takeSnapshot(
-    excludeFields,
-    [],
-    spyIde.activeTextEditor!,
+  const resultState = await getResultStateForComparison(
+    fixture.finalState,
+    readableHatMap,
     spyIde,
-    marks,
+    takeSnapshot,
   );
 
   const rawSpyIdeValues = spyIde.getSpyValues(fixture.ide?.flashes != null);
@@ -313,34 +288,3 @@ function checkMarks(
     assert.deepStrictEqual(rangeToPlainObject(currentToken.range), token);
   });
 }
-
-function getTokenHats(
-  marks: SerializedMarks | undefined,
-  editor: TextEditor,
-): TokenHat[] {
-  if (marks == null) {
-    return [];
-  }
-
-  return Object.entries(marks).map(([key, token]) => {
-    const { hatStyle, character } = splitKey(key);
-    const range = plainObjectToRange(token);
-
-    return {
-      hatStyle,
-      grapheme: character,
-      token: {
-        editor,
-        range,
-        offsets: {
-          start: editor.document.offsetAt(range.start),
-          end: editor.document.offsetAt(range.end),
-        },
-        text: editor.document.getText(range),
-      },
-
-      // NB: We don't care about the hat range for this test
-      hatRange: range,
-    };
-  });
-}

packages/common/src/util/serializedMarksToTokenHats.ts

@@ -0,0 +1,36 @@
+import { plainObjectToRange } from "../testUtil/fromPlainObject";
+import { splitKey } from "./splitKey";
+import { SerializedMarks } from "./toPlainObject";
+import { TextEditor } from "../types/TextEditor";
+import { TokenHat } from "../types/HatTokenMap";
+
+export function serializedMarksToTokenHats(
+  marks: SerializedMarks | undefined,
+  editor: TextEditor,
+): TokenHat[] {
+  if (marks == null) {
+    return [];
+  }
+
+  return Object.entries(marks).map(([key, token]) => {
+    const { hatStyle, character } = splitKey(key);
+    const range = plainObjectToRange(token);
+
+    return {
+      hatStyle,
+      grapheme: character,
+      token: {
+        editor,
+        range,
+        offsets: {
+          start: editor.document.offsetAt(range.start),
+          end: editor.document.offsetAt(range.end),
+        },
+        text: editor.document.getText(range),
+      },
+
+      // NB: We don't care about the hat range for this test
+      hatRange: range,
+    };
+  });
+}

packages/cursorless-engine/src/core/IndividualHatMap.ts

@@ -58,7 +58,7 @@ export class IndividualHatMap implements ReadOnlyHatMap {
   }
 
   /**
-   * Overwrites the hat assignemnt for this hat token map.
+   * Overwrites the hat assignment for this hat token map.
    *
    * @param tokenHats The new hat assignments
    */