Merge tag 'v15.1.0' into sc

* Mark old verification methods as deprecated ([\matrix-org#1994](matrix-org#1994)).
* Try to set a sender on search result events if possible ([\matrix-org#2004](matrix-org#2004)).
* Port some changes from group calls branch to develop ([\matrix-org#2001](matrix-org#2001)). Contributed by @SimonBrandner.
* Fetch room membership from server rather than relying on stored data ([\matrix-org#1998](matrix-org#1998)).
* Add method to fetch the MSC3266 Room Summary of a Room ([\matrix-org#1988](matrix-org#1988)).
* Don't show `Unable to access microphone` when cancelling screensharing dialog ([\matrix-org#2005](matrix-org#2005)). Fixes element-hq/element-web#19533 and element-hq/element-web#19533. Contributed by @SimonBrandner.
* Strip direction override characters from display names ([\matrix-org#1992](matrix-org#1992)). Fixes element-hq/element-web#1712 and element-hq/element-web#1712.

Author: su-ex

CHANGELOG.md

@@ -1,3 +1,35 @@
+Changes in [15.1.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v15.1.0) (2021-11-08)
+==================================================================================================
+
+## 🦖 Deprecations
+ * Mark old verification methods as deprecated ([\#1994](https://github.com/matrix-org/matrix-js-sdk/pull/1994)).
+
+## ✨ Features
+ * Try to set a sender on search result events if possible ([\#2004](https://github.com/matrix-org/matrix-js-sdk/pull/2004)).
+ * Port some changes from group calls branch to develop ([\#2001](https://github.com/matrix-org/matrix-js-sdk/pull/2001)). Contributed by @SimonBrandner.
+ * Fetch room membership from server rather than relying on stored data ([\#1998](https://github.com/matrix-org/matrix-js-sdk/pull/1998)).
+ * Add method to fetch the MSC3266 Room Summary of a Room ([\#1988](https://github.com/matrix-org/matrix-js-sdk/pull/1988)).
+
+## 🐛 Bug Fixes
+ * Don't show `Unable to access microphone` when cancelling screensharing dialog ([\#2005](https://github.com/matrix-org/matrix-js-sdk/pull/2005)). Fixes vector-im/element-web#19533 and vector-im/element-web#19533. Contributed by @SimonBrandner.
+ * Strip direction override characters from display names ([\#1992](https://github.com/matrix-org/matrix-js-sdk/pull/1992)). Fixes vector-im/element-web#1712 and vector-im/element-web#1712.
+
+Changes in [15.1.0-rc.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v15.1.0-rc.1) (2021-11-02)
+============================================================================================================
+
+## 🦖 Deprecations
+ * Mark old verification methods as deprecated ([\#1994](https://github.com/matrix-org/matrix-js-sdk/pull/1994)).
+
+## ✨ Features
+ * Try to set a sender on search result events if possible ([\#2004](https://github.com/matrix-org/matrix-js-sdk/pull/2004)).
+ * Port some changes from group calls branch to develop ([\#2001](https://github.com/matrix-org/matrix-js-sdk/pull/2001)). Contributed by @SimonBrandner.
+ * Fetch room membership from server rather than relying on stored data ([\#1998](https://github.com/matrix-org/matrix-js-sdk/pull/1998)).
+ * Add method to fetch the MSC3266 Room Summary of a Room ([\#1988](https://github.com/matrix-org/matrix-js-sdk/pull/1988)).
+
+## 🐛 Bug Fixes
+ * Don't show `Unable to access microphone` when cancelling screensharing dialog ([\#2005](https://github.com/matrix-org/matrix-js-sdk/pull/2005)). Fixes vector-im/element-web#19533 and vector-im/element-web#19533. Contributed by @SimonBrandner.
+ * Strip direction override characters from display names ([\#1992](https://github.com/matrix-org/matrix-js-sdk/pull/1992)). Fixes vector-im/element-web#1712 and vector-im/element-web#1712.
+
 Changes in [15.0.0](https://github.com/vector-im/element-desktop/releases/tag/v15.0.0) (2021-10-25)
 ===================================================================================================
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "matrix-js-sdk",
-  "version": "15.0.0",
+  "version": "15.1.0",
   "description": "Matrix Client-Server SDK for Javascript",
   "scripts": {
     "prepublishOnly": "yarn build",
@@ -81,7 +81,7 @@
     "@types/request": "^2.48.5",
     "@typescript-eslint/eslint-plugin": "^4.17.0",
     "@typescript-eslint/parser": "^4.17.0",
-    "allchange": "^1.0.2",
+    "allchange": "^1.0.5",
     "babel-jest": "^26.6.3",
     "babelify": "^10.0.0",
     "better-docs": "^2.4.0-beta.9",

src/client.ts

@@ -671,6 +671,12 @@ interface IThirdPartyUser {
     protocol: string;
     fields: object;
 }
+
+interface IRoomSummary extends Omit<IPublicRoomsChunkRoom, "canonical_alias" | "aliases"> {
+    room_type?: RoomType;
+    membership?: string;
+    is_encrypted: boolean;
+}
 /* eslint-enable camelcase */
 
 /**
@@ -1749,6 +1755,7 @@ export class MatrixClient extends EventEmitter {
      * @param {string} deviceId the device to verify
      *
      * @returns {Verification} a verification object
+     * @deprecated Use `requestVerification` instead.
      */
     public beginKeyVerification(method: string, userId: string, deviceId: string): Verification {
         if (!this.crypto) {
@@ -1911,6 +1918,7 @@ export class MatrixClient extends EventEmitter {
         return this.crypto.checkCrossSigningPrivateKey(privateKey, expectedPublicKey);
     }
 
+    // deprecated: use requestVerification instead
     public legacyDeviceVerification(
         userId: string,
         deviceId: string,
@@ -3397,15 +3405,15 @@ export class MatrixClient extends EventEmitter {
     /**
      * @param {string} roomId
      * @param {object} eventObject An object with the partial structure of an event, to which event_id, user_id, room_id and origin_server_ts will be added.
-     * @param {string} txnId the txnId.
+     * @param {string} txnId Optional.
      * @param {module:client.callback} callback Optional.
      * @return {Promise} Resolves: to an empty object {}
      * @return {module:http-api.MatrixError} Rejects: with an error response.
      */
     private sendCompleteEvent(
         roomId: string,
         eventObject: any,
-        txnId: string,
+        txnId?: string,
         callback?: Callback,
     ): Promise<ISendEventResponse> {
         if (utils.isFunction(txnId)) {
@@ -5414,6 +5422,14 @@ export class MatrixClient extends EventEmitter {
         const resultsLength = roomEvents.results ? roomEvents.results.length : 0;
         for (let i = 0; i < resultsLength; i++) {
             const sr = SearchResult.fromJson(roomEvents.results[i], this.getEventMapper());
+            const room = this.getRoom(sr.context.getEvent().getRoomId());
+            if (room) {
+                // Copy over a known event sender if we can
+                for (const ev of sr.context.getTimeline()) {
+                    const sender = room.getMember(ev.getSender());
+                    if (!ev.sender && sender) ev.sender = sender;
+                }
+            }
             searchResults.results.push(sr);
         }
         return searchResults;
@@ -8521,6 +8537,20 @@ export class MatrixClient extends EventEmitter {
     public supportsExperimentalThreads(): boolean {
         return this.clientOpts?.experimentalThreadSupport || false;
     }
+
+    /**
+     * Fetches the summary of a room as defined by an initial version of MSC3266 and implemented in Synapse
+     * Proposed at https://github.com/matrix-org/matrix-doc/pull/3266
+     * @param {string} roomIdOrAlias The ID or alias of the room to get the summary of.
+     * @param {string[]?} via The list of servers which know about the room if only an ID was provided.
+     */
+    public async getRoomSummary(roomIdOrAlias: string, via?: string[]): Promise<IRoomSummary> {
+        const path = utils.encodeUri("/rooms/$roomid/summary", { $roomid: roomIdOrAlias });
+        return this.http.authedRequest(undefined, "GET", path, { via }, null, {
+            qsStringifyOptions: { arrayFormat: 'repeat' },
+            prefix: "/_matrix/client/unstable/im.nheko.summary",
+        });
+    }
 }
 
 /**

src/models/event-timeline-set.ts

@@ -44,6 +44,7 @@ interface IOpts {
     timelineSupport?: boolean;
     filter?: Filter;
     unstableClientRelationAggregation?: boolean;
+    pendingEvents?: boolean;
 }
 
 export enum DuplicateStrategy {
@@ -54,6 +55,7 @@ export enum DuplicateStrategy {
 export class EventTimelineSet extends EventEmitter {
     private readonly timelineSupport: boolean;
     private unstableClientRelationAggregation: boolean;
+    private displayPendingEvents: boolean;
     private liveTimeline: EventTimeline;
     private timelines: EventTimeline[];
     private _eventIdToTimeline: Record<string, EventTimeline>;
@@ -102,6 +104,7 @@ export class EventTimelineSet extends EventEmitter {
         this.timelineSupport = Boolean(opts.timelineSupport);
         this.liveTimeline = new EventTimeline(this);
         this.unstableClientRelationAggregation = !!opts.unstableClientRelationAggregation;
+        this.displayPendingEvents = opts.pendingEvents !== false;
 
         // just a list - *not* ordered.
         this.timelines = [this.liveTimeline];
@@ -151,7 +154,7 @@ export class EventTimelineSet extends EventEmitter {
      * @throws If <code>opts.pendingEventOrdering</code> was not 'detached'
      */
     public getPendingEvents(): MatrixEvent[] {
-        if (!this.room) {
+        if (!this.room || !this.displayPendingEvents) {
             return [];
         }
 

src/models/room-member.ts

@@ -131,7 +131,9 @@ export class RoomMember extends EventEmitter {
             this.disambiguate,
         );
 
-        this.rawDisplayName = event.getDirectionalContent().displayname;
+        // not quite raw: we strip direction override chars so it can safely be inserted into
+        // blocks of text without breaking the text direction
+        this.rawDisplayName = utils.removeDirectionOverrideChars(event.getDirectionalContent().displayname);
         if (!this.rawDisplayName || !utils.removeHiddenChars(this.rawDisplayName)) {
             this.rawDisplayName = this.userId;
         }
@@ -355,15 +357,26 @@ function calculateDisplayName(
     roomState: RoomState,
     disambiguate: boolean,
 ): string {
-    if (disambiguate) return displayName + " (" + selfUserId + ")";
+    if (disambiguate) return utils.removeDirectionOverrideChars(displayName) + " (" + selfUserId + ")";
 
     if (!displayName || displayName === selfUserId) return selfUserId;
 
     // First check if the displayname is something we consider truthy
     // after stripping it of zero width characters and padding spaces
     if (!utils.removeHiddenChars(displayName)) return selfUserId;
 
-    return displayName;
+    // We always strip the direction override characters (LRO and RLO).
+    // These override the text direction for all subsequent characters
+    // in the paragraph so if display names contained these, they'd
+    // need to be wrapped in something to prevent this from leaking out
+    // (which we can do in HTML but not text) or we'd need to add
+    // control characters to the string to reset any overrides (eg.
+    // adding PDF characters at the end). As far as we can see,
+    // there should be no reason these would be necessary - rtl display
+    // names should flip into the correct direction automatically based on
+    // the characters, and you can still embed rtl in ltr or vice versa
+    // with the embed chars or marker chars.
+    return utils.removeDirectionOverrideChars(displayName);
 }
 
 /**

src/models/room.ts

@@ -672,7 +672,13 @@ export class Room extends EventEmitter {
         // were the members loaded from the server?
         let fromServer = false;
         let rawMembersEvents = await this.client.store.getOutOfBandMembers(this.roomId);
-        if (rawMembersEvents === null) {
+        // If the room is encrypted, we always fetch members from the server at
+        // least once, in case the latest state wasn't persisted properly.  Note
+        // that this function is only called once (unless loading the members
+        // fails), since loadMembersIfNeeded always returns this.membersPromise
+        // if set, which will be the result of the first (successful) call.
+        if (rawMembersEvents === null ||
+            (this.client.isCryptoEnabled() && this.client.isRoomEncrypted(this.roomId))) {
             fromServer = true;
             rawMembersEvents = await this.loadMembersFromServer();
             logger.log(`LL: got ${rawMembersEvents.length} ` +
@@ -1276,19 +1282,23 @@ export class Room extends EventEmitter {
      * Add an event to a thread's timeline. Will fire "Thread.update"
      * @experimental
      */
-    public addThreadedEvent(event: MatrixEvent): void {
+    public async addThreadedEvent(event: MatrixEvent): Promise<void> {
         let thread = this.findThreadForEvent(event);
         if (thread) {
             thread.addEvent(event);
         } else {
             const events = [event];
-            const rootEvent = this.findEventById(event.threadRootId);
-            if (rootEvent) {
-                events.unshift(rootEvent);
+            let rootEvent = this.findEventById(event.threadRootId);
+            // If the rootEvent does not exist in the current sync, then look for
+            // it over the network
+            if (!rootEvent) {
+                const eventData = await this.client.fetchRoomEvent(this.roomId, event.threadRootId);
+                rootEvent = new MatrixEvent(eventData);
             }
+            events.unshift(rootEvent);
             thread = new Thread(events, this, this.client);
-            this.reEmitter.reEmit(thread, [ThreadEvent.Update, ThreadEvent.Ready]);
             this.threads.set(thread.id, thread);
+            this.reEmitter.reEmit(thread, [ThreadEvent.Update, ThreadEvent.Ready]);
             this.emit(ThreadEvent.New, thread);
         }
         this.emit(ThreadEvent.Update, thread);

src/models/thread.ts

@@ -38,17 +38,22 @@ export class Thread extends EventEmitter {
     /**
      * A reference to all the events ID at the bottom of the threads
      */
-    public readonly timelineSet: EventTimelineSet;
+    public readonly timelineSet;
 
     constructor(
         events: MatrixEvent[] = [],
         public readonly room: Room,
         public readonly client: MatrixClient,
     ) {
         super();
-        this.timelineSet = new EventTimelineSet(room, {
+        if (events.length === 0) {
+            throw new Error("Can't create an empty thread");
+        }
+
+        this.timelineSet = new EventTimelineSet(this.room, {
             unstableClientRelationAggregation: true,
             timelineSupport: true,
+            pendingEvents: false,
         });
         events.forEach(event => this.addEvent(event));
     }
@@ -93,14 +98,6 @@ export class Thread extends EventEmitter {
         this.emit(ThreadEvent.Update, this);
     }
 
-    private async decryptEvents(): Promise<void> {
-        await Promise.allSettled(
-            Array.from(this.timelineSet.getLiveTimeline().getEvents()).map(event => {
-                return this.client.decryptEventIfNeeded(event, {});
-            }),
-        );
-    }
-
     /**
      * Finds an event by ID in the current thread
      */
@@ -135,9 +132,13 @@ export class Thread extends EventEmitter {
 
     /**
      * The number of messages in the thread
+     * Only count rel_type=m.thread as we want to
+     * exclude annotations from that number
      */
     public get length(): number {
-        return this.events.length;
+        return this.events
+            .filter(event => event.isThreadRelation)
+            .length;
     }
 
     /**

src/utils.ts

@@ -387,6 +387,18 @@ export function removeHiddenChars(str: string): string {
     return "";
 }
 
+/**
+ * Removes the direction override characters from a string
+ * @param {string} input
+ * @returns string with chars removed
+ */
+export function removeDirectionOverrideChars(str: string): string {
+    if (typeof str === "string") {
+        return str.replace(/[\u202d-\u202e]/g, '');
+    }
+    return "";
+}
+
 export function normalize(str: string): string {
     // Note: we have to match the filter with the removeHiddenChars() because the
     // function strips spaces and other characters (M becomes RN for example, in lowercase).