Stabilise flaky QR code rendering tests (#33593)

* Stabilise QR code rendering tests

* Extract QR mocking code to test-utils
This commit is contained in:
rbondesson
2026-05-25 09:10:10 +02:00
committed by GitHub
parent 1ffbe66d72
commit 40fbe1fae1
4 changed files with 65 additions and 7 deletions
+44
View File
@@ -0,0 +1,44 @@
/*
Copyright 2026 New Vector Ltd.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE files in the repository root for full details.
*/
import { act } from "jest-matrix-react";
import { toDataURL, type QRCodeSegment, type QRCodeToDataURLOptions } from "qrcode";
jest.mock("qrcode", () => ({
...jest.requireActual("qrcode"),
toDataURL: jest.fn(),
}));
const realQRCode = jest.requireActual("qrcode") as { toDataURL: typeof toDataURL };
const mockedToDataURL = jest.mocked(toDataURL);
let qrCodeRenderPromise: Promise<string> | undefined;
export function mockQRCodeRender(): void {
// Keep real PNG generation, but capture the promise so the test can await it directly.
mockedToDataURL.mockImplementation(((data: string | QRCodeSegment[], options?: QRCodeToDataURLOptions) => {
qrCodeRenderPromise = realQRCode.toDataURL(data, options);
return qrCodeRenderPromise;
}) as typeof toDataURL);
}
export async function waitForQRCodeRender(): Promise<void> {
if (!qrCodeRenderPromise) {
throw new Error("mockQRCodeRender() must be called before waitForQRCodeRender()");
}
// Flush the React state update scheduled by QRCode after toDataURL resolves.
await act(async () => {
await qrCodeRenderPromise;
await Promise.resolve();
});
}
export function resetQRCodeMock(): void {
mockedToDataURL.mockReset();
qrCodeRenderPromise = undefined;
}
@@ -6,13 +6,15 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
Please see LICENSE files in the repository root for full details.
*/
import { render, waitFor, cleanup } from "jest-matrix-react";
import { render, cleanup } from "jest-matrix-react";
import React from "react";
import { mockQRCodeRender, resetQRCodeMock, waitForQRCodeRender } from "../../../../test-utils/qrcode";
import QRCode from "../../../../../src/components/views/elements/QRCode";
describe("<QRCode />", () => {
afterEach(() => {
resetQRCodeMock();
cleanup();
});
@@ -22,14 +24,18 @@ describe("<QRCode />", () => {
});
it("renders a QR with defaults", async () => {
mockQRCodeRender();
const { container, getAllByAltText } = render(<QRCode data="asd" />);
await waitFor(() => getAllByAltText("QR Code").length === 1);
await waitForQRCodeRender();
expect(getAllByAltText("QR Code")).toHaveLength(1);
expect(container).toMatchSnapshot();
});
it("renders a QR with high error correction level", async () => {
mockQRCodeRender();
const { container, getAllByAltText } = render(<QRCode data="asd" errorCorrectionLevel="high" />);
await waitFor(() => getAllByAltText("QR Code").length === 1);
await waitForQRCodeRender();
expect(getAllByAltText("QR Code")).toHaveLength(1);
expect(container).toMatchSnapshot();
});
});
@@ -6,22 +6,26 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
Please see LICENSE files in the repository root for full details.
*/
import { cleanup, render, waitFor } from "jest-matrix-react";
import { cleanup, render } from "jest-matrix-react";
import React from "react";
import { mockQRCodeRender, resetQRCodeMock, waitForQRCodeRender } from "../../../../../test-utils/qrcode";
import VerificationQRCode from "../../../../../../src/components/views/elements/crypto/VerificationQRCode";
describe("<VerificationQRCode />", () => {
afterEach(() => {
resetQRCodeMock();
cleanup();
});
it("renders a QR code", async () => {
mockQRCodeRender();
const { container, getAllByAltText } = render(
<VerificationQRCode qrCodeBytes={new Uint8ClampedArray(Buffer.from("asd"))} />,
);
// wait for the spinner to go away
await waitFor(() => getAllByAltText("QR Code").length === 1, { timeout: 2000 });
await waitForQRCodeRender();
expect(getAllByAltText("QR Code")).toHaveLength(1);
expect(container).toMatchSnapshot();
});
});
@@ -6,10 +6,11 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
Please see LICENSE files in the repository root for full details.
*/
import { cleanup, fireEvent, render, screen, waitFor } from "jest-matrix-react";
import { cleanup, fireEvent, render, screen } from "jest-matrix-react";
import React from "react";
import { ClientRendezvousFailureReason, MSC4108FailureReason } from "matrix-js-sdk/src/rendezvous";
import { mockQRCodeRender, resetQRCodeMock, waitForQRCodeRender } from "../../../../../test-utils/qrcode";
import LoginWithQRFlow from "../../../../../../src/components/views/auth/LoginWithQRFlow";
import { LoginWithQRFailureReason, type FailureReason } from "../../../../../../src/components/views/auth/LoginWithQR";
import { Click, Phase } from "../../../../../../src/components/views/auth/LoginWithQR-types";
@@ -31,6 +32,7 @@ describe("<LoginWithQRFlow />", () => {
beforeEach(() => {});
afterEach(() => {
resetQRCodeMock();
onClick.mockReset();
cleanup();
});
@@ -47,11 +49,13 @@ describe("<LoginWithQRFlow />", () => {
});
it("renders QR code", async () => {
mockQRCodeRender();
const { container } = render(
getComponent({ phase: Phase.ShowingQR, code: new TextEncoder().encode("mock-code") }),
);
// QR code is rendered async so we wait for it:
await waitFor(() => screen.getAllByAltText("QR Code").length === 1);
await waitForQRCodeRender();
expect(screen.getAllByAltText("QR Code")).toHaveLength(1);
expect(container).toMatchSnapshot();
});