From b0bd20ea7f91fab9f4643fc0a1e180e1c2aec931 Mon Sep 17 00:00:00 2001
From: Joe Groocock <me@frebib.net>
Date: Mon, 22 Apr 2024 23:15:16 +0100
Subject: [PATCH] Don't update displayname/avatar when unset

Avoid sending no-op updates to the homeserver when there is no
displayname or avatar_url set. The database stores these as empty
strings, but the homeserver returns them as None, so when compared they
appear different and permit an update.

This is a workaround that should fix https://github.com/maubot/maubot/issues/235
by coercing empty strings that are stored in the database to/from
null/None values during saves/loads.

Signed-off-by: Joe Groocock <me@frebib.net>
---
 maubot/client.py    | 12 ++++++------
 maubot/db/client.py |  8 ++++----
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/maubot/client.py b/maubot/client.py
index bdb76fc..5e06a99 100644
--- a/maubot/client.py
+++ b/maubot/client.py
@@ -105,8 +105,8 @@ class Client(DBClient):
             sync=bool(sync),
             autojoin=bool(autojoin),
             online=bool(online),
-            displayname=displayname,
-            avatar_url=avatar_url,
+            displayname=(displayname if displayname != "" else None),
+            avatar_url=(avatar_url if avatar_url != "" else None),
         )
         self._postinited = False
 
@@ -287,9 +287,9 @@ class Client(DBClient):
                 )
             )
             await self.update()
-        if self.displayname != "disable":
+        if self.displayname not in ("disable", None):
             await self.client.set_displayname(self.displayname)
-        if self.avatar_url != "disable":
+        if self.avatar_url not in ("disable", None):
             await self.client.set_avatar_url(self.avatar_url)
         if self.crypto:
             await self._start_crypto()
@@ -376,7 +376,7 @@ class Client(DBClient):
             await self.update()
 
     async def update_displayname(self, displayname: str | None, save: bool = True) -> None:
-        if displayname is None or displayname == self.displayname:
+        if displayname == self.displayname:
             return
         self.displayname = displayname
         if self.displayname != "disable":
@@ -387,7 +387,7 @@ class Client(DBClient):
             await self.update()
 
     async def update_avatar_url(self, avatar_url: ContentURI, save: bool = True) -> None:
-        if avatar_url is None or avatar_url == self.avatar_url:
+        if avatar_url == self.avatar_url:
             return
         self.avatar_url = avatar_url
         if self.avatar_url != "disable":
diff --git a/maubot/db/client.py b/maubot/db/client.py
index 52f3a20..969ad15 100644
--- a/maubot/db/client.py
+++ b/maubot/db/client.py
@@ -44,8 +44,8 @@ class Client(SyncStore):
     autojoin: bool
     online: bool
 
-    displayname: str
-    avatar_url: ContentURI
+    displayname: str | None
+    avatar_url: ContentURI | None
 
     @classmethod
     def _from_row(cls, row: Record | None) -> Client | None:
@@ -71,8 +71,8 @@ class Client(SyncStore):
             self.sync,
             self.autojoin,
             self.online,
-            self.displayname,
-            self.avatar_url,
+            self.displayname or "",
+            self.avatar_url or "",
         )
 
     @classmethod