Use v1 prefix for /hierarchy API, falling back to both previous varia…

…nts (#2022)
matrix-org · Dec 15, 2021 · 6ac84a2 · 6ac84a2
1 parent e4d3124
commit 6ac84a2
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 11 deletions.
diff --git a/src/@types/spaces.ts b/src/@types/spaces.ts
@@ -44,7 +44,6 @@ export interface ISpaceSummaryEvent {
 }
 
 export interface IHierarchyRelation extends IStrippedState {
-    room_id: string;
     origin_server_ts: number;
     content: {
         order?: string;

diff --git a/src/client.ts b/src/client.ts
@@ -50,6 +50,7 @@ import {
     PREFIX_IDENTITY_V2,
     PREFIX_MEDIA_R0,
     PREFIX_R0,
+    PREFIX_V1,
     PREFIX_UNSTABLE,
     retryNetworkOperation,
     UploadContentResponseType,
@@ -722,6 +723,11 @@ interface IRoomKeysResponse {
 interface IRoomsKeysResponse {
     rooms: Record<string, IRoomKeysResponse>;
 }
+
+interface IRoomHierarchy {
+    rooms: IHierarchyRoom[];
+    next_batch?: string;
+}
 /* eslint-enable camelcase */
 
 // We're using this constant for methods overloading and inspect whether a variable
@@ -8372,24 +8378,32 @@ export class MatrixClient extends EventEmitter {
         maxDepth?: number,
         suggestedOnly = false,
         fromToken?: string,
-    ): Promise<{
-        rooms: IHierarchyRoom[];
-        next_batch?: string; // eslint-disable-line camelcase
-    }> {
+    ): Promise<IRoomHierarchy> {
         const path = utils.encodeUri("/rooms/$roomId/hierarchy", {
             $roomId: roomId,
         });
 
-        return this.http.authedRequest<{
-            rooms: IHierarchyRoom[];
-            next_batch?: string; // eslint-disable-line camelcase
-        }>(undefined, Method.Get, path, {
+        return this.http.authedRequest<IRoomHierarchy>(undefined, Method.Get, path, {
             suggested_only: String(suggestedOnly),
             max_depth: maxDepth?.toString(),
             from: fromToken,
             limit: limit?.toString(),
         }, undefined, {
-            prefix: "/_matrix/client/unstable/org.matrix.msc2946",
+            prefix: PREFIX_V1,
+        }).catch(e => {
+            if (e.errcode === "M_UNRECOGNIZED") {
+                // fall back to the development prefix
+                return this.http.authedRequest<IRoomHierarchy>(undefined, Method.Get, path, {
+                    suggested_only: String(suggestedOnly),
+                    max_depth: String(maxDepth),
+                    from: fromToken,
+                    limit: String(limit),
+                }, undefined, {
+                    prefix: "/_matrix/client/unstable/org.matrix.msc2946",
+                });
+            }
+
+            throw e;
         }).catch(e => {
             if (e.errcode === "M_UNRECOGNIZED") {
                 // fall back to the older space summary API as it exposes the same data just in a different shape.

diff --git a/src/http-api.ts b/src/http-api.ts
@@ -47,6 +47,11 @@ TODO:
  */
 export const PREFIX_R0 = "/_matrix/client/r0";
 
+/**
+ * A constant representing the URI path for release v1 of the Client-Server HTTP API.
+ */
+export const PREFIX_V1 = "/_matrix/client/v1";
+
 /**
  * A constant representing the URI path for as-yet unspecified Client-Server HTTP APIs.
  */

diff --git a/src/room-hierarchy.ts b/src/room-hierarchy.ts
@@ -112,7 +112,7 @@ export class RoomHierarchy {
                 if (!this.backRefs.has(childRoomId)) {
                     this.backRefs.set(childRoomId, []);
                 }
-                this.backRefs.get(childRoomId).push(ev.room_id);
+                this.backRefs.get(childRoomId).push(room.room_id);
 
                 // fill viaMap
                 if (Array.isArray(ev.content.via)) {