@textrp/briij-js-sdk 41.0.0

package/lib/rust-crypto/OutgoingRequestProcessor.js

@@ -0,0 +1,194 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+Copyright 2023 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 { KeysBackupRequest, KeysClaimRequest, KeysQueryRequest, KeysUploadRequest, PutDehydratedDeviceRequest, RoomMessageRequest, SignatureUploadRequest, ToDeviceRequest, UploadSigningKeysRequest } from "@matrix-org/matrix-sdk-crypto-wasm";
+import { calculateRetryBackoff, Method } from "../http-api/index.js";
+import { logDuration, sleep } from "../utils.js";
+import { ToDeviceMessageId } from "../@types/event.js";
+import { UnstablePrefix as DehydrationUnstablePrefix } from "./DehydratedDeviceManager.js";
+
+/**
+ * OutgoingRequestManager: turns `OutgoingRequest`s from the rust sdk into HTTP requests
+ *
+ * We have one of these per `RustCrypto` (and hence per `BriijClient`), not that it does anything terribly complicated.
+ * It's responsible for:
+ *
+ *   * holding the reference to the `BriijHttpApi`
+ *   * turning `OutgoingRequest`s from the rust backend into HTTP requests, and sending them
+ *   * sending the results of such requests back to the rust backend.
+ *
+ * @internal
+ */
+export class OutgoingRequestProcessor {
+  constructor(logger, olmMachine, http) {
+    this.logger = logger;
+    this.olmMachine = olmMachine;
+    this.http = http;
+  }
+  makeOutgoingRequest(msg, uiaCallback) {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      var resp;
+
+      /* refer https://docs.rs/matrix-sdk-crypto/0.6.0/matrix_sdk_crypto/requests/enum.OutgoingRequests.html
+       * for the complete list of request types
+       */
+      if (msg instanceof KeysUploadRequest) {
+        resp = yield _this.requestWithRetry(Method.Post, "/_matrix/client/v3/keys/upload", {}, msg.body);
+      } else if (msg instanceof KeysQueryRequest) {
+        resp = yield _this.requestWithRetry(Method.Post, "/_matrix/client/v3/keys/query", {}, msg.body);
+      } else if (msg instanceof KeysClaimRequest) {
+        resp = yield _this.requestWithRetry(Method.Post, "/_matrix/client/v3/keys/claim", {}, msg.body);
+      } else if (msg instanceof SignatureUploadRequest) {
+        resp = yield _this.requestWithRetry(Method.Post, "/_matrix/client/v3/keys/signatures/upload", {}, msg.body);
+      } else if (msg instanceof KeysBackupRequest) {
+        resp = yield _this.requestWithRetry(Method.Put, "/_matrix/client/v3/room_keys/keys", {
+          version: msg.version
+        }, msg.body);
+      } else if (msg instanceof ToDeviceRequest) {
+        resp = yield _this.sendToDeviceRequest(msg);
+      } else if (msg instanceof RoomMessageRequest) {
+        var path = "/_matrix/client/v3/rooms/".concat(encodeURIComponent(msg.room_id), "/send/") + "".concat(encodeURIComponent(msg.event_type), "/").concat(encodeURIComponent(msg.txn_id));
+        resp = yield _this.requestWithRetry(Method.Put, path, {}, msg.body);
+      } else if (msg instanceof UploadSigningKeysRequest) {
+        yield _this.makeRequestWithUIA(Method.Post, "/_matrix/client/v3/keys/device_signing/upload", {}, msg.body, uiaCallback);
+        // SigningKeysUploadRequest does not implement OutgoingRequest and does not need to be marked as sent.
+        return;
+      } else if (msg instanceof PutDehydratedDeviceRequest) {
+        var _path = DehydrationUnstablePrefix + "/dehydrated_device";
+        yield _this.rawJsonRequest(Method.Put, _path, {}, msg.body);
+        // PutDehydratedDeviceRequest does not implement OutgoingRequest and does not need to be marked as sent.
+        return;
+      } else {
+        _this.logger.warn("Unsupported outgoing message", Object.getPrototypeOf(msg));
+        resp = "";
+      }
+      if (msg.id) {
+        try {
+          yield logDuration(_this.logger, "Mark Request as sent ".concat(msg.type), /*#__PURE__*/_asyncToGenerator(function* () {
+            yield _this.olmMachine.markRequestAsSent(msg.id, msg.type, resp);
+          }));
+        } catch (e) {
+          // Ignore errors which are caused by the olmMachine having been freed. The exact error message depends
+          // on whether we are using a release or develop build of rust-sdk-crypto-wasm.
+          if (e instanceof Error && (e.message === "Attempt to use a moved value" || e.message === "null pointer passed to rust")) {
+            _this.logger.debug("Ignoring error '".concat(e.message, "': client is likely shutting down"));
+          } else {
+            throw e;
+          }
+        }
+      } else {
+        _this.logger.trace("Outgoing request type:".concat(msg.type, " does not have an ID"));
+      }
+    })();
+  }
+
+  /**
+   * Send the HTTP request for a `ToDeviceRequest`
+   *
+   * @param request - request to send
+   * @returns JSON-serialized body of the response, if successful
+   */
+  sendToDeviceRequest(request) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      // a bit of extra logging, to help trace to-device messages through the system
+      var parsedBody = JSON.parse(request.body);
+      var messageList = [];
+      for (var [userId, perUserMessages] of Object.entries(parsedBody.messages)) {
+        for (var [deviceId, message] of Object.entries(perUserMessages)) {
+          messageList.push("".concat(userId, "/").concat(deviceId, " (msgid ").concat(message[ToDeviceMessageId], ")"));
+        }
+      }
+      _this2.logger.info("Sending batch of to-device messages. type=".concat(request.event_type, " txnid=").concat(request.txn_id), messageList);
+      var path = "/_matrix/client/v3/sendToDevice/".concat(encodeURIComponent(request.event_type), "/") + encodeURIComponent(request.txn_id);
+      return yield _this2.requestWithRetry(Method.Put, path, {}, request.body);
+    })();
+  }
+  makeRequestWithUIA(method, path, queryParams, body, uiaCallback) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      if (!uiaCallback) {
+        return yield _this3.requestWithRetry(method, path, queryParams, body);
+      }
+      var parsedBody = JSON.parse(body);
+      var makeRequest = /*#__PURE__*/function () {
+        var _ref2 = _asyncToGenerator(function* (auth) {
+          var newBody = _objectSpread({}, parsedBody);
+          if (auth !== null) {
+            newBody.auth = auth;
+          }
+          var resp = yield _this3.requestWithRetry(method, path, queryParams, JSON.stringify(newBody));
+          return JSON.parse(resp);
+        });
+        return function makeRequest(_x) {
+          return _ref2.apply(this, arguments);
+        };
+      }();
+      var resp = yield uiaCallback(makeRequest);
+      return JSON.stringify(resp);
+    })();
+  }
+  requestWithRetry(method, path, queryParams, body) {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      var currentRetryCount = 0;
+
+      // eslint-disable-next-line no-constant-condition
+      while (true) {
+        try {
+          return yield _this4.rawJsonRequest(method, path, queryParams, body);
+        } catch (e) {
+          currentRetryCount++;
+          var backoff = calculateRetryBackoff(e, currentRetryCount, true);
+          if (backoff < 0) {
+            // Max number of retries reached, or error is not retryable. rethrow the error
+            throw e;
+          }
+          // wait for the specified time and then retry the request
+          yield sleep(backoff);
+        }
+      }
+    })();
+  }
+  rawJsonRequest(method, path, queryParams, body) {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      var opts = {
+        // inhibit the JSON stringification and parsing within HttpApi.
+        json: false,
+        // nevertheless, we are sending, and accept, JSON.
+        headers: {
+          "Content-Type": "application/json",
+          "Accept": "application/json"
+        },
+        // we use the full prefix
+        prefix: "",
+        // We set a timeout of 60 seconds to guard against requests getting stuck forever and wedging the
+        // request loop (cf https://github.com/element-hq/element-web/issues/29534).
+        //
+        // (XXX: should we do this in the whole of the js-sdk?)
+        localTimeoutMs: 60000
+      };
+      return yield _this5.http.authedRequest(method, path, queryParams, body, opts);
+    })();
+  }
+}
+//# sourceMappingURL=OutgoingRequestProcessor.js.map

