Refactor stores and their relationship to the MatrixClientPeg (#124)

* Refactor stores and their relationship to the MatrixClientPeg

to avoid import cycles and webpack weirdness

Signed-off-by: Michael Telatynski <[email protected]>

* Iterate

Signed-off-by: Michael Telatynski <[email protected]>

---------

Signed-off-by: Michael Telatynski <[email protected]>

Author: t3chguy

src/MatrixClientPeg.ts

@@ -43,6 +43,7 @@ import { formatList } from "./utils/FormattingUtils";
 import SdkConfig from "./SdkConfig";
 import { Features } from "./settings/Settings";
 import { setDeviceIsolationMode } from "./settings/controllers/DeviceIsolationModeController.ts";
+import { ReadyWatchingStore } from "./stores/ReadyWatchingStore.ts";
 
 export interface IMatrixClientCreds {
     homeserverUrl: string;
@@ -309,6 +310,7 @@ class MatrixClientPegClass implements IMatrixClientPeg {
         MatrixActionCreators.start(this.matrixClient);
         MatrixClientBackedSettingsHandler.matrixClient = this.matrixClient;
         MatrixClientBackedController.matrixClient = this.matrixClient;
+        ReadyWatchingStore.matrixClient = this.matrixClient;
 
         return opts;
     }

src/stores/AsyncStoreWithClient.ts

@@ -36,8 +36,13 @@ export abstract class AsyncStoreWithClient<T extends Object> extends AsyncStore<
         })(dispatcher);
     }
 
-    public async start(): Promise<void> {
-        await this.readyStore.start();
+    protected async start(matrixClient: MatrixClient | null): Promise<void> {
+        await this.readyStore.start(matrixClient);
+    }
+
+    // XXX: This method is intended only for use in tests.
+    public async useUnitTestClient(cli: MatrixClient): Promise<void> {
+        await this.readyStore.useUnitTestClient(cli);
     }
 
     public get matrixClient(): MatrixClient | null {

src/stores/AutoRageshakeStore.ts

@@ -46,9 +46,7 @@ interface IState {
  */
 export default class AutoRageshakeStore extends AsyncStoreWithClient<IState> {
     private static readonly internalInstance = (() => {
-        const instance = new AutoRageshakeStore();
-        instance.start();
-        return instance;
+        return new AutoRageshakeStore();
     })();
 
     private constructor() {

src/stores/BreadcrumbsStore.ts

@@ -30,9 +30,7 @@ interface IState {
 
 export class BreadcrumbsStore extends AsyncStoreWithClient<IState> {
     private static readonly internalInstance = (() => {
-        const instance = new BreadcrumbsStore();
-        instance.start();
-        return instance;
+        return new BreadcrumbsStore();
     })();
 
     private waitingRooms: { roomId: string; addedTs: number }[] = [];

src/stores/CallStore.ts

@@ -31,7 +31,6 @@ export class CallStore extends AsyncStoreWithClient<{}> {
     public static get instance(): CallStore {
         if (!this._instance) {
             this._instance = new CallStore();
-            this._instance.start();
         }
         return this._instance;
     }

src/stores/ModalWidgetStore.ts

@@ -24,7 +24,6 @@ interface IState {
 export class ModalWidgetStore extends AsyncStoreWithClient<IState> {
     private static readonly internalInstance = (() => {
         const instance = new ModalWidgetStore();
-        instance.start();
         return instance;
     })();
     private modalInstance: IHandle<typeof ModalWidgetDialog> | null = null;

src/stores/OwnBeaconStore.ts

@@ -87,7 +87,6 @@ const getLocallyCreatedBeaconEventIds = (): string[] => {
 export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> {
     private static readonly internalInstance = (() => {
         const instance = new OwnBeaconStore();
-        instance.start();
         return instance;
     })();
     // users beacons, keyed by event type

src/stores/OwnProfileStore.ts

@@ -28,7 +28,6 @@ const KEY_AVATAR_URL = "mx_profile_avatar_url";
 export class OwnProfileStore extends AsyncStoreWithClient<IState> {
     private static readonly internalInstance = (() => {
         const instance = new OwnProfileStore();
-        instance.start();
         return instance;
     })();
 

src/stores/ReadyWatchingStore.ts

@@ -9,27 +9,40 @@
 import { MatrixClient, SyncState } from "matrix-js-sdk/src/matrix";
 import { EventEmitter } from "events";
 
-import { MatrixClientPeg } from "../MatrixClientPeg";
 import { ActionPayload } from "../dispatcher/payloads";
 import { IDestroyable } from "../utils/IDestroyable";
 import { Action } from "../dispatcher/actions";
 import { MatrixDispatcher } from "../dispatcher/dispatcher";
 
 export abstract class ReadyWatchingStore extends EventEmitter implements IDestroyable {
-    protected matrixClient: MatrixClient | null = null;
+    private static instances: ReadyWatchingStore[] = [];
+    protected _matrixClient: MatrixClient | null = null;
     private dispatcherRef: string | null = null;
 
+    public static set matrixClient(client: MatrixClient) {
+        for (const instance of ReadyWatchingStore.instances) {
+            instance.start(client);
+        }
+    }
+
     public constructor(protected readonly dispatcher: MatrixDispatcher) {
         super();
-    }
 
-    public async start(): Promise<void> {
         this.dispatcherRef = this.dispatcher.register(this.onAction);
+    }
 
-        // MatrixClientPeg can be undefined in tests because of circular dependencies with other stores
-        const matrixClient = MatrixClientPeg?.get();
+    public get matrixClient(): MatrixClient | null {
+        return this._matrixClient;
+    }
+
+    public async start(matrixClient: MatrixClient | null): Promise<void> {
+        const oldClient = this._matrixClient;
+        this._matrixClient = matrixClient;
+
+        if (oldClient !== matrixClient) {
+            await this.onNotReady();
+        }
         if (matrixClient) {
-            this.matrixClient = matrixClient;
             await this.onReady();
         }
     }
@@ -38,8 +51,10 @@ export abstract class ReadyWatchingStore extends EventEmitter implements IDestro
         return this.matrixClient; // for external readonly access
     }
 
-    public useUnitTestClient(cli: MatrixClient): void {
-        this.matrixClient = cli;
+    // XXX: This method is intended only for use in tests.
+    public async useUnitTestClient(cli: MatrixClient): Promise<void> {
+        this._matrixClient = cli;
+        await this.onReady();
     }
 
     public destroy(): void {
@@ -74,13 +89,13 @@ export abstract class ReadyWatchingStore extends EventEmitter implements IDestro
                 if (this.matrixClient) {
                     await this.onNotReady();
                 }
-                this.matrixClient = payload.matrixClient;
+                this._matrixClient = payload.matrixClient;
                 await this.onReady();
             }
         } else if (payload.action === "on_client_not_viable" || payload.action === Action.OnLoggedOut) {
             if (this.matrixClient) {
                 await this.onNotReady();
-                this.matrixClient = null;
+                this._matrixClient = null;
             }
         }
     };

src/stores/VoiceRecordingStore.ts

@@ -30,7 +30,6 @@ export class VoiceRecordingStore extends AsyncStoreWithClient<IState> {
     public static get instance(): VoiceRecordingStore {
         if (!this.internalInstance) {
             this.internalInstance = new VoiceRecordingStore();
-            this.internalInstance.start();
         }
         return this.internalInstance;
     }