2022-03-16 14:11:06 +01:00
|
|
|
/*
|
|
|
|
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 EventEmitter from "events";
|
2022-11-04 11:48:08 +01:00
|
|
|
import { MethodLikeKeys, mocked, MockedObject, PropertyLikeKeys } from "jest-mock";
|
2022-10-13 19:22:25 +02:00
|
|
|
import { Feature, ServerSupport } from "matrix-js-sdk/src/feature";
|
2022-09-14 12:40:26 +02:00
|
|
|
import { MatrixClient, User } from "matrix-js-sdk/src/matrix";
|
2022-03-16 14:11:06 +01:00
|
|
|
|
|
|
|
import { MatrixClientPeg } from "../../src/MatrixClientPeg";
|
|
|
|
|
2022-10-26 15:04:03 +02:00
|
|
|
/**
|
|
|
|
* Mocked generic class with a real EventEmitter.
|
|
|
|
* Useful for mocks which need event emitters.
|
|
|
|
*/
|
|
|
|
export class MockEventEmitter<T> extends EventEmitter {
|
|
|
|
/**
|
|
|
|
* Construct a new event emitter with additional properties/functions. The event emitter functions
|
|
|
|
* like .emit and .on will be real.
|
|
|
|
* @param mockProperties An object with the mock property or function implementations. 'getters'
|
|
|
|
* are correctly cloned to this event emitter.
|
|
|
|
*/
|
2022-12-12 12:24:14 +01:00
|
|
|
constructor(mockProperties: Partial<Record<MethodLikeKeys<T> | PropertyLikeKeys<T>, unknown>> = {}) {
|
2022-10-26 15:04:03 +02:00
|
|
|
super();
|
|
|
|
// We must use defineProperties and not assign as the former clones getters correctly,
|
|
|
|
// whereas the latter invokes the getter and sets the return value permanently on the
|
|
|
|
// destination object.
|
|
|
|
Object.defineProperties(this, Object.getOwnPropertyDescriptors(mockProperties));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-03-16 14:11:06 +01:00
|
|
|
/**
|
|
|
|
* Mock client with real event emitter
|
|
|
|
* useful for testing code that listens
|
|
|
|
* to MatrixClient events
|
|
|
|
*/
|
|
|
|
export class MockClientWithEventEmitter extends EventEmitter {
|
2022-11-04 11:48:08 +01:00
|
|
|
constructor(mockProperties: Partial<Record<MethodLikeKeys<MatrixClient>, unknown>> = {}) {
|
2022-03-16 14:11:06 +01:00
|
|
|
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 = (
|
2023-05-23 14:01:27 +02:00
|
|
|
mockProperties: Partial<Record<keyof MatrixClient, unknown>>,
|
2022-03-16 14:11:06 +01:00
|
|
|
): MockedObject<MatrixClient> => {
|
|
|
|
const mock = mocked(new MockClientWithEventEmitter(mockProperties) as unknown as MatrixClient);
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
jest.spyOn(MatrixClientPeg, "get").mockReturnValue(mock);
|
2023-06-05 19:12:23 +02:00
|
|
|
jest.spyOn(MatrixClientPeg, "safeGet").mockReturnValue(mock);
|
2022-10-13 19:22:25 +02:00
|
|
|
|
2022-11-04 11:48:08 +01:00
|
|
|
// @ts-ignore simplified test stub
|
2022-10-13 19:22:25 +02:00
|
|
|
mock.canSupport = new Map();
|
2022-12-12 12:24:14 +01:00
|
|
|
Object.keys(Feature).forEach((feature) => {
|
2022-10-13 19:22:25 +02:00
|
|
|
mock.canSupport.set(feature as Feature, ServerSupport.Stable);
|
|
|
|
});
|
2022-03-16 14:11:06 +01:00
|
|
|
return mock;
|
|
|
|
};
|
|
|
|
|
2023-06-05 19:12:23 +02:00
|
|
|
export const unmockClientPeg = () => {
|
|
|
|
jest.spyOn(MatrixClientPeg, "get").mockRestore();
|
|
|
|
jest.spyOn(MatrixClientPeg, "safeGet").mockRestore();
|
|
|
|
};
|
2022-05-04 16:37:41 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns basic mocked client methods related to the current user
|
|
|
|
* ```
|
|
|
|
* const mockClient = getMockClientWithEventEmitter({
|
|
|
|
...mockClientMethodsUser('@mytestuser:domain'),
|
|
|
|
});
|
|
|
|
* ```
|
|
|
|
*/
|
2022-12-12 12:24:14 +01:00
|
|
|
export const mockClientMethodsUser = (userId = "@alice:domain") => ({
|
2022-05-04 16:37:41 +02:00
|
|
|
getUserId: jest.fn().mockReturnValue(userId),
|
2023-01-03 10:02:28 +01:00
|
|
|
getSafeUserId: jest.fn().mockReturnValue(userId),
|
2022-09-14 12:40:26 +02:00
|
|
|
getUser: jest.fn().mockReturnValue(new User(userId)),
|
2022-05-04 16:37:41 +02:00
|
|
|
isGuest: jest.fn().mockReturnValue(false),
|
2022-12-12 12:24:14 +01:00
|
|
|
mxcUrlToHttp: jest.fn().mockReturnValue("mock-mxcUrlToHttp"),
|
2022-06-02 10:25:56 +02:00
|
|
|
credentials: { userId },
|
2022-08-01 08:47:13 +02:00
|
|
|
getThreePids: jest.fn().mockResolvedValue({ threepids: [] }),
|
|
|
|
getAccessToken: jest.fn(),
|
2022-10-11 11:10:55 +02:00
|
|
|
getDeviceId: jest.fn(),
|
2022-10-17 11:16:04 +02:00
|
|
|
getAccountData: jest.fn(),
|
2022-06-02 10:25:56 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns basic mocked client methods related to rendering events
|
|
|
|
* ```
|
|
|
|
* const mockClient = getMockClientWithEventEmitter({
|
|
|
|
...mockClientMethodsUser('@mytestuser:domain'),
|
|
|
|
});
|
|
|
|
* ```
|
|
|
|
*/
|
|
|
|
export const mockClientMethodsEvents = () => ({
|
|
|
|
decryptEventIfNeeded: jest.fn(),
|
2022-06-30 14:41:53 +02:00
|
|
|
getPushActionsForEvent: jest.fn(),
|
2022-05-04 16:37:41 +02:00
|
|
|
});
|
2022-08-01 08:47:13 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns basic mocked client methods related to server support
|
|
|
|
*/
|
2022-11-04 11:48:08 +01:00
|
|
|
export const mockClientMethodsServer = (): Partial<Record<MethodLikeKeys<MatrixClient>, unknown>> => ({
|
2022-08-01 08:47:13 +02:00
|
|
|
doesServerSupportSeparateAddAndBind: jest.fn(),
|
|
|
|
getIdentityServerUrl: jest.fn(),
|
|
|
|
getHomeserverUrl: jest.fn(),
|
|
|
|
getCapabilities: jest.fn().mockReturnValue({}),
|
2022-10-11 11:10:55 +02:00
|
|
|
getClientWellKnown: jest.fn().mockReturnValue({}),
|
2022-08-01 08:47:13 +02:00
|
|
|
doesServerSupportUnstableFeature: jest.fn().mockResolvedValue(false),
|
2023-03-15 09:37:41 +01:00
|
|
|
isVersionSupported: jest.fn().mockResolvedValue(false),
|
2022-10-19 14:31:20 +02:00
|
|
|
getVersions: jest.fn().mockResolvedValue({}),
|
2022-10-17 11:16:04 +02:00
|
|
|
isFallbackICEServerAllowed: jest.fn(),
|
2022-08-01 08:47:13 +02:00
|
|
|
});
|
|
|
|
|
2022-10-11 11:10:55 +02:00
|
|
|
export const mockClientMethodsDevice = (
|
2022-12-12 12:24:14 +01:00
|
|
|
deviceId = "test-device-id",
|
2022-11-04 11:48:08 +01:00
|
|
|
): Partial<Record<MethodLikeKeys<MatrixClient>, unknown>> => ({
|
2022-10-11 11:10:55 +02:00
|
|
|
getDeviceId: jest.fn().mockReturnValue(deviceId),
|
|
|
|
getDeviceEd25519Key: jest.fn(),
|
|
|
|
getDevices: jest.fn().mockResolvedValue({ devices: [] }),
|
|
|
|
});
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
export const mockClientMethodsCrypto = (): Partial<
|
|
|
|
Record<MethodLikeKeys<MatrixClient> & PropertyLikeKeys<MatrixClient>, unknown>
|
2022-10-11 11:10:55 +02:00
|
|
|
> => ({
|
|
|
|
isCryptoEnabled: jest.fn(),
|
|
|
|
isCrossSigningReady: jest.fn(),
|
|
|
|
isKeyBackupKeyStored: jest.fn(),
|
|
|
|
getCrossSigningCacheCallbacks: jest.fn().mockReturnValue({ getCrossSigningKeyCache: jest.fn() }),
|
|
|
|
getStoredCrossSigningForUser: jest.fn(),
|
|
|
|
checkKeyBackup: jest.fn().mockReturnValue({}),
|
2023-05-23 14:01:27 +02:00
|
|
|
secretStorage: { hasKey: jest.fn() },
|
2022-10-11 11:10:55 +02:00
|
|
|
crypto: {
|
2023-05-23 14:01:27 +02:00
|
|
|
isSecretStorageReady: jest.fn(),
|
2022-10-11 11:10:55 +02:00
|
|
|
getSessionBackupPrivateKey: jest.fn(),
|
|
|
|
},
|
2023-06-12 20:33:39 +02:00
|
|
|
getCrypto: jest.fn().mockReturnValue({
|
|
|
|
getCrossSigningStatus: jest.fn().mockResolvedValue({
|
|
|
|
publicKeysOnDevice: true,
|
|
|
|
privateKeysInSecretStorage: false,
|
|
|
|
privateKeysCachedLocally: {
|
|
|
|
masterKey: true,
|
|
|
|
selfSigningKey: true,
|
|
|
|
userSigningKey: true,
|
|
|
|
},
|
|
|
|
}),
|
|
|
|
}),
|
2022-10-11 11:10:55 +02:00
|
|
|
});
|