package/lib/rust-crypto/OutgoingRequestProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingRequestProcessor.js","names":["KeysBackupRequest","KeysClaimRequest","KeysQueryRequest","KeysUploadRequest","PutDehydratedDeviceRequest","RoomMessageRequest","SignatureUploadRequest","ToDeviceRequest","UploadSigningKeysRequest","calculateRetryBackoff","Method","logDuration","sleep","ToDeviceMessageId","UnstablePrefix","DehydrationUnstablePrefix","OutgoingRequestProcessor","constructor","logger","olmMachine","http","makeOutgoingRequest","msg","uiaCallback","_this","_asyncToGenerator","resp","requestWithRetry","Post","body","Put","version","sendToDeviceRequest","path","concat","encodeURIComponent","room_id","event_type","txn_id","makeRequestWithUIA","rawJsonRequest","warn","Object","getPrototypeOf","id","type","markRequestAsSent","e","Error","message","debug","trace","request","_this2","parsedBody","JSON","parse","messageList","userId","perUserMessages","entries","messages","deviceId","push","info","method","queryParams","_this3","makeRequest","_ref2","auth","newBody","_objectSpread","stringify","_x","apply","arguments","_this4","currentRetryCount","backoff","_this5","opts","json","headers","prefix","localTimeoutMs","authedRequest"],"sources":["../../src/rust-crypto/OutgoingRequestProcessor.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport {\n    KeysBackupRequest,\n    KeysClaimRequest,\n    KeysQueryRequest,\n    KeysUploadRequest,\n    type OlmMachine,\n    type OutgoingRequest,\n    PutDehydratedDeviceRequest,\n    RoomMessageRequest,\n    SignatureUploadRequest,\n    ToDeviceRequest,\n    UploadSigningKeysRequest,\n} from \"@matrix-org/matrix-sdk-crypto-wasm\";\n\nimport { type Logger } from \"../logger.ts\";\nimport { calculateRetryBackoff, type IHttpOpts, type BriijHttpApi, Method } from \"../http-api/index.ts\";\nimport { logDuration, type QueryDict, sleep } from \"../utils.ts\";\nimport { type AuthDict, type UIAuthCallback } from \"../interactive-auth.ts\";\nimport { ToDeviceMessageId } from \"../@types/event.ts\";\nimport { UnstablePrefix as DehydrationUnstablePrefix } from \"./DehydratedDeviceManager.ts\";\n\n/**\n * OutgoingRequestManager: turns `OutgoingRequest`s from the rust sdk into HTTP requests\n *\n * We have one of these per `RustCrypto` (and hence per `BriijClient`), not that it does anything terribly complicated.\n * It's responsible for:\n *\n *   * holding the reference to the `BriijHttpApi`\n *   * turning `OutgoingRequest`s from the rust backend into HTTP requests, and sending them\n *   * sending the results of such requests back to the rust backend.\n *\n * @internal\n */\nexport class OutgoingRequestProcessor {\n    public constructor(\n        private readonly logger: Logger,\n        private readonly olmMachine: OlmMachine,\n        private readonly http: BriijHttpApi<IHttpOpts & { onlyData: true }>,\n    ) {}\n\n    public async makeOutgoingRequest<T>(\n        msg: OutgoingRequest | UploadSigningKeysRequest | PutDehydratedDeviceRequest,\n        uiaCallback?: UIAuthCallback<T>,\n    ): Promise<void> {\n        let resp: string;\n\n        /* refer https://docs.rs/matrix-sdk-crypto/0.6.0/matrix_sdk_crypto/requests/enum.OutgoingRequests.html\n         * for the complete list of request types\n         */\n        if (msg instanceof KeysUploadRequest) {\n            resp = await this.requestWithRetry(Method.Post, \"/_matrix/client/v3/keys/upload\", {}, msg.body);\n        } else if (msg instanceof KeysQueryRequest) {\n            resp = await this.requestWithRetry(Method.Post, \"/_matrix/client/v3/keys/query\", {}, msg.body);\n        } else if (msg instanceof KeysClaimRequest) {\n            resp = await this.requestWithRetry(Method.Post, \"/_matrix/client/v3/keys/claim\", {}, msg.body);\n        } else if (msg instanceof SignatureUploadRequest) {\n            resp = await this.requestWithRetry(Method.Post, \"/_matrix/client/v3/keys/signatures/upload\", {}, msg.body);\n        } else if (msg instanceof KeysBackupRequest) {\n            resp = await this.requestWithRetry(\n                Method.Put,\n                \"/_matrix/client/v3/room_keys/keys\",\n                { version: msg.version },\n                msg.body,\n            );\n        } else if (msg instanceof ToDeviceRequest) {\n            resp = await this.sendToDeviceRequest(msg);\n        } else if (msg instanceof RoomMessageRequest) {\n            const path =\n                `/_matrix/client/v3/rooms/${encodeURIComponent(msg.room_id)}/send/` +\n                `${encodeURIComponent(msg.event_type)}/${encodeURIComponent(msg.txn_id)}`;\n            resp = await this.requestWithRetry(Method.Put, path, {}, msg.body);\n        } else if (msg instanceof UploadSigningKeysRequest) {\n            await this.makeRequestWithUIA(\n                Method.Post,\n                \"/_matrix/client/v3/keys/device_signing/upload\",\n                {},\n                msg.body,\n                uiaCallback,\n            );\n            // SigningKeysUploadRequest does not implement OutgoingRequest and does not need to be marked as sent.\n            return;\n        } else if (msg instanceof PutDehydratedDeviceRequest) {\n            const path = DehydrationUnstablePrefix + \"/dehydrated_device\";\n            await this.rawJsonRequest(Method.Put, path, {}, msg.body);\n            // PutDehydratedDeviceRequest does not implement OutgoingRequest and does not need to be marked as sent.\n            return;\n        } else {\n            this.logger.warn(\"Unsupported outgoing message\", Object.getPrototypeOf(msg));\n            resp = \"\";\n        }\n\n        if (msg.id) {\n            try {\n                await logDuration(this.logger, `Mark Request as sent ${msg.type}`, async () => {\n                    await this.olmMachine.markRequestAsSent(msg.id!, msg.type, resp);\n                });\n            } catch (e) {\n                // Ignore errors which are caused by the olmMachine having been freed. The exact error message depends\n                // on whether we are using a release or develop build of rust-sdk-crypto-wasm.\n                if (\n                    e instanceof Error &&\n                    (e.message === \"Attempt to use a moved value\" || e.message === \"null pointer passed to rust\")\n                ) {\n                    this.logger.debug(`Ignoring error '${e.message}': client is likely shutting down`);\n                } else {\n                    throw e;\n                }\n            }\n        } else {\n            this.logger.trace(`Outgoing request type:${msg.type} does not have an ID`);\n        }\n    }\n\n    /**\n     * Send the HTTP request for a `ToDeviceRequest`\n     *\n     * @param request - request to send\n     * @returns JSON-serialized body of the response, if successful\n     */\n    private async sendToDeviceRequest(request: ToDeviceRequest): Promise<string> {\n        // a bit of extra logging, to help trace to-device messages through the system\n        const parsedBody: { messages: Record<string, Record<string, Record<string, any>>> } = JSON.parse(request.body);\n\n        const messageList = [];\n        for (const [userId, perUserMessages] of Object.entries(parsedBody.messages)) {\n            for (const [deviceId, message] of Object.entries(perUserMessages)) {\n                messageList.push(`${userId}/${deviceId} (msgid ${message[ToDeviceMessageId]})`);\n            }\n        }\n\n        this.logger.info(\n            `Sending batch of to-device messages. type=${request.event_type} txnid=${request.txn_id}`,\n            messageList,\n        );\n\n        const path =\n            `/_matrix/client/v3/sendToDevice/${encodeURIComponent(request.event_type)}/` +\n            encodeURIComponent(request.txn_id);\n        return await this.requestWithRetry(Method.Put, path, {}, request.body);\n    }\n\n    private async makeRequestWithUIA<T>(\n        method: Method,\n        path: string,\n        queryParams: QueryDict,\n        body: string,\n        uiaCallback: UIAuthCallback<T> | undefined,\n    ): Promise<string> {\n        if (!uiaCallback) {\n            return await this.requestWithRetry(method, path, queryParams, body);\n        }\n\n        const parsedBody = JSON.parse(body);\n        const makeRequest = async (auth: AuthDict | null): Promise<T> => {\n            const newBody: Record<string, any> = {\n                ...parsedBody,\n            };\n            if (auth !== null) {\n                newBody.auth = auth;\n            }\n            const resp = await this.requestWithRetry(method, path, queryParams, JSON.stringify(newBody));\n            return JSON.parse(resp) as T;\n        };\n\n        const resp = await uiaCallback(makeRequest);\n        return JSON.stringify(resp);\n    }\n\n    private async requestWithRetry(\n        method: Method,\n        path: string,\n        queryParams: QueryDict,\n        body: string,\n    ): Promise<string> {\n        let currentRetryCount = 0;\n\n        // eslint-disable-next-line no-constant-condition\n        while (true) {\n            try {\n                return await this.rawJsonRequest(method, path, queryParams, body);\n            } catch (e) {\n                currentRetryCount++;\n                const backoff = calculateRetryBackoff(e, currentRetryCount, true);\n                if (backoff < 0) {\n                    // Max number of retries reached, or error is not retryable. rethrow the error\n                    throw e;\n                }\n                // wait for the specified time and then retry the request\n                await sleep(backoff);\n            }\n        }\n    }\n\n    private async rawJsonRequest(method: Method, path: string, queryParams: QueryDict, body: string): Promise<string> {\n        const opts = {\n            // inhibit the JSON stringification and parsing within HttpApi.\n            json: false,\n\n            // nevertheless, we are sending, and accept, JSON.\n            headers: {\n                \"Content-Type\": \"application/json\",\n                \"Accept\": \"application/json\",\n            },\n\n            // we use the full prefix\n            prefix: \"\",\n\n            // We set a timeout of 60 seconds to guard against requests getting stuck forever and wedging the\n            // request loop (cf https://github.com/element-hq/element-web/issues/29534).\n            //\n            // (XXX: should we do this in the whole of the js-sdk?)\n            localTimeoutMs: 60000,\n        };\n\n        return await this.http.authedRequest<string>(method, path, queryParams, body, opts);\n    }\n}\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SACIA,iBAAiB,EACjBC,gBAAgB,EAChBC,gBAAgB,EAChBC,iBAAiB,EAGjBC,0BAA0B,EAC1BC,kBAAkB,EAClBC,sBAAsB,EACtBC,eAAe,EACfC,wBAAwB,QACrB,oCAAoC;AAG3C,SAASC,qBAAqB,EAAqCC,MAAM,QAAQ,sBAAsB;AACvG,SAASC,WAAW,EAAkBC,KAAK,QAAQ,aAAa;AAEhE,SAASC,iBAAiB,QAAQ,oBAAoB;AACtD,SAASC,cAAc,IAAIC,yBAAyB,QAAQ,8BAA8B;;AAE1F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,wBAAwB,CAAC;EAC3BC,WAAWA,CACGC,MAAc,EACdC,UAAsB,EACtBC,IAAkD,EACrE;IAAA,KAHmBF,MAAc,GAAdA,MAAc;IAAA,KACdC,UAAsB,GAAtBA,UAAsB;IAAA,KACtBC,IAAkD,GAAlDA,IAAkD;EACpE;EAEUC,mBAAmBA,CAC5BC,GAA4E,EAC5EC,WAA+B,EAClB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MACb,IAAIC,IAAY;;MAEhB;AACR;AACA;MACQ,IAAIJ,GAAG,YAAYnB,iBAAiB,EAAE;QAClCuB,IAAI,SAASF,KAAI,CAACG,gBAAgB,CAACjB,MAAM,CAACkB,IAAI,EAAE,gCAAgC,EAAE,CAAC,CAAC,EAAEN,GAAG,CAACO,IAAI,CAAC;MACnG,CAAC,MAAM,IAAIP,GAAG,YAAYpB,gBAAgB,EAAE;QACxCwB,IAAI,SAASF,KAAI,CAACG,gBAAgB,CAACjB,MAAM,CAACkB,IAAI,EAAE,+BAA+B,EAAE,CAAC,CAAC,EAAEN,GAAG,CAACO,IAAI,CAAC;MAClG,CAAC,MAAM,IAAIP,GAAG,YAAYrB,gBAAgB,EAAE;QACxCyB,IAAI,SAASF,KAAI,CAACG,gBAAgB,CAACjB,MAAM,CAACkB,IAAI,EAAE,+BAA+B,EAAE,CAAC,CAAC,EAAEN,GAAG,CAACO,IAAI,CAAC;MAClG,CAAC,MAAM,IAAIP,GAAG,YAAYhB,sBAAsB,EAAE;QAC9CoB,IAAI,SAASF,KAAI,CAACG,gBAAgB,CAACjB,MAAM,CAACkB,IAAI,EAAE,2CAA2C,EAAE,CAAC,CAAC,EAAEN,GAAG,CAACO,IAAI,CAAC;MAC9G,CAAC,MAAM,IAAIP,GAAG,YAAYtB,iBAAiB,EAAE;QACzC0B,IAAI,SAASF,KAAI,CAACG,gBAAgB,CAC9BjB,MAAM,CAACoB,GAAG,EACV,mCAAmC,EACnC;UAAEC,OAAO,EAAET,GAAG,CAACS;QAAQ,CAAC,EACxBT,GAAG,CAACO,IACR,CAAC;MACL,CAAC,MAAM,IAAIP,GAAG,YAAYf,eAAe,EAAE;QACvCmB,IAAI,SAASF,KAAI,CAACQ,mBAAmB,CAACV,GAAG,CAAC;MAC9C,CAAC,MAAM,IAAIA,GAAG,YAAYjB,kBAAkB,EAAE;QAC1C,IAAM4B,IAAI,GACN,4BAAAC,MAAA,CAA4BC,kBAAkB,CAACb,GAAG,CAACc,OAAO,CAAC,iBAAAF,MAAA,CACxDC,kBAAkB,CAACb,GAAG,CAACe,UAAU,CAAC,OAAAH,MAAA,CAAIC,kBAAkB,CAACb,GAAG,CAACgB,MAAM,CAAC,CAAE;QAC7EZ,IAAI,SAASF,KAAI,CAACG,gBAAgB,CAACjB,MAAM,CAACoB,GAAG,EAAEG,IAAI,EAAE,CAAC,CAAC,EAAEX,GAAG,CAACO,IAAI,CAAC;MACtE,CAAC,MAAM,IAAIP,GAAG,YAAYd,wBAAwB,EAAE;QAChD,MAAMgB,KAAI,CAACe,kBAAkB,CACzB7B,MAAM,CAACkB,IAAI,EACX,+CAA+C,EAC/C,CAAC,CAAC,EACFN,GAAG,CAACO,IAAI,EACRN,WACJ,CAAC;QACD;QACA;MACJ,CAAC,MAAM,IAAID,GAAG,YAAYlB,0BAA0B,EAAE;QAClD,IAAM6B,KAAI,GAAGlB,yBAAyB,GAAG,oBAAoB;QAC7D,MAAMS,KAAI,CAACgB,cAAc,CAAC9B,MAAM,CAACoB,GAAG,EAAEG,KAAI,EAAE,CAAC,CAAC,EAAEX,GAAG,CAACO,IAAI,CAAC;QACzD;QACA;MACJ,CAAC,MAAM;QACHL,KAAI,CAACN,MAAM,CAACuB,IAAI,CAAC,8BAA8B,EAAEC,MAAM,CAACC,cAAc,CAACrB,GAAG,CAAC,CAAC;QAC5EI,IAAI,GAAG,EAAE;MACb;MAEA,IAAIJ,GAAG,CAACsB,EAAE,EAAE;QACR,IAAI;UACA,MAAMjC,WAAW,CAACa,KAAI,CAACN,MAAM,0BAAAgB,MAAA,CAA0BZ,GAAG,CAACuB,IAAI,gBAAApB,iBAAA,CAAI,aAAY;YAC3E,MAAMD,KAAI,CAACL,UAAU,CAAC2B,iBAAiB,CAACxB,GAAG,CAACsB,EAAE,EAAGtB,GAAG,CAACuB,IAAI,EAAEnB,IAAI,CAAC;UACpE,CAAC,EAAC;QACN,CAAC,CAAC,OAAOqB,CAAC,EAAE;UACR;UACA;UACA,IACIA,CAAC,YAAYC,KAAK,KACjBD,CAAC,CAACE,OAAO,KAAK,8BAA8B,IAAIF,CAAC,CAACE,OAAO,KAAK,6BAA6B,CAAC,EAC/F;YACEzB,KAAI,CAACN,MAAM,CAACgC,KAAK,oBAAAhB,MAAA,CAAoBa,CAAC,CAACE,OAAO,sCAAmC,CAAC;UACtF,CAAC,MAAM;YACH,MAAMF,CAAC;UACX;QACJ;MACJ,CAAC,MAAM;QACHvB,KAAI,CAACN,MAAM,CAACiC,KAAK,0BAAAjB,MAAA,CAA0BZ,GAAG,CAACuB,IAAI,yBAAsB,CAAC;MAC9E;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACkBb,mBAAmBA,CAACoB,OAAwB,EAAmB;IAAA,IAAAC,MAAA;IAAA,OAAA5B,iBAAA;MACzE;MACA,IAAM6B,UAA6E,GAAGC,IAAI,CAACC,KAAK,CAACJ,OAAO,CAACvB,IAAI,CAAC;MAE9G,IAAM4B,WAAW,GAAG,EAAE;MACtB,KAAK,IAAM,CAACC,MAAM,EAAEC,eAAe,CAAC,IAAIjB,MAAM,CAACkB,OAAO,CAACN,UAAU,CAACO,QAAQ,CAAC,EAAE;QACzE,KAAK,IAAM,CAACC,QAAQ,EAAEb,OAAO,CAAC,IAAIP,MAAM,CAACkB,OAAO,CAACD,eAAe,CAAC,EAAE;UAC/DF,WAAW,CAACM,IAAI,IAAA7B,MAAA,CAAIwB,MAAM,OAAAxB,MAAA,CAAI4B,QAAQ,cAAA5B,MAAA,CAAWe,OAAO,CAACpC,iBAAiB,CAAC,MAAG,CAAC;QACnF;MACJ;MAEAwC,MAAI,CAACnC,MAAM,CAAC8C,IAAI,8CAAA9B,MAAA,CACiCkB,OAAO,CAACf,UAAU,aAAAH,MAAA,CAAUkB,OAAO,CAACd,MAAM,GACvFmB,WACJ,CAAC;MAED,IAAMxB,IAAI,GACN,mCAAAC,MAAA,CAAmCC,kBAAkB,CAACiB,OAAO,CAACf,UAAU,CAAC,SACzEF,kBAAkB,CAACiB,OAAO,CAACd,MAAM,CAAC;MACtC,aAAae,MAAI,CAAC1B,gBAAgB,CAACjB,MAAM,CAACoB,GAAG,EAAEG,IAAI,EAAE,CAAC,CAAC,EAAEmB,OAAO,CAACvB,IAAI,CAAC;IAAC;EAC3E;EAEcU,kBAAkBA,CAC5B0B,MAAc,EACdhC,IAAY,EACZiC,WAAsB,EACtBrC,IAAY,EACZN,WAA0C,EAC3B;IAAA,IAAA4C,MAAA;IAAA,OAAA1C,iBAAA;MACf,IAAI,CAACF,WAAW,EAAE;QACd,aAAa4C,MAAI,CAACxC,gBAAgB,CAACsC,MAAM,EAAEhC,IAAI,EAAEiC,WAAW,EAAErC,IAAI,CAAC;MACvE;MAEA,IAAMyB,UAAU,GAAGC,IAAI,CAACC,KAAK,CAAC3B,IAAI,CAAC;MACnC,IAAMuC,WAAW;QAAA,IAAAC,KAAA,GAAA5C,iBAAA,CAAG,WAAO6C,IAAqB,EAAiB;UAC7D,IAAMC,OAA4B,GAAAC,aAAA,KAC3BlB,UAAU,CAChB;UACD,IAAIgB,IAAI,KAAK,IAAI,EAAE;YACfC,OAAO,CAACD,IAAI,GAAGA,IAAI;UACvB;UACA,IAAM5C,IAAI,SAASyC,MAAI,CAACxC,gBAAgB,CAACsC,MAAM,EAAEhC,IAAI,EAAEiC,WAAW,EAAEX,IAAI,CAACkB,SAAS,CAACF,OAAO,CAAC,CAAC;UAC5F,OAAOhB,IAAI,CAACC,KAAK,CAAC9B,IAAI,CAAC;QAC3B,CAAC;QAAA,gBATK0C,WAAWA,CAAAM,EAAA;UAAA,OAAAL,KAAA,CAAAM,KAAA,OAAAC,SAAA;QAAA;MAAA,GAShB;MAED,IAAMlD,IAAI,SAASH,WAAW,CAAC6C,WAAW,CAAC;MAC3C,OAAOb,IAAI,CAACkB,SAAS,CAAC/C,IAAI,CAAC;IAAC;EAChC;EAEcC,gBAAgBA,CAC1BsC,MAAc,EACdhC,IAAY,EACZiC,WAAsB,EACtBrC,IAAY,EACG;IAAA,IAAAgD,MAAA;IAAA,OAAApD,iBAAA;MACf,IAAIqD,iBAAiB,GAAG,CAAC;;MAEzB;MACA,OAAO,IAAI,EAAE;QACT,IAAI;UACA,aAAaD,MAAI,CAACrC,cAAc,CAACyB,MAAM,EAAEhC,IAAI,EAAEiC,WAAW,EAAErC,IAAI,CAAC;QACrE,CAAC,CAAC,OAAOkB,CAAC,EAAE;UACR+B,iBAAiB,EAAE;UACnB,IAAMC,OAAO,GAAGtE,qBAAqB,CAACsC,CAAC,EAAE+B,iBAAiB,EAAE,IAAI,CAAC;UACjE,IAAIC,OAAO,GAAG,CAAC,EAAE;YACb;YACA,MAAMhC,CAAC;UACX;UACA;UACA,MAAMnC,KAAK,CAACmE,OAAO,CAAC;QACxB;MACJ;IAAC;EACL;EAEcvC,cAAcA,CAACyB,MAAc,EAAEhC,IAAY,EAAEiC,WAAsB,EAAErC,IAAY,EAAmB;IAAA,IAAAmD,MAAA;IAAA,OAAAvD,iBAAA;MAC9G,IAAMwD,IAAI,GAAG;QACT;QACAC,IAAI,EAAE,KAAK;QAEX;QACAC,OAAO,EAAE;UACL,cAAc,EAAE,kBAAkB;UAClC,QAAQ,EAAE;QACd,CAAC;QAED;QACAC,MAAM,EAAE,EAAE;QAEV;QACA;QACA;QACA;QACAC,cAAc,EAAE;MACpB,CAAC;MAED,aAAaL,MAAI,CAAC5D,IAAI,CAACkE,aAAa,CAASrB,MAAM,EAAEhC,IAAI,EAAEiC,WAAW,EAAErC,IAAI,EAAEoD,IAAI,CAAC;IAAC;EACxF;AACJ","ignoreList":[]}

