refactor BaseStore

Signed-off-by: Sebastian Malton <sebastian@malton.name>

src/common/base-store.ts

@@ -2,12 +2,13 @@ import path from "path";
 import Config from "conf";
 import { Options as ConfOptions } from "conf/dist/source/types";
 import { app, ipcMain, IpcMainEvent, ipcRenderer, IpcRendererEvent, remote } from "electron";
-import { IReactionOptions, observable, reaction, runInAction, when } from "mobx";
+import { IReactionOptions, observable, reaction, when } from "mobx";
 import Singleton from "./utils/singleton";
 import { getAppVersion } from "./utils/app-version";
 import logger from "../main/logger";
-import { broadcastMessage, subscribeToBroadcast, unsubscribeFromBroadcast } from "./ipc";
+import { createTypedSender } from "./ipc";
 import isEqual from "lodash/isEqual";
+import { autobind } from "./utils";
 
 export interface BaseStoreParams<T = any> extends ConfOptions<T> {
   autoLoad?: boolean;
@@ -39,13 +40,15 @@ export abstract class BaseStore<T = any> extends Singleton {
     return path.basename(this.storeConfig.path);
   }
 
-  protected get syncRendererChannel() {
+  protected readonly syncRenderer = createTypedSender({
-    return `store-sync-renderer:${this.path}`;
+    channel: `store-sync-renderer:${this.path}`,
-  }
+    verifier: (src: unknown): src is any => true,
+  });
 
-  protected get syncMainChannel() {
+  protected readonly syncMain = createTypedSender({
-    return `store-sync-main:${this.path}`;
+    channel: `store-sync-main:${this.path}`,
-  }
+    verifier: (src: unknown): src is any => true,
+  });
 
   get path() {
     return this.storeConfig.path;
@@ -90,55 +93,34 @@ export abstract class BaseStore<T = any> extends Singleton {
 
   enableSync() {
     this.syncDisposers.push(
-      reaction(() => this.toJSON(), model => this.onModelChange(model), this.params.syncOptions),
+      reaction(() => this.toJSON(), this.onModelChange, this.params.syncOptions),
     );
 
     if (ipcMain) {
-      const callback = (event: IpcMainEvent, model: T) => {
+      this.syncDisposers.push(this.syncMain.on((event: IpcMainEvent, model: T) => {
         logger.silly(`[STORE]: SYNC ${this.name} from renderer`, { model });
         this.onSync(model);
-      };
+      }));
-
-      subscribeToBroadcast(this.syncMainChannel, callback);
-      this.syncDisposers.push(() => unsubscribeFromBroadcast(this.syncMainChannel, callback));
     }
 
     if (ipcRenderer) {
-      const callback = (event: IpcRendererEvent, model: T) => {
+      this.syncDisposers.push(this.syncRenderer.on((event: IpcRendererEvent, model: T) => {
         logger.silly(`[STORE]: SYNC ${this.name} from main`, { model });
-        this.onSyncFromMain(model);
+        this.disableSync();
-      };
+        this.onSync(model);
 
-      subscribeToBroadcast(this.syncRendererChannel, callback);
+        if (this.params.syncEnabled) {
-      this.syncDisposers.push(() => unsubscribeFromBroadcast(this.syncRendererChannel, callback));
+          this.enableSync();
+        }
+      }));
     }
   }
 
-  protected onSyncFromMain(model: T) {
-    this.applyWithoutSync(() => {
-      this.onSync(model);
-    });
-  }
-
-  unregisterIpcListener() {
-    ipcRenderer.removeAllListeners(this.syncMainChannel);
-    ipcRenderer.removeAllListeners(this.syncRendererChannel);
-  }
-
   disableSync() {
     this.syncDisposers.forEach(dispose => dispose());
     this.syncDisposers.length = 0;
   }
 
-  protected applyWithoutSync(callback: () => void) {
-    this.disableSync();
-    runInAction(callback);
-
-    if (this.params.syncEnabled) {
-      this.enableSync();
-    }
-  }
-
   protected onSync(model: T) {
     // todo: use "resourceVersion" if merge required (to avoid equality checks => better performance)
     if (!isEqual(this.toJSON(), model)) {
@@ -146,12 +128,13 @@ export abstract class BaseStore<T = any> extends Singleton {
     }
   }
 
+  @autobind()
   protected async onModelChange(model: T) {
     if (ipcMain) {
       this.saveToFile(model); // save config file
-      broadcastMessage(this.syncRendererChannel, model);
+      this.syncRenderer.broadcast(model);
     } else {
-      broadcastMessage(this.syncMainChannel, model);
+      this.syncMain.broadcast(model);
     }
   }
 

src/common/cluster-store.ts

@@ -171,7 +171,6 @@ export class ClusterStore extends BaseStore<ClusterStoreModel> {
   }
 
   unregisterIpcListener() {
-    super.unregisterIpcListener();
     unsubscribeAllFromBroadcast("cluster:state");
   }
 

src/common/ipc/type-enforced-ipc.ts

@@ -188,12 +188,14 @@ export function createTypedInvoker<
   };
 }
 
+type Disposer = () => void;
+
 export interface TypedSender<
   Args extends any[]
 > {
   broadcast: (...args: Args) => void,
-  on: (listener: IpcListener<Event, Args>) => void,
+  on: (listener: IpcListener<Event, Args>) => Disposer,
-  once: (listener: IpcListener<Event, Args>) => void,
+  once: (listener: IpcListener<Event, Args>) => Disposer,
 }
 
 export function createTypedSender<
@@ -205,25 +207,31 @@ export function createTypedSender<
   channel: string,
   verifier: ListVerifier<Args>,
 }): TypedSender<Args> {
+  const source = ipcMain ?? ipcRenderer;
+
   return {
     broadcast(...args) {
       broadcastMessage(channel, ...args);
     },
     on(listener) {
       onCorrect({
-        source: ipcMain ?? ipcRenderer,
+        source,
         channel,
         listener,
         verifier: verifier as ListVerifier<Rest<[e: Event, ...args: Args]>>,
       });
+
+      return () => source.removeListener(channel, listener);
     },
     once(listener) {
       onceCorrect({
-        source: ipcMain ?? ipcRenderer,
+        source,
         channel,
         listener,
         verifier: verifier as ListVerifier<Rest<[e: Event, ...args: Args]>>,
       });
+
+      return () => source.removeListener(channel, listener);
     }
   };
 }

src/common/utils/type-narrowing.ts

@@ -1,4 +1,4 @@
-type TypeGuard<T> = (arg: unknown) => arg is T;
+export type TypeGuard<T> = (arg: unknown) => arg is T;
 type Rest<T extends any[]> = T extends [any, ...infer R] ? R : any;
 type First<T extends any[]> = T extends [infer R, ...any[]] ? R : any;
 type TypeGuardReturnType<T extends (src: unknown) => src is any> = T extends (src: unknown) => src is infer R ? R : any;