refactor: Rename BasicEncryptionManger to RTCEncryptionManager

Author: BillCarsonFr

package.json

@@ -130,5 +130,6 @@
         "outputDirectory": "coverage",
         "outputName": "jest-sonar-report.xml",
         "relativePaths": true
-    }
+    },
+    "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

spec/unit/matrixrtc/BasicEncrytionManager.spec.ts renamed to spec/unit/matrixrtc/RTCEncrytionManager.spec.ts

@@ -16,16 +16,16 @@ limitations under the License.
 
 import { type Mocked } from "jest-mock";
 
-import { BasicEncryptionManager } from "../../../src/matrixrtc/BasicEncryptionManager.ts";
+import { RTCEncryptionManager } from "../../../src/matrixrtc/RTCEncryptionManager.ts";
 import { type CallMembership, type Statistics } from "../../../src/matrixrtc";
 import { type ToDeviceKeyTransport } from "../../../src/matrixrtc/ToDeviceKeyTransport.ts";
 import { KeyTransportEvents, type KeyTransportEventsHandlerMap } from "../../../src/matrixrtc/IKeyTransport.ts";
 import { membershipTemplate, mockCallMembership } from "./mocks.ts";
 import { decodeBase64, TypedEventEmitter } from "../../../src";
 
-describe("BasicEncryptionManager", () => {
+describe("RTCEncryptionManager", () => {
     // The manager being tested
-    let encryptionManager: BasicEncryptionManager;
+    let encryptionManager: RTCEncryptionManager;
     let getMembershipMock: jest.Mock;
     let mockTransport: Mocked<ToDeviceKeyTransport>;
     let statistics: Statistics;
@@ -51,7 +51,7 @@ describe("BasicEncryptionManager", () => {
             off: jest.fn(),
         } as unknown as Mocked<ToDeviceKeyTransport>;
 
-        encryptionManager = new BasicEncryptionManager(
+        encryptionManager = new RTCEncryptionManager(
             "@alice:example.org",
             "DEVICE01",
             getMembershipMock,
@@ -294,7 +294,7 @@ describe("BasicEncryptionManager", () => {
                 off: emitter.off.bind(emitter),
                 emit: emitter.emit.bind(emitter),
             } as unknown as Mocked<ToDeviceKeyTransport>;
-            encryptionManager = new BasicEncryptionManager(
+            encryptionManager = new RTCEncryptionManager(
                 "@alice:example.org",
                 "DEVICE01",
                 getMembershipMock,

src/matrixrtc/MatrixRTCSession.ts

@@ -31,7 +31,7 @@ import { logDurationSync } from "../utils.ts";
 import { type Statistics } from "./types.ts";
 import { RoomKeyTransport } from "./RoomKeyTransport.ts";
 import type { IMembershipManager } from "./IMembershipManager.ts";
-import { BasicEncryptionManager } from "./BasicEncryptionManager.ts";
+import { RTCEncryptionManager } from "./RTCEncryptionManager.ts";
 import {
     RoomAndToDeviceEvents,
     type RoomAndToDeviceEventsHandlerMap,
@@ -410,7 +410,7 @@ export class MatrixRTCSession extends TypedEventEmitter<
 
                 // Expose the changes so the ui can display the currently used transport.
                 this.reEmitter.reEmit(transport, [RoomAndToDeviceEvents.EnabledTransportsChanged]);
-                this.encryptionManager = new BasicEncryptionManager(
+                this.encryptionManager = new RTCEncryptionManager(
                     this.client.getUserId()!,
                     this.client.getDeviceId()!,
                     () => this.memberships,

src/matrixrtc/BasicEncryptionManager.ts renamed to src/matrixrtc/RTCEncryptionManager.ts

@@ -33,9 +33,16 @@ type OutboundEncryptionSession = {
 };
 
 /**
- * A simple encryption manager.
+ * RTCEncryptionManager is used to manage the encryption keys for a call.
+ *
+ * It is responsible for distributing the keys to the other participants and rotating the keys if needed.
+ *
+ * This manager when used with to-device transport will share the existing key only to new joiners, and rotate
+ * if there is a leaver.
+ *
+ * XXX In the future we want to distribute a ratcheted key not the current one for new joiners.
  */
-export class BasicEncryptionManager implements IEncryptionManager {
+export class RTCEncryptionManager implements IEncryptionManager {
     // The current per-sender media key for this device
     private outboundSession: OutboundEncryptionSession | null = null;