Migrate settings.ini from utf16 to utf8

ori-community · Nov 24, 2023 · 81facac · 81facac
1 parent 0d6aa3e
commit 81facac
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 3 deletions.
diff --git a/electron/src/background.ts b/electron/src/background.ts
@@ -28,8 +28,9 @@ export function getWindow() {
 }
 
 async function createWindow() {
+  await SettingsService.runPreSettingsMigrations()
   await SettingsService.makeSureSettingsFileExists()
-  await SettingsService.migrateSettingsVersion()
+  await SettingsService.runSettingsMigrations()
 
   registerUIIpcApi()
 

diff --git a/electron/src/lib/SettingsService.js b/electron/src/lib/SettingsService.js
@@ -98,7 +98,32 @@ export class SettingsService {
     return events
   }
 
-  static async migrateSettingsVersion() {
+  /**
+   * Runs migrations before having read the settings
+   * @returns {Promise<void>}
+   */
+  static async runPreSettingsMigrations() {
+    if (!fs.existsSync(SETTINGS_PATH)) {
+      return
+    }
+
+    const currentVersion = (await updater.getVersion()).trim()
+
+    if (fs.existsSync(LAST_VERSION_FILE) && currentVersion !== 'develop') {
+      const lastVersion = (await fs.promises.readFile(LAST_VERSION_FILE, { encoding: 'utf-8' })).trim()
+
+      if (semver.lt(lastVersion, '3.0.0') && semver.gte(currentVersion, '3.0.0')) {  // settings.ini encoding changed from utf16le to utf-8 in 3.0.0
+        const settingsIniContent = await fs.promises.readFile(SETTINGS_PATH, { encoding: 'utf16le' });
+        await fs.promises.writeFile(SETTINGS_PATH, settingsIniContent, { encoding: 'utf-8' });
+      }
+    }
+  }
+
+  /**
+   * Run migrations after having read the settings
+   * @returns {Promise<void>}
+   */
+  static async runSettingsMigrations() {
     const currentVersion = (await updater.getVersion()).trim()
 
     if (fs.existsSync(LAST_VERSION_FILE) && currentVersion !== 'develop') {
@@ -175,7 +200,7 @@ export class SettingsService {
     let settingsObject = getDefaultSettings()
 
     if (fs.existsSync(SETTINGS_PATH)) {
-      const settingsIniContent = await fs.promises.readFile(SETTINGS_PATH, { encoding: 'utf16le' });
+      const settingsIniContent = await fs.promises.readFile(SETTINGS_PATH, { encoding: 'utf-8' });
       settingsObject = merge(settingsObject, ini.parse(settingsIniContent.trimStart()))
     } else {
       console.log("Settings file not found. Using default settings.");