reduce number of config files

Author: dem1fo

src/config/generateConfigHash.ts

@@ -1,7 +1,6 @@
 export { loadConfig } from './loadConfig';
 export { validateConfigCore, validateConfigFile } from './validateConfig';
-export { generateConfigHash } from './generateConfigHash';
 export { makeConfigStore, ConfigStore } from './configStore';
-export { appDataLocation, attemptToReadTOMLData } from './utils';
+export { appDataLocation, attemptToReadTOMLData, generateConfigHash } from './utils';
 
 export type { Config } from './Config';

src/config/index.ts

@@ -18,7 +18,7 @@ import fs from 'node:fs';
 
 import { validateConfigFile } from './validateConfig';
 import { loadSaltFile } from './loadSaltFile';
-import { generateConfigHash } from './generateConfigHash';
+import { generateConfigHash } from './utils';
 
 import { getSaltFilePath, attemptToReadTOMLData } from './utils';
 import type { Config } from './Config';

src/config/loadConfig.ts

@@ -18,8 +18,12 @@ import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import toml from 'toml';
+import { createHash } from 'node:crypto';
+import stableStringify from 'safe-stable-stringify';
+
 import type { Config } from './Config';
 
+
 // Tries to read the file data, returns null if unsuccessful
 export function attemptToReadFileData(filePath: string, encoding: fs.EncodingOption = 'utf-8') {
   try {
@@ -87,3 +91,42 @@ export function appDataLocation() {
       throw new Error(`Unsupported platform for salt file location: ${process.platform}`);
   }
 }
+
+const DEFAULT_HASH_TYPE = 'md5';
+const HASH_DIGEST_TYPE = 'hex';
+
+type RecursivePartial<T> = { [P in keyof T]?: RecursivePartial<T[P]> };
+
+// Takes a config, removes the "signature" and salt keys from it, generates
+// a stable JSON representation and hashes it using the provided algorithm
+export function generateConfigHash<T extends Config.CoreConfiguration>(config: T, hashType = DEFAULT_HASH_TYPE) {
+  // create a nested copy of the object
+  const configCopy = { ...(JSON.parse(JSON.stringify(config)) as RecursivePartial<T>) };
+
+  // remove the "signature" key
+  if (configCopy.meta && "signature" in configCopy.meta) {
+    delete configCopy.meta.signature;
+  }
+
+  // remove the "messages" key
+  // TODO: messages should go in a separate locales file to future proof translations
+  if ("messages" in configCopy) {
+    delete configCopy.messages;
+  }
+
+  // remove the "algorithm.salt" part as it may have injected keys
+  // TODO: this enables messing with the salt file path pre-injection without signature validations, but is required for compatibility w/ the injection workflow
+  delete configCopy.algorithm!.salt!.value;
+  // mock the salt source as STRING to ensure that both imported and saved
+  // (with pre-injected salt) config files work
+  configCopy.algorithm!.salt!.source = 'STRING';
+
+  // generate a stable JSON representation
+  const stableJson = stableStringify(configCopy);
+  if (typeof stableJson !== 'string') throw new Error(`Unable to serialise config object to JSON.`);
+
+  // generate the hash
+  const hash = createHash(hashType).update(stableJson).digest(HASH_DIGEST_TYPE);
+
+  return hash;
+}