feat: Add RuntimeService store

Stores transient state for services shared between the main and renderer
processes.

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

4 files changed, 203 insertions, 0 deletions

diff --git a/packages/renderer/src/env/RendererEnv.ts b/packages/renderer/src/env/RendererEnv.ts
new file mode 100644
index 0000000..5ca2978
--- /dev/null
+++ b/packages/renderer/src/env/RendererEnv.ts
@@ -0,0 +1,27 @@
+/*
+ * 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 type { Action, RuntimeService } from '@sophie/shared';
+
+export default interface RendererEnv {
+  dispatchMainAction(action: Action): void;
+
+  getRuntimeService(serviceId: string): RuntimeService | undefined;
+}
diff --git a/packages/renderer/src/env/getEnv.ts b/packages/renderer/src/env/getEnv.ts
new file mode 100644
index 0000000..4f7357a
--- /dev/null
+++ b/packages/renderer/src/env/getEnv.ts
@@ -0,0 +1,34 @@
+/*
+ * 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 { getEnv as getAnyEnv, IAnyStateTreeNode } from 'mobx-state-tree';
+
+import type RendererEnv from './RendererEnv';
+
+/**
+ * Gets a well-typed environment from `model`.
+ *
+ * Only useable inside state trees created by `createAndConnectRootStore`.
+ *
+ * @param model The state tree node.
+ */
+export default function getEnv(model: IAnyStateTreeNode): RendererEnv {
+  return getAnyEnv<RendererEnv>(model);
+}
diff --git a/packages/renderer/src/env/impl/RendererEnvImpl.ts b/packages/renderer/src/env/impl/RendererEnvImpl.ts
new file mode 100644
index 0000000..184d31b
--- /dev/null
+++ b/packages/renderer/src/env/impl/RendererEnvImpl.ts
@@ -0,0 +1,55 @@
+/*
+ * 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
new file mode 100644
index 0000000..d36462c
--- /dev/null
+++ b/packages/renderer/src/env/impl/__tests__/RendererEnvImpl.spec.ts
@@ -0,0 +1,87 @@
+/*
+ * 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();
+    });
+  });
+});