aboutsummaryrefslogtreecommitdiffstats
path: root/packages/preload/src/contextBridge/createSophieRenderer.ts
blob: 2055080fce2253305a741d04641e31bad102cac4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 * 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 {
  Action,
  action,
  MainToRendererIpcMessage,
  RendererToMainIpcMessage,
  sharedStore,
  SharedStoreListener,
  SophieRenderer,
} from '@sophie/shared';
import { ipcRenderer } from 'electron';
import log from 'loglevel';
import type { IJsonPatch } from 'mobx-state-tree';

class SharedStoreConnector {
  private onSharedStoreChangeCalled = false;

  private listener: SharedStoreListener | null = null;

  constructor(private readonly allowReplaceListener: boolean) {
    ipcRenderer.on(MainToRendererIpcMessage.SharedStorePatch, (_event, patch) => {
      try {
        // `mobx-state-tree` will validate the patch, so we can safely cast here.
        this.listener?.onPatch(patch as IJsonPatch);
      } catch (err) {
        log.error('Shared store listener onPatch failed', err);
        this.listener = null;
      }
    });
  }

  async onSharedStoreChange(listener: SharedStoreListener): Promise<void> {
    if (this.onSharedStoreChangeCalled && !this.allowReplaceListener) {
      throw new Error('Shared store change listener was already set');
    }
    this.onSharedStoreChangeCalled = true;
    let success = false;
    let snapshot: unknown | null = null;
    try {
      snapshot = await ipcRenderer.invoke(RendererToMainIpcMessage.GetSharedStoreSnapshot);
      success = true;
    } catch (err) {
      log.error('Failed to get initial shared store snapshot', err);
    }
    if (success) {
      if (sharedStore.is(snapshot)) {
        listener.onSnapshot(snapshot);
        this.listener = listener;
        return;
      }
      log.error('Got invalid initial shared store snapshot', snapshot);
    }
    throw new Error('Failed to connect to shared store');
  }
}

function dispatchAction(actionToDispatch: Action): void {
  // Let the full zod parse error bubble up to the main world,
  // since all data it may contain was provided from the main world.
  const parsedAction = action.parse(actionToDispatch);
  try {
    ipcRenderer.send(RendererToMainIpcMessage.DispatchAction, parsedAction);
  } catch (err) {
    // Do not leak IPC failure details into the main world.
    const message = 'Failed to dispatch action';
    log.error(message, actionToDispatch, err);
    throw new Error(message);
  }
}

export default function createSophieRenderer(allowReplaceListener: boolean): SophieRenderer {
  const connector = new SharedStoreConnector(allowReplaceListener);
  return {
    onSharedStoreChange: connector.onSharedStoreChange.bind(connector),
    dispatchAction,
  };
}