element-call-Github/src/room/GroupCallErrorBoundary.test.tsx

/*
Copyright 2025 New Vector Ltd.

SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE in the repository root for full details.
*/

import { describe, expect, onTestFinished, test, vi } from "vitest";
import { render, screen } from "@testing-library/react";
import {
  type FC,
  type ReactElement,
  type ReactNode,
  useCallback,
  useState,
} from "react";
import { LeaveToHomeProvider } from "../LeaveToHomeContext";
import userEvent from "@testing-library/user-event";
import { ConnectionError } from "livekit-client";
import { MatrixError } from "matrix-js-sdk";

import {
  type CallErrorRecoveryAction,
  GroupCallErrorBoundary,
} from "./GroupCallErrorBoundary.tsx";
import {
  ConnectionLostError,
  E2EENotSupportedError,
  type ElementCallError,
  FailToGetOpenIdToken,
  InsufficientCapacityError,
  LivekitConnectionError,
  MatrixRTCTransportMissingError,
  PeerConnectionTimeoutError,
  StickyEventsRequiredError,
  UnknownCallError,
} from "../utils/errors.ts";
import { mockConfig } from "../utils/test.ts";
import {
  type HostBridge,
  HostBridgeProvider,
  nullHostBridge,
} from "../HostBridge.ts";

// Somewhere to go home to, so that the error pages offer the way
const leaveToHome = vi.fn();

test.each([
  {
    error: new MatrixRTCTransportMissingError("example.com"),
    expectedTitle: "Call is not supported",
  },
  {
    error: new ConnectionLostError(),
    expectedTitle: "Connection lost",
    expectedDescription: "You were disconnected from the call.",
  },
  {
    error: new E2EENotSupportedError(),
    expectedTitle: "Incompatible browser",
    expectedDescription:
      "Your web browser does not support encrypted calls. Supported browsers include Chrome, Safari, and Firefox 117+.",
  },
  {
    error: new InsufficientCapacityError(),
    expectedTitle: "Insufficient capacity",
    expectedDescription:
      "The server has reached its maximum capacity and you cannot join the call at this time. Try again later, or contact your server admin if the problem persists.",
  },
  {
    error: new StickyEventsRequiredError(),
    expectedTitle: "Homeserver does not support Matrix 2.0 calls",
    expectedDescription:
      "This deployment is configured to use Matrix 2.0 call mode, but the homeserver does not advertise support for sticky events (MSC4354). Ask your server admin to upgrade, or switch the deployment to a compatible mode.",
  },
])(
  "should report correct error for $expectedTitle",
  async ({ error, expectedTitle, expectedDescription }) => {
    const TestComponent = (): ReactNode => {
      throw error;
    };

    const onErrorMock = vi.fn();
    const { asFragment } = render(
      <LeaveToHomeProvider value={leaveToHome}>
        <GroupCallErrorBoundary
          onError={onErrorMock}
          recoveryActionHandler={vi.fn()}
        >
          <TestComponent />
        </GroupCallErrorBoundary>
      </LeaveToHomeProvider>,
    );

    await screen.findByText(expectedTitle);
    if (expectedDescription) {
      expect(screen.queryByText(expectedDescription)).toBeInTheDocument();
    }
    expect(onErrorMock).toHaveBeenCalledWith(error);

    expect(asFragment()).toMatchSnapshot();
  },
);

test("should render the error page with link back to home", async () => {
  const error = new MatrixRTCTransportMissingError("example.com");
  const TestComponent = (): ReactNode => {
    throw error;
  };

  const onErrorMock = vi.fn();
  // From the home page itself the home button reloads instead of navigating,
  // so be somewhere else for this test
  window.history.pushState({}, "", "/room/somewhere");
  onTestFinished(() => window.history.pushState({}, "", "/"));
  const { asFragment } = render(
    <LeaveToHomeProvider value={leaveToHome}>
      <GroupCallErrorBoundary
        onError={onErrorMock}
        recoveryActionHandler={vi.fn()}
      >
        <TestComponent />
      </GroupCallErrorBoundary>
    </LeaveToHomeProvider>,
  );

  await screen.findByText("Call is not supported");
  expect(screen.getByText(/Domain: example\.com/i)).toBeInTheDocument();
  expect(
    screen.getByText(/Error Code: MISSING_MATRIX_RTC_TRANSPORT/i),
  ).toBeInTheDocument();

  // The way home is whatever the shell supplied, not a route of the call's own
  await userEvent
    .setup()
    .click(screen.getByRole("button", { name: "Return to home screen" }));
  expect(leaveToHome).toHaveBeenCalledOnce();

  expect(onErrorMock).toHaveBeenCalledOnce();
  expect(onErrorMock).toHaveBeenCalledWith(error);

  expect(asFragment()).toMatchSnapshot();
});

