matrix-js-sdk 42.1.0 → 42.2.0-rc.2

package/lib/client.js

@@ -33,7 +33,6 @@ import * as utils from "./utils.js";
 import { deepCompare, noUnsafeEventProps, replaceParam, safeSet, sleep } from "./utils.js";
 import { Direction, EventTimeline } from "./models/event-timeline.js";
 import { PushProcessor } from "./pushprocessor.js";
-import { AutoDiscovery } from "./autodiscovery.js";
 import { encodeUnpaddedBase64Url } from "./base64.js";
 import { TypedReEmitter } from "./ReEmitter.js";
 import { logger } from "./logger.js";
@@ -76,6 +75,8 @@ import { sha256 } from "./digest.js";
 import { OAuth2Error, isValidAuthMetadata } from "./oauth/index.js";
 import { UnsupportedDelayedEventsEndpointError, UnsupportedStickyEventsEndpointError } from "./errors.js";
 import { RetentionPolicyService } from "./retentionPolicy.js";
+import { createRtcTransportsCachedValue } from "./rtcTransportsCachedValue.js";
+import { createWellKnownCachedValue } from "./wellKnownCachedValue.js";
 const SCROLLBACK_DELAY_MS = 3000;
 const TURN_CHECK_INTERVAL = 10 * 60 * 1000; // poll for turn credentials every 10 minutes
 
@@ -307,6 +308,7 @@ export let ClientEvent = /*#__PURE__*/function (ClientEvent) {
   ClientEvent["TurnServers"] = "turnServers";
   ClientEvent["TurnServersError"] = "turnServers.error";
   ClientEvent["UserProfileUpdate"] = "userProfileUpdate";
+  ClientEvent["RtcTransportsUpdated"] = "rtcTransportsUpdated";
   return ClientEvent;
 }({});
 const SSO_ACTION_PARAM = new UnstableValue("action", "org.matrix.msc3824.action");
