2022-06-09 19:44:57 -06:00
|
|
|
'use strict';
|
|
|
|
|
|
|
|
const assert = require('assert');
|
|
|
|
const { URLSearchParams } = require('url');
|
|
|
|
const urlJoin = require('url-join');
|
|
|
|
const { fetchEndpointAsJson, fetchEndpoint } = require('../server/lib/fetch-endpoint');
|
|
|
|
|
|
|
|
const config = require('../server/lib/config');
|
|
|
|
const matrixAccessToken = config.get('matrixAccessToken');
|
|
|
|
assert(matrixAccessToken);
|
|
|
|
|
|
|
|
let txnCount = 0;
|
|
|
|
function getTxnId() {
|
|
|
|
txnCount++;
|
|
|
|
return `${new Date().getTime()}--${txnCount}`;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Get client to act with for all of the client methods. This will use the
|
|
|
|
// application service access token and client methods will append `?user_id`
|
|
|
|
// for the specific user to act upon so we can use the `?ts` message timestamp
|
|
|
|
// massaging when sending.
|
|
|
|
async function getTestClientForHs(testMatrixServerUrl) {
|
|
|
|
// Register the virtual user
|
|
|
|
const username = `user-t${new Date().getTime()}-r${Math.floor(Math.random() * 1000000000)}`;
|
|
|
|
const registerResponse = await fetchEndpointAsJson(
|
|
|
|
urlJoin(testMatrixServerUrl, '/_matrix/client/v3/register'),
|
|
|
|
{
|
|
|
|
method: 'POST',
|
|
|
|
body: {
|
|
|
|
type: 'm.login.application_service',
|
|
|
|
username,
|
|
|
|
},
|
|
|
|
accessToken: matrixAccessToken,
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
2022-06-29 05:56:13 -06:00
|
|
|
const applicationServiceUserIdOverride = registerResponse['user_id'];
|
|
|
|
assert(applicationServiceUserIdOverride);
|
2022-06-09 19:44:57 -06:00
|
|
|
|
|
|
|
return {
|
|
|
|
homeserverUrl: testMatrixServerUrl,
|
|
|
|
// We use the application service AS token because we need to be able to use
|
|
|
|
// the `?ts` timestamp massaging when sending events
|
|
|
|
accessToken: matrixAccessToken,
|
2022-06-29 05:56:13 -06:00
|
|
|
userId: applicationServiceUserIdOverride,
|
|
|
|
applicationServiceUserIdOverride,
|
2022-06-09 19:44:57 -06:00
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
// Create a public room to test in
|
|
|
|
async function createTestRoom(client) {
|
|
|
|
let qs = new URLSearchParams();
|
2022-06-29 05:56:13 -06:00
|
|
|
if (client.applicationServiceUserIdOverride) {
|
|
|
|
qs.append('user_id', client.applicationServiceUserIdOverride);
|
2022-06-09 19:44:57 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
const createRoomResponse = await fetchEndpointAsJson(
|
|
|
|
urlJoin(client.homeserverUrl, `/_matrix/client/v3/createRoom?${qs.toString()}`),
|
|
|
|
{
|
|
|
|
method: 'POST',
|
|
|
|
body: {
|
|
|
|
preset: 'public_chat',
|
|
|
|
name: 'the hangout spot',
|
|
|
|
initial_state: [
|
|
|
|
{
|
|
|
|
type: 'm.room.history_visibility',
|
|
|
|
state_key: '',
|
|
|
|
content: {
|
|
|
|
history_visibility: 'world_readable',
|
|
|
|
},
|
|
|
|
},
|
|
|
|
],
|
|
|
|
},
|
|
|
|
accessToken: client.accessToken,
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
|
|
|
const roomId = createRoomResponse['room_id'];
|
|
|
|
assert(roomId);
|
|
|
|
return roomId;
|
|
|
|
}
|
|
|
|
|
|
|
|
async function joinRoom({ client, roomId, viaServers }) {
|
|
|
|
let qs = new URLSearchParams();
|
|
|
|
if (viaServers) {
|
|
|
|
[].concat(viaServers).forEach((viaServer) => {
|
|
|
|
qs.append('server_name', viaServer);
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2022-06-29 05:56:13 -06:00
|
|
|
if (client.applicationServiceUserIdOverride) {
|
|
|
|
qs.append('user_id', client.applicationServiceUserIdOverride);
|
2022-06-09 19:44:57 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
const joinRoomResponse = await fetchEndpointAsJson(
|
|
|
|
urlJoin(client.homeserverUrl, `/_matrix/client/v3/join/${roomId}?${qs.toString()}`),
|
|
|
|
{
|
|
|
|
method: 'POST',
|
|
|
|
accessToken: client.accessToken,
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
|
|
|
const joinedRoomId = joinRoomResponse['room_id'];
|
|
|
|
assert(joinedRoomId);
|
|
|
|
return joinedRoomId;
|
|
|
|
}
|
|
|
|
|
2022-06-29 05:56:13 -06:00
|
|
|
async function sendEvent({ client, roomId, eventType, stateKey, content, timestamp }) {
|
2022-06-09 19:44:57 -06:00
|
|
|
assert(client);
|
|
|
|
assert(roomId);
|
|
|
|
assert(content);
|
|
|
|
|
|
|
|
let qs = new URLSearchParams();
|
|
|
|
if (timestamp) {
|
|
|
|
assert(
|
2022-06-29 05:56:13 -06:00
|
|
|
timestamp && client.applicationServiceUserIdOverride,
|
2022-06-09 19:44:57 -06:00
|
|
|
'We can only do `?ts` massaging from an application service access token. ' +
|
2022-06-29 05:56:13 -06:00
|
|
|
'Expected `client.applicationServiceUserIdOverride` to be defined so we can act on behalf of that user'
|
2022-06-09 19:44:57 -06:00
|
|
|
);
|
|
|
|
|
|
|
|
qs.append('ts', timestamp);
|
|
|
|
}
|
|
|
|
|
2022-06-29 05:56:13 -06:00
|
|
|
if (client.applicationServiceUserIdOverride) {
|
|
|
|
qs.append('user_id', client.applicationServiceUserIdOverride);
|
2022-06-09 19:44:57 -06:00
|
|
|
}
|
|
|
|
|
2022-06-29 05:56:13 -06:00
|
|
|
let url;
|
|
|
|
if (stateKey) {
|
|
|
|
url = urlJoin(
|
|
|
|
client.homeserverUrl,
|
|
|
|
`/_matrix/client/v3/rooms/${roomId}/state/${eventType}/${stateKey}?${qs.toString()}`
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
url = urlJoin(
|
2022-06-09 19:44:57 -06:00
|
|
|
client.homeserverUrl,
|
|
|
|
`/_matrix/client/v3/rooms/${roomId}/send/${eventType}/${getTxnId()}?${qs.toString()}`
|
2022-06-29 05:56:13 -06:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
const sendResponse = await fetchEndpointAsJson(url, {
|
|
|
|
method: 'PUT',
|
|
|
|
body: content,
|
|
|
|
accessToken: client.accessToken,
|
|
|
|
});
|
2022-06-09 19:44:57 -06:00
|
|
|
|
|
|
|
const eventId = sendResponse['event_id'];
|
|
|
|
assert(eventId);
|
|
|
|
return eventId;
|
|
|
|
}
|
|
|
|
|
|
|
|
async function sendMessage({ client, roomId, content, timestamp }) {
|
|
|
|
return sendEvent({ client, roomId, eventType: 'm.room.message', content, timestamp });
|
|
|
|
}
|
|
|
|
|
|
|
|
// Create a number of messages in the given room
|
|
|
|
async function createMessagesInRoom({ client, roomId, numMessages, prefix, timestamp }) {
|
|
|
|
let eventIds = [];
|
|
|
|
for (let i = 0; i < numMessages; i++) {
|
|
|
|
const eventId = await sendMessage({
|
|
|
|
client,
|
|
|
|
roomId,
|
|
|
|
content: {
|
|
|
|
msgtype: 'm.text',
|
|
|
|
body: `${prefix} - message${i}`,
|
|
|
|
},
|
|
|
|
timestamp,
|
|
|
|
});
|
|
|
|
eventIds.push(eventId);
|
|
|
|
}
|
|
|
|
|
|
|
|
return eventIds;
|
|
|
|
}
|
|
|
|
|
2022-06-29 05:56:13 -06:00
|
|
|
async function updateProfile({ client, displayName, avatarUrl }) {
|
|
|
|
let qs = new URLSearchParams();
|
|
|
|
if (client.applicationServiceUserIdOverride) {
|
|
|
|
qs.append('user_id', client.applicationServiceUserIdOverride);
|
|
|
|
}
|
|
|
|
|
|
|
|
const updateDisplayNamePromise = fetchEndpointAsJson(
|
|
|
|
urlJoin(
|
|
|
|
client.homeserverUrl,
|
|
|
|
`/_matrix/client/v3/profile/${client.userId}/displayname?${qs.toString()}`
|
|
|
|
),
|
|
|
|
{
|
|
|
|
method: 'PUT',
|
|
|
|
body: {
|
|
|
|
displayname: displayName,
|
|
|
|
},
|
|
|
|
accessToken: client.accessToken,
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
|
|
|
const updateAvatarUrlPromise = fetchEndpointAsJson(
|
|
|
|
urlJoin(
|
|
|
|
client.homeserverUrl,
|
|
|
|
`/_matrix/client/v3/profile/${client.userId}/avatar_url?${qs.toString()}`
|
|
|
|
),
|
|
|
|
{
|
|
|
|
method: 'PUT',
|
|
|
|
body: {
|
|
|
|
avatar_url: avatarUrl,
|
|
|
|
},
|
|
|
|
accessToken: client.accessToken,
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
|
|
|
await Promise.all([updateDisplayNamePromise, updateAvatarUrlPromise]);
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
2022-06-09 19:44:57 -06:00
|
|
|
// Uploads the given data Buffer and returns the MXC URI of the uploaded content
|
|
|
|
async function uploadContent({ client, roomId, data, fileName, contentType }) {
|
|
|
|
assert(client);
|
|
|
|
assert(roomId);
|
|
|
|
assert(data);
|
|
|
|
|
|
|
|
let qs = new URLSearchParams();
|
2022-06-29 05:56:13 -06:00
|
|
|
if (client.applicationServiceUserIdOverride) {
|
|
|
|
qs.append('user_id', client.applicationServiceUserIdOverride);
|
2022-06-09 19:44:57 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
if (fileName) {
|
|
|
|
qs.append('filename', fileName);
|
|
|
|
}
|
|
|
|
|
|
|
|
// We don't want to use `fetchEndpointAsJson` here because it will
|
|
|
|
// `JSON.stringify(...)` the body data
|
|
|
|
const uploadResponse = await fetchEndpoint(
|
|
|
|
urlJoin(client.homeserverUrl, `/_matrix/media/v3/upload`),
|
|
|
|
{
|
|
|
|
method: 'POST',
|
|
|
|
body: data,
|
|
|
|
headers: {
|
|
|
|
'Content-Type': contentType || 'application/octet-stream',
|
|
|
|
},
|
|
|
|
accessToken: client.accessToken,
|
|
|
|
}
|
|
|
|
);
|
|
|
|
|
|
|
|
const uploadResponseData = await uploadResponse.json();
|
|
|
|
|
|
|
|
const mxcUri = uploadResponseData['content_uri'];
|
|
|
|
assert(mxcUri);
|
|
|
|
return mxcUri;
|
|
|
|
}
|
|
|
|
|
|
|
|
module.exports = {
|
|
|
|
getTestClientForHs,
|
|
|
|
createTestRoom,
|
|
|
|
joinRoom,
|
|
|
|
sendEvent,
|
|
|
|
sendMessage,
|
|
|
|
createMessagesInRoom,
|
2022-06-29 05:56:13 -06:00
|
|
|
updateProfile,
|
2022-06-09 19:44:57 -06:00
|
|
|
uploadContent,
|
|
|
|
};
|