PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Broaden support for matrix spec versions (#12154)

Browse source 
Something of a compainion to
https://github.com/matrix-org/matrix-js-sdk/pull/4014, but also covering the
issues discussed at
https://github.com/matrix-org/matrix-js-sdk/issues/3915#issuecomment-1865221366.

In short: we should not reject servers which only implement recent versions of
the spec. Doing so holds back the ecosystem by requiring all new servers to
implement features that nobody actually uses any more.
This commit is contained in:
Richard van der Hoff 2024-01-19 10:00:22 +00:00 committed by GitHub
parent 0d2253e7d0
commit a8cc6cc207
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 31 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
src/Lifecycle.ts
View file

@ -23,7 +23,7 @@ import { InvalidStoreError } from "matrix-js-sdk/src/errors";
import { IEncryptedPayload } from "matrix-js-sdk/src/crypto/aes"; import { IEncryptedPayload } from "matrix-js-sdk/src/crypto/aes";
import { QueryDict } from "matrix-js-sdk/src/utils"; import { QueryDict } from "matrix-js-sdk/src/utils";
import { logger } from "matrix-js-sdk/src/logger"; import { logger } from "matrix-js-sdk/src/logger";
import { MINIMUM_MATRIX_VERSION } from "matrix-js-sdk/src/version-support"; import { MINIMUM_MATRIX_VERSION, SUPPORTED_MATRIX_VERSIONS } from "matrix-js-sdk/src/version-support";
import { IMatrixClientCreds, MatrixClientPeg } from "./MatrixClientPeg"; import { IMatrixClientCreds, MatrixClientPeg } from "./MatrixClientPeg";
import SecurityCustomisations from "./customisations/Security"; import SecurityCustomisations from "./customisations/Security";
@ -635,7 +635,7 @@ export async function restoreFromLocalStorage(opts?: { ignoreGuest?: boolean }):
}, },
false, false,
); );
checkServerVersions(); await checkServerVersions();
return true; return true;
} else { } else {
logger.log("No previous session found."); logger.log("No previous session found.");
@ -644,29 +644,34 @@ export async function restoreFromLocalStorage(opts?: { ignoreGuest?: boolean }):
} }
async function checkServerVersions(): Promise<void> { async function checkServerVersions(): Promise<void> {
MatrixClientPeg.get() const client = MatrixClientPeg.get();
?.getVersions() if (!client) return;
.then((response) => { for (const version of SUPPORTED_MATRIX_VERSIONS) {
if (!response.versions.includes(MINIMUM_MATRIX_VERSION)) { // Check if the server supports this spec version. (`isVersionSupported` caches the response, so this loop will
const toastKey = "LEGACY_SERVER"; // only make a single HTTP request).
ToastStore.sharedInstance().addOrReplaceToast({ if (await client.isVersionSupported(version)) {
key: toastKey, // we found a compatible spec version
title: _t("unsupported_server_title"), return;
props: { }
description: _t("unsupported_server_description", { }
version: MINIMUM_MATRIX_VERSION,
brand: SdkConfig.get().brand, const toastKey = "LEGACY_SERVER";
}), ToastStore.sharedInstance().addOrReplaceToast({
acceptLabel: _t("action|ok"), key: toastKey,
onAccept: () => { title: _t("unsupported_server_title"),
ToastStore.sharedInstance().dismissToast(toastKey); props: {
}, description: _t("unsupported_server_description", {
}, version: MINIMUM_MATRIX_VERSION,
component: GenericToast, brand: SdkConfig.get().brand,
priority: 98, }),
}); acceptLabel: _t("action|ok"),
} onAccept: () => {
}); ToastStore.sharedInstance().dismissToast(toastKey);
},
},
component: GenericToast,
priority: 98,
});
} }
async function handleLoadSessionFailure(e: unknown): Promise<boolean> { async function handleLoadSessionFailure(e: unknown): Promise<boolean> {

5
test/Lifecycle-test.ts
View file

@ -453,10 +453,7 @@ describe("Lifecycle", () => {
it("should show a toast if the matrix server version is unsupported", async () => { it("should show a toast if the matrix server version is unsupported", async () => {
const toastSpy = jest.spyOn(ToastStore.sharedInstance(), "addOrReplaceToast"); const toastSpy = jest.spyOn(ToastStore.sharedInstance(), "addOrReplaceToast");
mockClient.getVersions.mockResolvedValue({ mockClient.isVersionSupported.mockImplementation(async (version) => version == "r0.6.0");
versions: ["r0.6.0"],
unstable_features: {},
});
initLocalStorageMock({ ...localStorageSession }); initLocalStorageMock({ ...localStorageSession });
expect(await restoreFromLocalStorage()).toEqual(true); expect(await restoreFromLocalStorage()).toEqual(true);