fix tests to mock readRoomState instead of readRoomTimeline

Author: toger5

src/ClientWidgetApi.ts

@@ -530,24 +530,31 @@ export class ClientWidgetApi extends EventEmitter {
         // For backwards compatibility we still call the deprecated
         // readRoomEvents and readStateEvents methods in case the client isn't
         // letting us know the currently viewed room via setViewedRoomId
-        const events = request.data.room_ids === undefined && askRoomIds.length === 0
-            ? await (
-                // This returns [] with the current driver of Element Web.
-                // Add default implementations of the `readRoomEvents` and `readStateEvents`
-                // methods to use `readRoomTimeline` and `readRoomState` if they are not overwritten.
-                request.data.state_key === undefined
-                    ? this.driver.readRoomEvents(request.data.type, msgtype, limit, null, since)
-                    : this.driver.readStateEvents(request.data.type, stateKey, limit, null)
-            )
-            : (
-                request.data.state_key === undefined
-                    ? await Promise.all(askRoomIds.map(roomId =>
-                        this.driver.readRoomTimeline(roomId, request.data.type, msgtype, stateKey, limit, since),
-                    ))
-                    : await Promise.all(askRoomIds.map(roomId =>
-                        this.driver.readRoomState(roomId, request.data.type, stateKey),
-                    ))
-            ).flat(1);
+        const events =
+            request.data.room_ids === undefined && askRoomIds.length === 0
+                ? await // This returns [] with the current driver of Element Web.
+                  // Add default implementations of the `readRoomEvents` and `readStateEvents`
+                  // methods to use `readRoomTimeline` and `readRoomState` if they are not overwritten.
+                  (request.data.state_key === undefined
+                      ? this.driver.readRoomEvents(request.data.type, msgtype, limit, null, since)
+                      : this.driver.readStateEvents(request.data.type, stateKey, limit, null))
+                : (request.data.state_key === undefined
+                      ? await Promise.all(
+                            askRoomIds.map((roomId) =>
+                                this.driver.readRoomTimeline(
+                                    roomId,
+                                    request.data.type,
+                                    msgtype,
+                                    stateKey,
+                                    limit,
+                                    since,
+                                ),
+                            ),
+                        )
+                      : await Promise.all(
+                            askRoomIds.map((roomId) => this.driver.readRoomState(roomId, request.data.type, stateKey)),
+                        )
+                  ).flat(1);
         this.transport.reply<IReadEventFromWidgetResponseData>(request, { events });
     }
 

test/ClientWidgetApi-test.ts

@@ -1534,7 +1534,7 @@ describe("ClientWidgetApi", () => {
         });
 
         it("reads state events with any state key", async () => {
-            driver.readRoomTimeline.mockResolvedValue([
+            driver.readRoomState.mockResolvedValue([
                 createRoomEvent({ type: "net.example.test", state_key: "A" }),
                 createRoomEvent({ type: "net.example.test", state_key: "B" }),
             ]);
@@ -1556,22 +1556,15 @@ describe("ClientWidgetApi", () => {
             emitEvent(new CustomEvent("", { detail: event }));
 
             await waitFor(() => {
-                expect(transport.reply).toBeCalledWith(event, {
+                expect(transport.reply).toHaveBeenCalledWith(event, {
                     events: [
                         createRoomEvent({ type: "net.example.test", state_key: "A" }),
                         createRoomEvent({ type: "net.example.test", state_key: "B" }),
                     ],
                 });
             });
 
-            expect(driver.readRoomTimeline).toBeCalledWith(
-                "!room-id",
-                "net.example.test",
-                undefined,
-                undefined,
-                0,
-                undefined,
-            );
+            expect(driver.readRoomState).toHaveBeenLastCalledWith("!room-id", "net.example.test", undefined);
         });
 
         it("fails to read state events with any state key", async () => {
@@ -1600,7 +1593,7 @@ describe("ClientWidgetApi", () => {
         });
 
         it("reads state events with a specific state key", async () => {
-            driver.readRoomTimeline.mockResolvedValue([createRoomEvent({ type: "net.example.test", state_key: "B" })]);
+            driver.readRoomState.mockResolvedValue([createRoomEvent({ type: "net.example.test", state_key: "B" })]);
 
             const event: IReadEventFromWidgetActionRequest = {
                 api: WidgetApiDirection.FromWidget,
@@ -1619,19 +1612,12 @@ describe("ClientWidgetApi", () => {
             emitEvent(new CustomEvent("", { detail: event }));
 
             await waitFor(() => {
-                expect(transport.reply).toBeCalledWith(event, {
+                expect(transport.reply).toHaveBeenCalledWith(event, {
                     events: [createRoomEvent({ type: "net.example.test", state_key: "B" })],
                 });
             });
 
-            expect(driver.readRoomTimeline).toBeCalledWith(
-                "!room-id",
-                "net.example.test",
-                undefined,
-                "B",
-                0,
-                undefined,
-            );
+            expect(driver.readRoomState).toHaveBeenLastCalledWith("!room-id", "net.example.test", "B");
         });
 
         it("fails to read state events with a specific state key", async () => {