330 lines
15 KiB
TypeScript
330 lines
15 KiB
TypeScript
/*
|
|
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 { SlidingSync } from "matrix-js-sdk/src/sliding-sync";
|
|
import { mocked } from "jest-mock";
|
|
import { MatrixClient, MatrixEvent, Room } from "matrix-js-sdk/src/matrix";
|
|
import fetchMockJest from "fetch-mock-jest";
|
|
|
|
import { SlidingSyncManager } from "../src/SlidingSyncManager";
|
|
import { stubClient } from "./test-utils";
|
|
import SlidingSyncController from "../src/settings/controllers/SlidingSyncController";
|
|
import SettingsStore from "../src/settings/SettingsStore";
|
|
|
|
jest.mock("matrix-js-sdk/src/sliding-sync");
|
|
const MockSlidingSync = <jest.Mock<SlidingSync>>(<unknown>SlidingSync);
|
|
|
|
describe("SlidingSyncManager", () => {
|
|
let manager: SlidingSyncManager;
|
|
let slidingSync: SlidingSync;
|
|
let client: MatrixClient;
|
|
|
|
beforeEach(() => {
|
|
slidingSync = new MockSlidingSync();
|
|
manager = new SlidingSyncManager();
|
|
client = stubClient();
|
|
// by default the client has no rooms: stubClient magically makes rooms annoyingly.
|
|
mocked(client.getRoom).mockReturnValue(null);
|
|
manager.configure(client, "invalid");
|
|
manager.slidingSync = slidingSync;
|
|
fetchMockJest.reset();
|
|
fetchMockJest.get("https://proxy/client/server.json", {});
|
|
});
|
|
|
|
describe("setRoomVisible", () => {
|
|
it("adds a subscription for the room", async () => {
|
|
const roomId = "!room:id";
|
|
const subs = new Set<string>();
|
|
mocked(slidingSync.getRoomSubscriptions).mockReturnValue(subs);
|
|
mocked(slidingSync.modifyRoomSubscriptions).mockResolvedValue("yep");
|
|
await manager.setRoomVisible(roomId, true);
|
|
expect(slidingSync.modifyRoomSubscriptions).toHaveBeenCalledWith(new Set<string>([roomId]));
|
|
});
|
|
it("adds a custom subscription for a lazy-loadable room", async () => {
|
|
const roomId = "!lazy:id";
|
|
const room = new Room(roomId, client, client.getUserId()!);
|
|
room.getLiveTimeline().initialiseState([
|
|
new MatrixEvent({
|
|
type: "m.room.create",
|
|
state_key: "",
|
|
event_id: "$abc123",
|
|
sender: client.getUserId()!,
|
|
content: {
|
|
creator: client.getUserId()!,
|
|
},
|
|
}),
|
|
]);
|
|
mocked(client.getRoom).mockImplementation((r: string): Room | null => {
|
|
if (roomId === r) {
|
|
return room;
|
|
}
|
|
return null;
|
|
});
|
|
const subs = new Set<string>();
|
|
mocked(slidingSync.getRoomSubscriptions).mockReturnValue(subs);
|
|
mocked(slidingSync.modifyRoomSubscriptions).mockResolvedValue("yep");
|
|
await manager.setRoomVisible(roomId, true);
|
|
expect(slidingSync.modifyRoomSubscriptions).toHaveBeenCalledWith(new Set<string>([roomId]));
|
|
// we aren't prescriptive about what the sub name is.
|
|
expect(slidingSync.useCustomSubscription).toHaveBeenCalledWith(roomId, expect.anything());
|
|
});
|
|
});
|
|
|
|
describe("ensureListRegistered", () => {
|
|
it("creates a new list based on the key", async () => {
|
|
const listKey = "key";
|
|
mocked(slidingSync.getListParams).mockReturnValue(null);
|
|
mocked(slidingSync.setList).mockResolvedValue("yep");
|
|
await manager.ensureListRegistered(listKey, {
|
|
sort: ["by_recency"],
|
|
});
|
|
expect(slidingSync.setList).toHaveBeenCalledWith(
|
|
listKey,
|
|
expect.objectContaining({
|
|
sort: ["by_recency"],
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("updates an existing list based on the key", async () => {
|
|
const listKey = "key";
|
|
mocked(slidingSync.getListParams).mockReturnValue({
|
|
ranges: [[0, 42]],
|
|
});
|
|
mocked(slidingSync.setList).mockResolvedValue("yep");
|
|
await manager.ensureListRegistered(listKey, {
|
|
sort: ["by_recency"],
|
|
});
|
|
expect(slidingSync.setList).toHaveBeenCalledWith(
|
|
listKey,
|
|
expect.objectContaining({
|
|
sort: ["by_recency"],
|
|
ranges: [[0, 42]],
|
|
}),
|
|
);
|
|
});
|
|
|
|
it("updates ranges on an existing list based on the key if there's no other changes", async () => {
|
|
const listKey = "key";
|
|
mocked(slidingSync.getListParams).mockReturnValue({
|
|
ranges: [[0, 42]],
|
|
});
|
|
mocked(slidingSync.setList).mockResolvedValue("yep");
|
|
await manager.ensureListRegistered(listKey, {
|
|
ranges: [[0, 52]],
|
|
});
|
|
expect(slidingSync.setList).not.toHaveBeenCalled();
|
|
expect(slidingSync.setListRanges).toHaveBeenCalledWith(listKey, [[0, 52]]);
|
|
});
|
|
|
|
it("no-ops for idential changes", async () => {
|
|
const listKey = "key";
|
|
mocked(slidingSync.getListParams).mockReturnValue({
|
|
ranges: [[0, 42]],
|
|
sort: ["by_recency"],
|
|
});
|
|
mocked(slidingSync.setList).mockResolvedValue("yep");
|
|
await manager.ensureListRegistered(listKey, {
|
|
ranges: [[0, 42]],
|
|
sort: ["by_recency"],
|
|
});
|
|
expect(slidingSync.setList).not.toHaveBeenCalled();
|
|
expect(slidingSync.setListRanges).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe("startSpidering", () => {
|
|
it("requests in batchSizes", async () => {
|
|
const gapMs = 1;
|
|
const batchSize = 10;
|
|
mocked(slidingSync.setList).mockResolvedValue("yep");
|
|
mocked(slidingSync.setListRanges).mockResolvedValue("yep");
|
|
mocked(slidingSync.getListData).mockImplementation((key) => {
|
|
return {
|
|
joinedCount: 64,
|
|
roomIndexToRoomId: {},
|
|
};
|
|
});
|
|
await manager.startSpidering(batchSize, gapMs);
|
|
// we expect calls for 10,19 -> 20,29 -> 30,39 -> 40,49 -> 50,59 -> 60,69
|
|
const wantWindows = [
|
|
[10, 19],
|
|
[20, 29],
|
|
[30, 39],
|
|
[40, 49],
|
|
[50, 59],
|
|
[60, 69],
|
|
];
|
|
expect(slidingSync.getListData).toHaveBeenCalledTimes(wantWindows.length);
|
|
expect(slidingSync.setList).toHaveBeenCalledTimes(1);
|
|
expect(slidingSync.setListRanges).toHaveBeenCalledTimes(wantWindows.length - 1);
|
|
wantWindows.forEach((range, i) => {
|
|
if (i === 0) {
|
|
// eslint-disable-next-line jest/no-conditional-expect
|
|
expect(slidingSync.setList).toHaveBeenCalledWith(
|
|
SlidingSyncManager.ListSearch,
|
|
// eslint-disable-next-line jest/no-conditional-expect
|
|
expect.objectContaining({
|
|
ranges: [[0, batchSize - 1], range],
|
|
}),
|
|
);
|
|
return;
|
|
}
|
|
expect(slidingSync.setListRanges).toHaveBeenCalledWith(SlidingSyncManager.ListSearch, [
|
|
[0, batchSize - 1],
|
|
range,
|
|
]);
|
|
});
|
|
});
|
|
it("handles accounts with zero rooms", async () => {
|
|
const gapMs = 1;
|
|
const batchSize = 10;
|
|
mocked(slidingSync.setList).mockResolvedValue("yep");
|
|
mocked(slidingSync.getListData).mockImplementation((key) => {
|
|
return {
|
|
joinedCount: 0,
|
|
roomIndexToRoomId: {},
|
|
};
|
|
});
|
|
await manager.startSpidering(batchSize, gapMs);
|
|
expect(slidingSync.getListData).toHaveBeenCalledTimes(1);
|
|
expect(slidingSync.setList).toHaveBeenCalledTimes(1);
|
|
expect(slidingSync.setList).toHaveBeenCalledWith(
|
|
SlidingSyncManager.ListSearch,
|
|
expect.objectContaining({
|
|
ranges: [
|
|
[0, batchSize - 1],
|
|
[batchSize, batchSize + batchSize - 1],
|
|
],
|
|
}),
|
|
);
|
|
});
|
|
it("continues even when setList rejects", async () => {
|
|
const gapMs = 1;
|
|
const batchSize = 10;
|
|
mocked(slidingSync.setList).mockRejectedValue("narp");
|
|
mocked(slidingSync.getListData).mockImplementation((key) => {
|
|
return {
|
|
joinedCount: 0,
|
|
roomIndexToRoomId: {},
|
|
};
|
|
});
|
|
await manager.startSpidering(batchSize, gapMs);
|
|
expect(slidingSync.getListData).toHaveBeenCalledTimes(1);
|
|
expect(slidingSync.setList).toHaveBeenCalledTimes(1);
|
|
expect(slidingSync.setList).toHaveBeenCalledWith(
|
|
SlidingSyncManager.ListSearch,
|
|
expect.objectContaining({
|
|
ranges: [
|
|
[0, batchSize - 1],
|
|
[batchSize, batchSize + batchSize - 1],
|
|
],
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
describe("checkSupport", () => {
|
|
beforeEach(() => {
|
|
SlidingSyncController.serverSupportsSlidingSync = false;
|
|
jest.spyOn(manager, "getProxyFromWellKnown").mockResolvedValue("https://proxy/");
|
|
});
|
|
it("shorts out if the server has 'native' sliding sync support", async () => {
|
|
jest.spyOn(manager, "nativeSlidingSyncSupport").mockResolvedValue(true);
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeFalsy();
|
|
await manager.checkSupport(client);
|
|
expect(manager.getProxyFromWellKnown).not.toHaveBeenCalled(); // We return earlier
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeTruthy();
|
|
});
|
|
it("tries to find a sliding sync proxy url from the client well-known if there's no 'native' support", async () => {
|
|
jest.spyOn(manager, "nativeSlidingSyncSupport").mockResolvedValue(false);
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeFalsy();
|
|
await manager.checkSupport(client);
|
|
expect(manager.getProxyFromWellKnown).toHaveBeenCalled();
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeTruthy();
|
|
});
|
|
it("should query well-known on server_name not baseUrl", async () => {
|
|
fetchMockJest.get("https://matrix.org/.well-known/matrix/client", {
|
|
"m.homeserver": {
|
|
base_url: "https://matrix-client.matrix.org",
|
|
server: "matrix.org",
|
|
},
|
|
"org.matrix.msc3575.proxy": {
|
|
url: "https://proxy/",
|
|
},
|
|
});
|
|
fetchMockJest.get("https://matrix-client.matrix.org/_matrix/client/versions", { versions: ["v1.4"] });
|
|
|
|
mocked(manager.getProxyFromWellKnown).mockRestore();
|
|
jest.spyOn(manager, "nativeSlidingSyncSupport").mockResolvedValue(false);
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeFalsy();
|
|
await manager.checkSupport(client);
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeTruthy();
|
|
expect(fetchMockJest).not.toHaveFetched("https://matrix-client.matrix.org/.well-known/matrix/client");
|
|
});
|
|
});
|
|
describe("nativeSlidingSyncSupport", () => {
|
|
beforeEach(() => {
|
|
SlidingSyncController.serverSupportsSlidingSync = false;
|
|
});
|
|
it("should make an OPTIONS request to avoid unintended side effects", async () => {
|
|
// See https://github.com/element-hq/element-web/issues/27426
|
|
|
|
const unstableSpy = jest
|
|
.spyOn(client, "doesServerSupportUnstableFeature")
|
|
.mockImplementation(async (feature: string) => {
|
|
expect(feature).toBe("org.matrix.msc3575");
|
|
return true;
|
|
});
|
|
const proxySpy = jest.spyOn(manager, "getProxyFromWellKnown").mockResolvedValue("https://proxy/");
|
|
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeFalsy();
|
|
await manager.checkSupport(client); // first thing it does is call nativeSlidingSyncSupport
|
|
expect(proxySpy).not.toHaveBeenCalled();
|
|
expect(unstableSpy).toHaveBeenCalled();
|
|
expect(SlidingSyncController.serverSupportsSlidingSync).toBeTruthy();
|
|
});
|
|
});
|
|
describe("setup", () => {
|
|
beforeEach(() => {
|
|
jest.spyOn(manager, "configure");
|
|
jest.spyOn(manager, "startSpidering");
|
|
});
|
|
it("uses the baseUrl as a proxy if no proxy is set in the client well-known and the server has no native support", async () => {
|
|
await manager.setup(client);
|
|
expect(manager.configure).toHaveBeenCalled();
|
|
expect(manager.configure).toHaveBeenCalledWith(client, client.baseUrl);
|
|
expect(manager.startSpidering).toHaveBeenCalled();
|
|
});
|
|
it("uses the proxy declared in the client well-known", async () => {
|
|
jest.spyOn(manager, "getProxyFromWellKnown").mockResolvedValue("https://proxy/");
|
|
await manager.setup(client);
|
|
expect(manager.configure).toHaveBeenCalled();
|
|
expect(manager.configure).toHaveBeenCalledWith(client, "https://proxy/");
|
|
expect(manager.startSpidering).toHaveBeenCalled();
|
|
});
|
|
it("uses the legacy `feature_sliding_sync_proxy_url` if it was set", async () => {
|
|
jest.spyOn(manager, "getProxyFromWellKnown").mockResolvedValue("https://proxy/");
|
|
jest.spyOn(SettingsStore, "getValue").mockImplementation((name: string) => {
|
|
if (name === "feature_sliding_sync_proxy_url") return "legacy-proxy";
|
|
});
|
|
await manager.setup(client);
|
|
expect(manager.configure).toHaveBeenCalled();
|
|
expect(manager.configure).toHaveBeenCalledWith(client, "legacy-proxy");
|
|
expect(manager.startSpidering).toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|