Add font migration to v3

Author: florianduros

src/settings/Settings.tsx

@@ -526,6 +526,18 @@ export const SETTINGS: { [setting: string]: ISetting } = {
         supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
         default: false,
     },
+    /**
+     * With the transition to Compound we are moving to a base font size
+     * of 16px. We're taking the opportunity to move away from the `baseFontSize`
+     * setting that had a 5px offset.
+     *
+     */
+    "baseFontSizeV2": {
+        displayName: _td("settings|appearance|font_size"),
+        supportedLevels: [SettingLevel.DEVICE],
+        default: "",
+        controller: new FontSizeController(),
+    },
     /**
      * Moving from `baseFontSizeV2` to `baseFontSizeV3` to replace the default 16px to --cpd-font-size-root
      * which is using the browser default font size.

src/settings/controllers/FontSizeController.ts

@@ -26,8 +26,6 @@ export default class FontSizeController extends SettingController {
     }
 
     public onChange(level: SettingLevel, roomId: string, newValue: any): void {
-        // TODO migrate fontV2 to fontV3
-
         // In a distant past, `baseFontSize` was set on the account and config
         // level. This can be accessed only after the initial sync. If we end up
         // discovering that a logged in user has this kind of setting, we want to

src/settings/watchers/FontWatcher.ts

@@ -55,36 +55,96 @@ export class FontWatcher implements IWatcher {
         this.updateFont();
         this.dispatcherRef = dis.register(this.onAction);
         /**
-         * TODO To change before review
          * baseFontSize is an account level setting which is loaded after the initial
          * sync. Hence why we can't do that in the `constructor`
          */
         await this.migrateBaseFontSize();
     }
 
     /**
-     * Migrating the old `baseFontSize` for Compound.
-     * Everything will becomes slightly larger, and getting rid of the `SIZE_DIFF`
-     * weirdness for locally persisted values
+     * Migrate the base font size from the V1 and V2 version to the V3 version
+     * @private
      */
     private async migrateBaseFontSize(): Promise<void> {
-        const legacyBaseFontSize = SettingsStore.getValue("baseFontSize");
-        if (legacyBaseFontSize) {
-            console.log("Migrating base font size for Compound, current value", legacyBaseFontSize);
-
-            // For some odd reason, the persisted value in user storage has an offset
-            // of 5 pixels for all values stored under `baseFontSize`
-            const LEGACY_SIZE_DIFF = 5;
-            // Compound uses a base font size of `16px`, whereas the old Element
-            // styles based their calculations off a `15px` root font size.
-            const ROOT_FONT_SIZE_INCREASE = 1;
-
-            const baseFontSize = legacyBaseFontSize + ROOT_FONT_SIZE_INCREASE + LEGACY_SIZE_DIFF;
-
-            await SettingsStore.setValue("baseFontSizeV2", null, SettingLevel.DEVICE, baseFontSize);
-            await SettingsStore.setValue("baseFontSize", null, SettingLevel.DEVICE, "");
-            console.log("Migration complete, deleting legacy `baseFontSize`");
-        }
+        await this.migrateBaseFontV1toV3();
+        await this.migrateBaseFontV2toV3();
+    }
+
+    /**
+     * Migrating from the V1 version of the base font size to the V3 version
+     * The V3 is using the default browser font size as a base
+     * Everything will become slightly larger, and getting rid of the `SIZE_DIFF`
+     * weirdness for locally persisted values
+     * @private
+     */
+    private async migrateBaseFontV1toV3(): Promise<void> {
+        const legacyBaseFontSize = SettingsStore.getValue<number>("baseFontSize");
+        // No baseFontV1 found, nothing to migrate
+        if (!legacyBaseFontSize) return;
+
+        console.log(
+            "Migrating base font size -> base font size V2 -> base font size V3 for Compound, current value",
+            legacyBaseFontSize,
+        );
+
+        // Compute the new font size of the V2 version before migrating to V3
+        const baseFontSizeV2 = this.computeBaseFontSizeV1toV2(legacyBaseFontSize);
+
+        // Compute the difference between the V2 and the V3 version
+        const deltaV3 = this.computeBaseFontV2toV3(baseFontSizeV2);
+
+        await SettingsStore.setValue("baseFontSizeV3", null, SettingLevel.DEVICE, deltaV3);
+        await SettingsStore.setValue("baseFontSize", null, SettingLevel.DEVICE, 0);
+        console.log("Migration complete, deleting legacy `baseFontSize`");
+    }
+
+    /**
+     * Migrating from the V2 version of the base font size to the V3 version
+     * @private
+     */
+    private async migrateBaseFontV2toV3(): Promise<void> {
+        const legacyBaseFontV2Size = SettingsStore.getValue<number>("baseFontSizeV2");
+        // No baseFontV2 found, nothing to migrate
+        if (!legacyBaseFontV2Size) return;
+
+        console.log("Migrating base font size V2 for Compound, current value", legacyBaseFontV2Size);
+
+        // Compute the difference between the V2 and the V3 version
+        const deltaV3 = this.computeBaseFontV2toV3(legacyBaseFontV2Size);
+
+        await SettingsStore.setValue("baseFontSizeV3", null, SettingLevel.DEVICE, deltaV3);
+        await SettingsStore.setValue("baseFontSizeV2", null, SettingLevel.DEVICE, 0);
+        console.log("Migration complete, deleting legacy `baseFontSizeV2`");
+    }
+
+    private computeBaseFontSizeV1toV2(legacyBaseFontSize: number): number {
+        // For some odd reason, the persisted value in user storage has an offset
+        // of 5 pixels for all values stored under `baseFontSize`
+        const LEGACY_SIZE_DIFF = 5;
+
+        // Compound uses a base font size of `16px`, whereas the old Element
+        // styles based their calculations off a `15px` root font size.
+        const ROOT_FONT_SIZE_INCREASE = 1;
+
+        // Compute the font size of the V2 version before migrating to V3
+        return legacyBaseFontSize + ROOT_FONT_SIZE_INCREASE + LEGACY_SIZE_DIFF;
+    }
+
+    private computeBaseFontV2toV3(legacyBaseFontV2Size: number): number {
+        const browserDefaultFontSize = this.getBrowserDefaultFontSize();
+
+        // Compute the difference between the V2 font size and the default browser font size
+        return legacyBaseFontV2Size - browserDefaultFontSize;
+    }
+
+    /**
+     * Get the default font size of the browser
+     * Fallback to 16px if the value is not found
+     * @private
+     * @returns {number} the value of ${@link DEFAULT_SIZE} in pixels
+     */
+    private getBrowserDefaultFontSize(): number {
+        return parseInt(window.getComputedStyle(document.documentElement).getPropertyValue("font-size"), 10) || 16;
     }
 
     public stop(): void {
@@ -123,6 +183,10 @@ export class FontWatcher implements IWatcher {
         }
     };
 