@@ -400,7 +402,6 @@ export class MatrixClient extends TypedEventEmitter {
     _defineProperty(this, "syncLeftRoomsPromise", void 0);
     _defineProperty(this, "syncedLeftRooms", false);
     _defineProperty(this, "clientOpts", void 0);
-    _defineProperty(this, "clientWellKnownIntervalID", void 0);
     _defineProperty(this, "canResetTimelineCallback", void 0);
     _defineProperty(this, "canSupport", new Map());
     // The pushprocessor caches useful things, so keep one and re-use it
@@ -408,8 +409,6 @@ export class MatrixClient extends TypedEventEmitter {
     // Promise to a response of the server's /versions response
     // TODO: This should expire: https://github.com/matrix-org/matrix-js-sdk/issues/1020
     _defineProperty(this, "serverVersionsPromise", void 0);
-    _defineProperty(this, "clientWellKnown", void 0);
-    _defineProperty(this, "clientWellKnownPromise", void 0);
     _defineProperty(this, "turnServers", []);
     _defineProperty(this, "turnServersExpiry", 0);
     _defineProperty(this, "checkTurnServersIntervalID", void 0);
@@ -432,6 +431,8 @@ export class MatrixClient extends TypedEventEmitter {
     _defineProperty(this, "serverCapabilitiesService", void 0);
     _defineProperty(this, "retentionPolicyService", void 0);
     _defineProperty(this, "_unstable_shouldApplyMessageRetention", void 0);
+    _defineProperty(this, "cachedRtcTransports", void 0);
+    _defineProperty(this, "cachedWellKnown", void 0);
     _defineProperty(this, "startCallEventHandler", () => {
       if (this.isInitialSyncComplete()) {
         if (supportsMatrixCall()) {
@@ -562,6 +563,8 @@ export class MatrixClient extends TypedEventEmitter {
 
     // having lots of event listeners is not unusual. 0 means "unlimited".
     this.setMaxListeners(0);
+    this.cachedRtcTransports = createRtcTransportsCachedValue(this, this.logger);
+    this.cachedWellKnown = createWellKnownCachedValue(this, this.logger);
   }
   set store(newStore) {
     this._store = newStore;
@@ -628,17 +631,13 @@ export class MatrixClient extends TypedEventEmitter {
       this.syncApi = new SyncApi(this, this.clientOpts, this.buildSyncApiOptions());
     }
     this.syncApi.sync().catch(e => this.logger.info("Sync startup aborted with an error:", e));
-    if (this.clientOpts.clientWellKnownPollPeriod !== undefined) {
-      this.clientWellKnownIntervalID = setInterval(() => {
-        void this.fetchClientWellKnown();
-      }, 1000 * this.clientOpts.clientWellKnownPollPeriod);
-      void this.fetchClientWellKnown();
-    }
+    this.cachedWellKnown.start(this.clientOpts.clientWellKnownPollPeriod !== undefined ? 1000 * this.clientOpts.clientWellKnownPollPeriod : undefined);
     this.toDeviceMessageQueue.start();
     this.serverCapabilitiesService.start();
     if (this._unstable_shouldApplyMessageRetention) {
       this.retentionPolicyService?.start();
     }
+    this.cachedRtcTransports.start();
   }
 
   /**
@@ -678,12 +677,11 @@ export class MatrixClient extends TypedEventEmitter {
     this.groupCallEventHandler = undefined;
     globalThis.clearInterval(this.checkTurnServersIntervalID);
     this.checkTurnServersIntervalID = undefined;
-    if (this.clientWellKnownIntervalID !== undefined) {
-      globalThis.clearInterval(this.clientWellKnownIntervalID);
-    }
     this.toDeviceMessageQueue.stop();
     this.matrixRTC.stop();
     this.serverCapabilitiesService.stop();
+    this.cachedRtcTransports.stop();
+    this.cachedWellKnown.stop();
   }
 
   /**
@@ -1044,6 +1042,11 @@ export class MatrixClient extends TypedEventEmitter {
    * @param args.storagePassword - An alternative to `storageKey`. A password which will be used to derive a key to
    *    encrypt the store with. Deriving a key from a password is (deliberately) a slow operation, so prefer
    *    to pass a `storageKey` directly where possible.
+   * @param args.caCertsPem - Optional PEM-formatted string that provides CA certificates. These will be used to check
+   *    X.509 signatures on user identities. Any user identity that has a valid signature according to the supplied
+   *    CAs will be considered verified, without any manual verification taking place.
+   *
+   *    NOTE: this is an unspecified extension to Matrix. Applications should exercise caution when using it.
    *
    * @returns a Promise which will resolve when the crypto layer has been
    *    successfully initialised.
@@ -1081,7 +1084,8 @@ export class MatrixClient extends TypedEventEmitter {
       legacyMigrationProgressListener: (progress, total) => {
         this.emit(CryptoEvent.LegacyCryptoStoreMigrationProgress, progress, total);
       },
-      enableEncryptedStateEvents: this.enableEncryptedStateEvents
+      enableEncryptedStateEvents: this.enableEncryptedStateEvents,
+      caCertsPem: args.caCertsPem
     });
     rustCrypto.setSupportedVerificationMethods(this.verificationMethods);
     this.cryptoBackend = rustCrypto;
@@ -4398,21 +4402,15 @@ export class MatrixClient extends TypedEventEmitter {
       prefix: ""
     });
   }
-  async fetchClientWellKnown() {
-    // `getRawClientConfig` does not throw or reject on network errors, instead
-    // it absorbs errors and returns `{}`.
-    this.clientWellKnownPromise = AutoDiscovery.getRawClientConfig(this.getDomain() ?? undefined);
-    this.clientWellKnown = await this.clientWellKnownPromise;
-    this.emit(ClientEvent.ClientWellKnown, this.clientWellKnown);
-  }
   getClientWellKnown() {
-    return this.clientWellKnown;
+    return this.cachedWellKnown.get();
   }
-  waitForClientWellKnown() {
+  async waitForClientWellKnown() {
     if (!this.clientRunning) {
       throw new Error("Client is not running");
     }
-    return this.clientWellKnownPromise;
+    const wellKnown = await this.cachedWellKnown.wait();
+    return wellKnown;
   }
 
   /**
@@ -5239,8 +5237,7 @@ export class MatrixClient extends TypedEventEmitter {
       room_id: roomId,
       type: eventType,
       state_key: stateKey,
-      // Cast safety: StateEvents[K] is a stronger bound than IContent, which has [key: string]: any
-      content: content
+      content
     });
     await this.encryptStateEventIfNeeded(event, room ?? undefined);
     const pathParams = {