This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 834
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Replace MSC3244 support with in-client room version checking * Fix irrelevant ternary * It helps to use Jest correctly
- Loading branch information
Showing
7 changed files
with
121 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
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. | ||
*/ | ||
|
||
/** | ||
* The preferred room versions for various features within the app. The | ||
* room versions here are selected based on the client's support for the | ||
* possible room versions in combination with server support in the | ||
* ecosystem. | ||
* | ||
* Loosely follows https://spec.matrix.org/latest/rooms/#feature-matrix | ||
*/ | ||
export class PreferredRoomVersions { | ||
/** | ||
* The room version to use when creating "restricted" rooms. | ||
*/ | ||
public static readonly RestrictedRooms = "9"; | ||
|
||
private constructor() { | ||
// readonly, static, class | ||
} | ||
} | ||
|
||
/** | ||
* Determines if a room version supports the given feature using heuristics | ||
* for how Matrix works. | ||
* @param roomVer The room version to check support within. | ||
* @param featureVer The room version of the feature. Should be from PreferredRoomVersions. | ||
* @see PreferredRoomVersions | ||
*/ | ||
export function doesRoomVersionSupport(roomVer: string, featureVer: string): boolean { | ||
// Assumption: all unstable room versions don't support the feature. Calling code can check for unstable | ||
// room versions explicitly if it wants to. The spec reserves [0-9] and `.` for its room versions. | ||
if (!roomVer.match(/[\d.]+/)) { | ||
return false; | ||
} | ||
|
||
// Dev note: While the spec says room versions are not linear, we can make reasonable assumptions | ||
// until the room versions prove themselves to be non-linear in the spec. We should see this coming | ||
// from a mile away and can course-correct this function if needed. | ||
return Number(roomVer) >= Number(featureVer); | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/* | ||
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 { doesRoomVersionSupport, PreferredRoomVersions } from "../src/utils/PreferredRoomVersions"; | ||
|
||
describe("doesRoomVersionSupport", () => { | ||
it("should detect unstable as unsupported", () => { | ||
expect(doesRoomVersionSupport("org.example.unstable", "1")).toBe(false); | ||
expect(doesRoomVersionSupport("1.2-beta", "1")).toBe(false); | ||
}); | ||
|
||
it("should detect support properly", () => { | ||
expect(doesRoomVersionSupport("1", "2")).toBe(false); // older | ||
expect(doesRoomVersionSupport("2", "2")).toBe(true); // exact | ||
expect(doesRoomVersionSupport("3", "2")).toBe(true); // newer | ||
}); | ||
|
||
it("should handle decimal versions", () => { | ||
expect(doesRoomVersionSupport("1.1", "2.2")).toBe(false); // older | ||
expect(doesRoomVersionSupport("2.1", "2.2")).toBe(false); // exact-ish | ||
expect(doesRoomVersionSupport("2.2", "2.2")).toBe(true); // exact | ||
expect(doesRoomVersionSupport("2.3", "2.2")).toBe(true); // exact-ish | ||
expect(doesRoomVersionSupport("3.1", "2.2")).toBe(true); // newer | ||
}); | ||
|
||
it("should detect restricted rooms in v9 and v10", () => { | ||
// Dev note: we consider it a feature that v8 rooms have to upgrade considering the bug in v8. | ||
// https://spec.matrix.org/v1.3/rooms/v8/#redactions | ||
expect(doesRoomVersionSupport("8", PreferredRoomVersions.RestrictedRooms)).toBe(false); | ||
expect(doesRoomVersionSupport("9", PreferredRoomVersions.RestrictedRooms)).toBe(true); | ||
expect(doesRoomVersionSupport("10", PreferredRoomVersions.RestrictedRooms)).toBe(true); | ||
}); | ||
}); |