diff --git a/src/matrix/net/HomeServerApi.js b/src/matrix/net/HomeServerApi.js deleted file mode 100644 index 4d729cbf..00000000 --- a/src/matrix/net/HomeServerApi.js +++ /dev/null @@ -1,273 +0,0 @@ -/* -Copyright 2020 Bruno Windels -Copyright 2020 The Matrix.org Foundation C.I.C. - -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. -*/ - -import {encodeQueryParams, encodeBody} from "./common.js"; -import {HomeServerRequest} from "./HomeServerRequest.js"; - -const CS_R0_PREFIX = "/_matrix/client/r0"; -const DEHYDRATION_PREFIX = "/_matrix/client/unstable/org.matrix.msc2697.v2"; - -export class HomeServerApi { - constructor({homeserver, accessToken, request, reconnector}) { - // store these both in a closure somehow so it's harder to get at in case of XSS? - // one could change the homeserver as well so the token gets sent there, so both must be protected from read/write - this._homeserver = homeserver; - this._accessToken = accessToken; - this._requestFn = request; - this._reconnector = reconnector; - } - - _url(csPath, prefix = CS_R0_PREFIX) { - return this._homeserver + prefix + csPath; - } - - _baseRequest(method, url, queryParams, body, options, accessToken) { - const queryString = encodeQueryParams(queryParams); - url = `${url}?${queryString}`; - let log; - if (options?.log) { - const parent = options?.log; - log = parent.child({ - t: "network", - url, - method, - }, parent.level.Info); - } - let encodedBody; - const headers = new Map(); - if (accessToken) { - headers.set("Authorization", `Bearer ${accessToken}`); - } - headers.set("Accept", "application/json"); - if (body) { - const encoded = encodeBody(body); - headers.set("Content-Type", encoded.mimeType); - headers.set("Content-Length", encoded.length); - encodedBody = encoded.body; - } - - const requestResult = this._requestFn(url, { - method, - headers, - body: encodedBody, - timeout: options?.timeout, - uploadProgress: options?.uploadProgress, - format: "json" // response format - }); - - const hsRequest = new HomeServerRequest(method, url, requestResult, log); - - if (this._reconnector) { - hsRequest.response().catch(err => { - // Some endpoints such as /sync legitimately time-out - // (which is also reported as a ConnectionError) and will re-attempt, - // but spinning up the reconnector in this case is ok, - // as all code ran on session and sync start should be reentrant - if (err.name === "ConnectionError") { - this._reconnector.onRequestFailed(this); - } - }); - } - - return hsRequest; - } - - _unauthedRequest(method, url, queryParams, body, options) { - return this._baseRequest(method, url, queryParams, body, options, null); - } - - _authedRequest(method, url, queryParams, body, options) { - return this._baseRequest(method, url, queryParams, body, options, this._accessToken); - } - - _post(csPath, queryParams, body, options) { - return this._authedRequest("POST", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options); - } - - _put(csPath, queryParams, body, options) { - return this._authedRequest("PUT", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options); - } - - _get(csPath, queryParams, body, options) { - return this._authedRequest("GET", this._url(csPath, options?.prefix || CS_R0_PREFIX), queryParams, body, options); - } - - sync(since, filter, timeout, options = null) { - return this._get("/sync", {since, timeout, filter}, null, options); - } - - context(roomId, eventId, limit, filter) { - return this._get(`/rooms/${encodeURIComponent(roomId)}/context/${encodeURIComponent(eventId)}`, {filter, limit}); - } - - // params is from, dir and optionally to, limit, filter. - messages(roomId, params, options = null) { - return this._get(`/rooms/${encodeURIComponent(roomId)}/messages`, params, null, options); - } - - // params is at, membership and not_membership - members(roomId, params, options = null) { - return this._get(`/rooms/${encodeURIComponent(roomId)}/members`, params, null, options); - } - - send(roomId, eventType, txnId, content, options = null) { - return this._put(`/rooms/${encodeURIComponent(roomId)}/send/${encodeURIComponent(eventType)}/${encodeURIComponent(txnId)}`, {}, content, options); - } - - redact(roomId, eventId, txnId, content, options = null) { - return this._put(`/rooms/${encodeURIComponent(roomId)}/redact/${encodeURIComponent(eventId)}/${encodeURIComponent(txnId)}`, {}, content, options); - } - - receipt(roomId, receiptType, eventId, options = null) { - return this._post(`/rooms/${encodeURIComponent(roomId)}/receipt/${encodeURIComponent(receiptType)}/${encodeURIComponent(eventId)}`, - {}, {}, options); - } - - state(roomId, eventType, stateKey, options = null) { - return this._get(`/rooms/${encodeURIComponent(roomId)}/state/${encodeURIComponent(eventType)}/${encodeURIComponent(stateKey)}`, {}, null, options); - } - - getLoginFlows() { - return this._unauthedRequest("GET", this._url("/login"), null, null, null); - } - - passwordLogin(username, password, initialDeviceDisplayName, options = null) { - return this._unauthedRequest("POST", this._url("/login"), null, { - "type": "m.login.password", - "identifier": { - "type": "m.id.user", - "user": username - }, - "password": password, - "initial_device_display_name": initialDeviceDisplayName - }, options); - } - - tokenLogin(loginToken, txnId, initialDeviceDisplayName, options = null) { - return this._unauthedRequest("POST", this._url("/login"), null, { - "type": "m.login.token", - "identifier": { - "type": "m.id.user", - }, - "token": loginToken, - "txn_id": txnId, - "initial_device_display_name": initialDeviceDisplayName - }, options); - } - - createFilter(userId, filter, options = null) { - return this._post(`/user/${encodeURIComponent(userId)}/filter`, null, filter, options); - } - - versions(options = null) { - return this._unauthedRequest("GET", `${this._homeserver}/_matrix/client/versions`, null, null, options); - } - - uploadKeys(dehydratedDeviceId, payload, options = null) { - let path = "/keys/upload"; - if (dehydratedDeviceId) { - path = path + `/${encodeURIComponent(dehydratedDeviceId)}`; - } - return this._post(path, null, payload, options); - } - - queryKeys(queryRequest, options = null) { - return this._post("/keys/query", null, queryRequest, options); - } - - claimKeys(payload, options = null) { - return this._post("/keys/claim", null, payload, options); - } - - sendToDevice(type, payload, txnId, options = null) { - return this._put(`/sendToDevice/${encodeURIComponent(type)}/${encodeURIComponent(txnId)}`, null, payload, options); - } - - roomKeysVersion(version = null, options = null) { - let versionPart = ""; - if (version) { - versionPart = `/${encodeURIComponent(version)}`; - } - return this._get(`/room_keys/version${versionPart}`, null, null, options); - } - - roomKeyForRoomAndSession(version, roomId, sessionId, options = null) { - return this._get(`/room_keys/keys/${encodeURIComponent(roomId)}/${encodeURIComponent(sessionId)}`, {version}, null, options); - } - - uploadAttachment(blob, filename, options = null) { - return this._authedRequest("POST", `${this._homeserver}/_matrix/media/r0/upload`, {filename}, blob, options); - } - - setPusher(pusher, options = null) { - return this._post("/pushers/set", null, pusher, options); - } - - getPushers(options = null) { - return this._get("/pushers", null, null, options); - } - - join(roomId, options = null) { - return this._post(`/rooms/${encodeURIComponent(roomId)}/join`, null, null, options); - } - - joinIdOrAlias(roomIdOrAlias, options = null) { - return this._post(`/join/${encodeURIComponent(roomIdOrAlias)}`, null, null, options); - } - - leave(roomId, options = null) { - return this._post(`/rooms/${encodeURIComponent(roomId)}/leave`, null, null, options); - } - - forget(roomId, options = null) { - return this._post(`/rooms/${encodeURIComponent(roomId)}/forget`, null, null, options); - } - - logout(options = null) { - return this._post(`/logout`, null, null, options); - } - - getDehydratedDevice(options = {}) { - options.prefix = DEHYDRATION_PREFIX; - return this._get(`/dehydrated_device`, null, null, options); - } - - createDehydratedDevice(payload, options = {}) { - options.prefix = DEHYDRATION_PREFIX; - return this._put(`/dehydrated_device`, null, payload, options); - } - - claimDehydratedDevice(deviceId, options = {}) { - options.prefix = DEHYDRATION_PREFIX; - return this._post(`/dehydrated_device/claim`, null, {device_id: deviceId}, options); - } -} - -import {Request as MockRequest} from "../../mocks/Request.js"; - -export function tests() { - return { - "superficial happy path for GET": async assert => { - const hsApi = new HomeServerApi({ - request: () => new MockRequest().respond(200, 42), - homeserver: "https://hs.tld" - }); - const result = await hsApi._get("foo", null, null, null).response(); - assert.strictEqual(result, 42); - } - } -}