From 23c5446324a8658ed318f5391b270afe5df3bf86 Mon Sep 17 00:00:00 2001
From: Tulir Asokan <tulir@maunium.net>
Date: Sat, 10 Aug 2024 16:08:41 +0300
Subject: [PATCH] bridgev2/provisioning: nest bridge state in whoami response

---
 bridge/status/bridgestate.go    | 11 ++++++-----
 bridgev2/matrix/provisioning.go | 30 +++++++++++++++++++++---------
 bridgev2/userlogin.go           |  2 +-
 3 files changed, 28 insertions(+), 15 deletions(-)

diff --git a/bridge/status/bridgestate.go b/bridge/status/bridgestate.go
index 90f228d4..72e61415 100644
--- a/bridge/status/bridgestate.go
+++ b/bridge/status/bridgestate.go
@@ -18,6 +18,7 @@ import (
 
 	"github.com/tidwall/sjson"
 	"go.mau.fi/util/jsontime"
+	"go.mau.fi/util/ptr"
 	"golang.org/x/exp/maps"
 
 	"maunium.net/go/mautrix"
@@ -89,10 +90,10 @@ type BridgeState struct {
 	Error   BridgeStateErrorCode `json:"error,omitempty"`
 	Message string               `json:"message,omitempty"`
 
-	UserID        id.UserID     `json:"user_id,omitempty"`
-	RemoteID      string        `json:"remote_id,omitempty"`
-	RemoteName    string        `json:"remote_name,omitempty"`
-	RemoteProfile RemoteProfile `json:"remote_profile,omitempty"`
+	UserID        id.UserID      `json:"user_id,omitempty"`
+	RemoteID      string         `json:"remote_id,omitempty"`
+	RemoteName    string         `json:"remote_name,omitempty"`
+	RemoteProfile *RemoteProfile `json:"remote_profile,omitempty"`
 
 	Reason string                 `json:"reason,omitempty"`
 	Info   map[string]interface{} `json:"info,omitempty"`
@@ -186,7 +187,7 @@ func (pong *BridgeState) SendHTTP(ctx context.Context, url, token string) error
 func (pong *BridgeState) ShouldDeduplicate(newPong *BridgeState) bool {
 	return pong != nil &&
 		pong.StateEvent == newPong.StateEvent &&
-		pong.RemoteProfile == newPong.RemoteProfile &&
+		ptr.Val(pong.RemoteProfile) == ptr.Val(newPong.RemoteProfile) &&
 		pong.Error == newPong.Error &&
 		maps.EqualFunc(pong.Info, newPong.Info, reflect.DeepEqual) &&
 		pong.Timestamp.Add(time.Duration(pong.TTL)*time.Second).After(time.Now())
diff --git a/bridgev2/matrix/provisioning.go b/bridgev2/matrix/provisioning.go
index c3b8c3dc..5d9e1b8e 100644
--- a/bridgev2/matrix/provisioning.go
+++ b/bridgev2/matrix/provisioning.go
@@ -272,19 +272,25 @@ type RespWhoami struct {
 	BridgeBot     id.UserID            `json:"bridge_bot"`
 	CommandPrefix string               `json:"command_prefix"`
 
-	ManagementRoom id.RoomID         `json:"management_room"`
+	ManagementRoom id.RoomID         `json:"management_room,omitempty"`
 	Logins         []RespWhoamiLogin `json:"logins"`
 }
 
 type RespWhoamiLogin struct {
-	StateEvent  status.BridgeStateEvent `json:"state_event"`
-	StateTS     jsontime.Unix           `json:"state_ts"`
-	StateReason string                  `json:"state_reason,omitempty"`
-	StateInfo   map[string]any          `json:"state_info,omitempty"`
-	ID          networkid.UserLoginID   `json:"id"`
-	Name        string                  `json:"name"`
-	Profile     status.RemoteProfile    `json:"profile"`
-	SpaceRoom   id.RoomID               `json:"space_room"`
+	// Deprecated
+	StateEvent status.BridgeStateEvent `json:"state_event"`
+	// Deprecated
+	StateTS jsontime.Unix `json:"state_ts"`
+	// Deprecated
+	StateReason string `json:"state_reason,omitempty"`
+	// Deprecated
+	StateInfo map[string]any `json:"state_info,omitempty"`
+
+	State     status.BridgeState    `json:"state"`
+	ID        networkid.UserLoginID `json:"id"`
+	Name      string                `json:"name"`
+	Profile   status.RemoteProfile  `json:"profile"`
+	SpaceRoom id.RoomID             `json:"space_room,omitempty"`
 }
 
 func (prov *ProvisioningAPI) GetWhoami(w http.ResponseWriter, r *http.Request) {
@@ -301,11 +307,17 @@ func (prov *ProvisioningAPI) GetWhoami(w http.ResponseWriter, r *http.Request) {
 	resp.Logins = make([]RespWhoamiLogin, len(logins))
 	for i, login := range logins {
 		prevState := login.BridgeState.GetPrevUnsent()
+		// Clear redundant fields
+		prevState.UserID = ""
+		prevState.RemoteID = ""
+		prevState.RemoteName = ""
+		prevState.RemoteProfile = nil
 		resp.Logins[i] = RespWhoamiLogin{
 			StateEvent:  prevState.StateEvent,
 			StateTS:     prevState.Timestamp,
 			StateReason: prevState.Reason,
 			StateInfo:   prevState.Info,
+			State:       prevState,
 
 			ID:        login.ID,
 			Name:      login.RemoteName,
diff --git a/bridgev2/userlogin.go b/bridgev2/userlogin.go
index d1711b31..017df773 100644
--- a/bridgev2/userlogin.go
+++ b/bridgev2/userlogin.go
@@ -476,7 +476,7 @@ func (ul *UserLogin) FillBridgeState(state status.BridgeState) status.BridgeStat
 	state.UserID = ul.UserMXID
 	state.RemoteID = string(ul.ID)
 	state.RemoteName = ul.RemoteName
-	state.RemoteProfile = ul.RemoteProfile
+	state.RemoteProfile = &ul.RemoteProfile
 	filler, ok := ul.Client.(status.StandaloneCustomBridgeStateFiller)
 	if ok {
 		return filler.FillBridgeState(state)