mirror of
https://github.com/element-hq/element-web
synced 2024-10-23 11:15:47 +03:00
dcf497d013
* sliding-sync: spider all rooms on the user's account for search On startup, slowly accumulate room metadata for all rooms on the user's account. This is so we can populate the local search cache with enough data for it to function, obviating the need to have separate code paths for sliding sync searches. This will allow spotlight search to work with slow/no network connectivity, though clicking on the room will still require a round trip. This is an explicit request from @ara4n to improve the snapiness of room searches, despite the unbounded bandwidth costs requesting all N rooms on the user's account. * Comments and tweak defaults * Review comments; remove SS search code * bugfix: use setListRanges once the list has been set up If we don't, then we send needless extra data and can cause bugs because setList will wipe the index->room_id map, which trips up SlidingRoomListStore.
114 lines
4.6 KiB
TypeScript
114 lines
4.6 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 { SlidingSyncManager } from '../src/SlidingSyncManager';
|
|
import { stubClient } from './test-utils';
|
|
|
|
jest.mock('matrix-js-sdk/src/sliding-sync');
|
|
const MockSlidingSync = <jest.Mock<SlidingSync>><unknown>SlidingSync;
|
|
|
|
describe('SlidingSyncManager', () => {
|
|
let manager: SlidingSyncManager;
|
|
let slidingSync: SlidingSync;
|
|
|
|
beforeEach(() => {
|
|
slidingSync = new MockSlidingSync();
|
|
manager = new SlidingSyncManager();
|
|
manager.configure(stubClient(), "invalid");
|
|
manager.slidingSync = slidingSync;
|
|
});
|
|
|
|
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((i) => {
|
|
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).toBeCalledTimes(wantWindows.length);
|
|
expect(slidingSync.setList).toBeCalledTimes(1);
|
|
expect(slidingSync.setListRanges).toBeCalledTimes(wantWindows.length-1);
|
|
wantWindows.forEach((range, i) => {
|
|
if (i === 0) {
|
|
expect(slidingSync.setList).toBeCalledWith(
|
|
manager.getOrAllocateListIndex(SlidingSyncManager.ListSearch),
|
|
expect.objectContaining({
|
|
ranges: [[0, batchSize-1], range],
|
|
}),
|
|
);
|
|
return;
|
|
}
|
|
expect(slidingSync.setListRanges).toBeCalledWith(
|
|
manager.getOrAllocateListIndex(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((i) => {
|
|
return {
|
|
joinedCount: 0,
|
|
roomIndexToRoomId: {},
|
|
};
|
|
});
|
|
await manager.startSpidering(batchSize, gapMs);
|
|
expect(slidingSync.getListData).toBeCalledTimes(1);
|
|
expect(slidingSync.setList).toBeCalledTimes(1);
|
|
expect(slidingSync.setList).toBeCalledWith(
|
|
manager.getOrAllocateListIndex(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((i) => {
|
|
return {
|
|
joinedCount: 0,
|
|
roomIndexToRoomId: {},
|
|
};
|
|
});
|
|
await manager.startSpidering(batchSize, gapMs);
|
|
expect(slidingSync.getListData).toBeCalledTimes(1);
|
|
expect(slidingSync.setList).toBeCalledTimes(1);
|
|
expect(slidingSync.setList).toBeCalledWith(
|
|
manager.getOrAllocateListIndex(SlidingSyncManager.ListSearch),
|
|
expect.objectContaining({
|
|
ranges: [[0, batchSize-1], [batchSize, batchSize+batchSize-1]],
|
|
}),
|
|
);
|
|
});
|
|
});
|
|
});
|