Switch tag order from strings to floats, as The Spec preaches

The Spec wasn't entirely consistent on this until recently but floats actually are used in the wild, rather than strings.

4 files changed, 65 insertions, 57 deletions

diff --git a/lib/converters.h b/lib/converters.h
index 1e828393..7f78effe 100644
--- a/lib/converters.h
+++ b/lib/converters.h
@@ -163,6 +163,11 @@ namespace QMatrixClient
         auto operator()(const QJsonValue& jv) const { return jv.toDouble(); }
     };
 
+    template <> struct FromJson<float>
+    {
+        auto operator()(const QJsonValue& jv) const { return float(jv.toDouble()); }
+    };
+
     template <> struct FromJson<qint64>
     {
         auto operator()(const QJsonValue& jv) const { return qint64(jv.toDouble()); }
diff --git a/lib/events/accountdataevents.h b/lib/events/accountdataevents.h
index 94fc510a..27f6c77c 100644
--- a/lib/events/accountdataevents.h
+++ b/lib/events/accountdataevents.h
@@ -31,22 +31,40 @@ namespace QMatrixClient
 
     struct TagRecord
     {
-        TagRecord (QString order = {}) : order(std::move(order)) { }
-        explicit TagRecord(const QJsonValue& jv)
-            : order(jv.toObject().value("order"_ls).toString())
-        { }
+        using order_type = Omittable<float>;
+
+        order_type order;
 
-        QString order;
+        TagRecord (order_type order = none) : order(order) { }
+        explicit TagRecord(const QJsonValue& jv)
+        {
+            // Parse a float both from JSON double and JSON string because
+            // libqmatrixclient previously used to use strings to store order.
+            const auto orderJv = jv.toObject().value("order"_ls);
+            if (orderJv.isDouble())
+                order = fromJson<float>(orderJv);
+            else if (orderJv.isString())
+            {
+                bool ok;
+                order = orderJv.toString().toFloat(&ok);
+                if (!ok)
+                    order = none;
+            }
+        }
 
-        bool operator==(const TagRecord& other) const
-            { return order == other.order; }
-        bool operator!=(const TagRecord& other) const
-            { return !operator==(other); }
+        bool operator<(const TagRecord& other) const
+        {
+            // Per The Spec, rooms with no order should be after those with order
+            return !order.omitted() &&
+                        (other.order.omitted() || order.value() < other.order.value());
+        }
     };
 
     inline QJsonValue toJson(const TagRecord& rec)
     {
-        return QJsonObject {{ QStringLiteral("order"), rec.order }};
+        QJsonObject o;
+        addParam(o, QStringLiteral("order"), rec.order);
+        return o;
     }
 
     using TagsMap = QHash<QString, TagRecord>;
diff --git a/lib/room.cpp b/lib/room.cpp
index 07c39498..18b06b7d 100644
--- a/lib/room.cpp
+++ b/lib/room.cpp
@@ -233,14 +233,13 @@ class Room::Private
          */
         bool processRedaction(const RedactionEvent& redaction);
 
-        std::pair<TagsMap, QStringList> setTags(TagsMap newTags);
-        void broadcastTagUpdates(const TagsMap& additions,
-                                 const QStringList& removals)
+        void setTags(TagsMap newTags);
+        void sendTagUpdates()
         {
             connection->callApi<SetAccountDataPerRoomJob>(
                     connection->userId(), id, TagEvent::matrixTypeId(),
                         TagEvent(tags).contentJson());
-            emit q->tagsChanged(additions, removals);
+            emit q->tagsChanged();
         }
 
         QJsonObject toJson() const;
@@ -695,7 +694,7 @@ std::pair<bool, QString> validatedTag(QString name)
         return { false, name };
 
     qWarning(MAIN) << "The tag" << name
-        << "doesn't follow the CS API conventions, check your client code";
+                   << "doesn't follow the CS API conventions";
     name.prepend("u.");
     qWarning(MAIN) << "Using " << name << "instead";
 
@@ -709,8 +708,10 @@ void Room::addTag(const QString& name, const TagRecord& record)
             (checkRes.first && d->tags.contains(checkRes.second)))
         return;
 
