Absorb the matrix-react-sdk repository (#28192)

Co-authored-by: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com> Co-authored-by: github-merge-queue <github-merge-queue@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Florian Duros <florian.duros@ormaz.fr> Co-authored-by: Kim Brose <kim.brose@nordeck.net> Co-authored-by: Florian Duros <florianduros@element.io> Co-authored-by: R Midhun Suresh <hi@midhun.dev> Co-authored-by: dbkr <986903+dbkr@users.noreply.github.com> Co-authored-by: ElementRobot <releases@riot.im> Co-authored-by: dbkr <dbkr@users.noreply.github.com> Co-authored-by: David Baker <dbkr@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: David Langley <davidl@element.io> Co-authored-by: Michael Weimann <michaelw@matrix.org> Co-authored-by: Timshel <Timshel@users.noreply.github.com> Co-authored-by: Sahil Silare <32628578+sahil9001@users.noreply.github.com> Co-authored-by: Will Hunt <will@half-shot.uk> Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> Co-authored-by: Andrew Ferrazzutti <andrewf@element.io> Co-authored-by: Robin <robin@robin.town> Co-authored-by: Tulir Asokan <tulir@maunium.net>
2026-11-04 01:19:41 +00:00 · 2024-10-16 13:31:55 +01:00
parent 2b99496025
commit c05c429803
3280 changed files with 586617 additions and 905 deletions
@@ -0,0 +1,186 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { renderHook } from "@testing-library/react-hooks";
+
+import { useDebouncedCallback } from "../../../src/hooks/spotlight/useDebouncedCallback";
+
+describe("useDebouncedCallback", () => {
+    beforeAll(() => jest.useFakeTimers());
+    afterAll(() => jest.useRealTimers());
+
+    function render(enabled: boolean, callback: (...params: any[]) => void, params: any[]) {
+        return renderHook(({ enabled, callback, params }) => useDebouncedCallback(enabled, callback, params), {
+            initialProps: {
+                enabled,
+                callback,
+                params,
+            },
+        });
+    }
+
+    it("should be able to handle empty parameters", async () => {
+        // When
+        const params: any[] = [];
+        const callback = jest.fn();
+        render(true, callback, params);
+        jest.advanceTimersByTime(1);
+
+        // Then
+        expect(callback).toHaveBeenCalledTimes(0);
+
+        // When
+        jest.advanceTimersByTime(500);
+
+        // Then
+        expect(callback).toHaveBeenCalledTimes(1);
+    });
+
+    it("should call the callback with the parameters", async () => {
+        // When
+        const params = ["USER NAME"];
+        const callback = jest.fn();
+        render(true, callback, params);
+        jest.advanceTimersByTime(500);
+
+        // Then
+        expect(callback).toHaveBeenCalledTimes(1);
+        expect(callback).toHaveBeenCalledWith(...params);
+    });
+
+    it("should call the callback with the parameters when parameters change during the timeout", async () => {
+        // When
+        const params = ["USER NAME"];
+        const callback = jest.fn();
+        const { rerender } = render(true, callback, []);
+
+        jest.advanceTimersByTime(1);
+        rerender({ enabled: true, callback, params });
+        jest.advanceTimersByTime(500);
+
+        // Then
+        expect(callback).toHaveBeenCalledTimes(1);
+        expect(callback).toHaveBeenCalledWith(...params);
+    });
+
+    it("should handle multiple parameters", async () => {
+        // When
+        const params = [4, 8, 15, 16, 23, 42];
+        const callback = jest.fn();
+        const { rerender } = render(true, callback, []);
+
+        jest.advanceTimersByTime(1);
+        rerender({ enabled: true, callback, params });
+        jest.advanceTimersByTime(500);
+
+        // Then
+        expect(callback).toHaveBeenCalledTimes(1);
+        expect(callback).toHaveBeenCalledWith(...params);
+    });
+
+    it("should debounce quick changes", async () => {
+        // When
+        const queries = [
+            "U",
+            "US",
+            "USE",
+            "USER",
+            "USER ",
+            "USER N",
+            "USER NM",
+            "USER NMA",
+            "USER NM",
+            "USER N",
+            "USER NA",
+            "USER NAM",
+            "USER NAME",
+        ];
+        const callback = jest.fn();
+
+        const { rerender } = render(true, callback, []);
+        jest.advanceTimersByTime(1);
+
+        for (const query of queries) {
+            rerender({ enabled: true, callback, params: [query] });
+            jest.advanceTimersByTime(50);
+        }
+
+        jest.advanceTimersByTime(500);
+
+        // Then
+        const query = queries[queries.length - 1];
+        expect(callback).toHaveBeenCalledTimes(1);
+        expect(callback).toHaveBeenCalledWith(query);
+    });
+
+    it("should not debounce slow changes", async () => {
+        // When
+        const queries = [
+            "U",
+            "US",
+            "USE",
+            "USER",
+            "USER ",
+            "USER N",
+            "USER NM",
+            "USER NMA",
+            "USER NM",
+            "USER N",
+            "USER NA",
+            "USER NAM",
+            "USER NAME",
+        ];
+        const callback = jest.fn();
+
+        const { rerender } = render(true, callback, []);
+        jest.advanceTimersByTime(1);
+        for (const query of queries) {
+            rerender({ enabled: true, callback, params: [query] });
+            jest.advanceTimersByTime(200);
+        }
+
+        jest.advanceTimersByTime(500);
+
+        // Then
+        const query = queries[queries.length - 1];
+        expect(callback).toHaveBeenCalledTimes(queries.length);
+        expect(callback).toHaveBeenCalledWith(query);
+    });
+
+    it("should not call the callback if it’s disabled", async () => {
+        // When
+        const queries = [
+            "U",
+            "US",
+            "USE",
+            "USER",
+            "USER ",
+            "USER N",
+            "USER NM",
+            "USER NMA",
+            "USER NM",
+            "USER N",
+            "USER NA",
+            "USER NAM",
+            "USER NAME",
+        ];
+        const callback = jest.fn();
+
+        const { rerender } = render(false, callback, []);
+        jest.advanceTimersByTime(1);
+        for (const query of queries) {
+            rerender({ enabled: false, callback, params: [query] });
+            jest.advanceTimersByTime(200);
+        }
+
+        jest.advanceTimersByTime(500);
+
+        // Then
+        expect(callback).toHaveBeenCalledTimes(0);
+    });
+});