mv element.io @types __mocks__/ debian docker module_system/ playwright res src test webapp Dockerfile .dockerignore .eslintignore .stylelintrc.cjs babel.config.cjs recorder-worklet-loader.cjs .modernizr.json components.json config.json config.sample.json package.json project.json tsconfig.json tsconfig.module_system.json jest.config.ts playwright.config.ts webpack.config.ts build_config.sample.yaml apps/web/
mkdir apps/web/scripts
mv scripts/{cleanup.sh,ci_package.sh,copy-res.ts,deploy.py,package.sh} apps/web/scripts
And a couple of gitignore tweaks
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski
@@ -0,0 +1,916 @@
|
||||
/*
|
||||
Copyright 2024 New Vector Ltd.
|
||||
Copyright 2022 The Matrix.org Foundation C.I.C.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { mocked, type MockedObject } from "jest-mock";
|
||||
import fetchMock from "@fetch-mock/jest";
|
||||
import {
|
||||
type MatrixClient,
|
||||
ClientEvent,
|
||||
type ITurnServer as IClientTurnServer,
|
||||
Direction,
|
||||
EventType,
|
||||
MatrixEvent,
|
||||
MsgType,
|
||||
RelationType,
|
||||
type Room,
|
||||
} from "matrix-js-sdk/src/matrix";
|
||||
import {
|
||||
Widget,
|
||||
WidgetKind,
|
||||
type WidgetDriver,
|
||||
type ITurnServer,
|
||||
SimpleObservable,
|
||||
OpenIDRequestState,
|
||||
type IOpenIDUpdate,
|
||||
} from "matrix-widget-api";
|
||||
import {
|
||||
type ApprovalOpts,
|
||||
type CapabilitiesOpts,
|
||||
WidgetLifecycle,
|
||||
} from "@matrix-org/react-sdk-module-api/lib/lifecycles/WidgetLifecycle";
|
||||
|
||||
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
|
||||
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
|
||||
import { ElementWidgetDriver } from "../../../../src/stores/widgets/ElementWidgetDriver";
|
||||
import { mkEvent, stubClient } from "../../../test-utils";
|
||||
import { ModuleRunner } from "../../../../src/modules/ModuleRunner";
|
||||
import dis from "../../../../src/dispatcher/dispatcher";
|
||||
import Modal from "../../../../src/Modal";
|
||||
import SettingsStore from "../../../../src/settings/SettingsStore";
|
||||
import { WidgetType } from "../../../../src/widgets/WidgetType.ts";
|
||||
|
||||
describe("ElementWidgetDriver", () => {
|
||||
let client: MockedObject<MatrixClient>;
|
||||
|
||||
const mkDefaultDriver = (): WidgetDriver =>
|
||||
new ElementWidgetDriver(
|
||||
new Widget({
|
||||
id: "test",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: "example",
|
||||
url: "https://example.org",
|
||||
}),
|
||||
WidgetKind.Room,
|
||||
false,
|
||||
"!1:example.org",
|
||||
);
|
||||
|
||||
jest.spyOn(Modal, "createDialog").mockImplementation(() => {
|
||||
throw new Error("Should not have to create a dialog");
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
stubClient();
|
||||
client = mocked(MatrixClientPeg.safeGet());
|
||||
client.getUserId.mockReturnValue("@alice:example.org");
|
||||
client.getSafeUserId.mockReturnValue("@alice:example.org");
|
||||
});
|
||||
|
||||
it("auto-approves capabilities of virtual Element Call widgets", async () => {
|
||||
const driver = new ElementWidgetDriver(
|
||||
new Widget({
|
||||
id: "group_call",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: WidgetType.CALL.preferred,
|
||||
url: "https://call.element.io",
|
||||
}),
|
||||
WidgetKind.Room,
|
||||
true,
|
||||
"!1:example.org",
|
||||
);
|
||||
|
||||
// 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",
|
||||
"org.matrix.msc2762.send.event:org.matrix.msc4075.call.notify",
|
||||
"org.matrix.msc2762.send.event:org.matrix.msc4075.rtc.notification",
|
||||
"org.matrix.msc2762.send.event:org.matrix.rageshake_request",
|
||||
"org.matrix.msc2762.receive.event:org.matrix.rageshake_request",
|
||||
"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",
|
||||
"org.matrix.msc2762.send.event:io.element.call.reaction",
|
||||
"org.matrix.msc2762.receive.event:io.element.call.reaction",
|
||||
"org.matrix.msc2762.receive.state_event:m.room.create",
|
||||
"org.matrix.msc2762.receive.state_event:m.room.name",
|
||||
"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",
|
||||
`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}`,
|
||||
`org.matrix.msc2762.send.state_event:org.matrix.msc3401.call.member#_@alice:example.org_${client.deviceId}_m.call`,
|
||||
`org.matrix.msc2762.send.state_event:org.matrix.msc3401.call.member#@alice:example.org_${client.deviceId}_m.call`,
|
||||
"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",
|
||||
"org.matrix.msc4157.send.delayed_event",
|
||||
"org.matrix.msc4157.update_delayed_event",
|
||||
"org.matrix.msc4407.send.sticky_event",
|
||||
"org.matrix.msc4407.receive.sticky_event",
|
||||
// RTC decline events (send/receive, unstable/stable)
|
||||
"org.matrix.msc2762.send.event:org.matrix.msc4310.rtc.decline",
|
||||
"org.matrix.msc2762.send.event:m.rtc.decline",
|
||||
"org.matrix.msc2762.receive.event:org.matrix.msc4310.rtc.decline",
|
||||
"org.matrix.msc2762.receive.event:m.rtc.decline",
|
||||
// RTC member events (send/receive, unstable/stable)
|
||||
"org.matrix.msc2762.receive.event:org.matrix.msc4143.rtc.member",
|
||||
"org.matrix.msc2762.receive.event:m.rtc.member",
|
||||
"org.matrix.msc2762.send.event:m.rtc.member",
|
||||
"org.matrix.msc2762.send.event:org.matrix.msc4143.rtc.member",
|
||||
]);
|
||||
|
||||
const approvedCapabilities = await driver.validateCapabilities(requestedCapabilities);
|
||||
expect(approvedCapabilities).toEqual(requestedCapabilities);
|
||||
});
|
||||
|
||||
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(),
|
||||
};
|
||||
expect(listener).toHaveBeenCalledWith(openIdUpdate);
|
||||
});
|
||||
|
||||
describe("sendToDevice", () => {
|
||||
const contentMap = {
|
||||
"@alice:example.org": {
|
||||
"*": {
|
||||
hello: "alice",
|
||||
},
|
||||
},
|
||||
"@bob:example.org": {
|
||||
bobDesktop: {
|
||||
hello: "bob",
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
let driver: WidgetDriver;
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
});
|
||||
|
||||
it("sends unencrypted messages", async () => {
|
||||
await driver.sendToDevice("org.example.foo", false, contentMap);
|
||||
expect(client.queueToDevice).toHaveBeenCalledWith({
|
||||
eventType: "org.example.foo",
|
||||
batch: [
|
||||
{ deviceId: "*", payload: { hello: "alice" }, userId: "@alice:example.org" },
|
||||
{ deviceId: "bobDesktop", payload: { hello: "bob" }, userId: "@bob:example.org" },
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it("sends encrypted messages", async () => {
|
||||
const encryptToDeviceMessages = jest
|
||||
.fn()
|
||||
.mockImplementation(
|
||||
(eventType, recipients: { userId: string; deviceId: string }[], content: object) => ({
|
||||
eventType: "m.room.encrypted",
|
||||
batch: recipients.map(({ userId, deviceId }) => ({
|
||||
userId,
|
||||
deviceId,
|
||||
payload: {
|
||||
eventType,
|
||||
content,
|
||||
},
|
||||
})),
|
||||
}),
|
||||
);
|
||||
|
||||
MatrixClientPeg.safeGet().getCrypto()!.encryptToDeviceMessages = encryptToDeviceMessages;
|
||||
|
||||
await driver.sendToDevice("org.example.foo", true, {
|
||||
"@alice:example.org": {
|
||||
aliceMobile: {
|
||||
hello: "alice",
|
||||
},
|
||||
},
|
||||
"@bob:example.org": {
|
||||
bobDesktop: {
|
||||
hello: "bob",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(encryptToDeviceMessages).toHaveBeenCalledWith(
|
||||
"org.example.foo",
|
||||
[{ deviceId: "aliceMobile", userId: "@alice:example.org" }],
|
||||
{
|
||||
hello: "alice",
|
||||
},
|
||||
);
|
||||
expect(encryptToDeviceMessages).toHaveBeenCalledWith(
|
||||
"org.example.foo",
|
||||
[{ deviceId: "bobDesktop", userId: "@bob:example.org" }],
|
||||
{
|
||||
hello: "bob",
|
||||
},
|
||||
);
|
||||
expect(client.queueToDevice).toHaveBeenCalledWith({
|
||||
eventType: "m.room.encrypted",
|
||||
batch: expect.arrayContaining([
|
||||
{
|
||||
deviceId: "aliceMobile",
|
||||
payload: { content: { hello: "alice" }, eventType: "org.example.foo" },
|
||||
userId: "@alice:example.org",
|
||||
},
|
||||
]),
|
||||
});
|
||||
expect(client.queueToDevice).toHaveBeenCalledWith({
|
||||
eventType: "m.room.encrypted",
|
||||
batch: expect.arrayContaining([
|
||||
{
|
||||
deviceId: "bobDesktop",
|
||||
payload: { content: { hello: "bob" }, eventType: "org.example.foo" },
|
||||
userId: "@bob:example.org",
|
||||
},
|
||||
]),
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("getTurnServers", () => {
|
||||
let driver: WidgetDriver;
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
});
|
||||
|
||||
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);
|
||||
});
|
||||
});
|
||||
|
||||
describe("readEventRelations", () => {
|
||||
let driver: WidgetDriver;
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
});
|
||||
|
||||
it("reads related events from the current room", async () => {
|
||||
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!this-room-id");
|
||||
|
||||
client.relations.mockResolvedValue({
|
||||
originalEvent: new MatrixEvent(),
|
||||
events: [],
|
||||
});
|
||||
|
||||
await expect(driver.readEventRelations("$event")).resolves.toEqual({
|
||||
chunk: [],
|
||||
nextBatch: undefined,
|
||||
prevBatch: undefined,
|
||||
});
|
||||
|
||||
expect(client.relations).toHaveBeenCalledWith("!this-room-id", "$event", null, null, {});
|
||||
});
|
||||
|
||||
it("reads related events from a selected room", async () => {
|
||||
client.relations.mockResolvedValue({
|
||||
originalEvent: new MatrixEvent(),
|
||||
events: [new MatrixEvent(), new MatrixEvent()],
|
||||
nextBatch: "next-batch-token",
|
||||
});
|
||||
|
||||
await expect(driver.readEventRelations("$event", "!room-id")).resolves.toEqual({
|
||||
chunk: [expect.objectContaining({ content: {} }), expect.objectContaining({ content: {} })],
|
||||
nextBatch: "next-batch-token",
|
||||
prevBatch: undefined,
|
||||
});
|
||||
|
||||
expect(client.relations).toHaveBeenCalledWith("!room-id", "$event", null, null, {});
|
||||
});
|
||||
|
||||
it("reads related events with custom parameters", async () => {
|
||||
client.relations.mockResolvedValue({
|
||||
originalEvent: new MatrixEvent(),
|
||||
events: [],
|
||||
});
|
||||
|
||||
await expect(
|
||||
driver.readEventRelations(
|
||||
"$event",
|
||||
"!room-id",
|
||||
"m.reference",
|
||||
"m.room.message",
|
||||
"from-token",
|
||||
"to-token",
|
||||
25,
|
||||
"f",
|
||||
),
|
||||
).resolves.toEqual({
|
||||
chunk: [],
|
||||
nextBatch: undefined,
|
||||
prevBatch: undefined,
|
||||
});
|
||||
|
||||
expect(client.relations).toHaveBeenCalledWith("!room-id", "$event", "m.reference", "m.room.message", {
|
||||
limit: 25,
|
||||
from: "from-token",
|
||||
to: "to-token",
|
||||
dir: Direction.Forward,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
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();
|
||||
});
|
||||
});
|
||||
|
||||
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("can cancel scheduled delayed events", async () => {
|
||||
client._unstable_cancelScheduledDelayedEvent.mockResolvedValue({});
|
||||
await expect(driver.cancelScheduledDelayedEvent("id")).resolves.toBeUndefined();
|
||||
expect(client._unstable_cancelScheduledDelayedEvent).toHaveBeenCalledWith("id");
|
||||
});
|
||||
|
||||
it("can restart scheduled delayed events", async () => {
|
||||
client._unstable_restartScheduledDelayedEvent.mockResolvedValue({});
|
||||
await expect(driver.restartScheduledDelayedEvent("id")).resolves.toBeUndefined();
|
||||
expect(client._unstable_restartScheduledDelayedEvent).toHaveBeenCalledWith("id");
|
||||
});
|
||||
|
||||
it("can send scheduled delayed events", async () => {
|
||||
client._unstable_sendScheduledDelayedEvent.mockResolvedValue({});
|
||||
await expect(driver.sendScheduledDelayedEvent("id")).resolves.toBeUndefined();
|
||||
expect(client._unstable_sendScheduledDelayedEvent).toHaveBeenCalledWith("id");
|
||||
});
|
||||
|
||||
it("fails to cancel scheduled delayed events", async () => {
|
||||
const errorMessage = "Cannot cancel this delayed event";
|
||||
client._unstable_cancelScheduledDelayedEvent.mockRejectedValue(new Error(errorMessage));
|
||||
await expect(driver.cancelScheduledDelayedEvent("id")).rejects.toThrow(errorMessage);
|
||||
});
|
||||
|
||||
it("fails to restart scheduled delayed events", async () => {
|
||||
const errorMessage = "Cannot restart this delayed event";
|
||||
client._unstable_restartScheduledDelayedEvent.mockRejectedValue(new Error(errorMessage));
|
||||
await expect(driver.restartScheduledDelayedEvent("id")).rejects.toThrow(errorMessage);
|
||||
});
|
||||
|
||||
it("fails to send scheduled delayed events", async () => {
|
||||
const errorMessage = "Cannot send this delayed event";
|
||||
client._unstable_sendScheduledDelayedEvent.mockRejectedValue(new Error(errorMessage));
|
||||
await expect(driver.sendScheduledDelayedEvent("id")).rejects.toThrow(errorMessage);
|
||||
});
|
||||
});
|
||||
|
||||
describe("sendStickyEvent", () => {
|
||||
let driver: WidgetDriver;
|
||||
const roomId = "!this-room-id";
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
});
|
||||
|
||||
it("sends sticky message events", async () => {
|
||||
client._unstable_sendStickyEvent.mockResolvedValue({
|
||||
event_id: "id",
|
||||
});
|
||||
|
||||
await expect(driver.sendStickyEvent(2000, EventType.RoomMessage, {})).resolves.toEqual({
|
||||
roomId,
|
||||
eventId: "id",
|
||||
});
|
||||
|
||||
expect(client._unstable_sendStickyEvent).toHaveBeenCalledWith(
|
||||
roomId,
|
||||
2000,
|
||||
null,
|
||||
EventType.RoomMessage,
|
||||
{},
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("sendDelayedStickyEvent", () => {
|
||||
let driver: WidgetDriver;
|
||||
const roomId = "!this-room-id";
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
});
|
||||
|
||||
it("sends delayed sticky message events", async () => {
|
||||
client._unstable_sendStickyDelayedEvent.mockResolvedValue({
|
||||
delay_id: "id",
|
||||
});
|
||||
|
||||
await expect(driver.sendDelayedStickyEvent(1000, null, 2000, EventType.RoomMessage, {})).resolves.toEqual({
|
||||
roomId,
|
||||
delayId: "id",
|
||||
});
|
||||
|
||||
expect(client._unstable_sendStickyDelayedEvent).toHaveBeenCalledWith(
|
||||
roomId,
|
||||
2000,
|
||||
{ delay: 1000 },
|
||||
null,
|
||||
EventType.RoomMessage,
|
||||
{},
|
||||
);
|
||||
});
|
||||
it("sends child action delayed sticky message events", async () => {
|
||||
client._unstable_sendStickyDelayedEvent.mockResolvedValue({
|
||||
delay_id: "id-child",
|
||||
});
|
||||
|
||||
await expect(
|
||||
driver.sendDelayedStickyEvent(null, "id-parent", 2000, EventType.RoomMessage, {}),
|
||||
).resolves.toEqual({
|
||||
roomId,
|
||||
delayId: "id-child",
|
||||
});
|
||||
|
||||
expect(client._unstable_sendStickyDelayedEvent).toHaveBeenCalledWith(
|
||||
roomId,
|
||||
2000,
|
||||
{ parent_delay_id: "id-parent" },
|
||||
null,
|
||||
EventType.RoomMessage,
|
||||
{},
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
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.getKnownRooms();
|
||||
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.getKnownRooms();
|
||||
expect(client.getVisibleRooms).toHaveBeenCalledWith(true);
|
||||
});
|
||||
});
|
||||
|
||||
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 });
|
||||
});
|
||||
});
|
||||
|
||||
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");
|
||||
});
|
||||
});
|
||||
|
||||
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;
|
||||
});
|
||||
|
||||
fetchMock.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");
|
||||
});
|
||||
});
|
||||
|
||||
describe("readRoomTimeline", () => {
|
||||
const event1 = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id1",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: { hello: "world" },
|
||||
room: "!1:example.org",
|
||||
});
|
||||
const event2 = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id2",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
skey: "",
|
||||
content: { hello: "world" },
|
||||
room: "!1:example.org",
|
||||
});
|
||||
let driver: WidgetDriver;
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
client.getRoom.mockReturnValue({
|
||||
getLiveTimeline: () => ({ getEvents: () => [event1, event2] }),
|
||||
} as unknown as Room);
|
||||
});
|
||||
|
||||
it("reads all events", async () => {
|
||||
expect(
|
||||
await driver.readRoomTimeline("!1:example.org", "org.example.foo", undefined, undefined, 10, undefined),
|
||||
).toEqual([event2, event1].map((e) => e.getEffectiveEvent()));
|
||||
});
|
||||
|
||||
it("reads state events", async () => {
|
||||
expect(
|
||||
await driver.readRoomTimeline("!1:example.org", "org.example.foo", undefined, "", 10, undefined),
|
||||
).toEqual([event2.getEffectiveEvent()]);
|
||||
});
|
||||
|
||||
it("reads up to a limit", async () => {
|
||||
expect(
|
||||
await driver.readRoomTimeline("!1:example.org", "org.example.foo", undefined, undefined, 1, undefined),
|
||||
).toEqual([event2.getEffectiveEvent()]);
|
||||
});
|
||||
|
||||
it("reads up to a specific event", async () => {
|
||||
expect(
|
||||
await driver.readRoomTimeline(
|
||||
"!1:example.org",
|
||||
"org.example.foo",
|
||||
undefined,
|
||||
undefined,
|
||||
10,
|
||||
event1.getId(),
|
||||
),
|
||||
).toEqual([event2.getEffectiveEvent()]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("readRoomState", () => {
|
||||
const event1 = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id1",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: { hello: "world" },
|
||||
skey: "1",
|
||||
room: "!1:example.org",
|
||||
});
|
||||
const event2 = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id2",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: { hello: "world" },
|
||||
skey: "2",
|
||||
room: "!1:example.org",
|
||||
});
|
||||
let driver: WidgetDriver;
|
||||
let getStateEvents: jest.Mock;
|
||||
|
||||
beforeEach(() => {
|
||||
driver = mkDefaultDriver();
|
||||
getStateEvents = jest.fn();
|
||||
client.getRoom.mockReturnValue({
|
||||
getLiveTimeline: () => ({ getState: () => ({ getStateEvents }) }),
|
||||
} as unknown as Room);
|
||||
});
|
||||
|
||||
it("reads a specific state key", async () => {
|
||||
getStateEvents.mockImplementation((eventType, stateKey) => {
|
||||
if (eventType === "org.example.foo" && stateKey === "1") return event1;
|
||||
return undefined;
|
||||
});
|
||||
expect(await driver.readRoomState("!1:example.org", "org.example.foo", "1")).toEqual([
|
||||
event1.getEffectiveEvent(),
|
||||
]);
|
||||
});
|
||||
|
||||
it("reads all state keys", async () => {
|
||||
getStateEvents.mockImplementation((eventType, stateKey) => {
|
||||
if (eventType === "org.example.foo" && stateKey === undefined) return [event1, event2];
|
||||
return [];
|
||||
});
|
||||
expect(await driver.readRoomState("!1:example.org", "org.example.foo", undefined)).toEqual(
|
||||
[event1, event2].map((e) => e.getEffectiveEvent()),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,689 @@
|
||||
/*
|
||||
Copyright 2024 New Vector Ltd.
|
||||
Copyright 2022 The Matrix.org Foundation C.I.C
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { mocked, type MockedFunction, type MockedObject } from "jest-mock";
|
||||
import { findLast, last } from "lodash";
|
||||
import {
|
||||
MatrixEvent,
|
||||
type MatrixClient,
|
||||
ClientEvent,
|
||||
type EventTimeline,
|
||||
EventType,
|
||||
MatrixEventEvent,
|
||||
RoomStateEvent,
|
||||
type RoomState,
|
||||
type Room,
|
||||
} from "matrix-js-sdk/src/matrix";
|
||||
import {
|
||||
ClientWidgetApi,
|
||||
type IModalWidgetOpenRequest,
|
||||
type IStickerActionRequest,
|
||||
type IStickyActionRequest,
|
||||
type IWidgetApiRequest,
|
||||
MatrixCapabilities,
|
||||
WidgetApiDirection,
|
||||
WidgetApiFromWidgetAction,
|
||||
} from "matrix-widget-api";
|
||||
import { waitFor } from "jest-matrix-react";
|
||||
|
||||
import { stubClient, mkRoom, mkEvent } from "../../../test-utils";
|
||||
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
|
||||
import { ElementWidget, WidgetMessaging } from "../../../../src/stores/widgets/WidgetMessaging";
|
||||
import ActiveWidgetStore from "../../../../src/stores/ActiveWidgetStore";
|
||||
import SettingsStore from "../../../../src/settings/SettingsStore";
|
||||
import defaultDispatcher from "../../../../src/dispatcher/dispatcher";
|
||||
import { Action } from "../../../../src/dispatcher/actions";
|
||||
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
|
||||
import { UPDATE_EVENT } from "../../../../src/stores/AsyncStore";
|
||||
import { type IApp } from "../../../../src/utils/WidgetUtils-types";
|
||||
import { ModalWidgetStore } from "../../../../src/stores/ModalWidgetStore";
|
||||
import { ElementWidgetActions, type IViewRoomApiRequest } from "../../../../src/stores/widgets/ElementWidgetActions";
|
||||
import { ElementWidgetCapabilities } from "../../../../src/stores/widgets/ElementWidgetCapabilities";
|
||||
import { WidgetType } from "../../../../src/widgets/WidgetType";
|
||||
import { IntegrationManagers } from "../../../../src/integrations/IntegrationManagers";
|
||||
import { type IntegrationManagerInstance } from "../../../../src/integrations/IntegrationManagerInstance";
|
||||
|
||||
jest.mock("matrix-widget-api", () => ({
|
||||
...jest.requireActual("matrix-widget-api"),
|
||||
ClientWidgetApi: (jest.createMockFromModule("matrix-widget-api") as any).ClientWidgetApi,
|
||||
}));
|
||||
|
||||
const originGetValue = SettingsStore.getValue;
|
||||
|
||||
describe("WidgetMessaging", () => {
|
||||
let client: MockedObject<MatrixClient>;
|
||||
let widget: WidgetMessaging;
|
||||
let messaging: MockedObject<ClientWidgetApi>;
|
||||
|
||||
beforeEach(() => {
|
||||
stubClient();
|
||||
client = mocked(MatrixClientPeg.safeGet());
|
||||
|
||||
const app: IApp = {
|
||||
id: "test",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: "example",
|
||||
url: "https://example.org?user-id=$matrix_user_id&device-id=$org.matrix.msc3819.matrix_device_id&base-url=$org.matrix.msc4039.matrix_base_url&theme=$org.matrix.msc2873.client_theme",
|
||||
roomId: "!1:example.org",
|
||||
};
|
||||
widget = new WidgetMessaging(new ElementWidget(app), {
|
||||
app,
|
||||
room: mkRoom(client, "!1:example.org"),
|
||||
userId: "@alice:example.org",
|
||||
creatorUserId: "@alice:example.org",
|
||||
waitForIframeLoad: true,
|
||||
userWidget: false,
|
||||
});
|
||||
// Start messaging without an iframe, since ClientWidgetApi is mocked
|
||||
widget.start(null as unknown as HTMLIFrameElement);
|
||||
messaging = mocked(last(mocked(ClientWidgetApi).mock.instances)!);
|
||||
messaging.feedStateUpdate.mockResolvedValue();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
widget.stop();
|
||||
});
|
||||
|
||||
it("should replace parameters in widget url template", () => {
|
||||
const spy = jest.spyOn(SettingsStore, "getValue").mockImplementation((setting) => {
|
||||
if (setting === "theme") return "my-theme-for-testing";
|
||||
return originGetValue(setting);
|
||||
});
|
||||
expect(widget.embedUrl).toBe(
|
||||
"https://example.org/?user-id=%40userId%3Amatrix.org&device-id=ABCDEFGHI&base-url=https%3A%2F%2Fmatrix-client.matrix.org&theme=my-theme-for-testing&widgetId=test&parentUrl=http%3A%2F%2Flocalhost%2F",
|
||||
);
|
||||
spy.mockClear();
|
||||
});
|
||||
|
||||
it("should replace parameters in widget url template for popout", () => {
|
||||
const spy = jest.spyOn(SettingsStore, "getValue").mockImplementation((setting) => {
|
||||
if (setting === "theme") return "my-theme-for-testing";
|
||||
return originGetValue(setting);
|
||||
});
|
||||
expect(widget.popoutUrl).toBe(
|
||||
"https://example.org/?user-id=%40userId%3Amatrix.org&device-id=ABCDEFGHI&base-url=https%3A%2F%2Fmatrix-client.matrix.org&theme=my-theme-for-testing",
|
||||
);
|
||||
spy.mockClear();
|
||||
});
|
||||
|
||||
it("feeds incoming to-device messages to the widget", async () => {
|
||||
const receivedToDevice = {
|
||||
message: {
|
||||
type: "org.example.foo",
|
||||
sender: "@alice:example.org",
|
||||
content: {
|
||||
hello: "world",
|
||||
},
|
||||
},
|
||||
encryptionInfo: null,
|
||||
};
|
||||
|
||||
client.emit(ClientEvent.ReceivedToDeviceMessage, receivedToDevice);
|
||||
await Promise.resolve(); // flush promises
|
||||
expect(messaging.feedToDevice).toHaveBeenCalledWith(receivedToDevice.message, false);
|
||||
});
|
||||
|
||||
it("feeds incoming encrypted to-device messages to the widget", async () => {
|
||||
const receivedToDevice = {
|
||||
message: {
|
||||
type: "org.example.foo",
|
||||
sender: "@alice:example.org",
|
||||
content: {
|
||||
hello: "world",
|
||||
},
|
||||
},
|
||||
encryptionInfo: {
|
||||
senderVerified: false,
|
||||
sender: "@alice:example.org",
|
||||
senderCurve25519KeyBase64: "",
|
||||
senderDevice: "ABCDEFGHI",
|
||||
},
|
||||
};
|
||||
|
||||
client.emit(ClientEvent.ReceivedToDeviceMessage, receivedToDevice);
|
||||
await Promise.resolve(); // flush promises
|
||||
expect(messaging.feedToDevice).toHaveBeenCalledWith(receivedToDevice.message, true);
|
||||
});
|
||||
|
||||
it("feeds incoming state updates to the widget", () => {
|
||||
const event = mkEvent({
|
||||
event: true,
|
||||
type: "org.example.foo",
|
||||
skey: "",
|
||||
user: "@alice:example.org",
|
||||
content: { hello: "world" },
|
||||
room: "!1:example.org",
|
||||
});
|
||||
|
||||
client.emit(RoomStateEvent.Events, event, {} as unknown as RoomState, null);
|
||||
expect(messaging.feedStateUpdate).toHaveBeenCalledWith(event.getEffectiveEvent());
|
||||
});
|
||||
|
||||
it("informs widget of theme changes", () => {
|
||||
let theme = "light";
|
||||
const settingsSpy = jest
|
||||
.spyOn(SettingsStore, "getValue")
|
||||
.mockImplementation((name) => (name === "theme" ? theme : null));
|
||||
try {
|
||||
// Indicate that the widget is ready
|
||||
findLast(messaging.once.mock.calls, ([eventName]) => eventName === "ready")![1]();
|
||||
|
||||
// Now change the theme
|
||||
theme = "dark";
|
||||
defaultDispatcher.dispatch({ action: Action.RecheckTheme }, true);
|
||||
expect(messaging.updateTheme).toHaveBeenLastCalledWith({ name: "dark" });
|
||||
} finally {
|
||||
settingsSpy.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
describe("feed event", () => {
|
||||
let event1: MatrixEvent;
|
||||
let event2: MatrixEvent;
|
||||
|
||||
beforeEach(() => {
|
||||
event1 = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id1",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: { hello: "world" },
|
||||
room: "!1:example.org",
|
||||
});
|
||||
|
||||
event2 = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id2",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: { hello: "world" },
|
||||
room: "!1:example.org",
|
||||
});
|
||||
|
||||
const room = mkRoom(client, "!1:example.org");
|
||||
client.getRoom.mockImplementation((roomId) => (roomId === "!1:example.org" ? room : null));
|
||||
room.getLiveTimeline.mockReturnValue({
|
||||
getEvents: (): MatrixEvent[] => [event1, event2],
|
||||
} as unknown as EventTimeline);
|
||||
|
||||
messaging.feedEvent.mockResolvedValue();
|
||||
});
|
||||
|
||||
it("feeds incoming event to the widget", async () => {
|
||||
client.emit(ClientEvent.Event, event1);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledWith(event1.getEffectiveEvent());
|
||||
|
||||
client.emit(ClientEvent.Event, event2);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event2.getEffectiveEvent());
|
||||
});
|
||||
|
||||
it("should not feed incoming event to the widget if seen already", async () => {
|
||||
client.emit(ClientEvent.Event, event1);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledWith(event1.getEffectiveEvent());
|
||||
|
||||
client.emit(ClientEvent.Event, event2);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event2.getEffectiveEvent());
|
||||
|
||||
client.emit(ClientEvent.Event, event1);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event2.getEffectiveEvent());
|
||||
});
|
||||
|
||||
it("feeds decrypted events asynchronously", async () => {
|
||||
const event1Encrypted = new MatrixEvent({
|
||||
event_id: event1.getId(),
|
||||
type: EventType.RoomMessageEncrypted,
|
||||
sender: event1.sender?.userId,
|
||||
room_id: event1.getRoomId(),
|
||||
content: {},
|
||||
});
|
||||
const decryptingSpy1 = jest.spyOn(event1Encrypted, "isBeingDecrypted").mockReturnValue(true);
|
||||
client.emit(ClientEvent.Event, event1Encrypted);
|
||||
const event2Encrypted = new MatrixEvent({
|
||||
event_id: event2.getId(),
|
||||
type: EventType.RoomMessageEncrypted,
|
||||
sender: event2.sender?.userId,
|
||||
room_id: event2.getRoomId(),
|
||||
content: {},
|
||||
});
|
||||
const decryptingSpy2 = jest.spyOn(event2Encrypted, "isBeingDecrypted").mockReturnValue(true);
|
||||
client.emit(ClientEvent.Event, event2Encrypted);
|
||||
expect(messaging.feedEvent).not.toHaveBeenCalled();
|
||||
|
||||
// "Decrypt" the events, but in reverse order; first event 2…
|
||||
event2Encrypted.event.type = event2.getType();
|
||||
event2Encrypted.event.content = event2.getContent();
|
||||
decryptingSpy2.mockReturnValue(false);
|
||||
client.emit(MatrixEventEvent.Decrypted, event2Encrypted);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(1);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event2Encrypted.getEffectiveEvent());
|
||||
// …then event 1
|
||||
event1Encrypted.event.type = event1.getType();
|
||||
event1Encrypted.event.content = event1.getContent();
|
||||
decryptingSpy1.mockReturnValue(false);
|
||||
client.emit(MatrixEventEvent.Decrypted, event1Encrypted);
|
||||
// The events should be fed in that same order so that event 2
|
||||
// doesn't have to be blocked on the decryption of event 1 (or
|
||||
// worse, dropped)
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event1Encrypted.getEffectiveEvent());
|
||||
});
|
||||
|
||||
it("should not feed incoming event if not in timeline", () => {
|
||||
const event = mkEvent({
|
||||
event: true,
|
||||
id: "$event-id",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: {
|
||||
hello: "world",
|
||||
},
|
||||
room: "!1:example.org",
|
||||
});
|
||||
|
||||
client.emit(ClientEvent.Event, event);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledWith(event.getEffectiveEvent());
|
||||
});
|
||||
|
||||
it("feeds incoming event that is not in timeline but relates to unknown parent to the widget", async () => {
|
||||
const event = mkEvent({
|
||||
event: true,
|
||||
id: "$event-idRelation",
|
||||
type: "org.example.foo",
|
||||
user: "@alice:example.org",
|
||||
content: {
|
||||
"hello": "world",
|
||||
"m.relates_to": {
|
||||
event_id: "$unknown-parent",
|
||||
rel_type: "m.reference",
|
||||
},
|
||||
},
|
||||
room: "!1:example.org",
|
||||
});
|
||||
|
||||
client.emit(ClientEvent.Event, event1);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledWith(event1.getEffectiveEvent());
|
||||
|
||||
client.emit(ClientEvent.Event, event);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event.getEffectiveEvent());
|
||||
|
||||
client.emit(ClientEvent.Event, event1);
|
||||
expect(messaging.feedEvent).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.feedEvent).toHaveBeenLastCalledWith(event.getEffectiveEvent());
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("WidgetMessaging with stickyPromise", () => {
|
||||
let client: MockedObject<MatrixClient>;
|
||||
let widget: WidgetMessaging;
|
||||
let messaging: MockedObject<ClientWidgetApi>;
|
||||
|
||||
beforeEach(() => {
|
||||
stubClient();
|
||||
client = mocked(MatrixClientPeg.safeGet());
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
widget.stop();
|
||||
});
|
||||
it("should wait for the sticky promise to resolve before starting messaging", async () => {
|
||||
jest.useFakeTimers();
|
||||
const getStickyPromise = async () => {
|
||||
return new Promise<void>((resolve) => {
|
||||
setTimeout(() => {
|
||||
resolve();
|
||||
}, 1000);
|
||||
});
|
||||
};
|
||||
const app: IApp = {
|
||||
id: "test",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: "example",
|
||||
url: "https://example.org?user-id=$matrix_user_id&device-id=$org.matrix.msc3819.matrix_device_id&base-url=$org.matrix.msc4039.matrix_base_url",
|
||||
roomId: "!1:example.org",
|
||||
};
|
||||
widget = new WidgetMessaging(new ElementWidget(app), {
|
||||
app,
|
||||
room: mkRoom(client, "!1:example.org"),
|
||||
userId: "@alice:example.org",
|
||||
creatorUserId: "@alice:example.org",
|
||||
waitForIframeLoad: true,
|
||||
userWidget: false,
|
||||
stickyPromise: getStickyPromise,
|
||||
});
|
||||
|
||||
const setPersistenceSpy = jest.spyOn(ActiveWidgetStore.instance, "setWidgetPersistence");
|
||||
|
||||
// Start messaging without an iframe, since ClientWidgetApi is mocked
|
||||
widget.start(null as unknown as HTMLIFrameElement);
|
||||
const emitSticky = async () => {
|
||||
messaging = mocked(last(mocked(ClientWidgetApi).mock.instances)!);
|
||||
messaging?.hasCapability.mockReturnValue(true);
|
||||
// messaging.transport.reply will be called but transport is undefined in this test environment
|
||||
// This just makes sure the call doesn't throw
|
||||
Object.defineProperty(messaging, "transport", { value: { reply: () => {} } });
|
||||
messaging.on.mock.calls.find(([event, listener]) => {
|
||||
if (event === `action:${WidgetApiFromWidgetAction.UpdateAlwaysOnScreen}`) {
|
||||
listener({ preventDefault: () => {}, detail: { data: { value: true } } });
|
||||
return true;
|
||||
}
|
||||
});
|
||||
};
|
||||
await emitSticky();
|
||||
expect(setPersistenceSpy).not.toHaveBeenCalled();
|
||||
// Advance the fake timer so that the sticky promise resolves
|
||||
jest.runAllTimers();
|
||||
// Use a real timer and wait for the next tick so the sticky promise can resolve
|
||||
jest.useRealTimers();
|
||||
|
||||
waitFor(() => expect(setPersistenceSpy).toHaveBeenCalled(), { interval: 5 });
|
||||
});
|
||||
});
|
||||
|
||||
describe("WidgetMessaging as an account widget", () => {
|
||||
let widget: WidgetMessaging;
|
||||
let messaging: MockedObject<ClientWidgetApi>;
|
||||
let getRoomId: MockedFunction<() => string | null>;
|
||||
|
||||
beforeEach(() => {
|
||||
stubClient();
|
||||
// I give up, getting the return type of spyOn right is hopeless
|
||||
getRoomId = jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId") as unknown as MockedFunction<
|
||||
() => string | null
|
||||
>;
|
||||
getRoomId.mockReturnValue("!1:example.org");
|
||||
|
||||
const app: IApp = {
|
||||
id: "test",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: "example",
|
||||
url: "https://example.org?user-id=$matrix_user_id&device-id=$org.matrix.msc3819.matrix_device_id&base-url=$org.matrix.msc4039.matrix_base_url&theme=$org.matrix.msc2873.client_theme",
|
||||
roomId: "!1:example.org",
|
||||
};
|
||||
widget = new WidgetMessaging(new ElementWidget(app), {
|
||||
app,
|
||||
userId: "@alice:example.org",
|
||||
creatorUserId: "@alice:example.org",
|
||||
waitForIframeLoad: true,
|
||||
userWidget: false,
|
||||
});
|
||||
// Start messaging without an iframe, since ClientWidgetApi is mocked
|
||||
widget.start(null as unknown as HTMLIFrameElement);
|
||||
messaging = mocked(last(mocked(ClientWidgetApi).mock.instances)!);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
widget.stop();
|
||||
getRoomId.mockRestore();
|
||||
});
|
||||
|
||||
it("updates viewed room", () => {
|
||||
expect(messaging.setViewedRoomId).toHaveBeenCalledTimes(1);
|
||||
expect(messaging.setViewedRoomId).toHaveBeenLastCalledWith("!1:example.org");
|
||||
getRoomId.mockReturnValue("!2:example.org");
|
||||
SdkContextClass.instance.roomViewStore.emit(UPDATE_EVENT);
|
||||
expect(messaging.setViewedRoomId).toHaveBeenCalledTimes(2);
|
||||
expect(messaging.setViewedRoomId).toHaveBeenLastCalledWith("!2:example.org");
|
||||
});
|
||||
});
|
||||
|
||||
function createTransportEvent<T extends IWidgetApiRequest>(data: T["data"]): CustomEvent<T> {
|
||||
// Not the complete CustomEvent but good nuff.
|
||||
return {
|
||||
preventDefault: () => {},
|
||||
detail: {
|
||||
action: WidgetApiFromWidgetAction.OpenModalWidget,
|
||||
data: data,
|
||||
api: WidgetApiDirection.FromWidget,
|
||||
requestId: "12345",
|
||||
widgetId: "test",
|
||||
},
|
||||
} as unknown as CustomEvent;
|
||||
}
|
||||
|
||||
describe("WidgetMessaging action handling", () => {
|
||||
let widget: WidgetMessaging;
|
||||
let messaging: MockedObject<ClientWidgetApi>;
|
||||
let actionFns: Record<string, (ev: any) => void>;
|
||||
|
||||
beforeEach(() => {
|
||||
const client = stubClient();
|
||||
|
||||
const app: IApp = {
|
||||
id: "test",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: "example",
|
||||
url: "https://example.org?user-id=$matrix_user_id&device-id=$org.matrix.msc3819.matrix_device_id&base-url=$org.matrix.msc4039.matrix_base_url&theme=$org.matrix.msc2873.client_theme",
|
||||
roomId: "!1:example.org",
|
||||
};
|
||||
widget = new WidgetMessaging(new ElementWidget(app), {
|
||||
app,
|
||||
room: mkRoom(client, "!1:example.org"),
|
||||
userId: "@alice:example.org",
|
||||
creatorUserId: "@alice:example.org",
|
||||
waitForIframeLoad: true,
|
||||
userWidget: false,
|
||||
});
|
||||
// Start messaging without an iframe, since ClientWidgetApi is mocked
|
||||
widget.start(null as unknown as HTMLIFrameElement);
|
||||
messaging = mocked(last(mocked(ClientWidgetApi).mock.instances)!);
|
||||
Object.defineProperty(messaging, "transport", { value: { reply: jest.fn() } });
|
||||
actionFns = Object.fromEntries(messaging.on.mock.calls as any);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
widget.stop();
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
describe("open modal widget", () => {
|
||||
beforeEach(() => {
|
||||
// Trivial mock of ModalWidgetStore
|
||||
let hasModal = false;
|
||||
jest.spyOn(ModalWidgetStore.instance, "openModalWidget").mockImplementation(() => {
|
||||
if (hasModal) {
|
||||
throw Error("Modal already in view");
|
||||
}
|
||||
hasModal = true;
|
||||
});
|
||||
jest.spyOn(ModalWidgetStore.instance, "canOpenModalWidget").mockImplementation(() => !hasModal);
|
||||
jest.spyOn(ModalWidgetStore.instance, "closeModalWidget").mockImplementation(() => {
|
||||
if (!hasModal) {
|
||||
throw Error("No modal in view");
|
||||
}
|
||||
hasModal = false;
|
||||
});
|
||||
});
|
||||
|
||||
it("handles an open modal request", () => {
|
||||
const ev = createTransportEvent<IModalWidgetOpenRequest>({ type: "foo", url: "bar" });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.OpenModalWidget}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {});
|
||||
});
|
||||
|
||||
it("responds with an error if a modal is already open", () => {
|
||||
const ev = createTransportEvent<IModalWidgetOpenRequest>({ type: "foo", url: "bar" });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.OpenModalWidget}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {});
|
||||
messaging.transport.reply.mockReset();
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.OpenModalWidget}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {
|
||||
error: { message: "Unable to open modal at this time" },
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("view room", () => {
|
||||
afterEach(() => {
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
it("errors on invalid room", () => {
|
||||
const ev = createTransportEvent<IViewRoomApiRequest>({ room_id: null } as any);
|
||||
actionFns[`action:${ElementWidgetActions.ViewRoom}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {
|
||||
error: { message: "Room ID not supplied." },
|
||||
});
|
||||
});
|
||||
it("errors on missing permissions", () => {
|
||||
const ev = createTransportEvent<IViewRoomApiRequest>({ room_id: "!foo:example.org" } as any);
|
||||
actionFns[`action:${ElementWidgetActions.ViewRoom}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {
|
||||
error: { message: "This widget does not have permission for this action (denied)." },
|
||||
});
|
||||
});
|
||||
it("handles room change", async () => {
|
||||
const ev = createTransportEvent<IViewRoomApiRequest>({ room_id: "!foo:example.org" } as any);
|
||||
messaging.hasCapability.mockImplementation(
|
||||
(capability) => capability === ElementWidgetCapabilities.CanChangeViewedRoom,
|
||||
);
|
||||
const dispatch = (defaultDispatcher.dispatch = jest.fn());
|
||||
actionFns[`action:${ElementWidgetActions.ViewRoom}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {});
|
||||
expect(dispatch).toHaveBeenCalledWith({
|
||||
action: "view_room",
|
||||
metricsTrigger: "Widget",
|
||||
room_id: "!foo:example.org",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("always on screen", () => {
|
||||
let setWidgetPersistence: jest.SpyInstance<void, Parameters<ActiveWidgetStore["setWidgetPersistence"]>>;
|
||||
beforeEach(() => {
|
||||
setWidgetPersistence = jest.spyOn(ActiveWidgetStore.instance, "setWidgetPersistence");
|
||||
});
|
||||
|
||||
it("does nothing if the widget does not have permission", () => {
|
||||
const ev = createTransportEvent<IStickyActionRequest>({ value: true });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.UpdateAlwaysOnScreen}`](ev);
|
||||
// Currently there is no error response for this.
|
||||
expect(messaging.transport.reply).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("handles setting a widget as sticky", () => {
|
||||
messaging.hasCapability.mockImplementation(
|
||||
(capability) => capability === MatrixCapabilities.AlwaysOnScreen,
|
||||
);
|
||||
const ev = createTransportEvent<IStickyActionRequest>({ value: true });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.UpdateAlwaysOnScreen}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {});
|
||||
expect(setWidgetPersistence).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("handles setting a widget as unsticky", () => {
|
||||
messaging.hasCapability.mockImplementation(
|
||||
(capability) => capability === MatrixCapabilities.AlwaysOnScreen,
|
||||
);
|
||||
const evOpen = createTransportEvent<IStickyActionRequest>({ value: true });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.UpdateAlwaysOnScreen}`](evOpen);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(evOpen.detail, {});
|
||||
expect(setWidgetPersistence).toHaveBeenCalledTimes(1);
|
||||
messaging.transport.reply.mockReset();
|
||||
const evClose = createTransportEvent<IStickyActionRequest>({ value: false });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.UpdateAlwaysOnScreen}`](evClose);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(evClose.detail, {});
|
||||
expect(setWidgetPersistence).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe("send sticker", () => {
|
||||
it("does nothing if the widget does not have permission", () => {
|
||||
const ev = createTransportEvent<IStickerActionRequest>({ name: "foo", content: { url: "bar" } });
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.SendSticker}`](ev);
|
||||
// Currently there is no error response for this.
|
||||
expect(messaging.transport.reply).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("handles setting a widget as sticky", () => {
|
||||
messaging.hasCapability.mockImplementation(
|
||||
(capability) => capability === MatrixCapabilities.StickerSending,
|
||||
);
|
||||
const ev = createTransportEvent<IStickerActionRequest>({ name: "foo", content: { url: "bar" } });
|
||||
const dispatch = (defaultDispatcher.dispatch = jest.fn());
|
||||
actionFns[`action:${WidgetApiFromWidgetAction.SendSticker}`](ev);
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {});
|
||||
expect(dispatch).toHaveBeenCalledWith({
|
||||
action: "m.sticker",
|
||||
data: { content: { url: "bar" }, name: "foo" },
|
||||
widgetId: "test",
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("WidgetMessaging action handling for stickerpicker", () => {
|
||||
let widget: WidgetMessaging;
|
||||
let messaging: MockedObject<ClientWidgetApi>;
|
||||
let actionFns: Record<string, (ev: any) => void>;
|
||||
let room: Room;
|
||||
|
||||
beforeEach(() => {
|
||||
const client = mocked(stubClient());
|
||||
room = mkRoom(client, "!1:example.org");
|
||||
client.getRoom.mockImplementation((roomId) => (roomId === room.roomId ? room : null));
|
||||
const getRoomId = jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId") as unknown as MockedFunction<
|
||||
() => string | null
|
||||
>;
|
||||
getRoomId.mockReturnValue(room.roomId);
|
||||
const app: IApp = {
|
||||
id: "test",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: WidgetType.STICKERPICKER.preferred,
|
||||
url: "https://example.org?user-id=$matrix_user_id&device-id=$org.matrix.msc3819.matrix_device_id&base-url=$org.matrix.msc4039.matrix_base_url&theme=$org.matrix.msc2873.client_theme",
|
||||
roomId: room.roomId,
|
||||
};
|
||||
widget = new WidgetMessaging(new ElementWidget(app), {
|
||||
app,
|
||||
room,
|
||||
userId: "@alice:example.org",
|
||||
creatorUserId: "@alice:example.org",
|
||||
waitForIframeLoad: true,
|
||||
userWidget: false,
|
||||
});
|
||||
// Start messaging without an iframe, since ClientWidgetApi is mocked
|
||||
widget.start(null as unknown as HTMLIFrameElement);
|
||||
messaging = mocked(last(mocked(ClientWidgetApi).mock.instances)!);
|
||||
Object.defineProperty(messaging, "transport", { value: { reply: jest.fn() } });
|
||||
actionFns = Object.fromEntries(messaging.on.mock.calls as any);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
widget.stop();
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
describe("open integrations manager", () => {
|
||||
let openIntegrationManager: jest.SpyInstance<void, Parameters<IntegrationManagerInstance["open"]>>;
|
||||
beforeEach(() => {
|
||||
// Trivial mock of ModalWidgetStore
|
||||
openIntegrationManager = jest.fn();
|
||||
const inst = IntegrationManagers.sharedInstance();
|
||||
jest.spyOn(inst, "getPrimaryManager").mockImplementation(
|
||||
() =>
|
||||
({
|
||||
open: openIntegrationManager,
|
||||
}) as any,
|
||||
);
|
||||
});
|
||||
|
||||
it("open the integration manager", () => {
|
||||
const ev = createTransportEvent<IWidgetApiRequest>({ integType: "my_integ_type", integId: "my_integ_id" });
|
||||
const dispatch = (defaultDispatcher.dispatch = jest.fn());
|
||||
actionFns[`action:${ElementWidgetActions.OpenIntegrationManager}`](ev);
|
||||
expect(dispatch).toHaveBeenCalledWith({
|
||||
action: "stickerpicker_close",
|
||||
});
|
||||
expect(messaging.transport.reply).toHaveBeenCalledWith(ev.detail, {});
|
||||
expect(openIntegrationManager).toHaveBeenCalledWith(room, `type_my_integ_type`, "my_integ_id");
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,101 @@
|
||||
/*
|
||||
Copyright 2024 New Vector Ltd.
|
||||
Copyright 2022 The Matrix.org Foundation C.I.C.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { mocked } from "jest-mock";
|
||||
import { type MatrixClient } from "matrix-js-sdk/src/matrix";
|
||||
import { Widget, WidgetKind } from "matrix-widget-api";
|
||||
|
||||
import { OIDCState, WidgetPermissionStore } from "../../../../src/stores/widgets/WidgetPermissionStore";
|
||||
import SettingsStore from "../../../../src/settings/SettingsStore";
|
||||
import { TestSdkContext } from "../../TestSdkContext";
|
||||
import { type SettingLevel } from "../../../../src/settings/SettingLevel";
|
||||
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
|
||||
import { stubClient } from "../../../test-utils";
|
||||
import { ElementWidgetDriver } from "../../../../src/stores/widgets/ElementWidgetDriver";
|
||||
import { WidgetType } from "../../../../src/widgets/WidgetType.ts";
|
||||
|
||||
jest.mock("../../../../src/settings/SettingsStore");
|
||||
|
||||
describe("WidgetPermissionStore", () => {
|
||||
let widgetPermissionStore: WidgetPermissionStore;
|
||||
let mockClient: MatrixClient;
|
||||
const userId = "@alice:localhost";
|
||||
const roomId = "!room:localhost";
|
||||
const w = new Widget({
|
||||
id: "wid",
|
||||
creatorUserId: userId,
|
||||
type: "m.custom",
|
||||
url: "https://invalid.address.here",
|
||||
});
|
||||
const elementCallWidget = new Widget({
|
||||
id: "group_call",
|
||||
creatorUserId: "@alice:example.org",
|
||||
type: WidgetType.CALL.preferred,
|
||||
url: "https://call.element.io",
|
||||
});
|
||||
let settings: Record<string, any> = {}; // key value store
|
||||
|
||||
beforeEach(() => {
|
||||
settings = {}; // clear settings
|
||||
mocked(SettingsStore.getValue).mockImplementation((setting: string) => {
|
||||
return settings[setting];
|
||||
});
|
||||
mocked(SettingsStore.setValue).mockImplementation(
|
||||
(settingName: string, roomId: string | null, level: SettingLevel, value: any): Promise<void> => {
|
||||
// the store doesn't use any specific level or room ID (room IDs are packed into keys in `value`)
|
||||
settings[settingName] = value;
|
||||
return Promise.resolve();
|
||||
},
|
||||
);
|
||||
mockClient = stubClient();
|
||||
const context = new TestSdkContext();
|
||||
context.client = mockClient;
|
||||
widgetPermissionStore = new WidgetPermissionStore(context);
|
||||
});
|
||||
|
||||
it("should persist OIDCState.Allowed for a widget", () => {
|
||||
widgetPermissionStore.setOIDCState(w, WidgetKind.Account, roomId, OIDCState.Allowed);
|
||||
// check it remembered the value
|
||||
expect(widgetPermissionStore.getOIDCState(w, WidgetKind.Account, roomId)).toEqual(OIDCState.Allowed);
|
||||
});
|
||||
|
||||
it("should persist OIDCState.Denied for a widget", () => {
|
||||
widgetPermissionStore.setOIDCState(w, WidgetKind.Account, roomId, OIDCState.Denied);
|
||||
// check it remembered the value
|
||||
expect(widgetPermissionStore.getOIDCState(w, WidgetKind.Account, roomId)).toEqual(OIDCState.Denied);
|
||||
});
|
||||
|
||||
it("should update OIDCState for a widget", () => {
|
||||
widgetPermissionStore.setOIDCState(w, WidgetKind.Account, roomId, OIDCState.Allowed);
|
||||
widgetPermissionStore.setOIDCState(w, WidgetKind.Account, roomId, OIDCState.Denied);
|
||||
// check it remembered the latest value
|
||||
expect(widgetPermissionStore.getOIDCState(w, WidgetKind.Account, roomId)).toEqual(OIDCState.Denied);
|
||||
});
|
||||
|
||||
it("should scope the location for a widget when setting OIDC state", () => {
|
||||
// allow this widget for this room
|
||||
widgetPermissionStore.setOIDCState(w, WidgetKind.Room, roomId, OIDCState.Allowed);
|
||||
// check it remembered the value
|
||||
expect(widgetPermissionStore.getOIDCState(w, WidgetKind.Room, roomId)).toEqual(OIDCState.Allowed);
|
||||
// check this is not the case for the entire account
|
||||
expect(widgetPermissionStore.getOIDCState(w, WidgetKind.Account, roomId)).toEqual(OIDCState.Unknown);
|
||||
});
|
||||
it("is created once in SdkContextClass", () => {
|
||||
const context = new SdkContextClass();
|
||||
const store = context.widgetPermissionStore;
|
||||
expect(store).toBeDefined();
|
||||
const store2 = context.widgetPermissionStore;
|
||||
expect(store2).toStrictEqual(store);
|
||||
});
|
||||
it("auto-approves OIDC requests for element-call", async () => {
|
||||
new ElementWidgetDriver(elementCallWidget, WidgetKind.Room, true, roomId);
|
||||
expect(widgetPermissionStore.getOIDCState(elementCallWidget, WidgetKind.Room, roomId)).toEqual(
|
||||
OIDCState.Allowed,
|
||||
);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user