refactor: config file saving and debugging

Reduce the number of dependencies and the amount of code running in a
security sensitive context.

Instead of a deep comparison, we just compare the serialized versions
of the config files.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

4 files changed, 37 insertions, 37 deletions

diff --git a/packages/main/src/infrastructure/config/ConfigRepository.ts b/packages/main/src/infrastructure/config/ConfigRepository.ts
index e00f5a0..67bffb0 100644
--- a/packages/main/src/infrastructure/config/ConfigRepository.ts
+++ b/packages/main/src/infrastructure/config/ConfigRepository.ts
@@ -18,17 +18,16 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import type Config from '../../stores/config/Config';
 import type Disposer from '../../utils/Disposer';
 
 export type ReadConfigResult =
-  | { found: true; data: unknown }
+  | { found: true; contents: string }
   | { found: false };
 
 export default interface ConfigPersistence {
   readConfig(): Promise<ReadConfigResult>;
 
-  writeConfig(config: Config): Promise<void>;
+  writeConfig(contents: string): Promise<void>;
 
   watchConfig(callback: () => Promise<void>, throttleMs: number): Disposer;
 }
diff --git a/packages/main/src/infrastructure/config/impl/ConfigFile.ts b/packages/main/src/infrastructure/config/impl/ConfigFile.ts
index c4e6d22..8b110a2 100644
--- a/packages/main/src/infrastructure/config/impl/ConfigFile.ts
+++ b/packages/main/src/infrastructure/config/impl/ConfigFile.ts
@@ -24,7 +24,6 @@ import path from 'node:path';
 
 import { throttle } from 'lodash-es';
 
-import type Config from '../../../stores/config/Config';
 import type Disposer from '../../../utils/Disposer';
 import isErrno from '../../../utils/isErrno';
 import { getLogger } from '../../../utils/log';
@@ -48,9 +47,9 @@ export default class ConfigFile implements ConfigRepository {
   }
 
   async readConfig(): Promise<ReadConfigResult> {
-    let configStr: string;
+    let contents: string;
     try {
-      configStr = await readFile(this.configFilePath, 'utf8');
+      contents = await readFile(this.configFilePath, 'utf8');
     } catch (error) {
       if (isErrno(error, 'ENOENT')) {
         log.debug('Config file', this.configFilePath, 'was not found');
@@ -61,15 +60,14 @@ export default class ConfigFile implements ConfigRepository {
     log.info('Read config file', this.configFilePath);
     return {
       found: true,
-      data: JSON.parse(configStr),
+      contents,
     };
   }
 
-  async writeConfig(configSnapshot: Config): Promise<void> {
-    const configJson = JSON.stringify(configSnapshot, undefined, 2);
+  async writeConfig(contents: string): Promise<void> {
     this.writingConfig = true;
     try {
-      await writeFile(this.configFilePath, configJson, 'utf8');
+      await writeFile(this.configFilePath, contents, 'utf8');
       const { mtime } = await stat(this.configFilePath);
       log.trace('Config file', this.configFilePath, 'last written at', mtime);
       this.timeLastWritten = mtime;
diff --git a/packages/main/src/infrastructure/electron/impl/devTools.ts b/packages/main/src/infrastructure/electron/impl/devTools.ts
index 10f4545..6db88d1 100644
--- a/packages/main/src/infrastructure/electron/impl/devTools.ts
+++ b/packages/main/src/infrastructure/electron/impl/devTools.ts
@@ -18,34 +18,32 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import type { BrowserWindow } from 'electron';
+import { app, type BrowserWindow } from 'electron';
+
+/* eslint-disable
+  import/no-extraneous-dependencies,
+  global-require,
+  @typescript-eslint/no-var-requires,
+  unicorn/prefer-module --
+  Hack to lazily require a CJS module from an ES module transpiled into a CJS module.
+*/
 
 /**
- * URL prefixes Sophie is allowed load in dev mode.
- *
- * In dev mode, in addition to the application itself,
- * Sophie must be able do download and load the devtools and related extensions,
- * so we have to make exceptions in the UI process request filter.
+ * Makes sure we use a separate data dir for development.
  */
-export const DEVMODE_ALLOWED_URL_PREFIXES = [
-  'chrome-extension:',
-  'devtools:',
-  'https://clients2.google.com/service/update2/crx',
-  'https://clients2.googleusercontent.com/crx',
-];
+export function ensureDevDataDir(): void {
+  // Use alternative directory when debugging to avoid clobbering the main installation.
+  app.setPath('userData', `${app.getPath('userData')}-dev`);
+  const userData = app.getPath('userData');
+  const mkdirp = require('mkdirp') as typeof import('mkdirp');
+  mkdirp.sync(userData);
+}
 
 /**
  * Enables using source maps for node stack traces.
  */
 export function enableStacktraceSourceMaps(): void {
   const sourceMapSupport =
-    /* eslint-disable-next-line
-      import/no-extraneous-dependencies,
-      global-require,
-      @typescript-eslint/no-var-requires,
-      unicorn/prefer-module --
-      Hack to lazily require a CJS module from an ES module transpiled into a CJS module.
-    */
     require('source-map-support') as typeof import('source-map-support');
   sourceMapSupport.install();
 }
@@ -61,13 +59,6 @@ export async function installDevToolsExtensions(): Promise<void> {
     default: installExtension,
     REACT_DEVELOPER_TOOLS,
     REDUX_DEVTOOLS,
-    /* eslint-disable-next-line
-      import/no-extraneous-dependencies,
-      global-require,
-      @typescript-eslint/no-var-requires,
-      unicorn/prefer-module --
-      Hack to lazily require a CJS module from an ES module transpiled into a CJS module.
-    */
   } = require('electron-devtools-installer') as typeof import('electron-devtools-installer');
   await installExtension([REACT_DEVELOPER_TOOLS, REDUX_DEVTOOLS], {
     forceDownload: false,
diff --git a/packages/main/src/infrastructure/electron/impl/hardenSession.ts b/packages/main/src/infrastructure/electron/impl/hardenSession.ts
index 10b694a..53675a7 100644
--- a/packages/main/src/infrastructure/electron/impl/hardenSession.ts
+++ b/packages/main/src/infrastructure/electron/impl/hardenSession.ts
@@ -25,7 +25,19 @@ import type { Session } from 'electron';
 import { getLogger } from '../../../utils/log';
 import type Resources from '../../resources/Resources';
 
-import { DEVMODE_ALLOWED_URL_PREFIXES } from './devTools';
+/**
+ * URL prefixes Sophie is allowed load in dev mode.
+ *
+ * In dev mode, in addition to the application itself,
+ * Sophie must be able do download and load the devtools and related extensions,
+ * so we have to make exceptions in the UI process request filter.
+ */
+export const DEVMODE_ALLOWED_URL_PREFIXES = [
+  'chrome-extension:',
+  'devtools:',
+  'https://clients2.google.com/service/update2/crx',
+  'https://clients2.googleusercontent.com/crx',
+];
 
 const log = getLogger('hardenSession');