Modal Widget close actions are not interpreted anymore

[dhenneke]

Steps to reproduce

1. Open a new modal from a widget with matrixWidgetApi.openModalWidget(...).
2. Await the closing message with matrixWidgetApi.on('action:close_modal', ...).
3. Close the widget with matrixWidgetApi.closeModalWidget(...).

Outcome

What did you expect?

The close message is received by the event handler.

What happened instead?

The event is ignored and element throws an error.

---

This seems to be introduced by matrix-org/matrix-react-sdk#8052.

In the code, the ModalWidgetStore#closeModalWidget() call forwards the optional! widgetRoomId to WidgetMessagingStore#getMessaging() that has a required! widgetRoomId argument. Finally, WidgetUtils#calcWidgetUid(...) returns user_<widget-id> instead of room_<room-id>_<widget-id>.

The solution seems to be that the StopGapWidget should forward the correct room id:

  private onOpenModal = async (ev: CustomEvent<IModalWidgetOpenRequest>) => {
      ev.preventDefault();
      if (ModalWidgetStore.instance.canOpenModalWidget()) {
-         ModalWidgetStore.instance.openModalWidget(ev.detail.data, this.mockWidget);
+         ModalWidgetStore.instance.openModalWidget(ev.detail.data, this.mockWidget, this.roomId);
          this.messaging.transport.reply(ev.detail, {}); // ack
      } else {
          this.messaging.transport.reply(ev.detail, {
              error: {
                  message: "Unable to open modal at this time",
              },
          });
      }
  };

The string vs string | undefined situation is still not optimal, but at least the correct id is generated in my tests.

Operating system

No response

Browser information

No response

URL for webapp

No response

Application version

No response

Homeserver

No response

Will you send logs?

No