e946674df3
* Add Stores and StoresContext and use it in MatrixChat and RoomView Added a new kind of class: - Add God object `Stores` which will hold refs to all known stores and the `MatrixClient`. This object is NOT a singleton. - Add `StoresContext` to hold onto a ref of `Stores` for use inside components. `StoresContext` is created via: - Create `Stores` in `MatrixChat`, assigning the `MatrixClient` when we have one set. Currently sets the RVS to `RoomViewStore.instance`. - Wrap `MatrixChat`s `render()` function in a `StoresContext.Provider` so it can be used anywhere. `StoresContext` is currently only used in `RoomView` via the following changes: - Remove the HOC, which redundantly set `mxClient` as a prop. We don't need this as `RoomView` was using the client from `this.context`. - Change the type of context accepted from `MatrixClientContext` to `StoresContext`. - Modify alllll the places where `this.context` is used to interact with the client and suffix `.client`. - Modify places where we use `RoomViewStore.instance` and replace them with `this.context.roomViewStore`. This makes `RoomView` use a non-global instance of RVS. * Linting * SDKContext and make client an optional constructor arg * Move SDKContext to /src/contexts * Inject all RVS deps * Linting * Remove reset calls; deep copy the INITIAL_STATE to avoid test pollution * DI singletons used in RoomView; DI them in RoomView-test too * Initial RoomViewStore.instance after all files are imported to avoid cyclical deps * Lazily init stores to allow for circular dependencies Rather than stores accepting a list of other stores in their constructors, which doesn't work when A needs B and B needs A, make new-style stores simply accept Stores. When a store needs another store, they access it via `Stores` which then lazily constructs that store if it needs it. This breaks the circular dependency at constructor time, without needing to introduce wiring diagrams or any complex DI framework. * Delete RoomViewStore.instance Replaced with Stores.instance.roomViewStore * Linting * Move OverridableStores to test/TestStores * Rejig how eager stores get made; don't automatically do it else tests break * Linting * Linting and review comments * Fix new code to use Stores.instance * s/Stores/SdkContextClass/g * Update docs * Remove unused imports * Update src/stores/RoomViewStore.tsx Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> * Remove empty c'tor to make sonar happy Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
44 lines
1.8 KiB
TypeScript
44 lines
1.8 KiB
TypeScript
/*
|
|
Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { SdkContextClass } from "../src/contexts/SDKContext";
|
|
import { PosthogAnalytics } from "../src/PosthogAnalytics";
|
|
import { SlidingSyncManager } from "../src/SlidingSyncManager";
|
|
import { RoomNotificationStateStore } from "../src/stores/notifications/RoomNotificationStateStore";
|
|
import RightPanelStore from "../src/stores/right-panel/RightPanelStore";
|
|
import { RoomViewStore } from "../src/stores/RoomViewStore";
|
|
import { SpaceStoreClass } from "../src/stores/spaces/SpaceStore";
|
|
import { WidgetLayoutStore } from "../src/stores/widgets/WidgetLayoutStore";
|
|
import WidgetStore from "../src/stores/WidgetStore";
|
|
|
|
/**
|
|
* A class which provides the same API as Stores but adds additional unsafe setters which can
|
|
* replace individual stores. This is useful for tests which need to mock out stores.
|
|
*/
|
|
export class TestStores extends SdkContextClass {
|
|
public _RightPanelStore?: RightPanelStore;
|
|
public _RoomNotificationStateStore?: RoomNotificationStateStore;
|
|
public _RoomViewStore?: RoomViewStore;
|
|
public _WidgetLayoutStore?: WidgetLayoutStore;
|
|
public _WidgetStore?: WidgetStore;
|
|
public _PosthogAnalytics?: PosthogAnalytics;
|
|
public _SlidingSyncManager?: SlidingSyncManager;
|
|
public _SpaceStore?: SpaceStoreClass;
|
|
|
|
constructor() {
|
|
super();
|
|
}
|
|
}
|