Merge branch 'develop' into andybalaam/stas-demydiuk-membership-type3

src/utils/RoomUpgrade.ts

@@ -135,7 +135,7 @@ export async function upgradeRoom(
                     EventType.SpaceChild,
                     {
                         ...(currentEv?.getContent() || {}), // copy existing attributes like suggested
-                        via: [cli.getDomain()],
+                        via: [cli.getDomain()!],
                     },
                     newRoomId,
                 );

src/utils/colour.ts

@@ -27,13 +27,13 @@ export function textToHtmlRainbow(str: string): string {
             const [a, b] = generateAB(i * frequency, 1);
             const [red, green, blue] = labToRGB(75, a, b);
             return (
-                '<font color="#' +
+                '<span data-mx-color="#' +
                 red.toString(16).padStart(2, "0") +
                 green.toString(16).padStart(2, "0") +
                 blue.toString(16).padStart(2, "0") +
                 '">' +
                 c +
-                "</font>"
+                "</span>"
             );
         })
         .join("");

src/utils/location/index.ts

@@ -18,6 +18,6 @@ export * from "./findMapStyleUrl";
 export * from "./isSelfLocation";
 export * from "./locationEventGeoUri";
 export * from "./LocationShareErrors";
-export * from "./map";
+export * from "./links";
 export * from "./parseGeoUri";
 export * from "./positionFailureMessage";

src/utils/location/links.ts

@@ -0,0 +1,47 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { MatrixEvent, M_LOCATION } from "matrix-js-sdk/src/matrix";
+
+import { parseGeoUri } from "./parseGeoUri";
+
+export const makeMapSiteLink = (coords: GeolocationCoordinates): string => {
+    return (
+        "https://www.openstreetmap.org/" +
+        `?mlat=${coords.latitude}` +
+        `&mlon=${coords.longitude}` +
+        `#map=16/${coords.latitude}/${coords.longitude}`
+    );
+};
+
+export const createMapSiteLinkFromEvent = (event: MatrixEvent): string | null => {
+    const content = event.getContent();
+    const mLocation = content[M_LOCATION.name];
+    if (mLocation !== undefined) {
+        const uri = mLocation["uri"];
+        if (uri !== undefined) {
+            const geoCoords = parseGeoUri(uri);
+            return geoCoords ? makeMapSiteLink(geoCoords) : null;
+        }
+    } else {
+        const geoUri = content["geo_uri"];
+        if (geoUri) {
+            const geoCoords = parseGeoUri(geoUri);
+            return geoCoords ? makeMapSiteLink(geoCoords) : null;
+        }
+    }
+    return null;
+};

src/utils/location/map.ts

@@ -15,11 +15,10 @@ limitations under the License.
 */
 
 import * as maplibregl from "maplibre-gl";
-import { MatrixClient, MatrixEvent, M_LOCATION } from "matrix-js-sdk/src/matrix";
+import { MatrixClient } from "matrix-js-sdk/src/matrix";
 import { logger } from "matrix-js-sdk/src/logger";
 
 import { _t } from "../../languageHandler";
-import { parseGeoUri } from "./parseGeoUri";
 import { findMapStyleUrl } from "./findMapStyleUrl";
 import { LocationShareError } from "./LocationShareErrors";
 
@@ -75,31 +74,3 @@ export const createMarker = (coords: GeolocationCoordinates, element: HTMLElemen
     }).setLngLat({ lon: coords.longitude, lat: coords.latitude });
     return marker;
 };
-
-export const makeMapSiteLink = (coords: GeolocationCoordinates): string => {
-    return (
-        "https://www.openstreetmap.org/" +
-        `?mlat=${coords.latitude}` +
-        `&mlon=${coords.longitude}` +
-        `#map=16/${coords.latitude}/${coords.longitude}`
-    );
-};
-
-export const createMapSiteLinkFromEvent = (event: MatrixEvent): string | null => {
-    const content = event.getContent();
-    const mLocation = content[M_LOCATION.name];
-    if (mLocation !== undefined) {
-        const uri = mLocation["uri"];
-        if (uri !== undefined) {
-            const geoCoords = parseGeoUri(uri);
-            return geoCoords ? makeMapSiteLink(geoCoords) : null;
-        }
-    } else {
-        const geoUri = content["geo_uri"];
-        if (geoUri) {
-            const geoCoords = parseGeoUri(geoUri);
-            return geoCoords ? makeMapSiteLink(geoCoords) : null;
-        }
-    }
-    return null;
-};

