Standardize test fixture serialization (#1702)

- Depends on #1700

## Checklist

- [ ] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [ ] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [ ] I have not broken the cheatsheet

Author: pokey

packages/common/src/index.ts

@@ -59,6 +59,7 @@ export * from "./testUtil/getFixturePaths";
 export * from "./testUtil/getCursorlessRepoRoot";
 export * from "./testUtil/serialize";
 export * from "./testUtil/TestCaseSnapshot";
+export * from "./testUtil/serializeTestFixture";
 export * from "./util/typeUtils";
 export * from "./ide/types/hatStyles.types";
 export * from "./errors";

packages/cursorless-engine/src/scripts/transformRecordedTests/transformations/reorderFields.ts renamed to packages/common/src/testUtil/serializeTestFixture.ts

@@ -1,25 +1,24 @@
-import {
-  EnforceUndefined,
-  TestCaseFixture,
-  TestCaseFixtureLegacy,
-} from "@cursorless/common";
+import { TestCaseFixtureLegacy } from "../types/TestCaseFixture";
+import { EnforceUndefined } from "../util/typeUtils";
+import { serialize } from "./serialize";
 
-export function reorderFields(
-  fixture: TestCaseFixture,
-): EnforceUndefined<TestCaseFixture>;
-export function reorderFields(
+function reorderFields(
   fixture: TestCaseFixtureLegacy,
 ): EnforceUndefined<TestCaseFixtureLegacy> {
   return {
     languageId: fixture.languageId,
+    postEditorOpenSleepTimeMs: fixture.postEditorOpenSleepTimeMs,
+    postCommandSleepTimeMs: fixture.postCommandSleepTimeMs,
     command: fixture.command,
     marksToCheck: fixture.marksToCheck,
     initialState: fixture.initialState,
     finalState: fixture.finalState,
     returnValue: fixture.returnValue,
     thrownError: fixture.thrownError,
     ide: fixture.ide,
-    postEditorOpenSleepTimeMs: fixture.postEditorOpenSleepTimeMs,
-    postCommandSleepTimeMs: fixture.postCommandSleepTimeMs,
   };
 }
+
+export function serializeTestFixture(fixture: TestCaseFixtureLegacy): string {
+  return serialize(reorderFields(fixture));
+}

packages/cursorless-engine/src/scripts/transformRecordedTests/transformFile.ts

@@ -1,7 +1,6 @@
-import { serialize } from "@cursorless/common";
 import { promises as fsp } from "fs";
 import * as yaml from "js-yaml";
-import { TestCaseFixture } from "@cursorless/common";
+import { TestCaseFixture, serializeTestFixture } from "@cursorless/common";
 import { FixtureTransformation } from "./types";
 
 export async function transformFile(
@@ -12,6 +11,6 @@ export async function transformFile(
   const inputFixture = yaml.load(buffer.toString()) as TestCaseFixture;
   const outputFixture = transformation(inputFixture);
   if (outputFixture != null) {
-    await fsp.writeFile(file, serialize(outputFixture));
+    await fsp.writeFile(file, serializeTestFixture(outputFixture));
   }
 }

packages/cursorless-engine/src/scripts/transformRecordedTests/transformations/upgrade.ts

@@ -1,11 +1,7 @@
 import { TestCaseFixture, TestCaseFixtureLegacy } from "@cursorless/common";
-import { flow } from "lodash";
 import { canonicalizeAndValidateCommand } from "../../../core/commandVersionUpgrades/canonicalizeAndValidateCommand";
-import { reorderFields } from "./reorderFields";
 
-export const upgrade = flow(upgradeCommand, reorderFields);
-
-function upgradeCommand(fixture: TestCaseFixtureLegacy): TestCaseFixture {
+export function upgrade(fixture: TestCaseFixtureLegacy): TestCaseFixture {
   return {
     ...fixture,
     command: canonicalizeAndValidateCommand(fixture.command),

packages/cursorless-engine/src/scripts/transformRecordedTests/upgradeDecorations.ts

@@ -2,11 +2,9 @@ import {
   FlashStyle,
   GeneralizedRangePlainObject,
   PositionPlainObject,
-  TestCaseFixture,
   TestCaseFixtureLegacy,
 } from "@cursorless/common";
 import { groupBy, partition } from "lodash";
-import { reorderFields } from "./transformations/reorderFields";
 import { FixtureTransformation } from "./types";
 
 interface PlainTestDecoration {
@@ -64,7 +62,7 @@ export const upgradeDecorations: FixtureTransformation = (
           })),
   };
 
-  return reorderFields(fixture as TestCaseFixture);
+  return fixture;
 };
 
 function extractHighlightName(name: string): string {

packages/cursorless-engine/src/testCaseRecorder/TestCase.ts

@@ -1,14 +1,15 @@
 import {
   ActionType,
   CommandLatest,
+  EnforceUndefined,
   extractTargetedMarks,
   ExtraSnapshotField,
   marksToPlainObject,
   PartialTargetDescriptor,
   PlainSpyIDERecordedValues,
   ReadOnlyHatMap,
-  serialize,
   SerializedMarks,
+  serializeTestFixture,
   SpyIDE,
   spyIDERecordedValuesToPlainObject,
   TestCaseFixture,
@@ -130,8 +131,10 @@ export class TestCase {
     ) {
       throw Error("Two snapshots must be taken before serializing");
     }
-    const fixture: TestCaseFixture = {
+    const fixture: EnforceUndefined<TestCaseFixture> = {
       languageId: this.languageId,
+      postEditorOpenSleepTimeMs: undefined,
+      postCommandSleepTimeMs: undefined,
       command: this.command,
       marksToCheck: this.marksToCheck,
       initialState: this.initialState,
@@ -140,7 +143,7 @@ export class TestCase {
       thrownError: this.thrownError,
       ide: this.spyIdeValues,
     };
-    return serialize(fixture);
+    return serializeTestFixture(fixture);
   }
 
   async recordInitialState() {

packages/cursorless-vscode-e2e/src/suite/recorded.vscode.test.ts

@@ -11,8 +11,8 @@ import {
   rangeToPlainObject,
   ReadOnlyHatMap,
   SelectionPlainObject,
-  serialize,
   SerializedMarks,
+  serializeTestFixture,
   splitKey,
   SpyIDE,
   spyIDERecordedValuesToPlainObject,
@@ -140,7 +140,7 @@ async function runTest(file: string, spyIde: SpyIDE) {
         thrownError: { name: error.name },
       };
 
-      await fsp.writeFile(file, serialize(outputFixture));
+      await fsp.writeFile(file, serializeTestFixture(outputFixture));
     } else if (fixture.thrownError != null) {
       assert.strictEqual(error.name, fixture.thrownError.name);
     } else {
@@ -196,21 +196,18 @@ async function runTest(file: string, spyIde: SpyIDE) {
   const actualSpyIdeValues =
     rawSpyIdeValues == null
       ? undefined
-      : omitByDeep(
-          spyIDERecordedValuesToPlainObject(rawSpyIdeValues),
-          isUndefined,
-        );
+      : spyIDERecordedValuesToPlainObject(rawSpyIdeValues);
 
   if (shouldUpdateFixtures()) {
-    const outputFixture = {
+    const outputFixture: TestCaseFixtureLegacy = {
       ...fixture,
       finalState: resultState,
       returnValue,
       ide: actualSpyIdeValues,
       thrownError: undefined,
     };
 
-    await fsp.writeFile(file, serialize(outputFixture));
+    await fsp.writeFile(file, serializeTestFixture(outputFixture));
   } else {
     if (fixture.thrownError != null) {
       throw Error(
@@ -231,7 +228,7 @@ async function runTest(file: string, spyIde: SpyIDE) {
     );
 
     assert.deepStrictEqual(
-      actualSpyIdeValues,
+      omitByDeep(actualSpyIdeValues, isUndefined),
       fixture.ide,
       "Unexpected ide captured values",
     );