package/lib/rust-crypto/OutgoingRequestsManager.d.ts

@@ -0,0 +1,47 @@
+import { type OlmMachine } from "@matrix-org/matrix-sdk-crypto-wasm";
+import { type OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { type Logger } from "../logger.ts";
+/**
+ * OutgoingRequestsManager: responsible for processing outgoing requests from the OlmMachine.
+ * Ensure that only one loop is going on at once, and that the requests are processed in order.
+ */
+export declare class OutgoingRequestsManager {
+    private readonly logger;
+    private readonly olmMachine;
+    readonly outgoingRequestProcessor: OutgoingRequestProcessor;
+    /** whether {@link stop} has been called */
+    private stopped;
+    /** whether {@link outgoingRequestLoop} is currently running */
+    private outgoingRequestLoopRunning;
+    /**
+     * If there are additional calls to doProcessOutgoingRequests() while there is a current call running
+     * we need to remember in order to call `doProcessOutgoingRequests` again (as there could be new requests).
+     *
+     * If this is defined, it is an indication that we need to do another iteration; in this case the deferred
+     * will resolve once that next iteration completes. If it is undefined, there have been no new calls
+     * to `doProcessOutgoingRequests` since the current iteration started.
+     */
+    private nextLoopDeferred?;
+    constructor(logger: Logger, olmMachine: OlmMachine, outgoingRequestProcessor: OutgoingRequestProcessor);
+    /**
+     * Shut down as soon as possible the current loop of outgoing requests processing.
+     */
+    stop(): void;
+    /**
+     * Process the OutgoingRequests from the OlmMachine.
+     *
+     * This should be called at the end of each sync, to process any OlmMachine OutgoingRequests created by the rust sdk.
+     * In some cases if OutgoingRequests need to be sent immediately, this can be called directly.
+     *
+     * Calls to doProcessOutgoingRequests() are processed synchronously, one after the other, in order.
+     * If doProcessOutgoingRequests() is called while another call is still being processed, it will be queued.
+     * Multiple calls to doProcessOutgoingRequests() when a call is already processing will be batched together.
+     */
+    doProcessOutgoingRequests(): Promise<void>;
+    private outgoingRequestLoop;
+    /**
+     * Make a single request to `olmMachine.outgoingRequests` and do the corresponding requests.
+     */
+    private processOutgoingRequests;
+}
+//# sourceMappingURL=OutgoingRequestsManager.d.ts.map

package/lib/rust-crypto/OutgoingRequestsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingRequestsManager.d.ts","sourceRoot":"","sources":["../../src/rust-crypto/OutgoingRequestsManager.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,UAAU,EAAwB,MAAM,oCAAoC,CAAC;AAE3F,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAG3C;;;GAGG;AACH,qBAAa,uBAAuB;IAkB5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;aACX,wBAAwB,EAAE,wBAAwB;IAnBtE,2CAA2C;IAC3C,OAAO,CAAC,OAAO,CAAS;IAExB,+DAA+D;IAC/D,OAAO,CAAC,0BAA0B,CAAS;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB,CAAC,CAA6B;gBAGjC,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACvB,wBAAwB,EAAE,wBAAwB;IAGtE;;OAEG;IACI,IAAI,IAAI,IAAI;IAInB;;;;;;;;;OASG;IACI,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;YA2BnC,mBAAmB;IA4BjC;;OAEG;YACW,uBAAuB;CA6CxC"}

package/lib/rust-crypto/OutgoingRequestsManager.js

@@ -0,0 +1,175 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2023 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 { logDuration } from "../utils.js";
+
+/**
+ * OutgoingRequestsManager: responsible for processing outgoing requests from the OlmMachine.
+ * Ensure that only one loop is going on at once, and that the requests are processed in order.
+ */
+export class OutgoingRequestsManager {
+  constructor(logger, olmMachine, outgoingRequestProcessor) {
+    this.logger = logger;
+    this.olmMachine = olmMachine;
+    this.outgoingRequestProcessor = outgoingRequestProcessor;
+    /** whether {@link stop} has been called */
+    _defineProperty(this, "stopped", false);
+    /** whether {@link outgoingRequestLoop} is currently running */
+    _defineProperty(this, "outgoingRequestLoopRunning", false);
+    /**
+     * If there are additional calls to doProcessOutgoingRequests() while there is a current call running
+     * we need to remember in order to call `doProcessOutgoingRequests` again (as there could be new requests).
+     *
+     * If this is defined, it is an indication that we need to do another iteration; in this case the deferred
+     * will resolve once that next iteration completes. If it is undefined, there have been no new calls
+     * to `doProcessOutgoingRequests` since the current iteration started.
+     */
+    _defineProperty(this, "nextLoopDeferred", void 0);
+  }
+
+  /**
+   * Shut down as soon as possible the current loop of outgoing requests processing.
+   */
+  stop() {
+    this.stopped = true;
+  }
+
+  /**
+   * Process the OutgoingRequests from the OlmMachine.
+   *
+   * This should be called at the end of each sync, to process any OlmMachine OutgoingRequests created by the rust sdk.
+   * In some cases if OutgoingRequests need to be sent immediately, this can be called directly.
+   *
+   * Calls to doProcessOutgoingRequests() are processed synchronously, one after the other, in order.
+   * If doProcessOutgoingRequests() is called while another call is still being processed, it will be queued.
+   * Multiple calls to doProcessOutgoingRequests() when a call is already processing will be batched together.
+   */
+  doProcessOutgoingRequests() {
+    // Flag that we need at least one more iteration of the loop.
+    //
+    // It is important that we do this even if the loop is currently running. There is potential for a race whereby
+    // a request is added to the queue *after* `OlmMachine.outgoingRequests` checks the queue, but *before* it
+    // returns. In such a case, the item could sit there unnoticed for some time.
+    //
+    // In order to circumvent the race, we set a flag which tells the loop to go round once again even if the
+    // queue appears to be empty.
+    if (!this.nextLoopDeferred) {
+      this.nextLoopDeferred = Promise.withResolvers();
+    }
+
+    // ... and wait for it to complete.
+    var result = this.nextLoopDeferred.promise;
+
+    // set the loop going if it is not already.
+    if (!this.outgoingRequestLoopRunning) {
+      this.outgoingRequestLoop().catch(e => {
+        // this should not happen; outgoingRequestLoop should return any errors via `nextLoopDeferred`.
+        /* istanbul ignore next */
+        this.logger.error("Uncaught error in outgoing request loop", e);
+      });
+    }
+    return result;
+  }
+  outgoingRequestLoop() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      /* istanbul ignore if */
+      if (_this.outgoingRequestLoopRunning) {
+        throw new Error("Cannot run two outgoing request loops");
+      }
+      _this.outgoingRequestLoopRunning = true;
+      try {
+        while (!_this.stopped && _this.nextLoopDeferred) {
+          var loopTickResolvers = _this.nextLoopDeferred;
+
+          // reset `nextLoopDeferred` so that any future calls to `doProcessOutgoingRequests` are queued
+          // for another additional iteration.
+          _this.nextLoopDeferred = undefined;
+
+          // make the requests and feed the results back to the `nextLoopDeferred`
+          yield _this.processOutgoingRequests().then(loopTickResolvers.resolve, loopTickResolvers.reject);
+        }
+      } finally {
+        _this.outgoingRequestLoopRunning = false;
+      }
+      if (_this.nextLoopDeferred) {
+        // the loop was stopped, but there was a call to `doProcessOutgoingRequests`. Make sure that
+        // we reject the promise in case anything is waiting for it.
+        _this.nextLoopDeferred.reject(new Error("OutgoingRequestsManager was stopped"));
+      }
+    })();
+  }
+
+  /**
+   * Make a single request to `olmMachine.outgoingRequests` and do the corresponding requests.
+   */
+  processOutgoingRequests() {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      if (_this2.stopped) return;
+      var outgoingRequests = yield _this2.olmMachine.outgoingRequests();
+      var successes = 0;
+      var _loop = function* _loop(request) {
+          if (_this2.stopped) return {
+            v: void 0
+          };
+          try {
+            yield logDuration(_this2.logger, "Make outgoing request ".concat(request.type), /*#__PURE__*/_asyncToGenerator(function* () {
+              yield _this2.outgoingRequestProcessor.makeOutgoingRequest(request);
+              successes++;
+            }));
+          } catch (e) {
+            // as part of the loop we silently ignore errors, but log them.
+            // The rust sdk will retry the request later as it won't have been marked as sent.
+            _this2.logger.error("Failed to process outgoing request ".concat(request.type, ": ").concat(e));
+          }
+        },
+        _ret;
+      for (var request of outgoingRequests) {
+        _ret = yield* _loop(request);
+        if (_ret) return _ret.v;
+      }
+
+      // If we successfully handled any requests this time, more may have been queued as
+      // part of that handling.
+      //
+      // For example, we may have processed a `/keys/claim` request, which
+      // meant the rust side could establish an Olm session and is now ready to
+      // send out an `m.secret.send` message.
+      // (See https://github.com/element-hq/element-web/issues/30988.)
+      //
+      // So, if we have successfully processed any requests, flag that we need to make another
+      // pass around the outgoing-requests loop, to make sure we handle any
+      // pending requests immediately.
+      //
+      // If all requests failed (or there weren't any) we don't want to retry them in a tight
+      // loop. They will be retried after the next sync.
+      // (See https://github.com/element-hq/element-web/issues/31790.)
+      if (successes > 0) {
+        // We call doProcessOutgoingRequests but since we expect that we are
+        // already processing outgoing requests, this call will not kick off
+        // the processing loop, but just set `nextLoopDeferred` and return,
+        // which will mean we loop one more time.
+        _this2.doProcessOutgoingRequests().catch(e => {
+          _this2.logger.warn("processOutgoingRequests: Error re-checking outgoing requests", e);
+        });
+      }
+    })();
+  }
+}
+//# sourceMappingURL=OutgoingRequestsManager.js.map

