Class UserStorage

src/background/user-storage.ts:15–246

const SAVE_TIMEOUT = 1000;

export default class UserStorage {
    private static loadBarrier: PromiseBarrier<UserSettings, void>;
    private static saveStorageBarrier: PromiseBarrier<void, void> | null;
    static settings: Readonly<UserSettings>;

    static async loadSettings(): Promise<void> {
        if (!UserStorage.settings) {
            UserStorage.settings = await UserStorage.loadSettingsFromStorage();
        }
    }

    private static fillDefaults(settings: UserSettings) {
        settings.theme = {...DEFAULT_THEME, ...settings.theme};
        settings.time = {...DEFAULT_SETTINGS.time, ...settings.time};
        settings.presets.forEach((preset) => {
            preset.theme = {...DEFAULT_THEME, ...preset.theme};
        });
        settings.customThemes.forEach((site) => {
            site.theme = {...DEFAULT_THEME, ...site.theme};
        });
        if (settings.customThemes.length === 0) {
            settings.customThemes = DEFAULT_SETTINGS.customThemes;
        }
    }

    // migrateAutomationSettings migrates old automation settings to the new interface.
    // It will move settings.automation & settings.automationBehavior into,
    // settings.automation = { enabled, mode, behavior }.
    // Remove this over two years(mid-2024).
    // This won't always work, because browsers can decide to instead use the default settings
    // when they notice a different type being requested for automation, in that case it's a data-loss
    // and not something we can encounter for, except for doing always two extra requests to explicitly
    // check for this case which is inefficient usage of requesting storage.
    private static migrateAutomationSettings(settings: UserSettings): void {
        if (typeof settings.automation === 'string') {
            const automationMode = settings.automation;
            const automationBehavior: UserSettings['automation']['behavior'] = (settings as any).automationBehaviour;
            if (settings.automation === '') {
                settings.automation = {
                    enabled: false,
                    mode: automationMode,
                    behavior: automationBehavior,
                };
            } else {
                settings.automation = {
                    enabled: true,
                    mode: automationMode,
                    behavior: automationBehavior,
                };
            }
            delete (settings as any).automationBehaviour;
        }
    }

    private static migrateSiteListsV2(deprecated: any): Partial<UserSettings> {
        const settings: Partial<UserSettings> = {};
        settings.enabledByDefault = !deprecated.applyToListedOnly;
        if (settings.enabledByDefault) {