Set User-Agent string of Matrix client HTTP requests

re turt2live/matrix-bot-sdk#302
SeaGL · Mar 19, 2023 · b8d2186 · b8d2186
1 parent b86f9c8
commit b8d2186
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 1 deletion.
diff --git a/overrides.d.ts b/overrides.d.ts
@@ -0,0 +1,10 @@
+import { getRequestFn, setRequestFn } from "matrix-bot-sdk";
+import type _request from "request";
+
+type RequestFn = typeof _request;
+
+declare module "matrix-bot-sdk" {
+  function getRequestFn(): RequestFn;
+
+  function setRequestFn(request: RequestFn): void;
+}
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "@types/luxon": "^3.0.1",
     "@types/markdown-it": "^12.2.3",
     "@types/node": "^18.7.18",
+    "@types/request": "^2.48.8",
     "tiny-typed-emitter": "^2.1.0",
     "ttypescript": "^1.5.13",
     "typescript": "^4.8.3"

diff --git a/src/lib/Client.ts b/src/lib/Client.ts
@@ -1,14 +1,22 @@
 import Bottleneck from "bottleneck";
-import { MatrixClient, RoomCreateOptions as RoomCreateFullOptions } from "matrix-bot-sdk";
+import {
+  getRequestFn,
+  MatrixClient,
+  RoomCreateOptions as RoomCreateFullOptions,
+  setRequestFn,
+} from "matrix-bot-sdk";
 import { setTimeout } from "timers/promises";
 import type { Event, StateEvent, StateEventInput, Sync } from "./matrix.js";
 import { env } from "./utilities.js";
+import { userAgent } from "./version.js";
 
 export interface RoomCreateOptions extends RoomCreateFullOptions {
   initial_state?: StateEventInput[];
   preset?: Exclude<NonNullable<RoomCreateFullOptions["preset"]>, "trusted_private_chat">;
 }
 
+setRequestFn(getRequestFn().defaults({ headers: { "User-Agent": userAgent } }));
+
 const issue8895Cooldown = 1000 * Number(env("ISSUE_8895_COOLDOWN"));
 const minTime = 1000 / Number(env("MATRIX_RATE_LIMIT"));
 

diff --git a/yarn.lock b/yarn.lock
@@ -75,6 +75,11 @@
     "@types/connect" "*"
     "@types/node" "*"
 
+"@types/caseless@*":
+  version "0.12.2"
+  resolved "https://registry.yarnpkg.com/@types/caseless/-/caseless-0.12.2.tgz#f65d3d6389e01eeb458bd54dc8f52b95a9463bc8"
+  integrity sha512-6ckxMjBBD8URvjB6J3NcnuAn5Pkl7t3TizAg+xdlzzQGSPSmBcXf8KoIH0ua/i+tio+ZRUHEXp0HEmvaR4kt0w==
+
 "@types/connect@*":
   version "3.4.35"
   resolved "https://registry.yarnpkg.com/@types/connect/-/connect-3.4.35.tgz#5fcf6ae445e4021d1fc2219a4873cc73a3bb2ad1"
@@ -168,6 +173,16 @@
   resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.4.tgz#cd667bcfdd025213aafb7ca5915a932590acdcdc"
   integrity sha512-EEhsLsD6UsDM1yFhAvy0Cjr6VwmpMWqFBCb9w07wVugF7w9nfajxLuVmngTIpgS6svCnm6Vaw+MZhoDCKnOfsw==
 
+"@types/request@^2.48.8":
+  version "2.48.8"
+  resolved "https://registry.yarnpkg.com/@types/request/-/request-2.48.8.tgz#0b90fde3b655ab50976cb8c5ac00faca22f5a82c"
+  integrity sha512-whjk1EDJPcAR2kYHRbFl/lKeeKYTi05A15K9bnLInCVroNDCtXce57xKdI0/rQaA3K+6q0eFyUBPmqfSndUZdQ==
+  dependencies:
+    "@types/caseless" "*"
+    "@types/node" "*"
+    "@types/tough-cookie" "*"
+    form-data "^2.5.0"
+
 "@types/serve-static@*":
   version "1.15.1"
   resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.1.tgz#86b1753f0be4f9a1bee68d459fcda5be4ea52b5d"
@@ -176,6 +191,11 @@
     "@types/mime" "*"
     "@types/node" "*"
 
+"@types/tough-cookie@*":
+  version "4.0.2"
+  resolved "https://registry.yarnpkg.com/@types/tough-cookie/-/tough-cookie-4.0.2.tgz#6286b4c7228d58ab7866d19716f3696e03a09397"
+  integrity sha512-Q5vtl1W5ue16D+nIaW8JWebSSraJVlK+EthKn7e7UcD4KWsaSJ8BqGPXNaPghgtcn/fhvrN17Tv8ksUsQpiplw==
+
 accepts@~1.3.8:
   version "1.3.8"
   resolved "https://registry.yarnpkg.com/accepts/-/accepts-1.3.8.tgz#0bf0be125b67014adcb0b0921e62db7bffe16b2e"
@@ -626,6 +646,15 @@ forever-agent@~0.6.1:
   resolved "https://registry.yarnpkg.com/forever-agent/-/forever-agent-0.6.1.tgz#fbc71f0c41adeb37f96c577ad1ed42d8fdacca91"
   integrity sha512-j0KLYPhm6zeac4lz3oJ3o65qvgQCcPubiyotZrXqEaG4hNagNYO8qdlUrX5vwqv9ohqeT/Z3j6+yW067yWWdUw==
 
+form-data@^2.5.0:
+  version "2.5.1"
+  resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.5.1.tgz#f2cbec57b5e59e23716e128fe44d4e5dd23895f4"
+  integrity sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==
+  dependencies:
+    asynckit "^0.4.0"
+    combined-stream "^1.0.6"
+    mime-types "^2.1.12"
+
 form-data@~2.3.2:
   version "2.3.3"
   resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.3.3.tgz#dcce52c05f644f298c6a7ab936bd724ceffbf3a6"