mirror of
https://github.com/element-hq/element-web
synced 2024-11-27 03:36:07 +03:00
Widget receives updated state events if user is re-invited into the room.
This commit is contained in:
mikhail.aheichyk
parent
910aa0b813
commit
71d06b4d59
3 changed files with 216 additions and 1 deletions
205
cypress/e2e/widgets/events.spec.ts
Normal file
205
cypress/e2e/widgets/events.spec.ts
Normal file
|
|
@ -0,0 +1,205 @@
|
|||
/*
|
||||
Copyright 2022 Mikhail Aheichyk
|
||||
Copyright 2022 Nordeck IT + Consulting GmbH.
|
||||
|
||||
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.
|
||||
*/
|
||||
|
||||
/// <reference types="cypress" />
|
||||
|
||||
import { IWidget } from "matrix-widget-api/src/interfaces/IWidget";
|
||||
|
||||
import type {MatrixClient, MatrixEvent, Room} from "matrix-js-sdk/src/matrix";
|
||||
import { SynapseInstance } from "../../plugins/synapsedocker";
|
||||
import { UserCredentials } from "../../support/login";
|
||||
|
||||
const DEMO_WIDGET_ID = "demo-widget-id";
|
||||
const DEMO_WIDGET_NAME = "Demo Widget";
|
||||
const DEMO_WIDGET_TYPE = "demo";
|
||||
const ROOM_NAME = "Demo";
|
||||
|
||||
const DEMO_WIDGET_HTML = `
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Demo Widget</title>
|
||||
<script>
|
||||
let sendEventCount = 0
|
||||
window.onmessage = ev => {
|
||||
if (ev.data.action === 'capabilities') {
|
||||
window.parent.postMessage(Object.assign({
|
||||
response: {
|
||||
capabilities: [
|
||||
"org.matrix.msc2762.timeline:*",
|
||||
"org.matrix.msc2762.receive.state_event:net.metadata_invite_shared",
|
||||
"org.matrix.msc2762.send.event:net.widget_echo"
|
||||
]
|
||||
},
|
||||
}, ev.data), '*');
|
||||
} else if (ev.data.action === 'send_event' && !ev.data.response) {
|
||||
// wraps received event into 'net.widget_echo' and sends back
|
||||
sendEventCount += 1
|
||||
window.parent.postMessage({
|
||||
api: "fromWidget",
|
||||
widgetId: ev.data.widgetId,
|
||||
requestId: 'widget-' + sendEventCount,
|
||||
action: "send_event",
|
||||
data: {
|
||||
type: 'net.widget_echo',
|
||||
content: ev.data.data // sets matrix event to the content returned
|
||||
},
|
||||
}, '*')
|
||||
}
|
||||
};
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<button id="demo">Demo</button>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
function waitForRoom(win: Cypress.AUTWindow, roomId: string, predicate: (room: Room) => boolean): Promise<void> {
|
||||
const matrixClient = win.mxMatrixClientPeg.get();
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
const room = matrixClient.getRoom(roomId);
|
||||
|
||||
if (predicate(room)) {
|
||||
resolve();
|
||||
return;
|
||||
}
|
||||
|
||||
function onEvent(ev: MatrixEvent) {
|
||||
if (ev.getRoomId() !== roomId) return;
|
||||
|
||||
if (predicate(room)) {
|
||||
matrixClient.removeListener(win.matrixcs.ClientEvent.Event, onEvent);
|
||||
resolve();
|
||||
}
|
||||
}
|
||||
|
||||
matrixClient.on(win.matrixcs.ClientEvent.Event, onEvent);
|
||||
});
|
||||
}
|
||||
|
||||
describe("Widget Events", () => {
|
||||
let synapse: SynapseInstance;
|
||||
let user: UserCredentials;
|
||||
let bot: MatrixClient;
|
||||
let demoWidgetUrl: string;
|
||||
|
||||
beforeEach(() => {
|
||||
cy.startSynapse("default").then(data => {
|
||||
synapse = data;
|
||||
|
||||
cy.initTestUser(synapse, "Mike").then(_user => {
|
||||
user = _user;
|
||||
});
|
||||
cy.getBot(synapse, { displayName: "Bot", autoAcceptInvites: true }).then(_bot => {
|
||||
bot = _bot;
|
||||
});
|
||||
});
|
||||
cy.serveHtmlFile(DEMO_WIDGET_HTML).then(url => {
|
||||
demoWidgetUrl = url;
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
cy.stopSynapse(synapse);
|
||||
cy.stopWebServers();
|
||||
});
|
||||
|
||||
it('should be updated if user is re-invited into the room with updated state event', () => {
|
||||
cy.createRoom({
|
||||
name: ROOM_NAME,
|
||||
invite: [bot.getUserId()],
|
||||
}).then(roomId => {
|
||||
// setup widget via state event
|
||||
cy.getClient().then(async matrixClient => {
|
||||
const content: IWidget = {
|
||||
id: DEMO_WIDGET_ID,
|
||||
creatorUserId: 'somebody',
|
||||
type: DEMO_WIDGET_TYPE,
|
||||
name: DEMO_WIDGET_NAME,
|
||||
url: demoWidgetUrl,
|
||||
};
|
||||
await matrixClient.sendStateEvent(roomId, 'im.vector.modular.widgets', content, DEMO_WIDGET_ID);
|
||||
}).as('widgetEventSent');
|
||||
|
||||
// set initial layout
|
||||
cy.getClient().then(async matrixClient => {
|
||||
const content = {
|
||||
widgets: {
|
||||
[DEMO_WIDGET_ID]: {
|
||||
container: 'top', index: 1, width: 100, height: 0,
|
||||
},
|
||||
},
|
||||
};
|
||||
await matrixClient.sendStateEvent(roomId, 'io.element.widgets.layout', content, "");
|
||||
}).as('layoutEventSent');
|
||||
|
||||
// open the room
|
||||
cy.viewRoomByName(ROOM_NAME);
|
||||
|
||||
// approve capabilities
|
||||
cy.contains('.mx_WidgetCapabilitiesPromptDialog button', 'Approve').click();
|
||||
|
||||
cy.all([
|
||||
cy.get<string>("@widgetEventSent"),
|
||||
cy.get<string>("@layoutEventSent"),
|
||||
]).then(async () => {
|
||||
// bot creates a new room with 'net.metadata_invite_shared' state event
|
||||
const { room_id: roomNew } = await bot.createRoom({
|
||||
name: "New room",
|
||||
initial_state: [
|
||||
{
|
||||
type: 'net.metadata_invite_shared',
|
||||
state_key: '',
|
||||
content: {
|
||||
value: "initial",
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
await bot.invite(roomNew, user.userId);
|
||||
|
||||
// widget should receive 'net.metadata_invite_shared' event after invite
|
||||
cy.window().then(async win => {
|
||||
await waitForRoom(win, roomId, (room) => {
|
||||
const events = room.getLiveTimeline().getEvents();
|
||||
return events.some(e => e.getType() === 'net.widget_echo'
|
||||
&& e.getContent().type === 'net.metadata_invite_shared'
|
||||
&& e.getContent().content.value === 'initial');
|
||||
});
|
||||
});
|
||||
|
||||
await bot.sendStateEvent(roomNew, 'net.metadata_invite_shared', {
|
||||
value: "new_value",
|
||||
}, '');
|
||||
|
||||
await bot.invite(roomNew, user.userId, 'something changed in the room');
|
||||
|
||||
// widget should receive updated 'net.metadata_invite_shared' event after re-invite
|
||||
cy.window().then(async win => {
|
||||
await waitForRoom(win, roomId, (room) => {
|
||||
const events = room.getLiveTimeline().getEvents();
|
||||
return events.some(e => e.getType() === 'net.widget_echo'
|
||||
&& e.getContent().type === 'net.metadata_invite_shared'
|
||||
&& e.getContent().content.value === 'new_value');
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -74,3 +74,7 @@ suppress_key_server_warning: true
|
|||
|
||||
ui_auth:
|
||||
session_timeout: "300s"
|
||||
|
||||
room_prejoin_state:
|
||||
additional_event_types:
|
||||
- net.metadata_invite_shared
|
||||
|
|
|
|||
|
|
@ -520,7 +520,13 @@ export class StopGapWidget extends EventEmitter {
|
|||
}
|
||||
}
|
||||
|
||||
this.readUpToMap[ev.getRoomId()] = ev.getId();
|
||||
// Skip marker assignment if membership is 'invite', otherwise 'm.room.member' from
|
||||
// invitation room will assign it and new state events will be not forwarded to the widget
|
||||
// because of empty timeline for invitation room and assigned marker.
|
||||
const room = this.client.getRoom(ev.getRoomId());
|
||||
if (room && room.getMyMembership() !== 'invite') {
|
||||
this.readUpToMap[ev.getRoomId()] = ev.getId();
|
||||
}
|
||||
|
||||
const raw = ev.getEffectiveEvent();
|
||||
this.messaging.feedEvent(raw as IRoomEvent, this.eventListenerRoomId).catch((e) => {
|
||||
|
|
|
|||
Loading…
Reference in a new issue