Clean up preference types and tests [SYNTH-342] (#1492)

Author: PepperLola

fission/src/systems/preferences/PreferenceTypes.ts

@@ -7,14 +7,10 @@ import type { SimConfigData } from "../simulation/SimConfigShared"
 /** Names of all global preferences. */
 
 export type UserPreferences = {
-    ZoomSensitivity: number
-    PitchSensitivity: number
-    YawSensitivity: number
     SceneRotationSensitivity: number
     ScenePanSensitivity: number
     ViewCubeRotationSensitivity: number
     ReportAnalytics: boolean
-    UseMetric: boolean
     RenderScoringZones: boolean
     RenderProtectedZones: boolean
     InputSchemes: InputScheme[]
@@ -51,14 +47,10 @@ export type Preferences = {
  */
 export function defaultUserPreferences(): UserPreferences {
     return {
-        ZoomSensitivity: 15,
-        PitchSensitivity: 10,
-        YawSensitivity: 3,
         SceneRotationSensitivity: 0.5,
         ScenePanSensitivity: 1.0,
         ViewCubeRotationSensitivity: 0.025,
         ReportAnalytics: false,
-        UseMetric: false,
         RenderScoringZones: true,
         RenderProtectedZones: true,
         InputSchemes: [],

fission/src/test/PreferencesSystem.test.ts

@@ -11,73 +11,70 @@ import {
     type GraphicsPreferences,
     type RobotPreferences,
     type UserPreference,
-    type UserPreferences,
 } from "@/systems/preferences/PreferenceTypes"
 
-/**
- * Captures the full current user-preferences state by resolving every key
- * defined by defaultUserPreferences() through the public getter, so the whole
- * set can be asserted with toMatchSnapshot().
- */
-function captureUserPreferences(): UserPreferences {
-    const keys = Object.keys(defaultUserPreferences()) as UserPreference[]
-    return Object.fromEntries(keys.map(key => [key, PreferencesSystem.getUserPreference(key)])) as UserPreferences
+function expectDefaultPreferences() {
+    const defaults = defaultUserPreferences()
+    const keys = Object.keys(defaults) as UserPreference[]
+    keys.forEach(key => {
+        expect(PreferencesSystem.getUserPreference(key), `Mismatch in preference ${key}`).toEqual(defaults[key])
+    })
 }
 
 describe("Preferences System Global Values", () => {
     test("Setting values", () => {
-        PreferencesSystem.setUserPreference("ZoomSensitivity", 7)
+        PreferencesSystem.setUserPreference("SceneRotationSensitivity", 7)
         PreferencesSystem.setUserPreference("RenderSceneTags", false)
         PreferencesSystem.setUserPreference("RenderScoreboard", false)
 
-        expect(PreferencesSystem.getUserPreference("ZoomSensitivity")).toBe(7)
+        expect(PreferencesSystem.getUserPreference("SceneRotationSensitivity")).toBe(7)
         expect(PreferencesSystem.getUserPreference("RenderSceneTags")).toBe(false)
         expect(PreferencesSystem.getUserPreference("RenderScoreboard")).toBe(false)
     })
 
     test("Setting without saving", () => {
-        PreferencesSystem.setUserPreference("ZoomSensitivity", 13)
+        PreferencesSystem.setUserPreference("SceneRotationSensitivity", 13)
         PreferencesSystem.setUserPreference("RenderSceneTags", false)
         PreferencesSystem.setUserPreference("RenderScoreboard", true)
 
         window.localStorage.setItem("Preferences", "{}") // Clears local storage
         PreferencesSystem.loadPreferences()
 
-        expect(captureUserPreferences()).toMatchSnapshot("default user preferences")
+        expectDefaultPreferences()
     })
 
     test("Reset to default if undefined", () => {
-        PreferencesSystem.setUserPreference("ZoomSensitivity", undefined as unknown as number)
+        PreferencesSystem.setUserPreference("SceneRotationSensitivity", undefined as unknown as number)
         PreferencesSystem.setUserPreference("RenderSceneTags", undefined as unknown as boolean)
         PreferencesSystem.setUserPreference("RenderScoreboard", undefined as unknown as boolean)
 
-        expect(captureUserPreferences()).toMatchSnapshot("default user preferences")
+        expectDefaultPreferences()
     })
 
     test("Setting then saving", () => {
-        PreferencesSystem.setUserPreference("ZoomSensitivity", 13)
+        PreferencesSystem.setUserPreference("SceneRotationSensitivity", 13)
         PreferencesSystem.setUserPreference("RenderSceneTags", true)
         PreferencesSystem.setUserPreference("RenderScoreboard", false)
 
         PreferencesSystem.savePreferences()
-        PreferencesSystem.setUserPreference("ZoomSensitivity", 20)
+        PreferencesSystem.setUserPreference("SceneRotationSensitivity", 20)
         PreferencesSystem.setUserPreference("RenderSceneTags", false)
         PreferencesSystem.setUserPreference("RenderScoreboard", true)
         PreferencesSystem.loadPreferences()
 
-        expect(PreferencesSystem.getUserPreference("ZoomSensitivity")).toBe(13)
+        expect(PreferencesSystem.getUserPreference("SceneRotationSensitivity")).toBe(13)
         expect(PreferencesSystem.getUserPreference("RenderSceneTags")).toBe(true)
         expect(PreferencesSystem.getUserPreference("RenderScoreboard")).toBe(false)
     })
 
     test("Clearing preferences", () => {
-        PreferencesSystem.setUserPreference("ZoomSensitivity", 13)
+        PreferencesSystem.setUserPreference("SceneRotationSensitivity", 13)
         PreferencesSystem.setUserPreference("RenderSceneTags", true)
         PreferencesSystem.setUserPreference("RenderScoreboard", false)
 
         PreferencesSystem.clearPreferences()
 
-        expect(captureUserPreferences()).toMatchSnapshot("default user preferences")
+        expectDefaultPreferences()
     })
 
     test("Graphics preferences", () => {