2022-08-10 14:57:56 +02:00
|
|
|
/*
|
2024-09-09 15:57:16 +02:00
|
|
|
Copyright 2024 New Vector Ltd.
|
2022-08-10 14:57:56 +02:00
|
|
|
Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
|
|
|
2024-09-09 15:57:16 +02:00
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
|
|
Please see LICENSE files in the repository root for full details.
|
2022-08-10 14:57:56 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
import { mocked, MockedObject } from "jest-mock";
|
2024-08-30 16:45:25 +02:00
|
|
|
import fetchMockJest from "fetch-mock-jest";
|
2023-08-09 09:18:41 +02:00
|
|
|
import {
|
|
|
|
MatrixClient,
|
|
|
|
ClientEvent,
|
|
|
|
ITurnServer as IClientTurnServer,
|
|
|
|
Direction,
|
|
|
|
EventType,
|
|
|
|
MatrixEvent,
|
|
|
|
MsgType,
|
|
|
|
RelationType,
|
|
|
|
} from "matrix-js-sdk/src/matrix";
|
2022-08-10 14:57:56 +02:00
|
|
|
import { DeviceInfo } from "matrix-js-sdk/src/crypto/deviceinfo";
|
2023-02-23 15:53:44 +01:00
|
|
|
import {
|
|
|
|
Widget,
|
|
|
|
MatrixWidgetType,
|
|
|
|
WidgetKind,
|
|
|
|
WidgetDriver,
|
|
|
|
ITurnServer,
|
|
|
|
SimpleObservable,
|
|
|
|
OpenIDRequestState,
|
|
|
|
IOpenIDUpdate,
|
2024-08-07 17:06:30 +02:00
|
|
|
UpdateDelayedEventAction,
|
2023-02-23 15:53:44 +01:00
|
|
|
} from "matrix-widget-api";
|
|
|
|
import {
|
|
|
|
ApprovalOpts,
|
|
|
|
CapabilitiesOpts,
|
|
|
|
WidgetLifecycle,
|
|
|
|
} from "@matrix-org/react-sdk-module-api/lib/lifecycles/WidgetLifecycle";
|
2022-08-10 14:57:56 +02:00
|
|
|
|
2022-10-19 14:07:03 +02:00
|
|
|
import { SdkContextClass } from "../../../src/contexts/SDKContext";
|
2022-08-10 14:57:56 +02:00
|
|
|
import { MatrixClientPeg } from "../../../src/MatrixClientPeg";
|
|
|
|
import { StopGapWidgetDriver } from "../../../src/stores/widgets/StopGapWidgetDriver";
|
|
|
|
import { stubClient } from "../../test-utils";
|
2023-02-23 15:53:44 +01:00
|
|
|
import { ModuleRunner } from "../../../src/modules/ModuleRunner";
|
2023-02-20 15:46:07 +01:00
|
|
|
import dis from "../../../src/dispatcher/dispatcher";
|
2024-08-08 13:45:20 +02:00
|
|
|
import Modal from "../../../src/Modal";
|
2023-03-09 14:02:29 +01:00
|
|
|
import SettingsStore from "../../../src/settings/SettingsStore";
|
2022-08-10 14:57:56 +02:00
|
|
|
|
|
|
|
describe("StopGapWidgetDriver", () => {
|
|
|
|
let client: MockedObject<MatrixClient>;
|
2022-09-16 17:12:27 +02:00
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
const mkDefaultDriver = (): WidgetDriver =>
|
|
|
|
new StopGapWidgetDriver(
|
|
|
|
[],
|
|
|
|
new Widget({
|
|
|
|
id: "test",
|
|
|
|
creatorUserId: "@alice:example.org",
|
|
|
|
type: "example",
|
|
|
|
url: "https://example.org",
|
|
|
|
}),
|
|
|
|
WidgetKind.Room,
|
|
|
|
false,
|
|
|
|
"!1:example.org",
|
|
|
|
);
|
2022-08-10 14:57:56 +02:00
|
|
|
|
2024-08-08 13:45:20 +02:00
|
|
|
jest.spyOn(Modal, "createDialog").mockImplementation(() => {
|
|
|
|
throw new Error("Should not have to create a dialog");
|
|
|
|
});
|
|
|
|
|
2022-08-10 14:57:56 +02:00
|
|
|
beforeEach(() => {
|
|
|
|
stubClient();
|
2023-06-05 19:12:23 +02:00
|
|
|
client = mocked(MatrixClientPeg.safeGet());
|
2022-09-16 17:12:27 +02:00
|
|
|
client.getUserId.mockReturnValue("@alice:example.org");
|
2023-06-15 16:11:49 +02:00
|
|
|
client.getSafeUserId.mockReturnValue("@alice:example.org");
|
2022-09-16 17:12:27 +02:00
|
|
|
});
|
2022-08-10 14:57:56 +02:00
|
|
|
|
2022-09-16 17:12:27 +02:00
|
|
|
it("auto-approves capabilities of virtual Element Call widgets", async () => {
|
|
|
|
const driver = new StopGapWidgetDriver(
|
2022-08-10 14:57:56 +02:00
|
|
|
[],
|
|
|
|
new Widget({
|
2022-09-16 17:12:27 +02:00
|
|
|
id: "group_call",
|
2022-08-10 14:57:56 +02:00
|
|
|
creatorUserId: "@alice:example.org",
|
2022-09-16 17:12:27 +02:00
|
|
|
type: MatrixWidgetType.Custom,
|
|
|
|
url: "https://call.element.io",
|
2022-08-10 14:57:56 +02:00
|
|
|
}),
|
|
|
|
WidgetKind.Room,
|
2022-09-16 17:12:27 +02:00
|
|
|
true,
|
|
|
|
"!1:example.org",
|
2022-08-10 14:57:56 +02:00
|
|
|
);
|
2022-09-16 17:12:27 +02:00
|
|
|
|
|
|
|
// These are intentionally raw identifiers rather than constants, so it's obvious what's being requested
|
|
|
|
const requestedCapabilities = new Set([
|
|
|
|
"m.always_on_screen",
|
|
|
|
"town.robin.msc3846.turn_servers",
|
|
|
|
"org.matrix.msc2762.timeline:!1:example.org",
|
2022-10-24 19:49:54 +02:00
|
|
|
"org.matrix.msc2762.send.event:org.matrix.rageshake_request",
|
|
|
|
"org.matrix.msc2762.receive.event:org.matrix.rageshake_request",
|
2024-09-23 12:40:40 +02:00
|
|
|
"org.matrix.msc2762.send.event:m.reaction",
|
|
|
|
"org.matrix.msc2762.receive.event:m.reaction",
|
|
|
|
"org.matrix.msc2762.send.event:m.room.redaction",
|
|
|
|
"org.matrix.msc2762.receive.event:m.room.redaction",
|
2024-07-16 16:07:40 +02:00
|
|
|
"org.matrix.msc2762.receive.state_event:m.room.create",
|
2022-09-16 17:12:27 +02:00
|
|
|
"org.matrix.msc2762.receive.state_event:m.room.member",
|
|
|
|
"org.matrix.msc2762.receive.state_event:org.matrix.msc3401.call",
|
|
|
|
"org.matrix.msc2762.send.state_event:org.matrix.msc3401.call.member#@alice:example.org",
|
|
|
|
"org.matrix.msc2762.receive.state_event:org.matrix.msc3401.call.member",
|
2024-07-16 14:46:17 +02:00
|
|
|
`org.matrix.msc2762.send.state_event:org.matrix.msc3401.call.member#_@alice:example.org_${client.deviceId}`,
|
|
|
|
`org.matrix.msc2762.send.state_event:org.matrix.msc3401.call.member#@alice:example.org_${client.deviceId}`,
|
2022-09-16 17:12:27 +02:00
|
|
|
"org.matrix.msc3819.send.to_device:m.call.invite",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.invite",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.candidates",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.candidates",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.answer",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.answer",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.hangup",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.hangup",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.reject",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.reject",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.select_answer",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.select_answer",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.negotiate",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.negotiate",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.sdp_stream_metadata_changed",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.sdp_stream_metadata_changed",
|
|
|
|
"org.matrix.msc3819.send.to_device:org.matrix.call.sdp_stream_metadata_changed",
|
|
|
|
"org.matrix.msc3819.receive.to_device:org.matrix.call.sdp_stream_metadata_changed",
|
|
|
|
"org.matrix.msc3819.send.to_device:m.call.replaces",
|
|
|
|
"org.matrix.msc3819.receive.to_device:m.call.replaces",
|
2024-08-07 17:06:30 +02:00
|
|
|
"org.matrix.msc4157.send.delayed_event",
|
|
|
|
"org.matrix.msc4157.update_delayed_event",
|
2022-09-16 17:12:27 +02:00
|
|
|
]);
|
|
|
|
|
|
|
|
const approvedCapabilities = await driver.validateCapabilities(requestedCapabilities);
|
|
|
|
expect(approvedCapabilities).toEqual(requestedCapabilities);
|
2022-08-10 14:57:56 +02:00
|
|
|
});
|
|
|
|
|
2023-02-23 15:53:44 +01:00
|
|
|
it("approves capabilities via module api", async () => {
|
|
|
|
const driver = mkDefaultDriver();
|
|
|
|
|
|
|
|
const requestedCapabilities = new Set(["org.matrix.msc2931.navigate", "org.matrix.msc2762.timeline:*"]);
|
|
|
|
|
|
|
|
jest.spyOn(ModuleRunner.instance, "invoke").mockImplementation(
|
|
|
|
(lifecycleEvent, opts, widgetInfo, requested) => {
|
|
|
|
if (lifecycleEvent === WidgetLifecycle.CapabilitiesRequest) {
|
|
|
|
(opts as CapabilitiesOpts).approvedCapabilities = requested;
|
|
|
|
}
|
|
|
|
},
|
|
|
|
);
|
|
|
|
|
|
|
|
const approvedCapabilities = await driver.validateCapabilities(requestedCapabilities);
|
|
|
|
expect(approvedCapabilities).toEqual(requestedCapabilities);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("approves identity via module api", async () => {
|
|
|
|
const driver = mkDefaultDriver();
|
|
|
|
|
|
|
|
jest.spyOn(ModuleRunner.instance, "invoke").mockImplementation((lifecycleEvent, opts, widgetInfo) => {
|
|
|
|
if (lifecycleEvent === WidgetLifecycle.IdentityRequest) {
|
|
|
|
(opts as ApprovalOpts).approved = true;
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
const listener = jest.fn();
|
|
|
|
const observer = new SimpleObservable<IOpenIDUpdate>();
|
|
|
|
observer.onUpdate(listener);
|
|
|
|
await driver.askOpenID(observer);
|
|
|
|
|
|
|
|
const openIdUpdate: IOpenIDUpdate = {
|
|
|
|
state: OpenIDRequestState.Allowed,
|
|
|
|
token: await client.getOpenIdToken(),
|
|
|
|
};
|
2023-03-01 16:23:35 +01:00
|
|
|
expect(listener).toHaveBeenCalledWith(openIdUpdate);
|
2023-02-23 15:53:44 +01:00
|
|
|
});
|
|
|
|
|
2022-08-10 14:57:56 +02:00
|
|
|
describe("sendToDevice", () => {
|
|
|
|
const contentMap = {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"*": {
|
|
|
|
hello: "alice",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
"@bob:example.org": {
|
2022-12-12 12:24:14 +01:00
|
|
|
bobDesktop: {
|
2022-08-10 14:57:56 +02:00
|
|
|
hello: "bob",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
};
|
|
|
|
|
2022-09-16 17:12:27 +02:00
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
2022-09-16 17:12:27 +02:00
|
|
|
|
2022-08-10 14:57:56 +02:00
|
|
|
it("sends unencrypted messages", async () => {
|
|
|
|
await driver.sendToDevice("org.example.foo", false, contentMap);
|
|
|
|
expect(client.queueToDevice.mock.calls).toMatchSnapshot();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("sends encrypted messages", async () => {
|
|
|
|
const aliceWeb = new DeviceInfo("aliceWeb");
|
|
|
|
const aliceMobile = new DeviceInfo("aliceMobile");
|
|
|
|
const bobDesktop = new DeviceInfo("bobDesktop");
|
|
|
|
|
2023-04-04 12:41:46 +02:00
|
|
|
mocked(client.crypto!.deviceList).downloadKeys.mockResolvedValue(
|
2023-03-28 12:23:16 +02:00
|
|
|
new Map([
|
|
|
|
[
|
|
|
|
"@alice:example.org",
|
|
|
|
new Map([
|
|
|
|
["aliceWeb", aliceWeb],
|
|
|
|
["aliceMobile", aliceMobile],
|
|
|
|
]),
|
|
|
|
],
|
|
|
|
["@bob:example.org", new Map([["bobDesktop", bobDesktop]])],
|
|
|
|
]),
|
|
|
|
);
|
2022-08-10 14:57:56 +02:00
|
|
|
|
|
|
|
await driver.sendToDevice("org.example.foo", true, contentMap);
|
|
|
|
expect(client.encryptAndSendToDevices.mock.calls).toMatchSnapshot();
|
|
|
|
});
|
|
|
|
});
|
2022-08-10 15:26:42 +02:00
|
|
|
|
|
|
|
describe("getTurnServers", () => {
|
2022-09-16 17:12:27 +02:00
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
2022-09-16 17:12:27 +02:00
|
|
|
|
2022-08-10 15:26:42 +02:00
|
|
|
it("stops if VoIP isn't supported", async () => {
|
|
|
|
jest.spyOn(client, "pollingTurnServers", "get").mockReturnValue(false);
|
|
|
|
const servers = driver.getTurnServers();
|
|
|
|
expect(await servers.next()).toEqual({ value: undefined, done: true });
|
|
|
|
});
|
|
|
|
|
|
|
|
it("stops if the homeserver provides no TURN servers", async () => {
|
|
|
|
const servers = driver.getTurnServers();
|
|
|
|
expect(await servers.next()).toEqual({ value: undefined, done: true });
|
|
|
|
});
|
|
|
|
|
|
|
|
it("gets TURN servers", async () => {
|
|
|
|
const server1: ITurnServer = {
|
|
|
|
uris: [
|
|
|
|
"turn:turn.example.com:3478?transport=udp",
|
|
|
|
"turn:10.20.30.40:3478?transport=tcp",
|
|
|
|
"turns:10.20.30.40:443?transport=tcp",
|
|
|
|
],
|
|
|
|
username: "1443779631:@user:example.com",
|
|
|
|
password: "JlKfBy1QwLrO20385QyAtEyIv0=",
|
|
|
|
};
|
|
|
|
const server2: ITurnServer = {
|
|
|
|
uris: [
|
|
|
|
"turn:turn.example.com:3478?transport=udp",
|
|
|
|
"turn:10.20.30.40:3478?transport=tcp",
|
|
|
|
"turns:10.20.30.40:443?transport=tcp",
|
|
|
|
],
|
|
|
|
username: "1448999322:@user:example.com",
|
|
|
|
password: "hunter2",
|
|
|
|
};
|
|
|
|
const clientServer1: IClientTurnServer = {
|
|
|
|
urls: server1.uris,
|
|
|
|
username: server1.username,
|
|
|
|
credential: server1.password,
|
|
|
|
};
|
|
|
|
const clientServer2: IClientTurnServer = {
|
|
|
|
urls: server2.uris,
|
|
|
|
username: server2.username,
|
|
|
|
credential: server2.password,
|
|
|
|
};
|
|
|
|
|
|
|
|
client.getTurnServers.mockReturnValue([clientServer1]);
|
|
|
|
const servers = driver.getTurnServers();
|
|
|
|
expect(await servers.next()).toEqual({ value: server1, done: false });
|
|
|
|
|
|
|
|
const nextServer = servers.next();
|
|
|
|
client.getTurnServers.mockReturnValue([clientServer2]);
|
|
|
|
client.emit(ClientEvent.TurnServers, [clientServer2]);
|
|
|
|
expect(await nextServer).toEqual({ value: server2, done: false });
|
|
|
|
|
|
|
|
await servers.return(undefined);
|
|
|
|
});
|
|
|
|
});
|
2022-09-14 16:18:51 +02:00
|
|
|
|
|
|
|
describe("readEventRelations", () => {
|
2022-09-16 17:12:27 +02:00
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
2022-09-16 17:12:27 +02:00
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
it("reads related events from the current room", async () => {
|
|
|
|
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!this-room-id");
|
2022-09-14 16:18:51 +02:00
|
|
|
|
|
|
|
client.relations.mockResolvedValue({
|
|
|
|
originalEvent: new MatrixEvent(),
|
|
|
|
events: [],
|
|
|
|
});
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
await expect(driver.readEventRelations("$event")).resolves.toEqual({
|
2022-09-14 16:18:51 +02:00
|
|
|
chunk: [],
|
|
|
|
nextBatch: undefined,
|
|
|
|
prevBatch: undefined,
|
|
|
|
});
|
|
|
|
|
2023-03-01 16:23:35 +01:00
|
|
|
expect(client.relations).toHaveBeenCalledWith("!this-room-id", "$event", null, null, {});
|
2022-09-14 16:18:51 +02:00
|
|
|
});
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
it("reads related events from a selected room", async () => {
|
2022-09-14 16:18:51 +02:00
|
|
|
client.relations.mockResolvedValue({
|
|
|
|
originalEvent: new MatrixEvent(),
|
|
|
|
events: [new MatrixEvent(), new MatrixEvent()],
|
2022-12-12 12:24:14 +01:00
|
|
|
nextBatch: "next-batch-token",
|
2022-09-14 16:18:51 +02:00
|
|
|
});
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
await expect(driver.readEventRelations("$event", "!room-id")).resolves.toEqual({
|
|
|
|
chunk: [expect.objectContaining({ content: {} }), expect.objectContaining({ content: {} })],
|
|
|
|
nextBatch: "next-batch-token",
|
2022-09-14 16:18:51 +02:00
|
|
|
prevBatch: undefined,
|
|
|
|
});
|
|
|
|
|
2023-03-01 16:23:35 +01:00
|
|
|
expect(client.relations).toHaveBeenCalledWith("!room-id", "$event", null, null, {});
|
2022-09-14 16:18:51 +02:00
|
|
|
});
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
it("reads related events with custom parameters", async () => {
|
2022-09-14 16:18:51 +02:00
|
|
|
client.relations.mockResolvedValue({
|
|
|
|
originalEvent: new MatrixEvent(),
|
|
|
|
events: [],
|
|
|
|
});
|
|
|
|
|
2022-12-12 12:24:14 +01:00
|
|
|
await expect(
|
|
|
|
driver.readEventRelations(
|
|
|
|
"$event",
|
|
|
|
"!room-id",
|
|
|
|
"m.reference",
|
|
|
|
"m.room.message",
|
|
|
|
"from-token",
|
|
|
|
"to-token",
|
|
|
|
25,
|
|
|
|
"f",
|
|
|
|
),
|
|
|
|
).resolves.toEqual({
|
2022-09-14 16:18:51 +02:00
|
|
|
chunk: [],
|
|
|
|
nextBatch: undefined,
|
|
|
|
prevBatch: undefined,
|
|
|
|
});
|
|
|
|
|
2023-03-01 16:23:35 +01:00
|
|
|
expect(client.relations).toHaveBeenCalledWith("!room-id", "$event", "m.reference", "m.room.message", {
|
2022-12-12 12:24:14 +01:00
|
|
|
limit: 25,
|
|
|
|
from: "from-token",
|
|
|
|
to: "to-token",
|
|
|
|
dir: Direction.Forward,
|
|
|
|
});
|
2022-09-14 16:18:51 +02:00
|
|
|
});
|
|
|
|
});
|
2023-02-20 15:46:07 +01:00
|
|
|
|
|
|
|
describe("chat effects", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
// let client: MatrixClient;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
stubClient();
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
jest.spyOn(dis, "dispatch").mockReset();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("sends chat effects", async () => {
|
|
|
|
await driver.sendEvent(
|
|
|
|
EventType.RoomMessage,
|
|
|
|
{
|
|
|
|
msgtype: MsgType.Text,
|
|
|
|
body: "🎉",
|
|
|
|
},
|
|
|
|
null,
|
|
|
|
);
|
|
|
|
|
|
|
|
expect(dis.dispatch).toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("does not send chat effects in threads", async () => {
|
|
|
|
await driver.sendEvent(
|
|
|
|
EventType.RoomMessage,
|
|
|
|
{
|
|
|
|
"body": "🎉",
|
|
|
|
"m.relates_to": {
|
|
|
|
rel_type: RelationType.Thread,
|
|
|
|
event_id: "$123",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
null,
|
|
|
|
);
|
|
|
|
|
|
|
|
expect(dis.dispatch).not.toHaveBeenCalled();
|
|
|
|
});
|
|
|
|
});
|
2023-03-09 14:02:29 +01:00
|
|
|
|
2024-08-07 17:06:30 +02:00
|
|
|
describe("sendDelayedEvent", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
const roomId = "!this-room-id";
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("cannot send delayed events with missing arguments", async () => {
|
|
|
|
await expect(driver.sendDelayedEvent(null, null, EventType.RoomMessage, {})).rejects.toThrow(
|
|
|
|
"Must provide at least one of",
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("sends delayed message events", async () => {
|
|
|
|
client._unstable_sendDelayedEvent.mockResolvedValue({
|
|
|
|
delay_id: "id",
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.sendDelayedEvent(2000, null, EventType.RoomMessage, {})).resolves.toEqual({
|
|
|
|
roomId,
|
|
|
|
delayId: "id",
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client._unstable_sendDelayedEvent).toHaveBeenCalledWith(
|
|
|
|
roomId,
|
|
|
|
{ delay: 2000 },
|
|
|
|
null,
|
|
|
|
EventType.RoomMessage,
|
|
|
|
{},
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("sends child action delayed message events", async () => {
|
|
|
|
client._unstable_sendDelayedEvent.mockResolvedValue({
|
|
|
|
delay_id: "id-child",
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.sendDelayedEvent(null, "id-parent", EventType.RoomMessage, {})).resolves.toEqual({
|
|
|
|
roomId,
|
|
|
|
delayId: "id-child",
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client._unstable_sendDelayedEvent).toHaveBeenCalledWith(
|
|
|
|
roomId,
|
|
|
|
{ parent_delay_id: "id-parent" },
|
|
|
|
null,
|
|
|
|
EventType.RoomMessage,
|
|
|
|
{},
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("sends delayed state events", async () => {
|
|
|
|
client._unstable_sendDelayedStateEvent.mockResolvedValue({
|
|
|
|
delay_id: "id",
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.sendDelayedEvent(2000, null, EventType.RoomTopic, {}, "")).resolves.toEqual({
|
|
|
|
roomId,
|
|
|
|
delayId: "id",
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client._unstable_sendDelayedStateEvent).toHaveBeenCalledWith(
|
|
|
|
roomId,
|
|
|
|
{ delay: 2000 },
|
|
|
|
EventType.RoomTopic,
|
|
|
|
{},
|
|
|
|
"",
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("sends child action delayed state events", async () => {
|
|
|
|
client._unstable_sendDelayedStateEvent.mockResolvedValue({
|
|
|
|
delay_id: "id-child",
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.sendDelayedEvent(null, "id-parent", EventType.RoomTopic, {}, "")).resolves.toEqual({
|
|
|
|
roomId,
|
|
|
|
delayId: "id-child",
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client._unstable_sendDelayedStateEvent).toHaveBeenCalledWith(
|
|
|
|
roomId,
|
|
|
|
{ parent_delay_id: "id-parent" },
|
|
|
|
EventType.RoomTopic,
|
|
|
|
{},
|
|
|
|
"",
|
|
|
|
);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
|
|
|
describe("updateDelayedEvent", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("updates delayed events", async () => {
|
|
|
|
client._unstable_updateDelayedEvent.mockResolvedValue({});
|
|
|
|
for (const action of [
|
|
|
|
UpdateDelayedEventAction.Cancel,
|
|
|
|
UpdateDelayedEventAction.Restart,
|
|
|
|
UpdateDelayedEventAction.Send,
|
|
|
|
]) {
|
|
|
|
await expect(driver.updateDelayedEvent("id", action)).resolves.toBeUndefined();
|
|
|
|
expect(client._unstable_updateDelayedEvent).toHaveBeenCalledWith("id", action);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
it("fails to update delayed events", async () => {
|
|
|
|
const errorMessage = "Cannot restart this delayed event";
|
|
|
|
client._unstable_updateDelayedEvent.mockRejectedValue(new Error(errorMessage));
|
|
|
|
await expect(driver.updateDelayedEvent("id", UpdateDelayedEventAction.Restart)).rejects.toThrow(
|
|
|
|
errorMessage,
|
|
|
|
);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
2023-03-09 14:02:29 +01:00
|
|
|
describe("If the feature_dynamic_room_predecessors feature is not enabled", () => {
|
|
|
|
beforeEach(() => {
|
|
|
|
jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("passes the flag through to getVisibleRooms", () => {
|
|
|
|
const driver = mkDefaultDriver();
|
|
|
|
driver.readRoomEvents(EventType.CallAnswer, "", 0, ["*"]);
|
|
|
|
expect(client.getVisibleRooms).toHaveBeenCalledWith(false);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
|
|
|
describe("If the feature_dynamic_room_predecessors is enabled", () => {
|
|
|
|
beforeEach(() => {
|
|
|
|
// Turn on feature_dynamic_room_predecessors setting
|
|
|
|
jest.spyOn(SettingsStore, "getValue").mockImplementation(
|
|
|
|
(settingName) => settingName === "feature_dynamic_room_predecessors",
|
|
|
|
);
|
|
|
|
});
|
|
|
|
|
|
|
|
it("passes the flag through to getVisibleRooms", () => {
|
|
|
|
const driver = mkDefaultDriver();
|
|
|
|
driver.readRoomEvents(EventType.CallAnswer, "", 0, ["*"]);
|
|
|
|
expect(client.getVisibleRooms).toHaveBeenCalledWith(true);
|
|
|
|
});
|
|
|
|
});
|
2023-03-21 12:38:41 +01:00
|
|
|
|
|
|
|
describe("searchUserDirectory", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("searches for users in the user directory", async () => {
|
|
|
|
client.searchUserDirectory.mockResolvedValue({
|
|
|
|
limited: false,
|
|
|
|
results: [{ user_id: "@user", display_name: "Name", avatar_url: "mxc://" }],
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.searchUserDirectory("foo")).resolves.toEqual({
|
|
|
|
limited: false,
|
|
|
|
results: [{ userId: "@user", displayName: "Name", avatarUrl: "mxc://" }],
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client.searchUserDirectory).toHaveBeenCalledWith({ term: "foo", limit: undefined });
|
|
|
|
});
|
|
|
|
|
|
|
|
it("searches for users with a custom limit", async () => {
|
|
|
|
client.searchUserDirectory.mockResolvedValue({
|
|
|
|
limited: true,
|
|
|
|
results: [],
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.searchUserDirectory("foo", 25)).resolves.toEqual({
|
|
|
|
limited: true,
|
|
|
|
results: [],
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client.searchUserDirectory).toHaveBeenCalledWith({ term: "foo", limit: 25 });
|
|
|
|
});
|
|
|
|
});
|
2023-09-21 21:03:22 +02:00
|
|
|
|
|
|
|
describe("getMediaConfig", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("gets the media configuration", async () => {
|
|
|
|
client.getMediaConfig.mockResolvedValue({
|
|
|
|
"m.upload.size": 1000,
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.getMediaConfig()).resolves.toEqual({
|
|
|
|
"m.upload.size": 1000,
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client.getMediaConfig).toHaveBeenCalledWith();
|
|
|
|
});
|
|
|
|
});
|
|
|
|
|
|
|
|
describe("uploadFile", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("uploads a file", async () => {
|
|
|
|
client.uploadContent.mockResolvedValue({
|
|
|
|
content_uri: "mxc://...",
|
|
|
|
});
|
|
|
|
|
|
|
|
await expect(driver.uploadFile("data")).resolves.toEqual({
|
|
|
|
contentUri: "mxc://...",
|
|
|
|
});
|
|
|
|
|
|
|
|
expect(client.uploadContent).toHaveBeenCalledWith("data");
|
|
|
|
});
|
|
|
|
});
|
2024-08-30 16:45:25 +02:00
|
|
|
|
|
|
|
describe("downloadFile", () => {
|
|
|
|
let driver: WidgetDriver;
|
|
|
|
|
|
|
|
beforeEach(() => {
|
|
|
|
driver = mkDefaultDriver();
|
|
|
|
});
|
|
|
|
|
|
|
|
it("should download a file and return the blob", async () => {
|
|
|
|
// eslint-disable-next-line no-restricted-properties
|
|
|
|
client.mxcUrlToHttp.mockImplementation((mxcUrl) => {
|
|
|
|
if (mxcUrl === "mxc://example.com/test_file") {
|
|
|
|
return "https://example.com/_matrix/media/v3/download/example.com/test_file";
|
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
|
|
|
});
|
|
|
|
|
|
|
|
fetchMockJest.get("https://example.com/_matrix/media/v3/download/example.com/test_file", "test contents");
|
|
|
|
|
|
|
|
const result = await driver.downloadFile("mxc://example.com/test_file");
|
|
|
|
// A type test is impossible here because of
|
|
|
|
// https://github.com/jefflau/jest-fetch-mock/issues/209
|
|
|
|
// Tell TypeScript that file is a blob.
|
|
|
|
const file = result.file as Blob;
|
|
|
|
await expect(file.text()).resolves.toEqual("test contents");
|
|
|
|
});
|
|
|
|
});
|
2022-08-10 14:57:56 +02:00
|
|
|
});
|