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>

9 files changed, 15 insertions, 329 deletions

diff --git a/packages/renderer/src/components/ServiceSwitcher.tsx b/packages/renderer/src/components/ServiceSwitcher.tsx
index 0786b71..167153f 100644
--- a/packages/renderer/src/components/ServiceSwitcher.tsx
+++ b/packages/renderer/src/components/ServiceSwitcher.tsx
@@ -78,8 +78,8 @@ export default observer(() => {
         <ServiceSwitcherTab
           key={service.id}
           value={service.id}
-          icon={<ServiceIcon name={service.name} />}
-          aria-label={service.name}
+          icon={<ServiceIcon name={service.settings.name} />}
+          aria-label={service.settings.name}
         />
       ))}
     </ServiceSwitcherRoot>
diff --git a/packages/renderer/src/env/RendererEnv.ts b/packages/renderer/src/env/RendererEnv.ts
index 5ca2978..ba4c43e 100644
--- a/packages/renderer/src/env/RendererEnv.ts
+++ b/packages/renderer/src/env/RendererEnv.ts
@@ -18,10 +18,8 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import type { Action, RuntimeService } from '@sophie/shared';
+import type { Action } from '@sophie/shared';
 
 export default interface RendererEnv {
   dispatchMainAction(action: Action): void;
-
-  getRuntimeService(serviceId: string): RuntimeService | undefined;
 }
