Mirrors
/
matrix-public-archive
mirror of https://github.com/matrix-org/matrix-public-archive.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refactor `fetchEndpointAsText`/`fetchEndpointAsJson` to return `res` alongside `data` (#122) 

Split out of https://github.com/matrix-org/matrix-public-archive/pull/121
where we needed to use `res.url`.
This commit is contained in:
Eric Eastwood 2022-11-03 04:12:00 -05:00 committed by GitHub
parent 91d84fcc08
commit 2dff7ecea5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 43 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
server/lib/fetch-endpoint.js
View File

@ -43,7 +43,7 @@ async function fetchEndpoint(endpoint, options = {}) {
async function fetchEndpointAsText(endpoint, options) { async function fetchEndpointAsText(endpoint, options) {
const res = await fetchEndpoint(endpoint, options); const res = await fetchEndpoint(endpoint, options);
const data = await res.text(); const data = await res.text();
return data; return { data, res };
} }
async function fetchEndpointAsJson(endpoint, options) { async function fetchEndpointAsJson(endpoint, options) {
@ -62,7 +62,7 @@ async function fetchEndpointAsJson(endpoint, options) {
const res = await fetchEndpoint(endpoint, opts); const res = await fetchEndpoint(endpoint, opts);
const data = await res.json(); const data = await res.json();
return data; return { data, res };
} }
module.exports = { module.exports = {

2
server/lib/matrix-utils/ensure-room-joined.js
View File

@ -21,7 +21,7 @@ async function ensureRoomJoined(accessToken, roomIdOrAlias, viaServers = []) {
`_matrix/client/r0/join/${encodeURIComponent(roomIdOrAlias)}?${qs.toString()}` `_matrix/client/r0/join/${encodeURIComponent(roomIdOrAlias)}?${qs.toString()}`
); );
try { try {
const joinData = await fetchEndpointAsJson(joinEndpoint, { const { data: joinData } = await fetchEndpointAsJson(joinEndpoint, {
method: 'POST', method: 'POST',
accessToken, accessToken,
}); });

2
server/lib/matrix-utils/fetch-public-rooms.js
View File

@ -23,7 +23,7 @@ async function fetchPublicRooms(accessToken, { server, searchTerm, paginationTok
`_matrix/client/v3/publicRooms?${qs.toString()}` `_matrix/client/v3/publicRooms?${qs.toString()}`
); );
const publicRoomsRes = await fetchEndpointAsJson(publicRoomsEndpoint, { const { data: publicRoomsRes } = await fetchEndpointAsJson(publicRoomsEndpoint, {
method: 'POST', method: 'POST',
body: { body: {
include_all_networks: true, include_all_networks: true,

15
server/lib/matrix-utils/fetch-room-data.js
View File

@ -61,27 +61,32 @@ async function fetchRoomData(accessToken, roomId) {
let name; let name;
if (stateNameResDataOutcome.reason === undefined) { if (stateNameResDataOutcome.reason === undefined) {
name = stateNameResDataOutcome.value.name; const { data } = stateNameResDataOutcome.value;
name = data.name;
} }
let canonicalAlias; let canonicalAlias;
if (stateCanonicalAliasResDataOutcome.reason === undefined) { if (stateCanonicalAliasResDataOutcome.reason === undefined) {
canonicalAlias = stateCanonicalAliasResDataOutcome.value.alias; const { data } = stateCanonicalAliasResDataOutcome.value;
canonicalAlias = data.alias;
} }
let avatarUrl; let avatarUrl;
if (stateAvatarResDataOutcome.reason === undefined) { if (stateAvatarResDataOutcome.reason === undefined) {
avatarUrl = stateAvatarResDataOutcome.value.url; const { data } = stateAvatarResDataOutcome.value;
avatarUrl = data.url;
} }
let historyVisibility; let historyVisibility;
if (stateHistoryVisibilityResDataOutcome.reason === undefined) { if (stateHistoryVisibilityResDataOutcome.reason === undefined) {
historyVisibility = stateHistoryVisibilityResDataOutcome.value.history_visibility; const { data } = stateHistoryVisibilityResDataOutcome.value;
historyVisibility = data.history_visibility;
} }
let joinRule; let joinRule;
if (stateJoinRulesResDataOutcome.reason === undefined) { if (stateJoinRulesResDataOutcome.reason === undefined) {
joinRule = stateJoinRulesResDataOutcome.value.join_rule; const { data } = stateJoinRulesResDataOutcome.value;
joinRule = data.join_rule;
} }
return { return {

4
server/lib/matrix-utils/get-messages-response-from-event-id.js
View File

@ -28,7 +28,7 @@ async function getMessagesResponseFromEventId({ accessToken, roomId, eventId, di
eventId eventId
)}?limit=0&filter={"lazy_load_members":true}` )}?limit=0&filter={"lazy_load_members":true}`
); );
const contextResData = await fetchEndpointAsJson(contextEndpoint, { const { data: contextResData } = await fetchEndpointAsJson(contextEndpoint, {
accessToken, accessToken,
}); });
@ -42,7 +42,7 @@ async function getMessagesResponseFromEventId({ accessToken, roomId, eventId, di
contextResData.end contextResData.end
)}&limit=${limit}&filter={"lazy_load_members":true}` )}&limit=${limit}&filter={"lazy_load_members":true}`
); );
const messageResData = await fetchEndpointAsJson(messagesEndpoint, { const { data: messageResData } = await fetchEndpointAsJson(messagesEndpoint, {
accessToken, accessToken,
}); });

2
server/lib/matrix-utils/timestamp-to-event.js
View File

@ -22,7 +22,7 @@ async function timestampToEvent({ accessToken, roomId, ts, direction }) {
roomId roomId
)}/timestamp_to_event?ts=${encodeURIComponent(ts)}&dir=${encodeURIComponent(direction)}` )}/timestamp_to_event?ts=${encodeURIComponent(ts)}&dir=${encodeURIComponent(direction)}`
); );
const timestampToEventResData = await fetchEndpointAsJson(timestampToEventEndpoint, { const { data: timestampToEventResData } = await fetchEndpointAsJson(timestampToEventEndpoint, {
accessToken, accessToken,
}); });

38
test/e2e-tests.js
View File

@ -83,7 +83,7 @@ describe('matrix-public-archive', () => {
hs1Client.homeserverUrl, hs1Client.homeserverUrl,
`_matrix/client/r0/rooms/${hs2RoomId}/messages?limit=5&dir=b&filter={"types":["m.room.message"]}` `_matrix/client/r0/rooms/${hs2RoomId}/messages?limit=5&dir=b&filter={"types":["m.room.message"]}`
); );
const messageResData = await fetchEndpointAsJson(messagesEndpoint, { const { data: messageResData } = await fetchEndpointAsJson(messagesEndpoint, {
accessToken: hs1Client.accessToken, accessToken: hs1Client.accessToken,
}); });
@ -190,7 +190,7 @@ describe('matrix-public-archive', () => {
assert.strictEqual(eventIds.length, 3); assert.strictEqual(eventIds.length, 3);
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -358,7 +358,7 @@ describe('matrix-public-archive', () => {
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -445,7 +445,7 @@ describe('matrix-public-archive', () => {
viaServers: [HOMESERVER_URL_TO_PRETTY_NAME_MAP[testMatrixServerUrl2]], viaServers: [HOMESERVER_URL_TO_PRETTY_NAME_MAP[testMatrixServerUrl2]],
}); });
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -477,7 +477,7 @@ describe('matrix-public-archive', () => {
// Visit `/:roomIdOrAlias` and expect to be redirected to the last day with events // Visit `/:roomIdOrAlias` and expect to be redirected to the last day with events
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForRoom(roomId); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForRoom(roomId);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -516,7 +516,7 @@ describe('matrix-public-archive', () => {
'The date we visit the archive (`visitArchiveDate`) should be after where the messages were sent (`archiveDate`)' 'The date we visit the archive (`visitArchiveDate`) should be after where the messages were sent (`archiveDate`)'
); );
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, visitArchiveDate); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, visitArchiveDate);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -545,7 +545,7 @@ describe('matrix-public-archive', () => {
// We purposely send no events in the room // We purposely send no events in the room
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -574,7 +574,7 @@ describe('matrix-public-archive', () => {
}); });
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
assert.match(archivePageHtml, /TODO: Redirect user to smaller hour range/); assert.match(archivePageHtml, /TODO: Redirect user to smaller hour range/);
}); });
@ -609,7 +609,7 @@ describe('matrix-public-archive', () => {
}); });
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForDate(roomId, archiveDate);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -718,7 +718,7 @@ describe('matrix-public-archive', () => {
); );
// Set this for debugging if the test fails here // Set this for debugging if the test fails here
archiveUrl = firstPageArchiveUrl; archiveUrl = firstPageArchiveUrl;
const firstPageArchivePageHtml = await fetchEndpointAsText(firstPageArchiveUrl); const { data: firstPageArchivePageHtml } = await fetchEndpointAsText(firstPageArchiveUrl);
const firstPageDom = parseHTML(firstPageArchivePageHtml); const firstPageDom = parseHTML(firstPageArchivePageHtml);
const eventIdsOnFirstPage = [...firstPageDom.document.querySelectorAll(`[data-event-id]`)] const eventIdsOnFirstPage = [...firstPageDom.document.querySelectorAll(`[data-event-id]`)]
@ -746,7 +746,7 @@ describe('matrix-public-archive', () => {
const nextActivityLink = nextActivityLinkEl.getAttribute('href'); const nextActivityLink = nextActivityLinkEl.getAttribute('href');
// Set this for debugging if the test fails here // Set this for debugging if the test fails here
archiveUrl = nextActivityLink; archiveUrl = nextActivityLink;
const nextActivityArchivePageHtml = await fetchEndpointAsText(nextActivityLink); const { data: nextActivityArchivePageHtml } = await fetchEndpointAsText(nextActivityLink);
const nextActivityDom = parseHTML(nextActivityArchivePageHtml); const nextActivityDom = parseHTML(nextActivityArchivePageHtml);
// Assert that it's a smooth continuation to more messages with no overlap // Assert that it's a smooth continuation to more messages with no overlap
@ -792,7 +792,7 @@ describe('matrix-public-archive', () => {
); );
// Set this for debugging if the test fails here // Set this for debugging if the test fails here
archiveUrl = firstPageArchiveUrl; archiveUrl = firstPageArchiveUrl;
const firstPageArchivePageHtml = await fetchEndpointAsText(firstPageArchiveUrl); const { data: firstPageArchivePageHtml } = await fetchEndpointAsText(firstPageArchiveUrl);
const firstPageDom = parseHTML(firstPageArchivePageHtml); const firstPageDom = parseHTML(firstPageArchivePageHtml);
const eventIdsOnFirstPage = [...firstPageDom.document.querySelectorAll(`[data-event-id]`)] const eventIdsOnFirstPage = [...firstPageDom.document.querySelectorAll(`[data-event-id]`)]
@ -820,7 +820,9 @@ describe('matrix-public-archive', () => {
const previousActivityLink = previousActivityLinkEl.getAttribute('href'); const previousActivityLink = previousActivityLinkEl.getAttribute('href');
// Set this for debugging if the test fails here // Set this for debugging if the test fails here
archiveUrl = previousActivityLink; archiveUrl = previousActivityLink;
const previousActivityArchivePageHtml = await fetchEndpointAsText(previousActivityLink); const { data: previousActivityArchivePageHtml } = await fetchEndpointAsText(
previousActivityLink
);
const previousActivityDom = parseHTML(previousActivityArchivePageHtml); const previousActivityDom = parseHTML(previousActivityArchivePageHtml);
// Assert that it's a smooth continuation to more messages with no overlap // Assert that it's a smooth continuation to more messages with no overlap
@ -868,7 +870,7 @@ describe('matrix-public-archive', () => {
// Browse the room directory without search to see many rooms // Browse the room directory without search to see many rooms
archiveUrl = matrixPublicArchiveURLCreator.roomDirectoryUrl(); archiveUrl = matrixPublicArchiveURLCreator.roomDirectoryUrl();
const roomDirectoryPageHtml = await fetchEndpointAsText(archiveUrl); const { data: roomDirectoryPageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(roomDirectoryPageHtml); const dom = parseHTML(roomDirectoryPageHtml);
const roomsOnPageWithoutSearch = [ const roomsOnPageWithoutSearch = [
@ -882,7 +884,7 @@ describe('matrix-public-archive', () => {
archiveUrl = matrixPublicArchiveURLCreator.roomDirectoryUrl({ archiveUrl = matrixPublicArchiveURLCreator.roomDirectoryUrl({
searchTerm: roomPlanetPrefix, searchTerm: roomPlanetPrefix,
}); });
const roomDirectoryWithSearchPageHtml = await fetchEndpointAsText(archiveUrl); const { data: roomDirectoryWithSearchPageHtml } = await fetchEndpointAsText(archiveUrl);
const domWithSearch = parseHTML(roomDirectoryWithSearchPageHtml); const domWithSearch = parseHTML(roomDirectoryWithSearchPageHtml);
const roomsOnPageWithSearch = [ const roomsOnPageWithSearch = [
@ -919,7 +921,7 @@ describe('matrix-public-archive', () => {
homeserver: HOMESERVER_URL_TO_PRETTY_NAME_MAP[testMatrixServerUrl2], homeserver: HOMESERVER_URL_TO_PRETTY_NAME_MAP[testMatrixServerUrl2],
searchTerm: roomPlanetPrefix, searchTerm: roomPlanetPrefix,
}); });
const roomDirectoryWithSearchPageHtml = await fetchEndpointAsText(archiveUrl); const { data: roomDirectoryWithSearchPageHtml } = await fetchEndpointAsText(archiveUrl);
const domWithSearch = parseHTML(roomDirectoryWithSearchPageHtml); const domWithSearch = parseHTML(roomDirectoryWithSearchPageHtml);
// Make sure the `?homserver` is selected in the homeserver selector `<select>` // Make sure the `?homserver` is selected in the homeserver selector `<select>`
@ -975,7 +977,7 @@ describe('matrix-public-archive', () => {
const roomId = await createTestRoom(client); const roomId = await createTestRoom(client);
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForRoom(roomId); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForRoom(roomId);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);
@ -994,7 +996,7 @@ describe('matrix-public-archive', () => {
}); });
archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForRoom(roomId); archiveUrl = matrixPublicArchiveURLCreator.archiveUrlForRoom(roomId);
const archivePageHtml = await fetchEndpointAsText(archiveUrl); const { data: archivePageHtml } = await fetchEndpointAsText(archiveUrl);
const dom = parseHTML(archivePageHtml); const dom = parseHTML(archivePageHtml);

12
test/lib/client-utils.js
View File

@ -30,7 +30,7 @@ function slugify(inputText) {
} }
async function ensureUserRegistered({ matrixServerUrl, username }) { async function ensureUserRegistered({ matrixServerUrl, username }) {
const registerResponse = await fetchEndpointAsJson( const { data: registerResponse } = await fetchEndpointAsJson(
urlJoin(matrixServerUrl, '/_matrix/client/v3/register'), urlJoin(matrixServerUrl, '/_matrix/client/v3/register'),
{ {
method: 'POST', method: 'POST',
@ -60,7 +60,7 @@ async function getTestClientForAs() {
async function getTestClientForHs(testMatrixServerUrl) { async function getTestClientForHs(testMatrixServerUrl) {
// Register the virtual user // Register the virtual user
const username = `user-t${new Date().getTime()}-r${Math.floor(Math.random() * 1000000000)}`; const username = `user-t${new Date().getTime()}-r${Math.floor(Math.random() * 1000000000)}`;
const registerResponse = await fetchEndpointAsJson( const { data: registerResponse } = await fetchEndpointAsJson(
urlJoin(testMatrixServerUrl, '/_matrix/client/v3/register'), urlJoin(testMatrixServerUrl, '/_matrix/client/v3/register'),
{ {
method: 'POST', method: 'POST',
@ -95,7 +95,7 @@ async function createTestRoom(client, overrideCreateOptions = {}) {
const roomName = overrideCreateOptions.name || 'the hangout spot'; const roomName = overrideCreateOptions.name || 'the hangout spot';
const roomAlias = slugify(roomName + getTxnId()); const roomAlias = slugify(roomName + getTxnId());
const createRoomResponse = await fetchEndpointAsJson( const { data: createRoomResponse } = await fetchEndpointAsJson(
urlJoin(client.homeserverUrl, `/_matrix/client/v3/createRoom?${qs.toString()}`), urlJoin(client.homeserverUrl, `/_matrix/client/v3/createRoom?${qs.toString()}`),
{ {
method: 'POST', method: 'POST',
@ -125,7 +125,7 @@ async function createTestRoom(client, overrideCreateOptions = {}) {
} }
async function getCanonicalAlias({ client, roomId }) { async function getCanonicalAlias({ client, roomId }) {
const stateCanonicalAliasRes = await fetchEndpointAsJson( const { data: stateCanonicalAliasRes } = await fetchEndpointAsJson(
urlJoin( urlJoin(
client.homeserverUrl, client.homeserverUrl,
`_matrix/client/r0/rooms/${encodeURIComponent(roomId)}/state/m.room.canonical_alias` `_matrix/client/r0/rooms/${encodeURIComponent(roomId)}/state/m.room.canonical_alias`
@ -157,7 +157,7 @@ async function joinRoom({ client, roomId, viaServers }) {
client.homeserverUrl, client.homeserverUrl,
`/_matrix/client/v3/join/${encodeURIComponent(roomId)}?${qs.toString()}` `/_matrix/client/v3/join/${encodeURIComponent(roomId)}?${qs.toString()}`
); );
const joinRoomResponse = await fetchEndpointAsJson(joinRoomUrl, { const { data: joinRoomResponse } = await fetchEndpointAsJson(joinRoomUrl, {
method: 'POST', method: 'POST',
accessToken: client.accessToken, accessToken: client.accessToken,
}); });
@ -204,7 +204,7 @@ async function sendEvent({ client, roomId, eventType, stateKey, content, timesta
); );
} }
const sendResponse = await fetchEndpointAsJson(url, { const { data: sendResponse } = await fetchEndpointAsJson(url, {
method: 'PUT', method: 'PUT',
body: content, body: content,
accessToken: client.accessToken, accessToken: client.accessToken,