test("ConnectionLostError: Action handling should reset error state", async () => {
  const user = userEvent.setup();

  const TestComponent: FC<{ fail: boolean }> = ({ fail }): ReactNode => {
    if (fail) {
      throw new ConnectionLostError();
    }
    return <div>HELLO</div>;
  };

  const reconnectCallbackSpy = vi.fn();

  const WrapComponent = (): ReactNode => {
    const [failState, setFailState] = useState(true);
    const reconnectCallback = useCallback(
      async (action: CallErrorRecoveryAction) => {
        reconnectCallbackSpy(action);
        setFailState(false);
        return Promise.resolve();
      },
      [setFailState],
    );

    return (
      <LeaveToHomeProvider value={leaveToHome}>
        <GroupCallErrorBoundary recoveryActionHandler={reconnectCallback}>
          <TestComponent fail={failState} />
        </GroupCallErrorBoundary>
      </LeaveToHomeProvider>
    );
  };

  const { asFragment } = render(<WrapComponent />);

  // Should fail first
  await screen.findByText("Connection lost");
  await screen.findByRole("button", { name: "Reconnect" });
  await screen.findByRole("button", { name: "Return to home screen" });

  expect(asFragment()).toMatchSnapshot();

  await user.click(screen.getByRole("button", { name: "Reconnect" }));

  // reconnect should have reset the error, thus rendering should be ok
  await screen.findByText("HELLO");

  expect(reconnectCallbackSpy).toHaveBeenCalledOnce();
  expect(reconnectCallbackSpy).toHaveBeenCalledWith("reconnect");
});

describe("Rageshake button", () => {
  function setupTest(testError: ElementCallError): void {
    mockConfig({
      rageshake: {
        submit_url: "https://rageshake.example.com.localhost",
      },
    });

    const TestComponent = (): ReactElement => {
      throw testError;
    };

    render(
      <LeaveToHomeProvider value={leaveToHome}>
        <GroupCallErrorBoundary
          onError={vi.fn()}
          recoveryActionHandler={vi.fn()}
        >
          <TestComponent />
        </GroupCallErrorBoundary>
      </LeaveToHomeProvider>,
    );
  }

  test("should show send rageshake button for unknown errors", () => {
    setupTest(new UnknownCallError(new Error("FOO")));

    expect(
      screen.queryByRole("button", { name: "Send debug logs" }),
    ).toBeInTheDocument();
  });

  test("should not show send rageshake button for call errors", () => {
    setupTest(new E2EENotSupportedError());

    expect(
      screen.queryByRole("button", { name: "Send debug logs" }),
    ).not.toBeInTheDocument();
  });
});

test("should have a close button when the host can dismiss us", async () => {
  const error = new MatrixRTCTransportMissingError("example.com");
  const TestComponent = (): ReactNode => {
    throw error;
  };

  const close = vi.fn().mockResolvedValue(undefined);
  const hostBridge: HostBridge = { ...nullHostBridge, close };

  const user = userEvent.setup();
  const onErrorMock = vi.fn();
  const { asFragment } = render(
    <LeaveToHomeProvider value={leaveToHome}>
      <HostBridgeProvider value={hostBridge}>
        <GroupCallErrorBoundary
          onError={onErrorMock}
          recoveryActionHandler={vi.fn()}
        >
          <TestComponent />
        </GroupCallErrorBoundary>
      </HostBridgeProvider>
    </LeaveToHomeProvider>,
  );

  await screen.findByText("Call is not supported");

  await screen.findByRole("button", { name: "Close" });

  expect(asFragment()).toMatchSnapshot();

  await user.click(screen.getByRole("button", { name: "Close" }));

  expect(close).toHaveBeenCalled();
});