+    /**
+     * Set the root font size of the document
+     * @param delta {number} the delta to add to the default font size
+     */
     private setRootFontSize = async (delta: number): Promise<void> => {
         // Check that the new delta doesn't exceed the limits
         const fontDelta = clamp(delta, FontWatcher.MIN_DELTA, FontWatcher.MAX_DELTA);

test/settings/watchers/FontWatcher-test.tsx

@@ -123,6 +123,7 @@ describe("FontWatcher", function () {
         let watcher: FontWatcher | undefined;
 
         beforeEach(() => {
+            document.documentElement.style.fontSize = "14px";
             watcher = new FontWatcher();
         });
 
@@ -132,13 +133,35 @@ describe("FontWatcher", function () {
 
         it("should not run the migration", async () => {
             await watcher!.start();
-            expect(SettingsStore.getValue("baseFontSizeV2")).toBe(16);
+            expect(SettingsStore.getValue("baseFontSizeV3")).toBe(0);
         });
 
-        it("should migrate to default font size", async () => {
+        it("should migrate from V1 font size to V3", async () => {
             await SettingsStore.setValue("baseFontSize", null, SettingLevel.DEVICE, 13);
             await watcher!.start();
-            expect(SettingsStore.getValue("baseFontSizeV2")).toBe(19);
+            // 13px (V1 font size) + 5px (V1 offset) + 1px (root font size increase) - 14px (default browser font size) = 5px
+            expect(SettingsStore.getValue("baseFontSizeV3")).toBe(5);
+            // baseFontSize should be cleared
+            expect(SettingsStore.getValue("baseFontSize")).toBe(0);
+        });
+
+        it("should migrate from V2 font size to V3 using browser font size", async () => {
+            await SettingsStore.setValue("baseFontSizeV2", null, SettingLevel.DEVICE, 18);
+            await watcher!.start();
+            // 18px - 14px (default browser font size) = 2px
+            expect(SettingsStore.getValue("baseFontSizeV3")).toBe(4);
+            // baseFontSize should be cleared
+            expect(SettingsStore.getValue("baseFontSizeV2")).toBe(0);
+        });
+
+        it("should migrate from V2 font size to V3 using fallback font size", async () => {
+            document.documentElement.style.fontSize = "";
+            await SettingsStore.setValue("baseFontSizeV2", null, SettingLevel.DEVICE, 18);
+            await watcher!.start();
+            // 18px - 16px (fallback) = 2px
+            expect(SettingsStore.getValue("baseFontSizeV3")).toBe(2);
+            // baseFontSize should be cleared
+            expect(SettingsStore.getValue("baseFontSizeV2")).toBe(0);
         });
     });
 });