Let the client only send UpdateState if the widget supports it.

Author: toger5

src/ClientWidgetApi.ts

@@ -40,7 +40,7 @@ import {
     ISupportedVersionsActionRequest,
     ISupportedVersionsActionResponseData,
 } from "./interfaces/SupportedVersionsAction";
-import { CurrentApiVersions } from "./interfaces/ApiVersion";
+import { ApiVersion, CurrentApiVersions, UnstableApiVersion } from "./interfaces/ApiVersion";
 import { IScreenshotActionResponseData } from "./interfaces/ScreenshotAction";
 import { IVisibilityActionRequestData } from "./interfaces/VisibilityAction";
 import { IWidgetApiAcknowledgeResponseData, IWidgetApiResponseData } from "./interfaces/IWidgetApiResponse";
@@ -138,6 +138,7 @@ import { IUpdateStateToWidgetRequestData } from "./interfaces/UpdateStateAction"
 export class ClientWidgetApi extends EventEmitter {
     public readonly transport: ITransport;
 
+    private cachedWidgetVersions: ApiVersion[] | null = null;
     // contentLoadedActionSent is used to check that only one ContentLoaded request is send.
     private contentLoadedActionSent = false;
     private allowedCapabilities = new Set<Capability>();
@@ -227,6 +228,24 @@ export class ClientWidgetApi extends EventEmitter {
         this.transport.stop();
     }
 
+    public async getWidgetVersions(): Promise<ApiVersion[]> {
+        if (Array.isArray(this.cachedWidgetVersions)) {
+            return Promise.resolve(this.cachedWidgetVersions);
+        }
+
+        try {
+            const r = await this.transport.send<IWidgetApiRequestEmptyData, ISupportedVersionsActionResponseData>(
+                WidgetApiToWidgetAction.SupportedApiVersions,
+                {},
+            );
+            this.cachedWidgetVersions = r.supported_versions;
+            return r.supported_versions;
+        } catch (e) {
+            console.warn("non-fatal error getting supported widget versions: ", e);
+            return [];
+        }
+    }
+
     private beginCapabilities(): void {
         // widget has loaded - tell all the listeners that
         this.emit("preparing");
@@ -1013,7 +1032,7 @@ export class ClientWidgetApi extends EventEmitter {
     public async feedEvent(rawEvent: IRoomEvent, currentViewedRoomId: string): Promise<void>;
     /**
      * Feeds an event to the widget. As a client you are expected to call this
-     * for every new event in every room to which you are joined or invited.
+     * for every new event (including state events) in every room to which you are joined or invited.
      * @param {IRoomEvent} rawEvent The event to (try to) send to the widget.
      * @returns {Promise<void>} Resolves when delivered or if the widget is not
      *   able to read the event due to permissions, rejects if the widget failed
@@ -1082,6 +1101,7 @@ export class ClientWidgetApi extends EventEmitter {
     }
 
     private async flushRoomState(): Promise<void> {
+        const useUpdateState = (await this.getWidgetVersions()).includes(UnstableApiVersion.MSC2762_UPDATE_STATE);
         try {
             // Only send a single action once all concurrent tasks have completed
             do await Promise.all([...this.pushRoomStateTasks]);
@@ -1093,10 +1113,11 @@ export class ClientWidgetApi extends EventEmitter {
                     events.push(...stateKeyMap.values());
                 }
             }
-            await this.transport.send<IUpdateStateToWidgetRequestData>(
-                WidgetApiToWidgetAction.UpdateState,
-                { state: events },
-            );
+            if (useUpdateState) {
+                await this.transport.send<IUpdateStateToWidgetRequestData>(WidgetApiToWidgetAction.UpdateState, {
+                    state: events,
+                });
+            }
         } finally {
             this.flushRoomStateTask = null;
         }
@@ -1146,7 +1167,7 @@ export class ClientWidgetApi extends EventEmitter {
                 // Assuming no other tasks are already happening concurrently,
                 // schedule the widget action that actually pushes the events
                 this.flushRoomStateTask ??= this.flushRoomState();
-                this.flushRoomStateTask.catch(e => console.error('Failed to push room state', e));
+                this.flushRoomStateTask.catch((e) => console.error("Failed to push room state", e));
             }
         }
     }
@@ -1162,18 +1183,22 @@ export class ClientWidgetApi extends EventEmitter {
          widget failed to handle the update.
      */
     public async feedStateUpdate(rawEvent: IRoomEvent): Promise<void> {
-        if (rawEvent.state_key === undefined) throw new Error('Not a state event');
+        const useUpdateState = (await this.getWidgetVersions()).includes(UnstableApiVersion.MSC2762_UPDATE_STATE);
+
+        if (rawEvent.state_key === undefined) throw new Error("Not a state event");
         if (
-            (rawEvent.room_id === this.viewedRoomId || this.canUseRoomTimeline(rawEvent.room_id))
-            && this.canReceiveStateEvent(rawEvent.type, rawEvent.state_key)
+            (rawEvent.room_id === this.viewedRoomId || this.canUseRoomTimeline(rawEvent.room_id)) &&
+            this.canReceiveStateEvent(rawEvent.type, rawEvent.state_key)
         ) {
             // Updates could race with the initial push of the room's state
             if (this.pushRoomStateTasks.size === 0) {
                 // No initial push tasks are pending; safe to send immediately
-                await this.transport.send<IUpdateStateToWidgetRequestData>(
-                    WidgetApiToWidgetAction.UpdateState,
-                    { state: [rawEvent] },
-                );
+                if (useUpdateState) {
+                    // Only send state updates when using UpdateState. Otherwise we will use SendEvent.
+                    await this.transport.send<IUpdateStateToWidgetRequestData>(WidgetApiToWidgetAction.UpdateState, {
+                        state: [rawEvent],
+                    });
+                }
             } else {
                 // Lump the update in with whatever data will be sent in the
                 // initial push later. Even if we set it to an "outdated" entry