refactor: Move runtime state into shared models

Now the runtime state lives inside the model (instead of being
associated to the static settings via a map), which simplifies state
management. Static settings are now located inside the runtime models,
so we must create tests to make sure that the settings are being
persisted correctly. The contents of the config file are now generated
as a view of store (instead of a snapshot), which adds flexibility.

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

8 files changed, 95 insertions, 73 deletions

diff --git a/packages/shared/src/contextBridge/SophieRenderer.ts b/packages/shared/src/contextBridge/SophieRenderer.ts
index 9858aa9..28dc0b7 100644
--- a/packages/shared/src/contextBridge/SophieRenderer.ts
+++ b/packages/shared/src/contextBridge/SophieRenderer.ts
@@ -21,7 +21,7 @@
 import { Action } from '../schemas';
 import { SharedStoreListener } from '../stores/SharedStore';
 
-export interface SophieRenderer {
+export default interface SophieRenderer {
   onSharedStoreChange(this: void, listener: SharedStoreListener): Promise<void>;
 
   dispatchAction(this: void, action: Action): void;
diff --git a/packages/shared/src/index.ts b/packages/shared/src/index.ts
index df02854..55cf5ce 100644
--- a/packages/shared/src/index.ts
+++ b/packages/shared/src/index.ts
@@ -18,7 +18,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-export type { SophieRenderer } from './contextBridge/SophieRenderer';
+export type { default as SophieRenderer } from './contextBridge/SophieRenderer';
 
 export { MainToRendererIpcMessage, RendererToMainIpcMessage } from './ipc';
 
@@ -26,34 +26,33 @@ export type { Action, BrowserViewBounds, ThemeSource } from './schemas';
 export { action, browserViewBounds, themeSource } from './schemas';
 
 export type {
-  Config,
-  ConfigSnapshotIn,
-  ConfigSnapshotOut,
-} from './stores/Config';
-export { config } from './stores/Config';
+  GlobalSettings,
+  GlobalSettingsSnapshotIn,
+  GlobalSettingsSnapshotOut,
+} from './stores/GlobalSettings';
+export { globalSettings } from './stores/GlobalSettings';
 
-export type {
-  Profile,
-  ProfileSnapshotIn,
-  ProfileSnapshotOut,
-} from './stores/Profile';
+export type { Profile } from './stores/Profile';
 export { profile } from './stores/Profile';
 
 export type {
-  RuntimeService,
-  RuntimeServiceSnapshotIn,
-  RuntimeServiceSnapshotOut,
-} from './stores/RuntimeService';
-export { runtimeService } from './stores/RuntimeService';
+  ProfileSettings,
+  ProfileSettingsSnapshotIn,
+  ProfileSettingsSnapshotOut,
+} from './stores/ProfileSettings';
+export { profileSettings } from './stores/ProfileSettings';
 
