extracted verify and verifyElement into separate file + tests

src/renderer/src/reducers/index.ts

@@ -5,7 +5,6 @@
 import type { Reducer, ReducersMapObject } from "redux";
 
 import { unknownToError } from "@vortex/shared";
-import update from "immutability-helper";
 import { pick } from "lodash";
 import * as path from "path";
 import { combineReducers } from "redux";
@@ -17,8 +16,9 @@ import type { IReducerSpec, IStateVerifier } from "../types/IExtensionContext";
 import type { IState } from "../types/IState";
 
 import { log } from "../logging";
-import { VerifierDrop, VerifierDropParent } from "../types/IExtensionContext";
 import { UserCanceled } from "../util/CustomErrors";
+import { verify } from "./verify";
+export { verify, verifyElement } from "./verify";
 import deepMerge from "../util/deepMerge";
 import * as fs from "../util/fs";
 import getVortexPath from "../util/getVortexPath";
@@ -63,115 +63,6 @@ function safeCombineReducers(
   };
 }
 
-function verifyElement(verifier: IStateVerifier, value: any) {
-  if (
-    verifier.type !== undefined &&
-    (verifier.required || value !== undefined) &&
-    ((verifier.type === "array" && !Array.isArray(value)) ||
-      (verifier.type !== "array" && typeof value !== verifier.type))
-  ) {
-    return false;
-  }
-  if (verifier.noUndefined === true && value === undefined) {
-    return false;
-  }
-  if (verifier.noNull === true && value === null) {
-    return false;
-  }
-  if (verifier.noEmpty === true) {
-    if (verifier.type === "array" && value.length === 0) {
-      return false;
-    } else if (verifier.type === "object" && Object.keys(value).length === 0) {
-      return false;
-    } else if (verifier.type === "string" && value.length === 0) {
-      return false;
-    }
-  }
-  return true;
-}
-
-// exported for the purpose of testing
-export function verify(
-  statePath: string,
-  verifiers: { [key: string]: IStateVerifier } | undefined,
-  input: any,
-  defaults: { [key: string]: any },
-  emitDescription: (description: string) => void,
-): any {
-  if (input === undefined || verifiers === undefined) {
-    return input;
-  }
-  let res = input;
-
-  const recurse = (key: string, mapKey: string) => {
-    const sane = verify(
-      statePath,
-      verifiers[key].elements,
-      res[mapKey],
-      {},
-      emitDescription,
-    );
-    if (sane !== res[mapKey]) {
-      res =
-        sane === undefined
-          ? deleteOrNop(res, [mapKey])
-          : update(res, { [mapKey]: { $set: sane } });
-    }
-  };
-
-  const doTest = (key: string, realKey: string) => {
-    if (
-      (verifiers[key].required || input.hasOwnProperty(realKey)) &&
-      !verifyElement(verifiers[key], input[realKey])
-    ) {
-      log("warn", "invalid state", {
-        statePath,
-        input,
-        key: realKey,
-        ver: verifiers[key],
-      });
-      emitDescription(verifiers[key].description(input));
-      if (verifiers[key].deleteBroken !== undefined) {
-        res =
-          verifiers[key].deleteBroken === "parent"
-            ? undefined
-            : deleteOrNop(res, [realKey]);
-      } else if (verifiers[key].repair !== undefined) {
-        try {
-          const fixed = verifiers[key].repair(
-            input[realKey],
-            defaults[realKey],
-          );
-          res = update(res, { [realKey]: { $set: fixed } });
-        } catch (err) {
-          if (err instanceof VerifierDrop) {
-            res = deleteOrNop(res, [realKey]);
-          } else if (err instanceof VerifierDropParent) {
-            res = undefined;
-          }
-        }
-      } else {
-        res = update(res, { [realKey]: { $set: defaults[realKey] } });
-      }
-    } else if (verifiers[key].elements !== undefined) {
-      recurse(key, realKey);
-    }
-  };
-
-  Object.keys(verifiers).forEach((key) => {
-    if (res === undefined) {
-      return;
-    }
-    // _ is placeholder for every item
-    if (key === "_") {
-      Object.keys(res).forEach((mapKey) => doTest(key, mapKey));
-    } else {
-      doTest(key, key);
-    }
-  });
-  return res;
-}
-
 export enum Decision {
   SANITIZE,
   IGNORE,
@@ -256,6 +147,7 @@ function hydrateRed(
           ++moreCount;
         }
       },
+      log,
     );
     if (sanitized !== input) {
       if (moreCount > 0) {
@@ -456,6 +348,7 @@ export async function sanitizeHydrationState(
           ++moreCount;
         }
       },
+      log,
     );
     if (sanitized !== input) {
       if (moreCount > 0) {