+    emit tagsAboutToChange();
     d->tags.insert(checkRes.second, record);
-    d->broadcastTagUpdates({{ checkRes.second, record }}, {});
+    emit tagsChanged();
+    d->sendTagUpdates();
 }
 
 void Room::addTag(const QString& name, const QString& order)
@@ -720,43 +721,32 @@ void Room::addTag(const QString& name, const QString& order)
 
 void Room::removeTag(const QString& name)
 {
-    if (!d->tags.contains(name))
-        return;
-
-    d->tags.remove(name);
-    d->broadcastTagUpdates({}, {{ name }});
+    if (d->tags.contains(name))
+    {
+        emit tagsAboutToChange();
+        d->tags.remove(name);
+        emit tagsChanged();
+        d->sendTagUpdates();
+    } else if (!name.startsWith("u."))
+        removeTag("u." + name);
+    else
+        qWarning(MAIN) << "Tag" << name << "on room" << objectName()
+                       << "not found, nothing to remove";
 }
 
 void Room::setTags(TagsMap newTags)
 {
-    const auto& changes = d->setTags(move(newTags));
-    d->broadcastTagUpdates(changes.first, changes.second);
+    d->setTags(move(newTags));
+    d->sendTagUpdates();
 }
 
-std::pair<TagsMap, QStringList> Room::Private::setTags(TagsMap newTags)
+void Room::Private::setTags(TagsMap newTags)
 {
-    if (newTags == tags)
-        return {};
-
-    TagsMap additions;
-    const auto& tagNames = newTags.keys();
-    for (const auto& t: tagNames)
-    {
-        const auto& checkRes = validatedTag(t);
-        const auto& value = checkRes.first ?
-                newTags.insert(checkRes.second, newTags.take(t)).value() :
-                newTags.value(checkRes.second);
-        if (!tags.contains(checkRes.second))
-            additions.insert(checkRes.second, value);
-    }
-
-    QStringList removals;
-    for (const auto& tag: tags.keys())
-        if (!newTags.contains(tag))
-            removals.push_back(tag);
-
-    tags = newTags;
-    return { additions, removals };
+    emit q->tagsAboutToChange();
+    tags = move(newTags);
+    qCDebug(MAIN) << "Room" << id << "is tagged with:"
+                  << q->tagNames().join(", ");
+    emit q->tagsChanged();
 }
 
 bool Room::isFavourite() const
@@ -1843,15 +1833,8 @@ void Room::processEphemeralEvent(EventPtr&& event)
 void Room::processAccountDataEvent(EventPtr&& event)
 {
     if (auto* evt = eventCast<TagEvent>(event))
-    {
-        const auto& changes = d->setTags(evt->tags());
-        if (!(changes.first.empty() && changes.second.empty()))
-        {
-            qCDebug(MAIN) << "Room" << id() << "is tagged with:"
-                          << tagNames().join(", ");
-            emit tagsChanged(changes.first, changes.second);
-        }
-    }
+        d->setTags(evt->tags());
+
     if (auto* evt = eventCast<ReadMarkerEvent>(event))
     {
         auto readEventId = evt->event_id();
@@ -1869,6 +1852,7 @@ void Room::processAccountDataEvent(EventPtr&& event)
     // efficient; maaybe do it another day
     if (!currentData || currentData->contentJson() != event->contentJson())
     {
+        emit accountDataAboutToChange(event->matrixType());
         currentData = move(event);
         qCDebug(MAIN) << "Updated account data of type"
                       << currentData->matrixType();
diff --git a/lib/room.h b/lib/room.h
index 75cd7354..4f73003a 100644
--- a/lib/room.h
+++ b/lib/room.h
@@ -390,9 +390,10 @@ namespace QMatrixClient
             void readMarkerMoved(QString fromEventId, QString toEventId);
             void unreadMessagesChanged(Room* room);
 
+            void accountDataAboutToChange(QString type);
             void accountDataChanged(QString type);
-            void tagsChanged(const TagsMap& additions,
-                             const QStringList& removals);
+            void tagsAboutToChange();
+            void tagsChanged();
 
             void replacedEvent(const RoomEvent* newEvent,
                                const RoomEvent* oldEvent);