src/utils/location/useMap.ts

@@ -15,8 +15,8 @@ limitations under the License.
 */
 
 import { useEffect, useState } from "react";
-import { Map as MapLibreMap } from "maplibre-gl";
 
+import type { Map as MapLibreMap } from "maplibre-gl";
 import { createMap } from "./map";
 import { useMatrixClientContext } from "../../contexts/MatrixClientContext";
 

src/utils/notifications.ts

@@ -21,6 +21,7 @@ import {
     Room,
     LocalNotificationSettings,
     ReceiptType,
+    IMarkedUnreadEvent,
 } from "matrix-js-sdk/src/matrix";
 import { IndicatorIcon } from "@vector-im/compound-web";
 
@@ -28,6 +29,19 @@ import SettingsStore from "../settings/SettingsStore";
 import { NotificationLevel } from "../stores/notifications/NotificationLevel";
 import { doesRoomHaveUnreadMessages } from "../Unread";
 
+// MSC2867 is not yet spec at time of writing. We read from both stable
+// and unstable prefixes and accept the risk that the format may change,
+// since the stable prefix is not actually defined yet.
+
+/**
+ * Unstable identifier for the marked_unread event, per MSC2867
+ */
+export const MARKED_UNREAD_TYPE_UNSTABLE = "com.famedly.marked_unread";
+/**
+ * Stable identifier for the marked_unread event
+ */
+export const MARKED_UNREAD_TYPE_STABLE = "m.marked_unread";
+
 export const deviceNotificationSettingsKeys = [
     "notificationsEnabled",
     "notificationBodyEnabled",
@@ -74,6 +88,8 @@ export function localNotificationsAreSilenced(cli: MatrixClient): boolean {
 export async function clearRoomNotification(room: Room, client: MatrixClient): Promise<{} | undefined> {
     const lastEvent = room.getLastLiveEvent();
 
+    await setMarkedUnreadState(room, client, false);
+
     try {
         if (lastEvent) {
             const receiptType = SettingsStore.getValue("sendReadReceipts", room.roomId)
@@ -117,6 +133,39 @@ export function clearAllNotifications(client: MatrixClient): Promise<Array<{} |
     return Promise.all(receiptPromises);
 }
 
+/**
+ * Gives the marked_unread state of the given room
+ * @param room The room to check
+ * @returns - The marked_unread state of the room, or undefined if no explicit state is set.
+ */
+export function getMarkedUnreadState(room: Room): boolean | undefined {
+    const currentStateStable = room.getAccountData(MARKED_UNREAD_TYPE_STABLE)?.getContent<IMarkedUnreadEvent>()?.unread;
+    const currentStateUnstable = room
+        .getAccountData(MARKED_UNREAD_TYPE_UNSTABLE)
+        ?.getContent<IMarkedUnreadEvent>()?.unread;
+    return currentStateStable ?? currentStateUnstable;
+}
+
+/**
+ * Sets the marked_unread state of the given room. This sets some room account data that indicates to
+ * clients that the user considers this room to be 'unread', but without any actual notifications.
+ *
+ * @param room The room to set
+ * @param client MatrixClient object to use
+ * @param unread The new marked_unread state of the room
+ */
+export async function setMarkedUnreadState(room: Room, client: MatrixClient, unread: boolean): Promise<void> {
+    // if there's no event, treat this as false as we don't need to send the flag to clear it if the event isn't there
+    const currentState = getMarkedUnreadState(room);
+
+    if (Boolean(currentState) !== unread) {
+        // Assuming MSC2867 passes FCP with no changes, we should update to start writing
+        // the flag to the stable prefix (or both) and then ultimately use only the
+        // stable prefix.
+        await client.setRoomAccountData(room.roomId, MARKED_UNREAD_TYPE_UNSTABLE, { unread });
+    }
+}
+
 /**
  * A helper to transform a notification color to the what the Compound Icon Button
  * expects