Add tests

Author: AndrewFerr

spec/unit/embedded.spec.ts

@@ -59,8 +59,35 @@ class MockWidgetApi extends EventEmitter {
     public requestCapabilityToReceiveState = jest.fn();
     public requestCapabilityToSendToDevice = jest.fn();
     public requestCapabilityToReceiveToDevice = jest.fn();
-    public sendRoomEvent = jest.fn(() => ({ event_id: `$${Math.random()}` }));
-    public sendStateEvent = jest.fn(() => ({ event_id: `$${Math.random()}` }));
+    public sendRoomEvent = jest.fn(
+        (eventType: string, content: unknown, roomId?: string, futureTimeout?: number, futureGroupId?: string) =>
+            futureTimeout === undefined && futureGroupId === undefined
+                ? { event_id: `$${Math.random()}` }
+                : {
+                      future_group_id: futureGroupId ?? `fg-${Math.random()}`,
+                      send_token: `st-${Math.random()}`,
+                      cancel_token: `ct-${Math.random()}`,
+                      refresh_token: `rt-${Math.random()}`,
+                  },
+    );
+    public sendStateEvent = jest.fn(
+        (
+            eventType: string,
+            stateKey: string,
+            content: unknown,
+            roomId?: string,
+            futureTimeout?: number,
+            futureGroupId?: string,
+        ) =>
+            futureTimeout === undefined && futureGroupId === undefined
+                ? { event_id: `$${Math.random()}` }
+                : {
+                      future_group_id: futureGroupId ?? `fg-${Math.random()}`,
+                      send_token: `st-${Math.random()}`,
+                      cancel_token: `ct-${Math.random()}`,
+                      refresh_token: `rt-${Math.random()}`,
+                  },
+    );
     public sendToDevice = jest.fn();
     public requestOpenIDConnectToken = jest.fn(() => {
         return testOIDCToken;
@@ -160,6 +187,106 @@ describe("RoomWidgetClient", () => {
         });
     });
 
+    describe("futures", () => {
+        const doesServerSupportUnstableFeatureMock = jest.fn((feature) =>
+            Promise.resolve(feature === "org.matrix.msc4140"),
+        );
+
+        beforeAll(() => {
+            MatrixClient.prototype.doesServerSupportUnstableFeature = doesServerSupportUnstableFeatureMock;
+        });
+
+        afterAll(() => {
+            doesServerSupportUnstableFeatureMock.mockClear();
+        });
+
+        it("sends futures in a new group for message events", async () => {
+            await makeClient({ sendEvent: ["org.matrix.rageshake_request"] });
+            expect(widgetApi.requestCapabilityForRoomTimeline).toHaveBeenCalledWith("!1:example.org");
+            expect(widgetApi.requestCapabilityToSendEvent).toHaveBeenCalledWith("org.matrix.rageshake_request");
+            const futureOpts = {
+                future_timeout: 2000,
+            };
+            await client._unstable_sendFuture("!1:example.org", futureOpts, null, "org.matrix.rageshake_request", {
+                request_id: 123,
+            });
+            expect(widgetApi.sendRoomEvent).toHaveBeenCalledWith(
+                "org.matrix.rageshake_request",
+                { request_id: 123 },
+                "!1:example.org",
+                futureOpts.future_timeout,
+                undefined,
+            );
+        });
+
+        it("sends action futures in an existing group for message events", async () => {
+            await makeClient({ sendEvent: ["org.matrix.rageshake_request"] });
+            expect(widgetApi.requestCapabilityForRoomTimeline).toHaveBeenCalledWith("!1:example.org");
+            expect(widgetApi.requestCapabilityToSendEvent).toHaveBeenCalledWith("org.matrix.rageshake_request");
+            const futureOpts = {
+                future_group_id: "fg",
+            };
+            await client._unstable_sendFuture("!1:example.org", futureOpts, null, "org.matrix.rageshake_request", {
+                request_id: 123,
+            });
+            expect(widgetApi.sendRoomEvent).toHaveBeenCalledWith(
+                "org.matrix.rageshake_request",
+                { request_id: 123 },
+                "!1:example.org",
+                undefined,
+                futureOpts.future_group_id,
+            );
+        });
+
+        it("sends futures in a new group for state events", async () => {
+            await makeClient({ sendState: [{ eventType: "org.example.foo", stateKey: "bar" }] });
+            expect(widgetApi.requestCapabilityForRoomTimeline).toHaveBeenCalledWith("!1:example.org");
+            expect(widgetApi.requestCapabilityToSendState).toHaveBeenCalledWith("org.example.foo", "bar");
+            const futureOpts = {
+                future_timeout: 2000,
+            };
+            await client._unstable_sendStateFuture(
+                "!1:example.org",
+                futureOpts,
+                "org.example.foo",
+                { hello: "world" },
+                "bar",
+            );
+            expect(widgetApi.sendStateEvent).toHaveBeenCalledWith(
+                "org.example.foo",
+                "bar",
+                { hello: "world" },
+                "!1:example.org",
+                futureOpts.future_timeout,
+                undefined,
+            );
+        });
+
+        it("sends action futures in an existing group for state events", async () => {
+            await makeClient({ sendState: [{ eventType: "org.example.foo", stateKey: "bar" }] });
+            expect(widgetApi.requestCapabilityForRoomTimeline).toHaveBeenCalledWith("!1:example.org");
+            expect(widgetApi.requestCapabilityToSendState).toHaveBeenCalledWith("org.example.foo", "bar");
+            const futureOpts = {
+                future_group_id: "fg",
+            };
+            await client._unstable_sendStateFuture(
+                "!1:example.org",
+                futureOpts,
+                "org.example.foo",
+                { hello: "world" },
+                "bar",
+            );
+            expect(widgetApi.sendStateEvent).toHaveBeenCalledWith(
+                "org.example.foo",
+                "bar",
+                { hello: "world" },
+                "!1:example.org",
+                undefined,
+                futureOpts.future_group_id,
+            );
+        });
+    });
+
     describe("initialization", () => {
         it("requests permissions for specific message types", async () => {
             await makeClient({ sendMessage: [MsgType.Text], receiveMessage: [MsgType.Text] });