You've already forked matrix-js-sdk
mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-11-25 05:23:13 +03:00
819fc75202
* Fetch capabilities in the background & keep them up to date * Add missed await * Replace some more runAllTimers and round down the wait time for sanity * Remove double comment * Typo * Add a method back that will fetch capabilities if they're not already there * Add tests * Catch exception here too * Add test for room version code
94 lines
3.1 KiB
TypeScript
94 lines
3.1 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 { MethodLikeKeys, mocked, MockedObject } from "jest-mock";
|
|
|
|
import { ClientEventHandlerMap, EmittedEvents, MatrixClient } from "../../src/client";
|
|
import { TypedEventEmitter } from "../../src/models/typed-event-emitter";
|
|
import { User } from "../../src/models/user";
|
|
|
|
/**
|
|
* Mock client with real event emitter
|
|
* useful for testing code that listens
|
|
* to MatrixClient events
|
|
*/
|
|
export class MockClientWithEventEmitter extends TypedEventEmitter<EmittedEvents, ClientEventHandlerMap> {
|
|
constructor(mockProperties: Partial<Record<MethodLikeKeys<MatrixClient>, unknown>> = {}) {
|
|
super();
|
|
Object.assign(this, mockProperties);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* - make a mock client
|
|
* - cast the type to mocked(MatrixClient)
|
|
* - spy on MatrixClientPeg.get to return the mock
|
|
* eg
|
|
* ```
|
|
* const mockClient = getMockClientWithEventEmitter({
|
|
getUserId: jest.fn().mockReturnValue(aliceId),
|
|
});
|
|
* ```
|
|
*/
|
|
export const getMockClientWithEventEmitter = (
|
|
mockProperties: Partial<Record<MethodLikeKeys<MatrixClient>, unknown>>,
|
|
): MockedObject<MatrixClient> => {
|
|
const mock = mocked(new MockClientWithEventEmitter(mockProperties) as unknown as MatrixClient);
|
|
return mock;
|
|
};
|
|
|
|
/**
|
|
* Returns basic mocked client methods related to the current user
|
|
* ```
|
|
* const mockClient = getMockClientWithEventEmitter({
|
|
...mockClientMethodsUser('@mytestuser:domain'),
|
|
});
|
|
* ```
|
|
*/
|
|
export const mockClientMethodsUser = (userId = "@alice:domain") => ({
|
|
getUserId: jest.fn().mockReturnValue(userId),
|
|
getSafeUserId: jest.fn().mockReturnValue(userId),
|
|
getUser: jest.fn().mockReturnValue(new User(userId)),
|
|
isGuest: jest.fn().mockReturnValue(false),
|
|
mxcUrlToHttp: jest.fn().mockReturnValue("mock-mxcUrlToHttp"),
|
|
credentials: { userId },
|
|
getThreePids: jest.fn().mockResolvedValue({ threepids: [] }),
|
|
getAccessToken: jest.fn(),
|
|
});
|
|
|
|
/**
|
|
* Returns basic mocked client methods related to rendering events
|
|
* ```
|
|
* const mockClient = getMockClientWithEventEmitter({
|
|
...mockClientMethodsUser('@mytestuser:domain'),
|
|
});
|
|
* ```
|
|
*/
|
|
export const mockClientMethodsEvents = () => ({
|
|
decryptEventIfNeeded: jest.fn(),
|
|
getPushActionsForEvent: jest.fn(),
|
|
});
|
|
|
|
/**
|
|
* Returns basic mocked client methods related to server support
|
|
*/
|
|
export const mockClientMethodsServer = (): Partial<Record<MethodLikeKeys<MatrixClient>, unknown>> => ({
|
|
getIdentityServerUrl: jest.fn(),
|
|
getHomeserverUrl: jest.fn(),
|
|
getCachedCapabilities: jest.fn().mockReturnValue({}),
|
|
doesServerSupportUnstableFeature: jest.fn().mockResolvedValue(false),
|
|
});
|