Adding more logs (#3563)

* Adding more logs

* post merge fix

* fixup merge error

* review

---------

Co-authored-by: Timo K <toger5@hotmail.de>

src/state/CallViewModel/remoteMembers/Connection.test.ts

@@ -14,7 +14,6 @@ import {
   onTestFinished,
   vi,
 } from "vitest";
-import { BehaviorSubject } from "rxjs";
 import {
   type LocalParticipant,
   type RemoteParticipant,
@@ -25,11 +24,9 @@ import {
 import fetchMock from "fetch-mock";
 import EventEmitter from "events";
 import { type IOpenIDToken } from "matrix-js-sdk";
+import { logger } from "matrix-js-sdk/lib/logger";
 
-import type {
-  CallMembership,
-  LivekitTransport,
-} from "matrix-js-sdk/lib/matrixrtc";
+import type { LivekitTransport } from "matrix-js-sdk/lib/matrixrtc";
 import {
   Connection,
   type ConnectionOpts,
@@ -39,6 +36,7 @@ import {
 import { ObservableScope } from "../../ObservableScope.ts";
 import { type OpenIDClientParts } from "../../../livekit/openIDSFU.ts";
 import { FailToGetOpenIdToken } from "../../../utils/errors.ts";
+
 let testScope: ObservableScope;
 
 let client: MockedObject<OpenIDClientParts>;
@@ -49,9 +47,9 @@ let localParticipantEventEmiter: EventEmitter;
 let fakeLocalParticipant: MockedObject<LocalParticipant>;
 
 let fakeRoomEventEmiter: EventEmitter;
-let fakeMembershipsFocusMap$: BehaviorSubject<
-  { membership: CallMembership; transport: LivekitTransport }[]
->;
+// let fakeMembershipsFocusMap$: BehaviorSubject<
+//   { membership: CallMembership; transport: LivekitTransport }[]
+// >;
 
 const livekitFocus: LivekitTransport = {
   livekit_alias: "!roomID:example.org",
@@ -70,9 +68,6 @@ function setupTest(): void {
     }),
     getDeviceId: vi.fn().mockReturnValue("ABCDEF"),
   } as unknown as OpenIDClientParts);
-  fakeMembershipsFocusMap$ = new BehaviorSubject<
-    { membership: CallMembership; transport: LivekitTransport }[]
-  >([]);
 
   localParticipantEventEmiter = new EventEmitter();
 
@@ -131,7 +126,7 @@ function setupRemoteConnection(): Connection {
 
   fakeLivekitRoom.connect.mockResolvedValue(undefined);
 
-  return new Connection(opts);
+  return new Connection(opts, logger);
 }
 
 afterEach(() => {
@@ -150,7 +145,7 @@ describe("Start connection states", () => {
       scope: testScope,
       livekitRoomFactory: () => fakeLivekitRoom,
     };
-    const connection = new Connection(opts);
+    const connection = new Connection(opts, logger);
 
     expect(connection.state$.getValue().state).toEqual("Initialized");
   });
@@ -166,7 +161,7 @@ describe("Start connection states", () => {
       livekitRoomFactory: () => fakeLivekitRoom,
     };
 
-    const connection = new Connection(opts, undefined);
+    const connection = new Connection(opts, logger);
 
     const capturedStates: ConnectionState[] = [];
     const s = connection.state$.subscribe((value) => {
@@ -218,7 +213,7 @@ describe("Start connection states", () => {
       livekitRoomFactory: () => fakeLivekitRoom,
     };
 
-    const connection = new Connection(opts, undefined);
+    const connection = new Connection(opts, logger);
 
     const capturedStates: ConnectionState[] = [];
     const s = connection.state$.subscribe((value) => {
@@ -274,7 +269,7 @@ describe("Start connection states", () => {
       livekitRoomFactory: () => fakeLivekitRoom,
     };
 
-    const connection = new Connection(opts, undefined);
+    const connection = new Connection(opts, logger);
 
     const capturedStates: ConnectionState[] = [];
     const s = connection.state$.subscribe((value) => {

src/state/CallViewModel/remoteMembers/Connection.ts

@@ -98,6 +98,7 @@ export class Connection {
   // TODO dont make this throw and instead store a connection error state in this class?
   // TODO consider an autostart pattern...
   public async start(): Promise<void> {
+    this.logger.debug("Starting Connection");
     this.stopped = false;
     try {
       this._state$.next({
@@ -145,6 +146,7 @@ export class Connection {
         livekitConnectionState$: connectionStateObserver(this.livekitRoom),
       });
     } catch (error) {
+      this.logger.debug(`Failed to connect to LiveKit room: ${error}`);
       this._state$.next({
         state: "FailedToStart",
         error: error instanceof Error ? error : new Error(`${error}`),
@@ -169,6 +171,9 @@ export class Connection {
    * If the connection is already stopped, this is a no-op.
    */
   public async stop(): Promise<void> {
+    this.logger.debug(
+      `Stopping connection to ${this.transport.livekit_service_url}`,
+    );
     if (this.stopped) return;
     await this.livekitRoom.disconnect();
     this._state$.next({
@@ -195,15 +200,18 @@ export class Connection {
   private readonly client: OpenIDClientParts;
   public readonly livekitRoom: LivekitRoom;
 
+  private readonly logger: Logger;
+
   /**
    * Creates a new connection to a matrix RTC LiveKit backend.
    *
-   * @param livekitRoom - LiveKit room instance to use.
    * @param opts - Connection options {@link ConnectionOpts}.
    *
+   * @param logger
    */
-  public constructor(opts: ConnectionOpts, logger?: Logger) {
-    logger?.info(
+  public constructor(opts: ConnectionOpts, logger: Logger) {
+    this.logger = logger.getChild("[Connection]");
+    this.logger.info(
       `[Connection] Creating new connection to ${opts.transport.livekit_service_url} ${opts.transport.livekit_alias}`,
     );
     const { transport, client, scope } = opts;
@@ -223,15 +231,17 @@ export class Connection {
         ],
       }).pipe(
         map((participants) => {
-          const partsFiltered = participants.filter(
+          return participants.filter(
             (participant) => participant.getTrackPublications().length > 0,
           );
-          return partsFiltered;
         }),
       ),
       [],
     );
 
-    scope.onEnd(() => void this.stop());
+    scope.onEnd(() => {
+      this.logger.info(`Connection scope ended, stopping connection`);
+      void this.stop();
+    });
   }
 }

src/state/CallViewModel/remoteMembers/ConnectionManager.test.ts

@@ -9,6 +9,7 @@ import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
 import { BehaviorSubject } from "rxjs";
 import { type LivekitTransport } from "matrix-js-sdk/lib/matrixrtc";
 import { type Participant as LivekitParticipant } from "livekit-client";
+import { logger } from "matrix-js-sdk/lib/logger";
 
 import { Epoch, ObservableScope } from "../../ObservableScope.ts";
 import {
@@ -78,6 +79,7 @@ describe("connections$ stream", () => {
         inputTransports$: behavior("a", {
           a: new Epoch([TRANSPORT_1, TRANSPORT_2], 0),
         }),
+        logger: logger,
       });
 
       expectObservable(connections$).toBe("a", {
@@ -119,6 +121,7 @@ describe("connections$ stream", () => {
           e: new Epoch([TRANSPORT_1], 4),
           f: new Epoch([TRANSPORT_1, TRANSPORT_2], 5),
         }),
+        logger: logger,
       });
 
       expectObservable(connections$).toBe("xxxxxa", {
@@ -158,6 +161,7 @@ describe("connections$ stream", () => {
           b: new Epoch([TRANSPORT_1, TRANSPORT_2], 1),
           c: new Epoch([TRANSPORT_1], 2),
         }),
+        logger: logger,
       });
 
       expectObservable(connections$).toBe("xab", {
@@ -272,6 +276,7 @@ describe("connectionManagerData$ stream", () => {
         inputTransports$: behavior("a", {
           a: new Epoch([TRANSPORT_1, TRANSPORT_2], 0),
         }),
+        logger,
       });
 
       expectObservable(connectionManagerData$).toBe("abcd", {

src/state/CallViewModel/remoteMembers/ConnectionManager.ts

@@ -13,8 +13,8 @@ import {
   type LivekitTransport,
   type ParticipantId,
 } from "matrix-js-sdk/lib/matrixrtc";
-import { BehaviorSubject, combineLatest, map, of, switchMap } from "rxjs";
-import { logger as rootLogger } from "matrix-js-sdk/lib/logger";
+import { BehaviorSubject, combineLatest, map, of, switchMap, tap } from "rxjs";
+import { type Logger } from "matrix-js-sdk/lib/logger";
 import { type LocalParticipant, type RemoteParticipant } from "livekit-client";
 
 import { type Behavior } from "../../Behavior.ts";
@@ -91,6 +91,7 @@ interface Props {
   scope: ObservableScope;
   connectionFactory: ConnectionFactory;
   inputTransports$: Behavior<Epoch<LivekitTransport[]>>;
+  logger: Logger;
 }
 // TODO - write test for scopes (do we really need to bind scope)
 export interface IConnectionManager {
@@ -116,8 +117,9 @@ export function createConnectionManager$({
   scope,
   connectionFactory,
   inputTransports$,
+  logger: parentLogger,
 }: Props): IConnectionManager {
-  const logger = rootLogger.getChild("[ConnectionManager]");
+  const logger = parentLogger.getChild("[ConnectionManager]");
 
   const running$ = new BehaviorSubject(true);
   scope.onEnd(() => running$.next(false));
@@ -137,6 +139,11 @@ export function createConnectionManager$({
         transports.mapInner((transport) => (running ? transport : [])),
       ),
       map((transports) => transports.mapInner(removeDuplicateTransports)),
+      tap(({ value: transports }) => {
+        logger.trace(
+          `Managing transports: ${transports.map((t) => t.livekit_service_url).join(", ")}`,
+        );
+      }),
     ),
   );
 
@@ -154,6 +161,7 @@ export function createConnectionManager$({
             };
         },
         (scope, _data$, serviceUrl, alias) => {
+          logger.debug(`Creating connection to ${serviceUrl} (${alias})`);
           const connection = connectionFactory.createConnection(
             {
               type: "livekit",

src/state/CallViewModel/remoteMembers/integration.test.ts

@@ -11,6 +11,7 @@ import { type Room as LivekitRoom } from "livekit-client";
 import EventEmitter from "events";
 import fetchMock from "fetch-mock";
 import { type LivekitTransport } from "matrix-js-sdk/lib/matrixrtc";
+import { logger } from "matrix-js-sdk/lib/logger";
 
 import {
   type Epoch,
@@ -120,6 +121,7 @@ test("bob, carl, then bob joining no tracks yet", () => {
       scope: testScope,
       connectionFactory: ecConnectionFactory,
       inputTransports$: membershipsAndTransports.transports$,
+      logger: logger,
     });
 
     const matrixLivekitItems$ = createMatrixLivekitMembers$({