-export type {
-  Service,
-  ServiceSnapshotIn,
-  ServiceSnapshotOut,
-} from './stores/Service';
+export type { Service } from './stores/Service';
 export { service } from './stores/Service';
 
 export type {
+  ServiceSettings,
+  ServiceSettingsSnapshotIn,
+  ServiceSettingsSnapshotOut,
+} from './stores/ServiceSettings';
+export { serviceSettings } from './stores/ServiceSettings';
+
+export type {
   SharedStore,
   SharedStoreListener,
   SharedStoreSnapshotIn,
diff --git a/packages/shared/src/stores/Config.ts b/packages/shared/src/stores/GlobalSettings.ts
index 1d97e7d..bd0155a 100644
--- a/packages/shared/src/stores/Config.ts
+++ b/packages/shared/src/stores/GlobalSettings.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
+ * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
  *
  * This file is part of Sophie.
  *
@@ -22,17 +22,14 @@ import { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
 
 import { themeSource } from '../schemas';
 
-import { profile } from './Profile';
-import { service } from './Service';
-
-export const config = types.model('Config', {
-  profiles: types.array(profile),
-  services: types.array(service),
+export const globalSettings = types.model('GlobalSettings', {
   themeSource: types.optional(types.enumeration(themeSource.options), 'system'),
 });
 
-export interface Config extends Instance<typeof config> {}
+export interface GlobalSettings extends Instance<typeof globalSettings> {}
 
-export interface ConfigSnapshotIn extends SnapshotIn<typeof config> {}
+export interface GlobalSettingsSnapshotIn
+  extends SnapshotIn<typeof globalSettings> {}
 
-export interface ConfigSnapshotOut extends SnapshotOut<typeof config> {}
+export interface GlobalSettingsSnapshotOut
+  extends SnapshotOut<typeof globalSettings> {}
diff --git a/packages/shared/src/stores/Profile.ts b/packages/shared/src/stores/Profile.ts
index 88a0f4d..bb058f6 100644
--- a/packages/shared/src/stores/Profile.ts
+++ b/packages/shared/src/stores/Profile.ts
@@ -18,15 +18,13 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
+import { Instance, types } from 'mobx-state-tree';
+
+import { profileSettings } from './ProfileSettings';
 
 export const profile = types.model('Profile', {
   id: types.identifier,
-  name: types.string,
+  settings: profileSettings,
 });
 
 export interface Profile extends Instance<typeof profile> {}
-
-export interface ProfileSnapshotIn extends SnapshotIn<typeof profile> {}
-
-export interface ProfileSnapshotOut extends SnapshotOut<typeof profile> {}
diff --git a/packages/shared/src/stores/RuntimeService.ts b/packages/shared/src/stores/ProfileSettings.ts
index c5b9031..ec8da5f 100644
--- a/packages/shared/src/stores/RuntimeService.ts
+++ b/packages/shared/src/stores/ProfileSettings.ts
@@ -20,28 +20,14 @@
 
 import { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
 
-export const runtimeService = types.model({
-  url: types.maybe(types.string),
-  canGoBack: false,
-  canGoForward: false,
-  title: types.maybe(types.string),
-  state: types.optional(
-    types.enumeration('ServiceState', [
-      'hibernated',
-      'loading',
-      'loaded',
-      'crashed',
-    ]),
-    'hibernated',
-  ),
-  directMessageCount: 0,
-  indirectMessageCount: 0,
+export const profileSettings = types.model('ProfileSettings', {
+  name: types.string,
 });
 
-export interface RuntimeService extends Instance<typeof runtimeService> {}
+export interface ProfileSettings extends Instance<typeof profileSettings> {}
 
-export interface RuntimeServiceSnapshotIn
-  extends SnapshotIn<typeof runtimeService> {}
+export interface ProfileSettingsSnapshotIn
+  extends SnapshotIn<typeof profileSettings> {}
 
-export interface RuntimeServiceSnapshotOut
-  extends SnapshotOut<typeof runtimeService> {}
+export interface ProfileSettingsSnapshotOut
+  extends SnapshotOut<typeof profileSettings> {}
diff --git a/packages/shared/src/stores/Service.ts b/packages/shared/src/stores/Service.ts
index ed2cd9a..36acd3d 100644
--- a/packages/shared/src/stores/Service.ts
+++ b/packages/shared/src/stores/Service.ts
@@ -18,20 +18,23 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
+import { Instance, types } from 'mobx-state-tree';
 
-import { profile } from './Profile';
+import { serviceSettings } from './ServiceSettings';
 
 export const service = types.model('Service', {
   id: types.identifier,
-  name: types.string,
-  profile: types.reference(profile),
-  // TODO: Remove this once recipes are added.
-  url: types.string,
+  settings: serviceSettings,
+  currentUrl: types.maybe(types.string),
+  canGoBack: false,
+  canGoForward: false,
+  title: types.maybe(types.string),
+  state: types.optional(
+    types.enumeration('ServiceState', ['loading', 'loaded', 'crashed']),
+    'loading',
+  ),
+  directMessageCount: 0,
+  indirectMessageCount: 0,
 });
 
 export interface Service extends Instance<typeof service> {}
-
-export interface ServiceSnapshotIn extends SnapshotIn<typeof service> {}
-
-export interface ServiceSnapshotOut extends SnapshotOut<typeof service> {}
diff --git a/packages/shared/src/stores/ServiceSettings.ts b/packages/shared/src/stores/ServiceSettings.ts
new file mode 100644
index 0000000..54cd7eb
--- /dev/null
+++ b/packages/shared/src/stores/ServiceSettings.ts
@@ -0,0 +1,38 @@
+/*
+ * Copyright (C)  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 { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
+
+import { profile } from './Profile';
+
+export const serviceSettings = types.model('ServiceSettings', {
+  name: types.string,
+  profile: types.reference(profile),
+  // TODO: Remove this once recipes are added.
+  url: types.string,
+});
+
+export interface ServiceSettings extends Instance<typeof serviceSettings> {}
+
+export interface ServiceSettingsSnapshotIn
+  extends SnapshotIn<typeof serviceSettings> {}
+
+export interface ServiceSettingsSnapshotOut
+  extends SnapshotOut<typeof serviceSettings> {}
diff --git a/packages/shared/src/stores/SharedStore.ts b/packages/shared/src/stores/SharedStore.ts
index e6e2cad..a04f4bf 100644
--- a/packages/shared/src/stores/SharedStore.ts
+++ b/packages/shared/src/stores/SharedStore.ts
@@ -26,13 +26,14 @@ import {
   SnapshotOut,
 } from 'mobx-state-tree';
 
-import { config } from './Config';
-import { runtimeService } from './RuntimeService';
+import { globalSettings } from './GlobalSettings';
+import { profile } from './Profile';
 import { service } from './Service';
 
 export const sharedStore = types.model('SharedStore', {
-  config: types.optional(config, {}),
-  runtimeServices: types.map(runtimeService),
+  settings: types.optional(globalSettings, {}),
+  profiles: types.array(profile),
+  services: types.array(service),
   selectedService: types.safeReference(service),
   shouldUseDarkColors: false,
 });