test("should show technical details when error has a matrixError cause", async () => {
  const underlyingError = new MatrixError(
    {
      errcode: "M_LOOKUP_FAILED",
      error: "Failed to look up user info from homeserver",
    },
    500,
    "https://matrix-rtc.m.localhost/livekit/jwt/sfu/get",
  );
  const error = new FailToGetOpenIdToken(underlyingError);

  const TestComponent = (): ReactNode => {
    throw error;
  };

  render(
    <LeaveToHomeProvider value={leaveToHome}>
      <GroupCallErrorBoundary onError={vi.fn()} recoveryActionHandler={vi.fn()}>
        <TestComponent />
      </GroupCallErrorBoundary>
    </LeaveToHomeProvider>,
  );

  await screen.findByText("Something went wrong");

  // Technical details should be present
  const detailsElement = screen.getByText("Technical details");
  expect(detailsElement).toBeInTheDocument();

  // Verify error details are shown
  expect(
    screen.getByText(/Failed to look up user info from homeserver/i, {
      selector: "pre",
    }),
  ).toBeInTheDocument();
});

test("should not show technical details when error has no matrix error cause", async () => {
  const error = new ConnectionLostError();

  const TestComponent = (): ReactNode => {
    throw error;
  };

  render(
    <LeaveToHomeProvider value={leaveToHome}>
      <GroupCallErrorBoundary onError={vi.fn()} recoveryActionHandler={vi.fn()}>
        <TestComponent />
      </GroupCallErrorBoundary>
    </LeaveToHomeProvider>,
  );

  await screen.findByText("Connection lost");

  // Technical details should not be present (ConnectionLostError has no cause)
  expect(screen.queryByText("Technical details")).not.toBeInTheDocument();
});

describe("LiveKit ConnectionError variants", () => {
  test.each([
    {
      name: "notAllowed",
      error: ConnectionError.notAllowed("Permission denied by server", 403),
      expectedReason: "NotAllowed",
    },
    {
      name: "timeout",
      error: ConnectionError.timeout("Connection timed out"),
      expectedReason: "Timeout",
    },
    {
      name: "serverUnreachable",
      error: ConnectionError.serverUnreachable("Server is unreachable", 503),
      expectedReason: "ServerUnreachable",
    },
    {
      name: "serviceNotFound",
      error: ConnectionError.serviceNotFound(
        "RTC service not found",
        "v0-rtc" as const,
      ),
      expectedReason: "ServiceNotFound",
    },
    {
      name: "internal",
      error: ConnectionError.internal("Internal server error", {
        status: 500,
        statusText: "Internal Server Error",
      }),
      expectedReason: "InternalError",
    },
  ])(
    "should display LiveKit $name error correctly",
    async ({ error, expectedReason }) => {
      const TestComponent = (): ReactNode => {
        throw new LivekitConnectionError(error);
      };

      const { asFragment } = render(
        <LeaveToHomeProvider value={leaveToHome}>
          <GroupCallErrorBoundary
            onError={vi.fn()}
            recoveryActionHandler={vi.fn()}
          >
            <TestComponent />
          </GroupCallErrorBoundary>
        </LeaveToHomeProvider>,
      );

      // Check title
      await screen.findByText("Failed to connect to Livekit server");

      // Check that reason is displayed in the description
      expect(screen.getByText(/Reason:/i)).toBeInTheDocument();
      expect(screen.getByText(expectedReason)).toBeInTheDocument();

      expect(asFragment()).toMatchSnapshot();
    },
  );

  test("should link to troubleshoot guide when timeout error", async () => {
    const error = new PeerConnectionTimeoutError();

    const TestComponent = (): ReactNode => {
      throw error;
    };

    const { asFragment } = render(
      <LeaveToHomeProvider value={leaveToHome}>
        <GroupCallErrorBoundary
          onError={vi.fn()}
          recoveryActionHandler={vi.fn()}
        >
          <TestComponent />
        </GroupCallErrorBoundary>
      </LeaveToHomeProvider>,
    );

    await screen.findByText("Connection timeout");

    // Verify the link is present and has correct href
    const link = screen.getByText("troubleshooting guide");
    expect(link).toHaveAttribute(
      "href",
      "https://docs.element.io/latest/element-server-suite-pro/configuring-components/configuring-matrix-rtc/#sfu-connectivity-troubleshooting",
    );

    // Snapshot the complete rendered error
    expect(asFragment()).toMatchSnapshot();
  });
});