fix: default snapshot and config not actually cloning (@Miodec) (monkeytypegame#6333)

!nuf Closes monkeytypegame#6280

Author: Miodec

frontend/__tests__/utils/config.spec.ts

@@ -1,5 +1,5 @@
+import { getDefaultConfig } from "../../src/ts/constants/default-config";
 import { migrateConfig } from "../../src/ts/utils/config";
-import DefaultConfig from "../../src/ts/constants/default-config";
 import {
   PartialConfig,
   ShowAverageSchema,
@@ -11,8 +11,8 @@ describe("config.ts", () => {
       const partialConfig = {} as PartialConfig;
 
       const result = migrateConfig(partialConfig);
-      expect(result).toEqual(expect.objectContaining(DefaultConfig));
-      for (const [key, value] of Object.entries(DefaultConfig)) {
+      expect(result).toEqual(expect.objectContaining(getDefaultConfig()));
+      for (const [key, value] of Object.entries(getDefaultConfig())) {
         expect(result).toHaveProperty(key, value);
       }
     });
@@ -22,7 +22,7 @@ describe("config.ts", () => {
       } as PartialConfig;
 
       const result = migrateConfig(partialConfig);
-      expect(result).toEqual(expect.objectContaining(DefaultConfig));
+      expect(result).toEqual(expect.objectContaining(getDefaultConfig()));
       expect(result).not.toHaveProperty("legacy");
     });
     it("should correctly merge properties of various types", () => {

frontend/__tests__/utils/format.spec.ts

@@ -1,5 +1,5 @@
+import { getDefaultConfig } from "../../src/ts/constants/default-config";
 import { Formatting } from "../../src/ts/utils/format";
-import DefaultConfig from "../../src/ts/constants/default-config";
 import { Config } from "@monkeytype/contracts/schemas/configs";
 
 describe("format.ts", () => {
@@ -274,6 +274,6 @@ describe("format.ts", () => {
 });
 
 function getInstance(config?: Partial<Config>): Formatting {
-  const target: Config = { ...DefaultConfig, ...config };
+  const target: Config = { ...getDefaultConfig(), ...config };
   return new Formatting(target);
 }

frontend/src/ts/config.ts

@@ -7,7 +7,6 @@ import {
   isConfigValueValid,
 } from "./config-validation";
 import * as ConfigEvent from "./observables/config-event";
-import DefaultConfig from "./constants/default-config";
 import { isAuthenticated } from "./firebase";
 import * as AnalyticsController from "./controllers/analytics-controller";
 import * as AccountButton from "./elements/account-button";
@@ -29,14 +28,15 @@ import { Language, LanguageSchema } from "@monkeytype/contracts/schemas/util";
 import { LocalStorageWithSchema } from "./utils/local-storage-with-schema";
 import { migrateConfig } from "./utils/config";
 import { roundTo1 } from "@monkeytype/util/numbers";
+import { getDefaultConfig } from "./constants/default-config";
 
 const configLS = new LocalStorageWithSchema({
   key: "config",
   schema: ConfigSchemas.ConfigSchema,
-  fallback: DefaultConfig,
+  fallback: getDefaultConfig(),
   migrate: (value, _issues) => {
     if (!isObject(value)) {
-      return DefaultConfig;
+      return getDefaultConfig();
     }
     //todo maybe send a full config to db so that it removes legacy values
 
@@ -47,7 +47,7 @@ const configLS = new LocalStorageWithSchema({
 let loadDone: (value?: unknown) => void;
 
 const config = {
-  ...DefaultConfig,
+  ...getDefaultConfig(),
 };
 
 let configToSend = {} as Config;
@@ -1095,7 +1095,7 @@ export function setTimeConfig(
   time: ConfigSchemas.TimeConfig,
   nosave?: boolean
 ): boolean {
-  time = isNaN(time) || time < 0 ? DefaultConfig.time : time;
+  time = isNaN(time) || time < 0 ? getDefaultConfig().time : time;
   if (!isConfigValueValid("time", time, ConfigSchemas.TimeConfigSchema))
     return false;
 
@@ -1168,7 +1168,7 @@ export function setWordCount(
   nosave?: boolean
 ): boolean {
   wordCount =
-    wordCount < 0 || wordCount > 100000 ? DefaultConfig.words : wordCount;
+    wordCount < 0 || wordCount > 100000 ? getDefaultConfig().words : wordCount;
 
   if (!isConfigValueValid("words", wordCount, ConfigSchemas.WordCountSchema))
     return false;
@@ -1382,7 +1382,7 @@ export function setAutoSwitchTheme(
     return false;
   }
 
-  boolean = boolean ?? DefaultConfig.autoSwitchTheme;
+  boolean = boolean ?? getDefaultConfig().autoSwitchTheme;
   config.autoSwitchTheme = boolean;
   saveToLocalStorage("autoSwitchTheme", nosave);
   ConfigEvent.dispatch("autoSwitchTheme", config.autoSwitchTheme);
@@ -1985,9 +1985,9 @@ export async function apply(
   ConfigEvent.dispatch("fullConfigChange");
 
   const configObj = configToApply as Config;
-  (Object.keys(DefaultConfig) as (keyof Config)[]).forEach((configKey) => {
+  (Object.keys(getDefaultConfig()) as (keyof Config)[]).forEach((configKey) => {
     if (configObj[configKey] === undefined) {
-      const newValue = DefaultConfig[configKey];
+      const newValue = getDefaultConfig()[configKey];
       (configObj[configKey] as typeof newValue) = newValue;
     }
   });
@@ -2095,7 +2095,7 @@ export async function apply(
 }
 
 export async function reset(): Promise<void> {
-  await apply(DefaultConfig);
+  await apply(getDefaultConfig());
   await DB.resetConfig();
   saveFullConfigToLocalStorage(true);
 }
@@ -2116,7 +2116,7 @@ export function getConfigChanges(): Partial<Config> {
   const configChanges: Partial<Config> = {};
   typedKeys(config)
     .filter((key) => {
-      return config[key] !== DefaultConfig[key];
+      return config[key] !== getDefaultConfig()[key];
     })
     .forEach((key) => {
       //@ts-expect-error this is fine

frontend/src/ts/constants/default-config.ts

@@ -105,4 +105,6 @@ const obj = {
   maxLineWidth: 0,
 } as Config;
 
-export default deepClone(obj);
+export function getDefaultConfig(): Config {
+  return deepClone(obj);
+}

frontend/src/ts/constants/default-snapshot.ts

@@ -1,5 +1,94 @@
+import {
+  ResultFilters,
+  User,
+  UserProfileDetails,
+  UserTag,
+} from "@monkeytype/contracts/schemas/users";
 import { deepClone } from "../utils/misc";
-import defaultConfig from "./default-config";
+import { getDefaultConfig } from "./default-config";
+import { Mode } from "@monkeytype/contracts/schemas/shared";
+import { Result } from "@monkeytype/contracts/schemas/results";
+import { Config } from "@monkeytype/contracts/schemas/configs";
+import {
+  ModifiableTestActivityCalendar,
+  TestActivityCalendar,
+} from "../elements/test-activity-calendar";
+import { Preset } from "@monkeytype/contracts/schemas/presets";
+
+export type SnapshotUserTag = UserTag & {
+  active?: boolean;
+  display: string;
+};
+
+export type SnapshotResult<M extends Mode> = Omit<
+  Result<M>,
+  | "_id"
+  | "bailedOut"
+  | "blindMode"
+  | "lazyMode"
+  | "difficulty"
+  | "funbox"
+  | "language"
+  | "numbers"
+  | "punctuation"
+  | "quoteLength"
+  | "restartCount"
+  | "incompleteTestSeconds"
+  | "afkDuration"
+  | "tags"
+> & {
+  _id: string;
+  bailedOut: boolean;
+  blindMode: boolean;
+  lazyMode: boolean;
+  difficulty: string;
+  funbox: string;
+  language: string;
+  numbers: boolean;
+  punctuation: boolean;
+  quoteLength: number;
+  restartCount: number;
+  incompleteTestSeconds: number;
+  afkDuration: number;
+  tags: string[];
+};
+
+export type Snapshot = Omit<
+  User,
+  | "timeTyping"
+  | "startedTests"
+  | "completedTests"
+  | "profileDetails"
+  | "streak"
+  | "resultFilterPresets"
+  | "tags"
+  | "xp"
+  | "testActivity"
+> & {
+  typingStats: {
+    timeTyping: number;
+    startedTests: number;
+    completedTests: number;
+  };
+  details?: UserProfileDetails;
+  inboxUnreadSize: number;
+  streak: number;
+  maxStreak: number;
+  filterPresets: ResultFilters[];
+  isPremium: boolean;
+  streakHourOffset?: number;
+  config: Config;
+  tags: SnapshotUserTag[];
+  presets: SnapshotPreset[];
+  results?: SnapshotResult<Mode>[];
+  xp: number;
+  testActivity?: ModifiableTestActivityCalendar;
+  testActivityByYear?: { [key: string]: TestActivityCalendar };
+};
+
+export type SnapshotPreset = Preset & {
+  display: string;
+};
 
 const defaultSnap = {
   results: undefined,
@@ -14,7 +103,7 @@ const defaultSnap = {
   email: "",
   uid: "",
   isPremium: false,
-  config: defaultConfig,
+  config: getDefaultConfig(),
   customThemes: [],
   presets: [],
   tags: [],
@@ -42,6 +131,8 @@ const defaultSnap = {
       60: { english: { count: 0, rank: 0 } },
     },
   },
-};
+} as Snapshot;
 
-export default deepClone(defaultSnap);
+export function getDefaultSnapshot(): Snapshot {
+  return deepClone(defaultSnap);
+}

frontend/src/ts/controllers/account-controller.ts

@@ -49,6 +49,7 @@ import { FirebaseError } from "firebase/app";
 import * as PSA from "../elements/psa";
 import defaultResultFilters from "../constants/default-result-filters";
 import { getActiveFunboxesWithFunction } from "../test/funbox/list";
+import { Snapshot } from "../constants/default-snapshot";
 
 export const gmailProvider = new GoogleAuthProvider();
 export const githubProvider = new GithubAuthProvider();
@@ -124,7 +125,7 @@ async function getDataAndInit(): Promise<boolean> {
     LoadingPage.updateBar(45);
   }
   LoadingPage.updateText("Applying settings...");
-  const snapshot = DB.getSnapshot() as DB.Snapshot;
+  const snapshot = DB.getSnapshot() as Snapshot;
   AccountButton.update(snapshot);
   Alerts.setNotificationBubbleVisible(snapshot.inboxUnreadSize > 0);
   showFavoriteQuoteLength();

frontend/src/ts/controllers/preset-controller.ts

@@ -5,6 +5,7 @@ import * as Notifications from "../elements/notifications";
 import * as TestLogic from "../test/test-logic";
 import { migrateConfig, replaceLegacyValues } from "../utils/config";
 import * as TagController from "./tag-controller";
+import { SnapshotPreset } from "../constants/default-snapshot";
 
 export async function apply(_id: string): Promise<void> {
   const snapshot = DB.getSnapshot();
@@ -41,7 +42,7 @@ export async function apply(_id: string): Promise<void> {
   });
   UpdateConfig.saveFullConfigToLocalStorage();
 }
-function isPartialPreset(preset: DB.SnapshotPreset): boolean {
+function isPartialPreset(preset: SnapshotPreset): boolean {
   return preset.settingGroups !== undefined && preset.settingGroups !== null;
 }