package/lib/rust-crypto/OutgoingRequestsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingRequestsManager.js","names":["logDuration","OutgoingRequestsManager","constructor","logger","olmMachine","outgoingRequestProcessor","_defineProperty","stop","stopped","doProcessOutgoingRequests","nextLoopDeferred","Promise","withResolvers","result","promise","outgoingRequestLoopRunning","outgoingRequestLoop","catch","e","error","_this","_asyncToGenerator","Error","loopTickResolvers","undefined","processOutgoingRequests","then","resolve","reject","_this2","outgoingRequests","successes","_loop","request","v","concat","type","makeOutgoingRequest","_ret","warn"],"sources":["../../src/rust-crypto/OutgoingRequestsManager.ts"],"sourcesContent":["/*\r\nCopyright 2023 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { type OlmMachine, type OutgoingRequest } from \"@matrix-org/matrix-sdk-crypto-wasm\";\r\n\r\nimport { type OutgoingRequestProcessor } from \"./OutgoingRequestProcessor.ts\";\r\nimport { type Logger } from \"../logger.ts\";\r\nimport { logDuration } from \"../utils.ts\";\r\n\r\n/**\r\n * OutgoingRequestsManager: responsible for processing outgoing requests from the OlmMachine.\r\n * Ensure that only one loop is going on at once, and that the requests are processed in order.\r\n */\r\nexport class OutgoingRequestsManager {\r\n    /** whether {@link stop} has been called */\r\n    private stopped = false;\r\n\r\n    /** whether {@link outgoingRequestLoop} is currently running */\r\n    private outgoingRequestLoopRunning = false;\r\n\r\n    /**\r\n     * If there are additional calls to doProcessOutgoingRequests() while there is a current call running\r\n     * we need to remember in order to call `doProcessOutgoingRequests` again (as there could be new requests).\r\n     *\r\n     * If this is defined, it is an indication that we need to do another iteration; in this case the deferred\r\n     * will resolve once that next iteration completes. If it is undefined, there have been no new calls\r\n     * to `doProcessOutgoingRequests` since the current iteration started.\r\n     */\r\n    private nextLoopDeferred?: PromiseWithResolvers<void>;\r\n\r\n    public constructor(\r\n        private readonly logger: Logger,\r\n        private readonly olmMachine: OlmMachine,\r\n        public readonly outgoingRequestProcessor: OutgoingRequestProcessor,\r\n    ) {}\r\n\r\n    /**\r\n     * Shut down as soon as possible the current loop of outgoing requests processing.\r\n     */\r\n    public stop(): void {\r\n        this.stopped = true;\r\n    }\r\n\r\n    /**\r\n     * Process the OutgoingRequests from the OlmMachine.\r\n     *\r\n     * This should be called at the end of each sync, to process any OlmMachine OutgoingRequests created by the rust sdk.\r\n     * In some cases if OutgoingRequests need to be sent immediately, this can be called directly.\r\n     *\r\n     * Calls to doProcessOutgoingRequests() are processed synchronously, one after the other, in order.\r\n     * If doProcessOutgoingRequests() is called while another call is still being processed, it will be queued.\r\n     * Multiple calls to doProcessOutgoingRequests() when a call is already processing will be batched together.\r\n     */\r\n    public doProcessOutgoingRequests(): Promise<void> {\r\n        // Flag that we need at least one more iteration of the loop.\r\n        //\r\n        // It is important that we do this even if the loop is currently running. There is potential for a race whereby\r\n        // a request is added to the queue *after* `OlmMachine.outgoingRequests` checks the queue, but *before* it\r\n        // returns. In such a case, the item could sit there unnoticed for some time.\r\n        //\r\n        // In order to circumvent the race, we set a flag which tells the loop to go round once again even if the\r\n        // queue appears to be empty.\r\n        if (!this.nextLoopDeferred) {\r\n            this.nextLoopDeferred = Promise.withResolvers();\r\n        }\r\n\r\n        // ... and wait for it to complete.\r\n        const result = this.nextLoopDeferred.promise;\r\n\r\n        // set the loop going if it is not already.\r\n        if (!this.outgoingRequestLoopRunning) {\r\n            this.outgoingRequestLoop().catch((e) => {\r\n                // this should not happen; outgoingRequestLoop should return any errors via `nextLoopDeferred`.\r\n                /* istanbul ignore next */\r\n                this.logger.error(\"Uncaught error in outgoing request loop\", e);\r\n            });\r\n        }\r\n        return result;\r\n    }\r\n\r\n    private async outgoingRequestLoop(): Promise<void> {\r\n        /* istanbul ignore if */\r\n        if (this.outgoingRequestLoopRunning) {\r\n            throw new Error(\"Cannot run two outgoing request loops\");\r\n        }\r\n        this.outgoingRequestLoopRunning = true;\r\n        try {\r\n            while (!this.stopped && this.nextLoopDeferred) {\r\n                const loopTickResolvers = this.nextLoopDeferred;\r\n\r\n                // reset `nextLoopDeferred` so that any future calls to `doProcessOutgoingRequests` are queued\r\n                // for another additional iteration.\r\n                this.nextLoopDeferred = undefined;\r\n\r\n                // make the requests and feed the results back to the `nextLoopDeferred`\r\n                await this.processOutgoingRequests().then(loopTickResolvers.resolve, loopTickResolvers.reject);\r\n            }\r\n        } finally {\r\n            this.outgoingRequestLoopRunning = false;\r\n        }\r\n\r\n        if (this.nextLoopDeferred) {\r\n            // the loop was stopped, but there was a call to `doProcessOutgoingRequests`. Make sure that\r\n            // we reject the promise in case anything is waiting for it.\r\n            this.nextLoopDeferred.reject(new Error(\"OutgoingRequestsManager was stopped\"));\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Make a single request to `olmMachine.outgoingRequests` and do the corresponding requests.\r\n     */\r\n    private async processOutgoingRequests(): Promise<void> {\r\n        if (this.stopped) return;\r\n\r\n        const outgoingRequests: OutgoingRequest[] = await this.olmMachine.outgoingRequests();\r\n\r\n        let successes = 0;\r\n        for (const request of outgoingRequests) {\r\n            if (this.stopped) return;\r\n            try {\r\n                await logDuration(this.logger, `Make outgoing request ${request.type}`, async () => {\r\n                    await this.outgoingRequestProcessor.makeOutgoingRequest(request);\r\n                    successes++;\r\n                });\r\n            } catch (e) {\r\n                // as part of the loop we silently ignore errors, but log them.\r\n                // The rust sdk will retry the request later as it won't have been marked as sent.\r\n                this.logger.error(`Failed to process outgoing request ${request.type}: ${e}`);\r\n            }\r\n        }\r\n\r\n        // If we successfully handled any requests this time, more may have been queued as\r\n        // part of that handling.\r\n        //\r\n        // For example, we may have processed a `/keys/claim` request, which\r\n        // meant the rust side could establish an Olm session and is now ready to\r\n        // send out an `m.secret.send` message.\r\n        // (See https://github.com/element-hq/element-web/issues/30988.)\r\n        //\r\n        // So, if we have successfully processed any requests, flag that we need to make another\r\n        // pass around the outgoing-requests loop, to make sure we handle any\r\n        // pending requests immediately.\r\n        //\r\n        // If all requests failed (or there weren't any) we don't want to retry them in a tight\r\n        // loop. They will be retried after the next sync.\r\n        // (See https://github.com/element-hq/element-web/issues/31790.)\r\n        if (successes > 0) {\r\n            // We call doProcessOutgoingRequests but since we expect that we are\r\n            // already processing outgoing requests, this call will not kick off\r\n            // the processing loop, but just set `nextLoopDeferred` and return,\r\n            // which will mean we loop one more time.\r\n            this.doProcessOutgoingRequests().catch((e) => {\r\n                this.logger.warn(\"processOutgoingRequests: Error re-checking outgoing requests\", e);\r\n            });\r\n        }\r\n    }\r\n}\r\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA,SAASA,WAAW,QAAQ,aAAa;;AAEzC;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAuB,CAAC;EAiB1BC,WAAWA,CACGC,MAAc,EACdC,UAAsB,EACvBC,wBAAkD,EACpE;IAAA,KAHmBF,MAAc,GAAdA,MAAc;IAAA,KACdC,UAAsB,GAAtBA,UAAsB;IAAA,KACvBC,wBAAkD,GAAlDA,wBAAkD;IAnBtE;IAAAC,eAAA,kBACkB,KAAK;IAEvB;IAAAA,eAAA,qCACqC,KAAK;IAE1C;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;IAPIA,eAAA;EAcG;;EAEH;AACJ;AACA;EACWC,IAAIA,CAAA,EAAS;IAChB,IAAI,CAACC,OAAO,GAAG,IAAI;EACvB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,yBAAyBA,CAAA,EAAkB;IAC9C;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA,IAAI,CAAC,IAAI,CAACC,gBAAgB,EAAE;MACxB,IAAI,CAACA,gBAAgB,GAAGC,OAAO,CAACC,aAAa,CAAC,CAAC;IACnD;;IAEA;IACA,IAAMC,MAAM,GAAG,IAAI,CAACH,gBAAgB,CAACI,OAAO;;IAE5C;IACA,IAAI,CAAC,IAAI,CAACC,0BAA0B,EAAE;MAClC,IAAI,CAACC,mBAAmB,CAAC,CAAC,CAACC,KAAK,CAAEC,CAAC,IAAK;QACpC;QACA;QACA,IAAI,CAACf,MAAM,CAACgB,KAAK,CAAC,yCAAyC,EAAED,CAAC,CAAC;MACnE,CAAC,CAAC;IACN;IACA,OAAOL,MAAM;EACjB;EAEcG,mBAAmBA,CAAA,EAAkB;IAAA,IAAAI,KAAA;IAAA,OAAAC,iBAAA;MAC/C;MACA,IAAID,KAAI,CAACL,0BAA0B,EAAE;QACjC,MAAM,IAAIO,KAAK,CAAC,uCAAuC,CAAC;MAC5D;MACAF,KAAI,CAACL,0BAA0B,GAAG,IAAI;MACtC,IAAI;QACA,OAAO,CAACK,KAAI,CAACZ,OAAO,IAAIY,KAAI,CAACV,gBAAgB,EAAE;UAC3C,IAAMa,iBAAiB,GAAGH,KAAI,CAACV,gBAAgB;;UAE/C;UACA;UACAU,KAAI,CAACV,gBAAgB,GAAGc,SAAS;;UAEjC;UACA,MAAMJ,KAAI,CAACK,uBAAuB,CAAC,CAAC,CAACC,IAAI,CAACH,iBAAiB,CAACI,OAAO,EAAEJ,iBAAiB,CAACK,MAAM,CAAC;QAClG;MACJ,CAAC,SAAS;QACNR,KAAI,CAACL,0BAA0B,GAAG,KAAK;MAC3C;MAEA,IAAIK,KAAI,CAACV,gBAAgB,EAAE;QACvB;QACA;QACAU,KAAI,CAACV,gBAAgB,CAACkB,MAAM,CAAC,IAAIN,KAAK,CAAC,qCAAqC,CAAC,CAAC;MAClF;IAAC;EACL;;EAEA;AACJ;AACA;EACkBG,uBAAuBA,CAAA,EAAkB;IAAA,IAAAI,MAAA;IAAA,OAAAR,iBAAA;MACnD,IAAIQ,MAAI,CAACrB,OAAO,EAAE;MAElB,IAAMsB,gBAAmC,SAASD,MAAI,CAACzB,UAAU,CAAC0B,gBAAgB,CAAC,CAAC;MAEpF,IAAIC,SAAS,GAAG,CAAC;MAAC,IAAAC,KAAA,aAAAA,MAAAC,OAAA,EACsB;UACpC,IAAIJ,MAAI,CAACrB,OAAO;YAAA0B,CAAA;UAAA;UAChB,IAAI;YACA,MAAMlC,WAAW,CAAC6B,MAAI,CAAC1B,MAAM,2BAAAgC,MAAA,CAA2BF,OAAO,CAACG,IAAI,gBAAAf,iBAAA,CAAI,aAAY;cAChF,MAAMQ,MAAI,CAACxB,wBAAwB,CAACgC,mBAAmB,CAACJ,OAAO,CAAC;cAChEF,SAAS,EAAE;YACf,CAAC,EAAC;UACN,CAAC,CAAC,OAAOb,CAAC,EAAE;YACR;YACA;YACAW,MAAI,CAAC1B,MAAM,CAACgB,KAAK,uCAAAgB,MAAA,CAAuCF,OAAO,CAACG,IAAI,QAAAD,MAAA,CAAKjB,CAAC,CAAE,CAAC;UACjF;QACJ,CAAC;QAAAoB,IAAA;MAZD,KAAK,IAAML,OAAO,IAAIH,gBAAgB;QAAAQ,IAAA,UAAAN,KAAA,CAAAC,OAAA;QAAA,IAAAK,IAAA,SAAAA,IAAA,CAAAJ,CAAA;MAAA;;MActC;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA;MACA,IAAIH,SAAS,GAAG,CAAC,EAAE;QACf;QACA;QACA;QACA;QACAF,MAAI,CAACpB,yBAAyB,CAAC,CAAC,CAACQ,KAAK,CAAEC,CAAC,IAAK;UAC1CW,MAAI,CAAC1B,MAAM,CAACoC,IAAI,CAAC,8DAA8D,EAAErB,CAAC,CAAC;QACvF,CAAC,CAAC;MACN;IAAC;EACL;AACJ","ignoreList":[]}

package/lib/rust-crypto/PerSessionKeyBackupDownloader.d.ts

@@ -0,0 +1,120 @@
+import { type OlmMachine } from "@matrix-org/matrix-sdk-crypto-wasm";
+import { type KeyBackupInfo } from "../crypto-api/keybackup.ts";
+import { type Logger } from "../logger.ts";
+import { type IHttpOpts, type BriijHttpApi } from "../http-api/index.ts";
+import { type RustBackupManager } from "./backup.ts";
+/**
+ * Used when an 'unable to decrypt' error occurs. It attempts to download the key from the backup.
+ *
+ * The current backup API lacks pagination, which can lead to lengthy key retrieval times for large histories (several 10s of minutes).
+ * To mitigate this, keys are downloaded on demand as decryption errors occurs.
+ * While this approach may result in numerous requests, it improves user experience by reducing wait times for message decryption.
+ *
+ * The PerSessionKeyBackupDownloader is resistant to backup configuration changes: it will automatically resume querying when
+ * the backup is configured correctly.
+ */
+export declare class PerSessionKeyBackupDownloader {
+    private readonly olmMachine;
+    private readonly http;
+    private readonly backupManager;
+    private stopped;
+    /**
+     * The version and decryption key to use with current backup if all set up correctly.
+     *
+     * Will not be set unless `hasConfigurationProblem` is `false`.
+     */
+    private configuration;
+    /** We remember when a session was requested and not found in backup to avoid query again too soon.
+     * Map of session_id to timestamp */
+    private sessionLastCheckAttemptedTime;
+    /** The logger to use */
+    private readonly logger;
+    /** Whether the download loop is running. */
+    private downloadLoopRunning;
+    /** The list of requests that are queued. */
+    private queuedRequests;
+    /** Remembers if we have a configuration problem. */
+    private hasConfigurationProblem;
+    /** The current server backup version check promise. To avoid doing a server call if one is in flight. */
+    private currentBackupVersionCheck;
+    /**
+     * Creates a new instance of PerSessionKeyBackupDownloader.
+     *
+     * @param backupManager - The backup manager to use.
+     * @param olmMachine - The olm machine to use.
+     * @param http - The http instance to use.
+     * @param logger - The logger to use.
+     */
+    constructor(logger: Logger, olmMachine: OlmMachine, http: BriijHttpApi<IHttpOpts & {
+        onlyData: true;
+    }>, backupManager: RustBackupManager);
+    /**
+     * Check if key download is successfully configured and active.
+     *
+     * @return `true` if key download is correctly configured and active; otherwise `false`.
+     */
+    isKeyBackupDownloadConfigured(): boolean;
+    /**
+     * Return the details of the latest backup on the server, when we last checked.
+     *
+     * This is just a convenience method to expose {@link RustBackupManager.getServerBackupInfo}.
+     */
+    getServerBackupInfo(): Promise<KeyBackupInfo | null | undefined>;
+    /**
+     * Called when a MissingRoomKey or UnknownMessageIndex decryption error is encountered.
+     *
+     * This will try to download the key from the backup if there is a trusted active backup.
+     * In case of success the key will be imported and the onRoomKeysUpdated callback will be called
+     * internally by the rust-sdk and decryption will be retried.
+     *
+     * @param roomId - The room ID of the room where the error occurred.
+     * @param megolmSessionId - The megolm session ID that is missing.
+     */
+    onDecryptionKeyMissingError(roomId: string, megolmSessionId: string): void;
+    stop(): void;
+    /**
+     * Called when the backup status changes (CryptoEvents)
+     * This will trigger a check of the backup configuration.
+     */
+    private onBackupStatusChanged;
+    /** Returns true if the megolm session is already queued for download. */
+    private isAlreadyInQueue;
+    /**
+     * Marks the session as not found in backup, to avoid retrying to soon for a key not in backup
+     *
+     * @param megolmSessionId - The megolm session ID that is missing.
+     */
+    private markAsNotFoundInBackup;
+    /** Returns true if the session was requested recently. */
+    private wasRequestedRecently;
+    private getBackupDecryptionKey;
+    /**
+     * Requests a key from the server side backup.
+     *
+     * @param version - The backup version to use.
+     * @param roomId - The room ID of the room where the error occurred.
+     * @param sessionId - The megolm session ID that is missing.
+     */
+    private requestRoomKeyFromBackup;
+    private downloadKeysLoop;
+    /**
+     * Query the backup for a key.
+     *
+     * @param targetRoomId - ID of the room that the session is used in.
+     * @param targetSessionId - ID of the session for which to check backup.
+     * @param configuration - The backup configuration to use.
+     */
+    private queryKeyBackup;
+    private decryptAndImport;
+    /**
+     * Gets the current backup configuration or create one if it doesn't exist.
+     *
+     * When a valid configuration is found it is cached and returned for subsequent calls.
+     * Otherwise, if a check is forced or a check has not yet been done, a new check is done.
+     *
+     * @returns The backup configuration to use or null if there is a configuration problem.
+     */
+    private getOrCreateBackupConfiguration;
+    private internalCheckFromServer;
+}
+//# sourceMappingURL=PerSessionKeyBackupDownloader.d.ts.map

package/lib/rust-crypto/PerSessionKeyBackupDownloader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerSessionKeyBackupDownloader.d.ts","sourceRoot":"","sources":["../../src/rust-crypto/PerSessionKeyBackupDownloader.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAGrE,OAAO,EAA2B,KAAK,aAAa,EAAyB,MAAM,4BAA4B,CAAC;AAEhH,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAgB,KAAK,SAAS,EAAc,KAAK,YAAY,EAAU,MAAM,sBAAsB,CAAC;AAC3G,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AA8CrD;;;;;;;;;GASG;AACH,qBAAa,6BAA6B;IAuClC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAxClC,OAAO,CAAC,OAAO,CAAS;IAExB;;;;OAIG;IACH,OAAO,CAAC,aAAa,CAA8B;IAEnD;wCACoC;IACpC,OAAO,CAAC,6BAA6B,CAAkC;IAEvE,wBAAwB;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,4CAA4C;IAC5C,OAAO,CAAC,mBAAmB,CAAS;IAEpC,4CAA4C;IAC5C,OAAO,CAAC,cAAc,CAAqB;IAE3C,oDAAoD;IACpD,OAAO,CAAC,uBAAuB,CAAS;IAExC,yGAAyG;IACzG,OAAO,CAAC,yBAAyB,CAA8C;IAE/E;;;;;;;OAOG;gBAEC,MAAM,EAAE,MAAM,EACG,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,YAAY,CAAC,SAAS,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC,EAClD,aAAa,EAAE,iBAAiB;IASrD;;;;OAIG;IACI,6BAA6B,IAAI,OAAO;IAI/C;;;;OAIG;IACU,mBAAmB,IAAI,OAAO,CAAC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IAI7E;;;;;;;;;OASG;IACI,2BAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI;IA4B1E,IAAI,IAAI,IAAI;IAOnB;;;OAGG;IACH,OAAO,CAAC,qBAAqB,CAU3B;IAEF,yEAAyE;IACzE,OAAO,CAAC,gBAAgB;IAMxB;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAa9B,0DAA0D;IAC1D,OAAO,CAAC,oBAAoB;YAMd,sBAAsB;IAQpC;;;;;;OAMG;YACW,wBAAwB;YAexB,gBAAgB;IAoE9B;;;;;;OAMG;YACW,cAAc;YA4Cd,gBAAgB;IAc9B;;;;;;;OAOG;YACW,8BAA8B;YA0B9B,uBAAuB;CA+DxC"}