diff --git a/packages/renderer/src/env/impl/RendererEnvImpl.ts b/packages/renderer/src/env/impl/RendererEnvImpl.ts
deleted file mode 100644
index 184d31b..0000000
--- a/packages/renderer/src/env/impl/RendererEnvImpl.ts
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- * 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 {
-  Action,
-  runtimeService,
-  RuntimeService,
-  SophieRenderer,
-} from '@sophie/shared';
-import type { IMSTMap } from 'mobx-state-tree';
-
-import type { RendererStore } from '../../stores/RendererStore';
-import type RendererEnv from '../RendererEnv';
-
-export default class RendererEnvImpl implements RendererEnv {
-  readonly #ipc: SophieRenderer;
-
-  #runtimeServices: IMSTMap<typeof runtimeService> | undefined;
-
-  constructor(ipc: SophieRenderer) {
-    this.#ipc = ipc;
-  }
-
-  setStore(store: RendererStore): void {
-    this.#runtimeServices = store.shared.runtimeServices;
-  }
-
-  dispatchMainAction(action: Action): void {
-    this.#ipc.dispatchAction(action);
-  }
-
-  getRuntimeService(serviceId: string): RuntimeService | undefined {
-    if (this.#runtimeServices === undefined) {
-      throw new Error('runtime services map is not yet set');
-    }
-    return this.#runtimeServices.get(serviceId);
-  }
-}
diff --git a/packages/renderer/src/env/impl/__tests__/RendererEnvImpl.spec.ts b/packages/renderer/src/env/impl/__tests__/RendererEnvImpl.spec.ts
deleted file mode 100644
index d36462c..0000000
--- a/packages/renderer/src/env/impl/__tests__/RendererEnvImpl.spec.ts
+++ /dev/null
@@ -1,87 +0,0 @@
-/*
- * 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 { jest } from '@jest/globals';
-import {
-  Action,
-  runtimeService,
-  RuntimeService,
-  SophieRenderer,
-} from '@sophie/shared';
-
-import { rendererStore } from '../../../stores/RendererStore';
-import RendererEnvImpl from '../RendererEnvImpl';
-
-const ipc: SophieRenderer = {
-  dispatchAction: jest.fn(),
-  onSharedStoreChange: jest.fn(),
-};
-let sut: RendererEnvImpl;
-
-beforeEach(() => {
-  sut = new RendererEnvImpl(ipc);
-});
-
-describe('dispatchMainAction', () => {
-  it('should dispatch actions via the IPC', () => {
-    const action: Action = {
-      action: 'set-theme-source',
-      themeSource: 'dark',
-    };
-    sut.dispatchMainAction(action);
-    expect(ipc.dispatchAction).toHaveBeenCalledWith(action);
-  });
-});
-
-describe('getRuntimeService', () => {
-  describe('when no store was set', () => {
-    it('should throw an error', () => {
-      expect(() => sut.getRuntimeService('someId')).toThrow();
-    });
-  });
-
-  describe('when the store was set', () => {
-    let runtimeServiceStore: RuntimeService;
-
-    beforeEach(() => {
-      runtimeServiceStore = runtimeService.create({
-        state: 'loaded',
-      });
-      const store = rendererStore.create({
-        shared: {
-          runtimeServices: {
-            someId: runtimeServiceStore,
-          },
-        },
-      });
-      sut.setStore(store);
-    });
-
-    it('should return the runtime service for the given ID', () => {
-      const returnedStore = sut.getRuntimeService('someId');
-      expect(returnedStore).toBe(runtimeServiceStore);
-    });
-
-    it('should return undefined for an unknown ID', () => {
-      const returnedStore = sut.getRuntimeService('unknownId');
-      expect(returnedStore).toBeUndefined();
-    });
-  });
-});
diff --git a/packages/renderer/src/stores/Config.ts b/packages/renderer/src/stores/Config.ts
deleted file mode 100644
index 070c4ec..0000000
--- a/packages/renderer/src/stores/Config.ts
+++ /dev/null
@@ -1,32 +0,0 @@
-/*
- * 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 { config as originalConfig } from '@sophie/shared';
-import { Instance, types } from 'mobx-state-tree';
-
-import { service } from './Service';
-
-export const config = originalConfig.props({
-  services: types.array(service),
-});
-
-export interface Config extends Instance<typeof config> {}
-
-export type { ConfigSnapshotIn, ConfigSnapshotOut } from '@sophie/shared';
diff --git a/packages/renderer/src/stores/RendererStore.ts b/packages/renderer/src/stores/RendererStore.ts
index 731ca28..a4e6197 100644
--- a/packages/renderer/src/stores/RendererStore.ts
+++ b/packages/renderer/src/stores/RendererStore.ts
@@ -18,17 +18,19 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { BrowserViewBounds, SophieRenderer, ThemeSource } from '@sophie/shared';
+import {
+  BrowserViewBounds,
+  sharedStore,
+  Service,
+  SophieRenderer,
+  ThemeSource,
+} from '@sophie/shared';
 import { applySnapshot, applyPatch, Instance, types } from 'mobx-state-tree';
 
+import RendererEnv from '../env/RendererEnv';
 import getEnv from '../env/getEnv';
-import RendererEnvImpl from '../env/impl/RendererEnvImpl';
 import { getLogger } from '../utils/log';
 
-import type { Config } from './Config';
-import type { Service } from './Service';
-import { sharedStore } from './SharedStore';
-
 const log = getLogger('RendererStore');
 
 export const rendererStore = types
@@ -36,11 +38,8 @@ export const rendererStore = types
     shared: types.optional(sharedStore, {}),
   })
   .views((self) => ({
-    get config(): Config {
-      return self.shared.config;
-    },
     get services(): Service[] {
-      return this.config.services;
+      return self.shared.services;
     },
     get selectedService(): Service | undefined {
       return self.shared.selectedService;
@@ -87,9 +86,10 @@ export interface RendererStore extends Instance<typeof rendererStore> {}
 export function createAndConnectRendererStore(
   ipc: SophieRenderer,
 ): RendererStore {
-  const env = new RendererEnvImpl(ipc);
+  const env: RendererEnv = {
+    dispatchMainAction: ipc.dispatchAction,
+  };
   const store = rendererStore.create({}, env);
-  env.setStore(store);
 
   ipc
     .onSharedStoreChange({
diff --git a/packages/renderer/src/stores/Service.ts b/packages/renderer/src/stores/Service.ts
deleted file mode 100644
index 2f45106..0000000
--- a/packages/renderer/src/stores/Service.ts
+++ /dev/null
@@ -1,38 +0,0 @@
-/*
- * 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 {
-  runtimeService,
-  RuntimeService,
-  service as originalService,
-} from '@sophie/shared';
-import { Instance } from 'mobx-state-tree';
-
-import getEnv from '../env/getEnv';
-
-export const service = originalService.views((self) => ({
-  get runtime(): RuntimeService {
-    return getEnv(self).getRuntimeService(self.id) ?? runtimeService.create();
-  },
-}));
-
-export interface Service extends Instance<typeof service> {}
-
-export type { ServiceSnapshotIn, ServiceSnapshotOut } from '@sophie/shared';
diff --git a/packages/renderer/src/stores/SharedStore.ts b/packages/renderer/src/stores/SharedStore.ts
deleted file mode 100644
index 962f7e2..0000000
--- a/packages/renderer/src/stores/SharedStore.ts
+++ /dev/null
@@ -1,37 +0,0 @@
-/*
- * 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 { sharedStore as originalSharedStore } from '@sophie/shared';
-import { Instance, types } from 'mobx-state-tree';
-
-import { config } from './Config';
-import { service } from './Service';
-
-export const sharedStore = originalSharedStore.props({
-  config: types.optional(config, {}),
-  selectedService: types.safeReference(service),
-});
-
-export interface SharedStore extends Instance<typeof sharedStore> {}
-
-export type {
-  SharedStoreSnapshotIn,
-  SharedStoreSnapshotOut,
-} from '@sophie/shared';
diff --git a/packages/renderer/src/stores/__tests__/Service.spec.ts b/packages/renderer/src/stores/__tests__/Service.spec.ts
deleted file mode 100644
index f835d41..0000000
--- a/packages/renderer/src/stores/__tests__/Service.spec.ts
+++ /dev/null
@@ -1,63 +0,0 @@
-/*
- * 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 { jest } from '@jest/globals';
-import { runtimeService } from '@sophie/shared';
-import { mocked } from 'jest-mock';
-
-import type RendererEnv from '../../env/RendererEnv';
-import { service, Service } from '../Service';
-
-const env: RendererEnv = {
-  dispatchMainAction: jest.fn(),
-  getRuntimeService: jest.fn(),
-};
-let sut: Service;
-
-beforeEach(() => {
-  sut = service.create(
-    {
-      id: 'serviceId',
-      name: 'Foo',
-      url: 'https://example.com',
-      profile: 'profileId',
-    },
-    env,
-  );
-});
-
-describe('runtime', () => {
-  it('should return the runtime service with for the service ID', () => {
-    const runtimeServiceStore = runtimeService.create({}, env);
-    mocked(env.getRuntimeService).mockReturnValueOnce(runtimeServiceStore);
-    const returnedStore = sut.runtime;
-    expect(env.getRuntimeService).toHaveBeenCalledWith('serviceId');
-    expect(returnedStore).toBe(runtimeServiceStore);
-  });
-
-  it('should return a valid runtime service even if none exists in the environment', () => {
-    /*
-      eslint-disable-next-line unicorn/no-useless-undefined --
-      `mockReturnValueOnce` expects 1 parameter.
-    */
-    mocked(env.getRuntimeService).mockReturnValueOnce(undefined);
-    expect(sut.runtime).toHaveProperty('state', 'hibernated');
-  });
-});