refactor: Coding conventions

Make sure that files have a default import with the same name as the
file whenever possible to reduce surprise.

Also shuffles around some file names for better legibility.

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

1 files changed, 0 insertions, 229 deletions

diff --git a/packages/main/src/controllers/__tests__/initConfig.spec.ts b/packages/main/src/controllers/__tests__/initConfig.spec.ts
deleted file mode 100644
index fdd22c9..0000000
--- a/packages/main/src/controllers/__tests__/initConfig.spec.ts
+++ /dev/null
@@ -1,229 +0,0 @@
-/*
- * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
- *
- * This file is part of Sophie.
- *
- * Sophie is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import { jest } from '@jest/globals';
-import { mocked } from 'jest-mock';
-import ms from 'ms';
-
-import type ConfigPersistence from '../../infrastructure/ConfigPersistence';
-import { sharedStore, SharedStore } from '../../stores/SharedStore';
-import type Disposer from '../../utils/Disposer';
-import { silenceLogger } from '../../utils/log';
-import initConfig from '../initConfig';
-
-let store: SharedStore;
-const persistenceService: ConfigPersistence = {
-  readConfig: jest.fn(),
-  writeConfig: jest.fn(),
-  watchConfig: jest.fn(),
-};
-const lessThanThrottleMs = ms('0.1s');
-const throttleMs = ms('1s');
-
-beforeAll(() => {
-  jest.useFakeTimers();
-  silenceLogger();
-});
-
-beforeEach(() => {
-  store = sharedStore.create();
-});
-
-describe('when initializing', () => {
-  describe('when there is no config file', () => {
-    beforeEach(() => {
-      mocked(persistenceService.readConfig).mockResolvedValueOnce({
-        found: false,
-      });
-    });
-
-    it('should create a new config file', async () => {
-      await initConfig(store, persistenceService);
-      expect(persistenceService.writeConfig).toHaveBeenCalledTimes(1);
-    });
-
-    it('should bail if there is an an error creating the config file', async () => {
-      mocked(persistenceService.writeConfig).mockRejectedValue(
-        new Error('boo'),
-      );
-      await expect(() =>
-        initConfig(store, persistenceService),
-      ).rejects.toBeInstanceOf(Error);
-    });
-  });
-
-  describe('when there is a valid config file', () => {
-    beforeEach(() => {
-      mocked(persistenceService.readConfig).mockResolvedValueOnce({
-        found: true,
-        data: {
-          // Use a default empty config file to not trigger config rewrite.
-          ...store.config,
-          themeSource: 'dark',
-        },
-      });
-    });
-
-    it('should read the existing config file is there is one', async () => {
-      await initConfig(store, persistenceService);
-      expect(persistenceService.writeConfig).not.toHaveBeenCalled();
-      expect(store.settings.themeSource).toBe('dark');
-    });
-
-    it('should bail if it cannot set up a watcher', async () => {
-      mocked(persistenceService.watchConfig).mockImplementationOnce(() => {
-        throw new Error('boo');
-      });
-      await expect(() =>
-        initConfig(store, persistenceService),
-      ).rejects.toBeInstanceOf(Error);
-    });
-  });
-
-  it('should update the config file if new details are added during read', async () => {
-    mocked(persistenceService.readConfig).mockResolvedValueOnce({
-      found: true,
-      data: {
-        themeSource: 'light',
-        profile: {
-          name: 'Test profile',
-        },
-      },
-    });
-    await initConfig(store, persistenceService);
-    expect(persistenceService.writeConfig).toHaveBeenCalledTimes(1);
-  });
-
-  it('should not apply an invalid config file but should not overwrite it', async () => {
-    mocked(persistenceService.readConfig).mockResolvedValueOnce({
-      found: true,
-      data: {
-        themeSource: -1,
-      },
-    });
-    await initConfig(store, persistenceService);
-    expect(store.settings.themeSource).not.toBe(-1);
-    expect(persistenceService.writeConfig).not.toHaveBeenCalled();
-  });
-
-  it('should bail if it cannot determine whether there is a config file', async () => {
-    mocked(persistenceService.readConfig).mockRejectedValue(new Error('boo'));
-    await expect(() =>
-      initConfig(store, persistenceService),
-    ).rejects.toBeInstanceOf(Error);
-  });
-});
-
-describe('when it has loaded the config', () => {
-  let sutDisposer: Disposer;
-  const watcherDisposer: Disposer = jest.fn();
-  let configChangedCallback: () => Promise<void>;
-
-  beforeEach(async () => {
-    mocked(persistenceService.readConfig).mockResolvedValueOnce({
-      found: true,
-      data: store.config,
-    });
-    mocked(persistenceService.watchConfig).mockReturnValueOnce(watcherDisposer);
-    sutDisposer = await initConfig(store, persistenceService, throttleMs);
-    [[configChangedCallback]] = mocked(
-      persistenceService.watchConfig,
-    ).mock.calls;
-    jest.resetAllMocks();
-  });
-
-  it('should throttle saving changes to the config file', () => {
-    mocked(persistenceService.writeConfig).mockResolvedValue();
-    store.settings.setThemeSource('dark');
-    jest.advanceTimersByTime(lessThanThrottleMs);
-    store.settings.setThemeSource('light');
-    jest.advanceTimersByTime(throttleMs);
-    expect(persistenceService.writeConfig).toHaveBeenCalledTimes(1);
-  });
-
-  it('should handle config writing errors gracefully', () => {
-    mocked(persistenceService.writeConfig).mockRejectedValue(new Error('boo'));
-    store.settings.setThemeSource('dark');
-    jest.advanceTimersByTime(throttleMs);
-    expect(persistenceService.writeConfig).toHaveBeenCalledTimes(1);
-  });
-
-  it('should read the config file when it has changed', async () => {
-    mocked(persistenceService.readConfig).mockResolvedValueOnce({
-      found: true,
-      data: {
-        // Use a default empty config file to not trigger config rewrite.
-        ...store.config,
-        themeSource: 'dark',
-      },
-    });
-    await configChangedCallback();
-    // Do not write back the changes we have just read.
-    expect(persistenceService.writeConfig).not.toHaveBeenCalled();
-    expect(store.settings.themeSource).toBe('dark');
-  });
-
-  it('should update the config file if new details are added', async () => {
-    mocked(persistenceService.readConfig).mockResolvedValueOnce({
-      found: true,
-      data: {
-        themeSource: 'light',
-        profile: {
-          name: 'Test profile',
-        },
-      },
-    });
-    await configChangedCallback();
-    expect(persistenceService.writeConfig).toHaveBeenCalledTimes(1);
-  });
-
-  it('should not apply an invalid config file when it has changed but should not overwrite it', async () => {
-    mocked(persistenceService.readConfig).mockResolvedValueOnce({
-      found: true,
-      data: {
-        themeSource: -1,
-      },
-    });
-    await configChangedCallback();
-    expect(store.settings.themeSource).not.toBe(-1);
-    expect(persistenceService.writeConfig).not.toHaveBeenCalled();
-  });
-
-  it('should handle config reading errors gracefully', async () => {
-    mocked(persistenceService.readConfig).mockRejectedValue(new Error('boo'));
-    await expect(configChangedCallback()).resolves.not.toThrow();
-  });
-
-  describe('when it was disposed', () => {
-    beforeEach(() => {
-      sutDisposer();
-    });
-
-    it('should dispose the watcher', () => {
-      expect(watcherDisposer).toHaveBeenCalled();
-    });
-
-    it('should not listen to store changes any more', () => {
-      store.settings.setThemeSource('dark');
-      jest.advanceTimersByTime(2 * throttleMs);
-      expect(persistenceService.writeConfig).not.toHaveBeenCalled();
-    });
-  });
-});