298 lines
11 KiB
JavaScript
298 lines
11 KiB
JavaScript
"use strict";
|
|
|
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.FetchHttpApi = void 0;
|
|
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
var _utils = require("../utils");
|
|
var _method = require("./method");
|
|
var _errors = require("./errors");
|
|
var _interface = require("./interface");
|
|
var _utils2 = require("./utils");
|
|
var _logger = require("../logger");
|
|
/*
|
|
Copyright 2022 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.
|
|
*/
|
|
|
|
/**
|
|
* This is an internal module. See {@link MatrixHttpApi} for the public class.
|
|
*/
|
|
|
|
class FetchHttpApi {
|
|
constructor(eventEmitter, opts) {
|
|
var _opts$useAuthorizatio;
|
|
this.eventEmitter = eventEmitter;
|
|
this.opts = opts;
|
|
(0, _defineProperty2.default)(this, "abortController", new AbortController());
|
|
(0, _utils.checkObjectHasKeys)(opts, ["baseUrl", "prefix"]);
|
|
opts.onlyData = !!opts.onlyData;
|
|
opts.useAuthorizationHeader = (_opts$useAuthorizatio = opts.useAuthorizationHeader) !== null && _opts$useAuthorizatio !== void 0 ? _opts$useAuthorizatio : true;
|
|
}
|
|
abort() {
|
|
this.abortController.abort();
|
|
this.abortController = new AbortController();
|
|
}
|
|
fetch(resource, options) {
|
|
if (this.opts.fetchFn) {
|
|
return this.opts.fetchFn(resource, options);
|
|
}
|
|
return global.fetch(resource, options);
|
|
}
|
|
|
|
/**
|
|
* Sets the base URL for the identity server
|
|
* @param url - The new base url
|
|
*/
|
|
setIdBaseUrl(url) {
|
|
this.opts.idBaseUrl = url;
|
|
}
|
|
idServerRequest(method, path, params, prefix, accessToken) {
|
|
if (!this.opts.idBaseUrl) {
|
|
throw new Error("No identity server base URL set");
|
|
}
|
|
let queryParams = undefined;
|
|
let body = undefined;
|
|
if (method === _method.Method.Get) {
|
|
queryParams = params;
|
|
} else {
|
|
body = params;
|
|
}
|
|
const fullUri = this.getUrl(path, queryParams, prefix, this.opts.idBaseUrl);
|
|
const opts = {
|
|
json: true,
|
|
headers: {}
|
|
};
|
|
if (accessToken) {
|
|
opts.headers.Authorization = `Bearer ${accessToken}`;
|
|
}
|
|
return this.requestOtherUrl(method, fullUri, body, opts);
|
|
}
|
|
|
|
/**
|
|
* Perform an authorised request to the homeserver.
|
|
* @param method - The HTTP method e.g. "GET".
|
|
* @param path - The HTTP path <b>after</b> the supplied prefix e.g.
|
|
* "/createRoom".
|
|
*
|
|
* @param queryParams - A dict of query params (these will NOT be
|
|
* urlencoded). If unspecified, there will be no query params.
|
|
*
|
|
* @param body - The HTTP JSON body.
|
|
*
|
|
* @param opts - additional options. If a number is specified,
|
|
* this is treated as `opts.localTimeoutMs`.
|
|
*
|
|
* @returns Promise which resolves to
|
|
* ```
|
|
* {
|
|
* data: {Object},
|
|
* headers: {Object},
|
|
* code: {Number},
|
|
* }
|
|
* ```
|
|
* If `onlyData` is set, this will resolve to the `data` object only.
|
|
* @returns Rejects with an error if a problem occurred.
|
|
* This includes network problems and Matrix-specific error JSON.
|
|
*/
|
|
authedRequest(method, path, queryParams, body, opts = {}) {
|
|
if (!queryParams) queryParams = {};
|
|
if (this.opts.accessToken) {
|
|
if (this.opts.useAuthorizationHeader) {
|
|
if (!opts.headers) {
|
|
opts.headers = {};
|
|
}
|
|
if (!opts.headers.Authorization) {
|
|
opts.headers.Authorization = "Bearer " + this.opts.accessToken;
|
|
}
|
|
if (queryParams.access_token) {
|
|
delete queryParams.access_token;
|
|
}
|
|
} else if (!queryParams.access_token) {
|
|
queryParams.access_token = this.opts.accessToken;
|
|
}
|
|
}
|
|
const requestPromise = this.request(method, path, queryParams, body, opts);
|
|
requestPromise.catch(err => {
|
|
if (err.errcode == "M_UNKNOWN_TOKEN" && !(opts !== null && opts !== void 0 && opts.inhibitLogoutEmit)) {
|
|
this.eventEmitter.emit(_interface.HttpApiEvent.SessionLoggedOut, err);
|
|
} else if (err.errcode == "M_CONSENT_NOT_GIVEN") {
|
|
this.eventEmitter.emit(_interface.HttpApiEvent.NoConsent, err.message, err.data.consent_uri);
|
|
}
|
|
});
|
|
|
|
// return the original promise, otherwise tests break due to it having to
|
|
// go around the event loop one more time to process the result of the request
|
|
return requestPromise;
|
|
}
|
|
|
|
/**
|
|
* Perform a request to the homeserver without any credentials.
|
|
* @param method - The HTTP method e.g. "GET".
|
|
* @param path - The HTTP path <b>after</b> the supplied prefix e.g.
|
|
* "/createRoom".
|
|
*
|
|
* @param queryParams - A dict of query params (these will NOT be
|
|
* urlencoded). If unspecified, there will be no query params.
|
|
*
|
|
* @param body - The HTTP JSON body.
|
|
*
|
|
* @param opts - additional options
|
|
*
|
|
* @returns Promise which resolves to
|
|
* ```
|
|
* {
|
|
* data: {Object},
|
|
* headers: {Object},
|
|
* code: {Number},
|
|
* }
|
|
* ```
|
|
* If `onlyData</code> is set, this will resolve to the <code>data`
|
|
* object only.
|
|
* @returns Rejects with an error if a problem
|
|
* occurred. This includes network problems and Matrix-specific error JSON.
|
|
*/
|
|
request(method, path, queryParams, body, opts) {
|
|
const fullUri = this.getUrl(path, queryParams, opts === null || opts === void 0 ? void 0 : opts.prefix, opts === null || opts === void 0 ? void 0 : opts.baseUrl);
|
|
return this.requestOtherUrl(method, fullUri, body, opts);
|
|
}
|
|
|
|
/**
|
|
* Perform a request to an arbitrary URL.
|
|
* @param method - The HTTP method e.g. "GET".
|
|
* @param url - The HTTP URL object.
|
|
*
|
|
* @param body - The HTTP JSON body.
|
|
*
|
|
* @param opts - additional options
|
|
*
|
|
* @returns Promise which resolves to data unless `onlyData` is specified as false,
|
|
* where the resolved value will be a fetch Response object.
|
|
* @returns Rejects with an error if a problem
|
|
* occurred. This includes network problems and Matrix-specific error JSON.
|
|
*/
|
|
async requestOtherUrl(method, url, body, opts = {}) {
|
|
var _opts$json, _body$constructor, _opts$localTimeoutMs, _opts$keepAlive;
|
|
const urlForLogs = this.sanitizeUrlForLogs(url);
|
|
_logger.logger.debug(`FetchHttpApi: --> ${method} ${urlForLogs}`);
|
|
const headers = Object.assign({}, opts.headers || {});
|
|
const json = (_opts$json = opts.json) !== null && _opts$json !== void 0 ? _opts$json : true;
|
|
// We can't use getPrototypeOf here as objects made in other contexts e.g. over postMessage won't have same ref
|
|
const jsonBody = json && (body === null || body === void 0 || (_body$constructor = body.constructor) === null || _body$constructor === void 0 ? void 0 : _body$constructor.name) === Object.name;
|
|
if (json) {
|
|
if (jsonBody && !headers["Content-Type"]) {
|
|
headers["Content-Type"] = "application/json";
|
|
}
|
|
if (!headers["Accept"]) {
|
|
headers["Accept"] = "application/json";
|
|
}
|
|
}
|
|
const timeout = (_opts$localTimeoutMs = opts.localTimeoutMs) !== null && _opts$localTimeoutMs !== void 0 ? _opts$localTimeoutMs : this.opts.localTimeoutMs;
|
|
const keepAlive = (_opts$keepAlive = opts.keepAlive) !== null && _opts$keepAlive !== void 0 ? _opts$keepAlive : false;
|
|
const signals = [this.abortController.signal];
|
|
if (timeout !== undefined) {
|
|
signals.push((0, _utils2.timeoutSignal)(timeout));
|
|
}
|
|
if (opts.abortSignal) {
|
|
signals.push(opts.abortSignal);
|
|
}
|
|
let data;
|
|
if (jsonBody) {
|
|
data = JSON.stringify(body);
|
|
} else {
|
|
data = body;
|
|
}
|
|
const {
|
|
signal,
|
|
cleanup
|
|
} = (0, _utils2.anySignal)(signals);
|
|
let res;
|
|
const start = Date.now();
|
|
try {
|
|
res = await this.fetch(url, {
|
|
signal,
|
|
method,
|
|
body: data,
|
|
headers,
|
|
mode: "cors",
|
|
redirect: "follow",
|
|
referrer: "",
|
|
referrerPolicy: "no-referrer",
|
|
cache: "no-cache",
|
|
credentials: "omit",
|
|
// we send credentials via headers
|
|
keepalive: keepAlive,
|
|
priority: opts.priority
|
|
});
|
|
_logger.logger.debug(`FetchHttpApi: <-- ${method} ${urlForLogs} [${Date.now() - start}ms ${res.status}]`);
|
|
} catch (e) {
|
|
_logger.logger.debug(`FetchHttpApi: <-- ${method} ${urlForLogs} [${Date.now() - start}ms ${e}]`);
|
|
if (e.name === "AbortError") {
|
|
throw e;
|
|
}
|
|
throw new _errors.ConnectionError("fetch failed", e);
|
|
} finally {
|
|
cleanup();
|
|
}
|
|
if (!res.ok) {
|
|
throw (0, _utils2.parseErrorResponse)(res, await res.text());
|
|
}
|
|
if (this.opts.onlyData) {
|
|
return json ? res.json() : res.text();
|
|
}
|
|
return res;
|
|
}
|
|
sanitizeUrlForLogs(url) {
|
|
try {
|
|
let asUrl;
|
|
if (typeof url === "string") {
|
|
asUrl = new URL(url);
|
|
} else {
|
|
asUrl = url;
|
|
}
|
|
// Remove the values of any URL params that could contain potential secrets
|
|
const sanitizedQs = new URLSearchParams();
|
|
for (const key of asUrl.searchParams.keys()) {
|
|
sanitizedQs.append(key, "xxx");
|
|
}
|
|
const sanitizedQsString = sanitizedQs.toString();
|
|
const sanitizedQsUrlPiece = sanitizedQsString ? `?${sanitizedQsString}` : "";
|
|
return asUrl.origin + asUrl.pathname + sanitizedQsUrlPiece;
|
|
} catch (error) {
|
|
// defensive coding for malformed url
|
|
return "??";
|
|
}
|
|
}
|
|
/**
|
|
* Form and return a homeserver request URL based on the given path params and prefix.
|
|
* @param path - The HTTP path <b>after</b> the supplied prefix e.g. "/createRoom".
|
|
* @param queryParams - A dict of query params (these will NOT be urlencoded).
|
|
* @param prefix - The full prefix to use e.g. "/_matrix/client/v2_alpha", defaulting to this.opts.prefix.
|
|
* @param baseUrl - The baseUrl to use e.g. "https://matrix.org", defaulting to this.opts.baseUrl.
|
|
* @returns URL
|
|
*/
|
|
getUrl(path, queryParams, prefix, baseUrl) {
|
|
const baseUrlWithFallback = baseUrl !== null && baseUrl !== void 0 ? baseUrl : this.opts.baseUrl;
|
|
const baseUrlWithoutTrailingSlash = baseUrlWithFallback.endsWith("/") ? baseUrlWithFallback.slice(0, -1) : baseUrlWithFallback;
|
|
const url = new URL(baseUrlWithoutTrailingSlash + (prefix !== null && prefix !== void 0 ? prefix : this.opts.prefix) + path);
|
|
if (queryParams) {
|
|
(0, _utils.encodeParams)(queryParams, url.searchParams);
|
|
}
|
|
return url;
|
|
}
|
|
}
|
|
exports.FetchHttpApi = FetchHttpApi;
|
|
//# sourceMappingURL=fetch.js.map
|