Get SFU tokens and delegate delayed leaves through the MSC4195 CS API

src/livekit/auth now fronts two flows. For a transport with a LiveKit SFU
`url`, tokens come from our own homeserver's MSC4195 get_token endpoint
and delayed leaves are delegated through delegate_delayed_leave, both via
the js-sdk's unstable client methods. Transports with only a
livekit_service_url keep using the OpenID flow against the JWT service.

A transport advertising both shapes lets a subscriber fall back to the
OpenID flow when the homeserver answers get_token with a 404 (Synapse
reports M_UNRECOGNIZED for unknown routes rather than M_NOT_FOUND), so a
client can still join calls hosted on servers that have not deployed
MSC4195 yet. Publishers never fall back: a homeserver that advertises a
`url` but does not implement the endpoints is misconfigured and the
admin should hear about it, so they get NoMatrix2AuthorizationService.
Delegation uses the same flow as the token so that the participant
identity the service computes matches.

The local member only probes a transport's delegate_delayed_leave
endpoint when it has a service URL. The developer settings tab validates
a custom service URL through the same facade.
This commit is contained in:
Robin
2026-10-12 10:33:00 +02:00
committed by Johannes Marbach
parent 17c3a7cb5d
commit e336ee5cfa
14 changed files with 709 additions and 104 deletions
+124
View File
@@ -0,0 +1,124 @@
/*
Copyright 2026 Element Creations Ltd.
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE in the repository root for full details.
*/
import { type MatrixClient } from "matrix-js-sdk";
import { type CallMembershipIdentityParts } from "matrix-js-sdk/lib/matrixrtc/EncryptionManager";
import { extractFullConfigFromToken, type SFUConfig } from "./types.ts";
import { doNetworkOperationWithRetry } from "../../utils/matrix.ts";
export type ClientGetTokenParts = Pick<
MatrixClient,
"_unstable_getLivekitToken"
>;
export interface GetSFUConfigParams {
/**
* The Matrix client.
*/
client: ClientGetTokenParts;
/**
* Data identifying the local user's session membership.
*/
membership: CallMembershipIdentityParts;
/**
* The WebSocket URL of the SFU for which we wish to get an access token.
*/
url: string;
/**
* The name of the homeserver to which the SFU belongs.
*/
serverName: string;
/**
* The ID of the Matrix room in which the session takes place.
*/
roomId: string;
/**
* The ID of the MatrixRTC slot in which the session takes place.
*/
slotId: string;
}
/**
* Gets an {@link SFUConfig} appropriate for connecting to a given SFU, using
* the MSC4195 LiveKit client-server API endpoints.
*/
export async function getSFUConfig({
client,
membership,
url,
serverName,
roomId,
slotId,
}: GetSFUConfigParams): Promise<SFUConfig> {
const res = await doNetworkOperationWithRetry(async () =>
client._unstable_getLivekitToken({
url,
server_name: serverName,
room_id: roomId,
slot_id: slotId,
member_id: membership.memberId,
}),
);
return extractFullConfigFromToken({ url, jwt: res.jwt });
}
export type ClientDelegationParts = Pick<
MatrixClient,
"_unstable_delegateDelayedLeave" | "baseUrl"
>;
export interface DelegateDelayedLeaveParams {
/**
* The Matrix client.
*/
client: ClientDelegationParts;
/**
* Data identifying the local user's session membership.
*/
membership: CallMembershipIdentityParts;
/**
* The WebSocket URL of the SFU to which we are publishing and wish to
* delegate the delayed leave event.
*/
url: string;
/**
* The ID of the Matrix room in which the session takes place.
*/
roomId: string;
/**
* The ID of the MatrixRTC slot in which the session takes place.
*/
slotId: string;
/**
* The delay ID of the leave event to be delegated.
*/
delayId: string;
}
/**
* Delegates a delayed leave event to a given SFU, so that the event will
* be sent on our behalf whenever we disconnect from the SFU.
*/
export async function delegateDelayedLeave({
client,
membership,
url,
roomId,
slotId,
delayId,
}: DelegateDelayedLeaveParams): Promise<void> {
await doNetworkOperationWithRetry(async () =>
client._unstable_delegateDelayedLeave({
url,
room_id: roomId,
slot_id: slotId,
member_id: membership.memberId,
delay_id: delayId,
}),
);
}
+252
View File
@@ -0,0 +1,252 @@
/*
Copyright 2026 Element Creations Ltd.
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE in the repository root for full details.
*/
import { afterEach, expect, type Mocked, vi, describe, it } from "vitest";
import { type UnstableLivekitTransport } from "matrix-js-sdk/lib/matrixrtc";
import { logger } from "matrix-js-sdk/lib/logger";
import {
aliceDeviceId,
aliceId,
aliceUserId,
createJWTToken,
} from "../../utils/test-fixtures";
import type * as csApi from "./csApi";
import * as openID from "./openID";
import { delegateDelayedLeave, getSFUConfig } from ".";
import { mocked } from "storybook/test";
import { ConnectionError, MatrixError } from "matrix-js-sdk";
import { NoMatrix2AuthorizationService } from "../../utils/errors";
import { type CallMembershipIdentityParts } from "matrix-js-sdk/lib/matrixrtc/EncryptionManager";
vi.mock("./openID", () => ({ getSFUConfig: vi.fn() }));
vi.useFakeTimers();
const csApiJWTToken = createJWTToken(aliceId, "via CS API");
const openIDJWTToken = createJWTToken(aliceId, "via OpenID");
mocked(openID).getSFUConfig.mockResolvedValue({
url: "mock-openID-url",
jwt: openIDJWTToken,
livekitAlias: "via OpenID",
livekitIdentity: aliceId,
});
const client: Mocked<
csApi.ClientGetTokenParts &
csApi.ClientDelegationParts &
openID.ClientOpenIDParts
> = {
baseUrl: "https://matrix.example.org",
_unstable_getLivekitToken: vi.fn().mockResolvedValue({ jwt: csApiJWTToken }),
_unstable_delegateDelayedLeave: vi.fn().mockResolvedValue({}),
getOpenIdToken: vi
.fn()
.mockResolvedValue({ access_token: "mock-openID-token" }),
};
const membership: CallMembershipIdentityParts = {
userId: aliceUserId,
deviceId: aliceDeviceId,
memberId: "123",
};
const roomId = "!room:example.org";
const slotId = "m.call#ROOM";
const unsupportedError = new MatrixError({ errcode: "M_UNSUPPORTED" }, 404);
const urlTransport: UnstableLivekitTransport = {
type: "livekit",
url: "wss://livekit.example.org",
};
const serviceUrlTransport: UnstableLivekitTransport = {
type: "livekit",
livekit_service_url: "https://livekit-jwt.example.org",
};
const urlAndServiceUrlTransport: UnstableLivekitTransport = {
...urlTransport,
...serviceUrlTransport,
};
afterEach(() => vi.clearAllMocks());
describe("getSFUConfig", () => {
const defaultParams = {
client,
membership,
serverName: "example.org",
role: "subscriber" as const,
roomId,
slotId,
logger,
};
it("uses CS API with url transport", async () => {
expect(
await getSFUConfig({ ...defaultParams, transport: urlTransport }),
).toEqual(
expect.objectContaining({
jwt: csApiJWTToken,
livekitAlias: "via CS API",
}),
);
expect(client._unstable_getLivekitToken).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("does not fall back to OpenID with url transport", async () => {
client._unstable_getLivekitToken.mockRejectedValueOnce(unsupportedError);
await expect(
getSFUConfig({ ...defaultParams, transport: urlTransport }),
).rejects.toThrow(expect.any(NoMatrix2AuthorizationService));
expect(client._unstable_getLivekitToken).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("uses OpenID with livekit_service_url transport", async () => {
expect(
await getSFUConfig({ ...defaultParams, transport: serviceUrlTransport }),
).toEqual(
expect.objectContaining({
jwt: openIDJWTToken,
livekitAlias: "via OpenID",
}),
);
expect(client._unstable_getLivekitToken).not.toHaveBeenCalled();
expect(openID.getSFUConfig).toHaveBeenCalled();
});
it("uses CS API with url + livekit_service_url transport", async () => {
expect(
await getSFUConfig({
...defaultParams,
transport: urlAndServiceUrlTransport,
}),
).toEqual(
expect.objectContaining({
jwt: csApiJWTToken,
livekitAlias: "via CS API",
}),
);
expect(client._unstable_getLivekitToken).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("falls back to OpenID with url + livekit_service_url transport", async () => {
client._unstable_getLivekitToken.mockRejectedValueOnce(unsupportedError);
expect(
await getSFUConfig({
...defaultParams,
transport: urlAndServiceUrlTransport,
}),
).toEqual(
expect.objectContaining({
jwt: openIDJWTToken,
livekitAlias: "via OpenID",
}),
);
expect(client._unstable_getLivekitToken).toHaveBeenCalled();
expect(openID.getSFUConfig).toHaveBeenCalled();
});
it("does not fall back to OpenID when publishing", async () => {
client._unstable_getLivekitToken.mockRejectedValueOnce(unsupportedError);
await expect(
getSFUConfig({
...defaultParams,
transport: urlAndServiceUrlTransport,
role: "publisher",
}),
).rejects.toThrow(expect.any(NoMatrix2AuthorizationService));
expect(client._unstable_getLivekitToken).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("does not fall back to OpenID on connection error", async () => {
const client_ = {
...client,
_unstable_getLivekitToken: vi
.fn()
.mockRejectedValue(new ConnectionError("No connection")),
};
await Promise.all([
expect(
getSFUConfig({
...defaultParams,
client: client_,
transport: urlAndServiceUrlTransport,
}),
).rejects.toThrow(expect.any(ConnectionError)),
vi.runAllTimersAsync(), // Allow request to be retried
]);
expect(client_._unstable_getLivekitToken).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
});
describe("delegateDelayedLeave", () => {
const defaultParams = {
client,
membership,
roomId,
slotId,
delayId: "delay123",
logger,
};
it("uses CS API with url transport", async () => {
await delegateDelayedLeave({ ...defaultParams, transport: urlTransport });
expect(client._unstable_delegateDelayedLeave).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("does not fall back to OpenID with url transport", async () => {
client._unstable_delegateDelayedLeave.mockRejectedValueOnce(
unsupportedError,
);
await expect(
delegateDelayedLeave({ ...defaultParams, transport: urlTransport }),
).rejects.toThrow();
expect(client._unstable_delegateDelayedLeave).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("uses OpenID with livekit_service_url transport", async () => {
await delegateDelayedLeave({
...defaultParams,
transport: serviceUrlTransport,
});
expect(client._unstable_delegateDelayedLeave).not.toHaveBeenCalled();
expect(openID.getSFUConfig).toHaveBeenCalled();
});
it("uses CS API with url + livekit_service_url transport", async () => {
await delegateDelayedLeave({
...defaultParams,
transport: urlAndServiceUrlTransport,
});
expect(client._unstable_delegateDelayedLeave).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
it("does not fall back to OpenID with url + livekit_service_url transport", async () => {
client._unstable_delegateDelayedLeave.mockRejectedValueOnce(
unsupportedError,
);
await expect(
delegateDelayedLeave({
...defaultParams,
transport: urlAndServiceUrlTransport,
}),
).rejects.toThrow();
expect(client._unstable_delegateDelayedLeave).toHaveBeenCalled();
expect(openID.getSFUConfig).not.toHaveBeenCalled();
});
});
+200 -1
View File
@@ -5,5 +5,204 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE in the repository root for full details. Please see LICENSE in the repository root for full details.
*/ */
export * from "./openID"; import { type CallMembershipIdentityParts } from "matrix-js-sdk/lib/matrixrtc/EncryptionManager";
import { type Logger } from "matrix-js-sdk/lib/logger";
import { MatrixError } from "matrix-js-sdk";
import { type UnstableLivekitTransport } from "matrix-js-sdk/lib/matrixrtc";
import * as openID from "./openID";
import * as csApi from "./csApi";
import { type SFUConfig } from "./types";
import { NoMatrix2AuthorizationService } from "../../utils/errors";
export type { ClientOpenIDParts } from "./openID";
export type { ClientGetTokenParts, ClientDelegationParts } from "./csApi";
export type * from "./types"; export type * from "./types";
/**
* Checks whether an error means "this homeserver does not implement the
* (unstable) MSC4195 endpoints".
*
* MSC4195 documents `M_NOT_FOUND` for this, but a homeserver without support
* answers with whatever it uses for unknown endpoints (Synapse: 404 with
* `M_UNRECOGNIZED`), so we accept any 404 as "unsupported".
* @param e The error to check.
*/
function isEndpointUnsupported(e: unknown): boolean {
return (
e instanceof MatrixError &&
(e.httpStatus === 404 ||
e.errcode === "M_NOT_FOUND" ||
e.errcode === "M_UNRECOGNIZED")
);
}
export interface GetSFUConfigParams {
/**
* The Matrix client.
*/
client: csApi.ClientGetTokenParts & openID.ClientOpenIDParts;
/**
* Data identifying the local user's session membership.
*/
membership: CallMembershipIdentityParts;
/**
* The transport for which we wish to get an access token.
*/
transport: UnstableLivekitTransport;
/**
* The name of the homeserver to which the {@link transport} belongs.
*/
serverName: string;
/**
* The ID of the Matrix room in which the session takes place.
*/
roomId: string;
/**
* The ID of the MatrixRTC slot in which the session takes place.
*/
slotId: string;
/**
* Whether we want to publish or only subscribe on the {@link transport}.
*/
role: "publisher" | "subscriber";
logger: Logger;
}
/**
* Gets an {@link SFUConfig} appropriate for connecting to a given transport.
*/
export async function getSFUConfig({
client,
membership,
transport,
serverName,
roomId,
slotId,
role,
logger,
}: GetSFUConfigParams): Promise<SFUConfig> {
if ("url" in transport) {
try {
return await csApi.getSFUConfig({
client,
membership,
url: transport.url,
serverName,
roomId,
slotId,
});
} catch (e) {
if (isEndpointUnsupported(e)) {
// Publishers should never fall back. If a homeserver advertises a `url`
// but doesn't support MSC4195 itself, that's a misconfiguration which
// the admin should know about so they can prepare for the future
// deprecation of `livekit_service_url`.
const mayFallBack =
role === "subscriber" && "livekit_service_url" in transport;
if (mayFallBack) {
logger.warn(
`Homeserver does not support the MSC4195 get_token endpoint, falling back to the OpenID flow with service ${transport.livekit_service_url}`,
);
// Fall through
} else {
logger.error(
`Homeserver does not support the MSC4195 get_token endpoint, cannot get token for transport ${transport.url}`,
);
throw new NoMatrix2AuthorizationService(e as Error);
}
} else {
throw e;
}
}
}
return await openID.getSFUConfig({
client,
membership,
serviceUrl: transport.livekit_service_url,
roomId,
slotId,
role,
logger,
});
}
export interface DelegateDelayedLeaveParams {
/**
* The Matrix client.
*/
client: csApi.ClientDelegationParts & openID.ClientOpenIDParts;
/**
* Data identifying the local user's session membership.
*/
membership: CallMembershipIdentityParts;
/**
* The transport to which we are publishing and wish to delegate the delayed
* leave event.
*/
transport: UnstableLivekitTransport;
/**
* The ID of the Matrix room in which the session takes place.
*/
roomId: string;
/**
* The ID of the MatrixRTC slot in which the session takes place.
*/
slotId: string;
/**
* The delay ID of the leave event to be delegated.
*/
delayId: string;
logger: Logger;
}
/**
* Delegates a delayed leave event to a given transport, so that the event will
* be sent on our behalf whenever we disconnect from the transport's SFU.
*/
export async function delegateDelayedLeave({
client,
membership,
transport,
roomId,
slotId,
delayId,
logger,
}: DelegateDelayedLeaveParams): Promise<void> {
// It's important that we use the same flow (CS API or OpenID) as whatever we
// would've used to get a JWT token for this transport, since the participant
// identity computed by the service needs to match.
if ("url" in transport) {
try {
await csApi.delegateDelayedLeave({
client,
membership,
url: transport.url,
roomId,
slotId,
delayId,
});
} catch (e) {
if (isEndpointUnsupported(e))
logger.error(
"Server misconfigured: transport contains a 'url' field but server does not support the MSC4195 delegate_delayed_leave endpoint",
);
throw e;
}
} else {
// This will technically cause the service to issue a new JWT token, but
// it's safe to discard. We're only interested in triggering delegation.
await openID.getSFUConfig({
client,
membership,
serviceUrl: transport.livekit_service_url,
roomId,
slotId,
role: "publisher",
delayEndpointBaseUrl: client.baseUrl,
delayId,
logger,
});
}
}
+5 -1
View File
@@ -133,6 +133,7 @@ describe("DeveloperSettingsTab", () => {
getCrypto: () => ({ getVersion: (): string => "x" }), getCrypto: () => ({ getVersion: (): string => "x" }),
getUserId: () => "@u:hs", getUserId: () => "@u:hs",
getDeviceId: () => "DEVICE", getDeviceId: () => "DEVICE",
getDomain: () => "hs",
} as unknown as MatrixClient; } as unknown as MatrixClient;
it("will not update custom livekit url without roomId", async () => { it("will not update custom livekit url without roomId", async () => {
const user = userEvent.setup(); const user = userEvent.setup();
@@ -228,7 +229,10 @@ describe("DeveloperSettingsTab", () => {
await user.click(saveButton); await user.click(saveButton);
expect(getSFUConfig).toHaveBeenCalledWith( expect(getSFUConfig).toHaveBeenCalledWith(
expect.objectContaining({ expect.objectContaining({
serviceUrl: "wss://example.livekit.valid", transport: {
type: "livekit",
livekit_service_url: "wss://example.livekit.valid",
},
roomId: "#testRoom", roomId: "#testRoom",
}), }),
); );
+5 -1
View File
@@ -521,7 +521,11 @@ export const DeveloperSettingsTab: FC<Props> = ({
await getSFUConfig({ await getSFUConfig({
client, client,
membership: { userId, deviceId, memberId: "" }, membership: { userId, deviceId, memberId: "" },
serviceUrl: customLivekitUrlTextBuffer, transport: {
type: "livekit",
livekit_service_url: customLivekitUrlTextBuffer,
},
serverName: client.getDomain()!,
roomId, roomId,
slotId: "org.example.fake-slot#room", slotId: "org.example.fake-slot#room",
role: "publisher", role: "publisher",
@@ -122,6 +122,8 @@ export function withCallViewModel(mode: MatrixRTCMode) {
}; };
const room = mockMatrixRoom({ const room = mockMatrixRoom({
client: new (class extends EventEmitter { client: new (class extends EventEmitter {
public readonly baseUrl = "https://matrix.example.com";
public getUserId(): string | undefined { public getUserId(): string | undefined {
return localRtcMember.userId; return localRtcMember.userId;
} }
@@ -116,6 +116,7 @@ const delegatedTimings: ResolvedDelayedLeaveTimings = {
}; };
const mockedClient = { const mockedClient = {
baseUrl: "https://matrix.example.org",
getDomain: vi.fn().mockReturnValue("example.org"), getDomain: vi.fn().mockReturnValue("example.org"),
getDeviceId: vi.fn().mockReturnValue("AAAA"), getDeviceId: vi.fn().mockReturnValue("AAAA"),
getOpenIdToken: vi.fn().mockResolvedValue({ getOpenIdToken: vi.fn().mockResolvedValue({
@@ -124,6 +125,7 @@ const mockedClient = {
matrix_server_name: "localhost", matrix_server_name: "localhost",
expires_in: 10000, expires_in: 10000,
}), }),
_unstable_delegateDelayedLeave: vi.fn().mockResolvedValue({}),
}; };
describe("enterRTCSession", () => { describe("enterRTCSession", () => {
@@ -239,6 +241,7 @@ describe("LocalMembership", () => {
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
client: mockedClient, client: mockedClient,
delayId$: constant(null), delayId$: constant(null),
matrixRTCMode: MATRIX_RTC_MODE,
}; };
beforeEach(() => { beforeEach(() => {
@@ -304,9 +307,11 @@ describe("LocalMembership", () => {
expect(internalLogger).toHaveBeenCalledWith(expextedLog); expect(internalLogger).toHaveBeenCalledWith(expextedLog);
}); });
const mockTransport = { const mockTransport: UnstableLivekitTransport = {
livekit_service_url: "a", type: "livekit",
} as UnstableLivekitTransport; url: "https://sfu.example.org",
livekit_service_url: "https://jwt.example.org",
};
const mockTransportLocator: livekitAuth.TransportLocator = { const mockTransportLocator: livekitAuth.TransportLocator = {
transport: mockTransport, transport: mockTransport,
@@ -336,10 +341,10 @@ describe("LocalMembership", () => {
livekitRoom: mockLivekitRoom({}), livekitRoom: mockLivekitRoom({}),
} as unknown as Connection; } as unknown as Connection;
const authCallSpy = vi const delegationSpy = vi
.spyOn(livekitAuth, "getSFUConfig") .spyOn(livekitAuth, "delegateDelayedLeave")
.mockImplementation(() => mockedClient.getOpenIdToken()); .mockResolvedValue();
afterEach(() => authCallSpy.mockClear()); afterEach(() => delegationSpy.mockClear());
it.each([ it.each([
["no", null, timings], ["no", null, timings],
@@ -348,7 +353,11 @@ describe("LocalMembership", () => {
"https://matrix.example.org/_matrix/client/unstable/io.element.msc4195/rtc/livekit/delegate_delayed_leave", "https://matrix.example.org/_matrix/client/unstable/io.element.msc4195/rtc/livekit/delegate_delayed_leave",
delegatedTimings, delegatedTimings,
], ],
["transport", "/a/delegate_delayed_leave", delegatedTimings], [
"transport",
"https://jwt.example.org/delegate_delayed_leave",
delegatedTimings,
],
])( ])(
"joins session with %s delegation support", "joins session with %s delegation support",
async (_serviceName, delegationUrl, delayedLeaveTimings) => { async (_serviceName, delegationUrl, delayedLeaveTimings) => {
@@ -379,22 +388,20 @@ describe("LocalMembership", () => {
delayedLeaveTimings, delayedLeaveTimings,
); );
expect(authCallSpy).not.toHaveBeenCalled(); expect(delegationSpy).not.toHaveBeenCalled();
delayId$.next("leave1"); delayId$.next("leave1");
await flushPromises(); await flushPromises();
if (delegationUrl === null) { if (delegationUrl === null) {
expect(authCallSpy).not.toHaveBeenCalled(); expect(delegationSpy).not.toHaveBeenCalled();
} else { } else {
// Delegation is supported in this test case, so go on to check that // Delegation is supported in this test case, so go on to check that
// LocalMember actually performs delegation // LocalMember actually performs delegation
const expectDelegation = (delayId: string) => const expectDelegation = (delayId: string) =>
expect(authCallSpy).toHaveBeenLastCalledWith({ expect(delegationSpy).toHaveBeenLastCalledWith({
client: mockedClient, client: mockedClient,
membership: ownMemberMock, membership: ownMemberMock,
serviceUrl: "a", transport: mockTransport,
roomId: "!test-room-id:example.org", roomId: "!test-room-id:example.org",
role: "publisher",
delayEndpointBaseUrl: "https://matrix.example.org",
delayId, delayId,
logger: expect.anything(), logger: expect.anything(),
}); });
@@ -79,8 +79,9 @@ import {
} from "../remoteMembers/Connection.ts"; } from "../remoteMembers/Connection.ts";
import { type HomeserverConnected } from "./HomeserverConnected.ts"; import { type HomeserverConnected } from "./HomeserverConnected.ts";
import { import {
type ClientDelegationParts,
delegateDelayedLeave,
type ClientOpenIDParts, type ClientOpenIDParts,
getSFUConfig,
type TransportLocator, type TransportLocator,
} from "../../../livekit/auth"; } from "../../../livekit/auth";
@@ -152,7 +153,7 @@ interface Props {
roomId: string; roomId: string;
ownMembershipIdentity: CallMembershipIdentityParts; ownMembershipIdentity: CallMembershipIdentityParts;
localTransport$: Observable<TransportLocator>; localTransport$: Observable<TransportLocator>;
client: ClientOpenIDParts; client: ClientDelegationParts & ClientOpenIDParts;
matrixRTCSession: Pick< matrixRTCSession: Pick<
MatrixRTCSession, MatrixRTCSession,
"slotId" | "updateCallIntent" | "leave" "slotId" | "updateCallIntent" | "leave"
@@ -720,22 +721,19 @@ export const createLocalMembership$ = ({
async ([joinParams, delayId]) => { async ([joinParams, delayId]) => {
if (joinParams?.delegationSupported && delayId !== null) { if (joinParams?.delegationSupported && delayId !== null) {
try { try {
if (!("livekit_service_url" in joinParams.transport)) logger.info(
throw new Error("Transport has no livekit_service_url"); `Delegating delayed leave to ${JSON.stringify(joinParams.transport)}…`,
// This will technically cause the service to issue a new JWT token, );
// but it's safe to discard. We're only interested in triggering await delegateDelayedLeave({
// delegation.
await getSFUConfig({
client, client,
membership: ownMembershipIdentity, membership: ownMembershipIdentity,
serviceUrl: joinParams.transport.livekit_service_url, transport: joinParams.transport,
roomId,
slotId: matrixRTCSession.slotId, slotId: matrixRTCSession.slotId,
role: "publisher", roomId,
delayEndpointBaseUrl: baseUrl,
delayId, delayId,
logger, logger,
}); });
logger.info("Delayed leave successfully delegated");
} catch (e) { } catch (e) {
// TODO: Surface this to the user as a service interruption? // TODO: Surface this to the user as a service interruption?
logger.error(`Failed to delegate leave`, e); logger.error(`Failed to delegate leave`, e);
@@ -8,6 +8,7 @@ Please see LICENSE in the repository root for full details.
import { import {
afterEach, afterEach,
beforeEach,
describe, describe,
expect, expect,
it, it,
@@ -27,9 +28,12 @@ import {
} from "livekit-client"; } from "livekit-client";
import fetchMock from "fetch-mock"; import fetchMock from "fetch-mock";
import EventEmitter from "events"; import EventEmitter from "events";
import { type IOpenIDToken } from "matrix-js-sdk"; import { MatrixError } from "matrix-js-sdk";
import { logger, type Logger } from "matrix-js-sdk/lib/logger"; import { logger, type Logger } from "matrix-js-sdk/lib/logger";
import { type UnstableLivekitTransport } from "matrix-js-sdk/lib/matrixrtc"; import {
type LivekitGetTokenResponse,
type UnstableLivekitTransport,
} from "matrix-js-sdk/lib/matrixrtc";
import { import {
Connection, Connection,
@@ -40,11 +44,14 @@ import { ObservableScope } from "../../ObservableScope.ts";
import { FailToGetOpenIdToken } from "../../../utils/errors.ts"; import { FailToGetOpenIdToken } from "../../../utils/errors.ts";
import { testJWTToken } from "../../../utils/test-fixtures.ts"; import { testJWTToken } from "../../../utils/test-fixtures.ts";
import { mockRemoteParticipant, ownMemberMock } from "../../../utils/test.ts"; import { mockRemoteParticipant, ownMemberMock } from "../../../utils/test.ts";
import { type ClientOpenIDParts } from "../../../livekit/auth"; import {
type ClientGetTokenParts,
type ClientOpenIDParts,
} from "../../../livekit/auth";
let testScope: ObservableScope; let testScope: ObservableScope;
let client: MockedObject<ClientOpenIDParts>; let client: MockedObject<ClientGetTokenParts & ClientOpenIDParts>;
let fakeLivekitRoom: MockedObject<LivekitRoom>; let fakeLivekitRoom: MockedObject<LivekitRoom>;
@@ -54,21 +61,21 @@ let fakeLocalParticipant: MockedObject<LocalParticipant>;
const ROOM_ID = "!roomID:example.org"; const ROOM_ID = "!roomID:example.org";
const SLOT_ID = "m.call#ROOM"; const SLOT_ID = "m.call#ROOM";
const livekitServiceUrl = "https://matrix-rtc.example.org/livekit/jwt"; const transport: UnstableLivekitTransport = {
const livekitFocus: UnstableLivekitTransport = {
livekit_service_url: livekitServiceUrl,
type: "livekit", type: "livekit",
url: "wss://matrix-rtc.m.localhost/livekit/sfu",
}; };
function setupTest(): void { function setupTest(): void {
testScope = new ObservableScope(); testScope = new ObservableScope();
client = vi.mocked<ClientOpenIDParts>({ client = vi.mocked<ClientGetTokenParts & ClientOpenIDParts>({
getOpenIdToken: vi.fn().mockResolvedValue({ getOpenIdToken: vi.fn().mockResolvedValue({
access_token: "rYsmGUEwNjKgJYyeNUkZseJN", access_token: "rYsmGUEwNjKgJYyeNUkZseJN",
token_type: "Bearer", token_type: "Bearer",
matrix_server_name: "example.org", matrix_server_name: "example.org",
expires_in: 3600, expires_in: 3600,
}), }),
_unstable_getLivekitToken: vi.fn().mockResolvedValue({ jwt: testJWTToken }),
}); });
localParticipantEventEmiter = new EventEmitter(); localParticipantEventEmiter = new EventEmitter();
@@ -117,23 +124,13 @@ function setupRemoteConnection(): Connection {
roomId: ROOM_ID, roomId: ROOM_ID,
slotId: SLOT_ID, slotId: SLOT_ID,
role: "subscriber", role: "subscriber",
transport: livekitFocus, transport,
serverName: "m.localhost", serverName: "m.localhost",
scope: testScope, scope: testScope,
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
livekitRoomFactory: () => fakeLivekitRoom, livekitRoomFactory: () => fakeLivekitRoom,
}; };
fetchMock.post(`${livekitServiceUrl}/get_token`, () => {
return {
status: 200,
body: {
url: "wss://matrix-rtc.m.localhost/livekit/sfu",
jwt: testJWTToken,
},
};
});
fakeLivekitRoom.connect.mockImplementation(async (): Promise<void> => { fakeLivekitRoom.connect.mockImplementation(async (): Promise<void> => {
const changeEv = RoomEvent.ConnectionStateChanged; const changeEv = RoomEvent.ConnectionStateChanged;
@@ -155,6 +152,19 @@ afterEach(() => {
}); });
describe("Start connection states", () => { describe("Start connection states", () => {
beforeEach(() => {
fetchMock.post(
`https://matrix-rtc.example.org/livekit/jwt/get_token`,
() => {
return {
// Return a non-retryable error, if not, the retry logic will
// wait and fail the test with a timeout.
status: 404,
};
},
);
});
it("start in initialized state", () => { it("start in initialized state", () => {
setupTest(); setupTest();
@@ -163,7 +173,7 @@ describe("Start connection states", () => {
roomId: ROOM_ID, roomId: ROOM_ID,
slotId: SLOT_ID, slotId: SLOT_ID,
role: "subscriber", role: "subscriber",
transport: livekitFocus, transport,
serverName: "m.localhost", serverName: "m.localhost",
scope: testScope, scope: testScope,
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
@@ -174,7 +184,7 @@ describe("Start connection states", () => {
expect(connection.state$.getValue()).toEqual({ state: "initialized" }); expect(connection.state$.getValue()).toEqual({ state: "initialized" });
}); });
it("fail to getOpenId token then error state", async () => { it("fail to get SFU token then error state", async () => {
setupTest(); setupTest();
vi.useFakeTimers(); vi.useFakeTimers();
@@ -183,7 +193,7 @@ describe("Start connection states", () => {
roomId: ROOM_ID, roomId: ROOM_ID,
slotId: SLOT_ID, slotId: SLOT_ID,
role: "subscriber", role: "subscriber",
transport: livekitFocus, transport,
serverName: "m.localhost", serverName: "m.localhost",
scope: testScope, scope: testScope,
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
@@ -198,10 +208,10 @@ describe("Start connection states", () => {
}); });
onTestFinished(() => s.unsubscribe()); onTestFinished(() => s.unsubscribe());
const deferred = Promise.withResolvers<IOpenIDToken>(); const deferred = Promise.withResolvers<LivekitGetTokenResponse>();
client.getOpenIdToken.mockImplementation( client._unstable_getLivekitToken.mockImplementation(
async (): Promise<IOpenIDToken> => { async (): Promise<LivekitGetTokenResponse> => {
return await deferred.promise; return await deferred.promise;
}, },
); );
@@ -221,7 +231,7 @@ describe("Start connection states", () => {
capturedState = capturedStates.pop(); capturedState = capturedStates.pop();
if (capturedState?.state === "error") { if (capturedState?.state === "error") {
expect(capturedState.error.message).toEqual("Something went wrong"); expect(capturedState.error.message).toEqual("Something went wrong");
expect(connection.transport).toEqual(livekitFocus); expect(connection.transport).toEqual(transport);
} else { } else {
expect.fail( expect.fail(
"Expected FailedToStart state but got " + JSON.stringify(capturedState), "Expected FailedToStart state but got " + JSON.stringify(capturedState),
@@ -238,7 +248,7 @@ describe("Start connection states", () => {
roomId: ROOM_ID, roomId: ROOM_ID,
slotId: SLOT_ID, slotId: SLOT_ID,
role: "subscriber", role: "subscriber",
transport: livekitFocus, transport,
serverName: "m.localhost", serverName: "m.localhost",
scope: testScope, scope: testScope,
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
@@ -254,16 +264,15 @@ describe("Start connection states", () => {
onTestFinished(() => s.unsubscribe()); onTestFinished(() => s.unsubscribe());
const deferredSFU = Promise.withResolvers<void>(); const deferredSFU = Promise.withResolvers<void>();
// mock the /get_token call client._unstable_getLivekitToken.mockImplementation(async () => {
fetchMock.post(`${livekitServiceUrl}/get_token`, async () => {
await deferredSFU.promise; await deferredSFU.promise;
return { throw new MatrixError(
status: 500, {
body: {
errcode: "M_LOOKUP_FAILED", errcode: "M_LOOKUP_FAILED",
error: "Failed to look up user info from homeserver", error: "Failed to look up user info from homeserver",
}, },
}; 500,
);
}); });
connection.start().catch(() => { connection.start().catch(() => {
@@ -286,7 +295,7 @@ describe("Start connection states", () => {
expect(capturedState.error.cause.message).toContain( expect(capturedState.error.cause.message).toContain(
"Failed to look up user info from homeserver", "Failed to look up user info from homeserver",
); );
expect(connection.transport).toEqual(livekitFocus); expect(connection.transport).toEqual(transport);
} else { } else {
expect.fail( expect.fail(
"Expected FailedToStart state but got " + JSON.stringify(capturedState), "Expected FailedToStart state but got " + JSON.stringify(capturedState),
@@ -303,7 +312,7 @@ describe("Start connection states", () => {
roomId: ROOM_ID, roomId: ROOM_ID,
slotId: SLOT_ID, slotId: SLOT_ID,
role: "subscriber", role: "subscriber",
transport: livekitFocus, transport,
serverName: "m.localhost", serverName: "m.localhost",
scope: testScope, scope: testScope,
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
@@ -319,17 +328,6 @@ describe("Start connection states", () => {
onTestFinished(() => s.unsubscribe()); onTestFinished(() => s.unsubscribe());
const deferredSFU = Promise.withResolvers<void>(); const deferredSFU = Promise.withResolvers<void>();
// mock the /get_token call
fetchMock.post(`${livekitServiceUrl}/get_token`, () => {
return {
status: 200,
body: {
url: "wss://matrix-rtc.m.localhost/livekit/sfu",
jwt: testJWTToken,
},
};
});
fakeLivekitRoom.connect.mockImplementation(async () => { fakeLivekitRoom.connect.mockImplementation(async () => {
await deferredSFU.promise; await deferredSFU.promise;
throw new Error("Failed to connect to livekit"); throw new Error("Failed to connect to livekit");
@@ -356,7 +354,7 @@ describe("Start connection states", () => {
expect(capturedState.error.cause.message).toContain( expect(capturedState.error.cause.message).toContain(
"Failed to connect to livekit", "Failed to connect to livekit",
); );
expect(connection.transport).toEqual(livekitFocus); expect(connection.transport).toEqual(transport);
} else { } else {
expect.fail( expect.fail(
"Expected FailedToStart state but got " + JSON.stringify(capturedState), "Expected FailedToStart state but got " + JSON.stringify(capturedState),
@@ -564,7 +562,7 @@ describe("remote track logging", () => {
roomId: ROOM_ID, roomId: ROOM_ID,
slotId: SLOT_ID, slotId: SLOT_ID,
role: "subscriber", role: "subscriber",
transport: livekitFocus, transport,
serverName: "m.localhost", serverName: "m.localhost",
scope: testScope, scope: testScope,
ownMembershipIdentity: ownMemberMock, ownMembershipIdentity: ownMemberMock,
@@ -39,6 +39,7 @@ import {
UnknownCallError, UnknownCallError,
} from "../../../utils/errors.ts"; } from "../../../utils/errors.ts";
import { import {
type ClientGetTokenParts,
getSFUConfig, getSFUConfig,
type ClientOpenIDParts, type ClientOpenIDParts,
type SFUConfig, type SFUConfig,
@@ -54,7 +55,7 @@ export interface ConnectionOpts {
/** The name of the homeserver to which the {@link transport} belongs. */ /** The name of the homeserver to which the {@link transport} belongs. */
serverName: string; serverName: string;
/** The Matrix client to use for OpenID and SFU config requests. */ /** The Matrix client to use for OpenID and SFU config requests. */
client: ClientOpenIDParts; client: ClientGetTokenParts & ClientOpenIDParts;
/** The ID of the Matrix room in which the session takes place. */ /** The ID of the Matrix room in which the session takes place. */
roomId: string; roomId: string;
/** The ID of the MatrixRTC slot in which the session takes place. */ /** The ID of the MatrixRTC slot in which the session takes place. */
@@ -134,7 +135,7 @@ export class Connection {
protected stopped = false; protected stopped = false;
// TODO: can we just keep the ConnectionOpts object instead of spreading? // TODO: can we just keep the ConnectionOpts object instead of spreading?
private readonly client: ClientOpenIDParts; private readonly client: ClientGetTokenParts & ClientOpenIDParts;
private readonly roomId: string; private readonly roomId: string;
private readonly slotId: string; private readonly slotId: string;
private readonly logger: Logger; private readonly logger: Logger;
@@ -385,13 +386,12 @@ export class Connection {
} }
protected async getSFUConfig(): Promise<SFUConfig> { protected async getSFUConfig(): Promise<SFUConfig> {
if (!("livekit_service_url" in this.transport))
throw new Error("Transport has no livekit_service_url");
return await getSFUConfig({ return await getSFUConfig({
client: this.client, client: this.client,
membership: this.ownMembershipIdentity, membership: this.ownMembershipIdentity,
role: this.role, role: this.role,
serviceUrl: this.transport.livekit_service_url, transport: this.transport,
serverName: this.serverName,
roomId: this.roomId, roomId: this.roomId,
slotId: this.slotId, slotId: this.slotId,
logger: this.logger, logger: this.logger,
@@ -35,7 +35,10 @@ import {
noiseSuppressionSetting, noiseSuppressionSetting,
autoGainControlSetting, autoGainControlSetting,
} from "../../../settings/settings.ts"; } from "../../../settings/settings.ts";
import { type ClientOpenIDParts } from "../../../livekit/auth"; import {
type ClientGetTokenParts,
type ClientOpenIDParts,
} from "../../../livekit/auth";
// TODO evaluate if this should be done like the Publisher Factory // TODO evaluate if this should be done like the Publisher Factory
export interface ConnectionFactory { export interface ConnectionFactory {
@@ -65,7 +68,7 @@ export class ECConnectionFactory implements ConnectionFactory {
* @param livekitRoomFactory - Optional factory function (for testing) to create LivekitRoom instances. If not provided, a default factory is used. * @param livekitRoomFactory - Optional factory function (for testing) to create LivekitRoom instances. If not provided, a default factory is used.
*/ */
public constructor( public constructor(
private client: ClientOpenIDParts, private client: ClientGetTokenParts & ClientOpenIDParts,
private readonly roomId: string, private readonly roomId: string,
private readonly slotId: string, private readonly slotId: string,
private devices: MediaDevices, private devices: MediaDevices,
@@ -14,7 +14,10 @@ import EventEmitter from "events";
import { ObservableScope } from "../../ObservableScope.ts"; import { ObservableScope } from "../../ObservableScope.ts";
import { ECConnectionFactory } from "./ConnectionFactory.ts"; import { ECConnectionFactory } from "./ConnectionFactory.ts";
import { type ClientOpenIDParts } from "../../../livekit/auth"; import {
type ClientGetTokenParts,
type ClientOpenIDParts,
} from "../../../livekit/auth";
import { import {
exampleTransport, exampleTransport,
mockMediaDevices, mockMediaDevices,
@@ -32,6 +35,7 @@ import {
cameraBitrate, cameraBitrate,
cameraCodec, cameraCodec,
} from "../../../settings/settings.ts"; } from "../../../settings/settings.ts";
import { testJWTToken } from "../../../utils/test-fixtures.ts";
// At the top of your test file, after imports // At the top of your test file, after imports
vi.mock("livekit-client", async (importOriginal) => { vi.mock("livekit-client", async (importOriginal) => {
@@ -51,12 +55,13 @@ vi.mock("livekit-client", async (importOriginal) => {
}); });
let testScope: ObservableScope; let testScope: ObservableScope;
let mockClient: ClientOpenIDParts; let mockClient: ClientGetTokenParts & ClientOpenIDParts;
beforeEach(() => { beforeEach(() => {
testScope = new ObservableScope(); testScope = new ObservableScope();
mockClient = { mockClient = {
getOpenIdToken: vi.fn().mockReturnValue(""), getOpenIdToken: vi.fn().mockReturnValue(""),
_unstable_getLivekitToken: vi.fn().mockResolvedValue({ jwt: testJWTToken }),
}; };
}); });
@@ -18,7 +18,10 @@ import {
trackEpoch, trackEpoch,
} from "../../ObservableScope.ts"; } from "../../ObservableScope.ts";
import { ECConnectionFactory } from "./ConnectionFactory.ts"; import { ECConnectionFactory } from "./ConnectionFactory.ts";
import { type ClientOpenIDParts } from "../../../livekit/auth"; import {
type ClientGetTokenParts,
type ClientOpenIDParts,
} from "../../../livekit/auth";
import { import {
exampleTransportLocator, exampleTransportLocator,
mockMediaDevices, mockMediaDevices,
@@ -40,7 +43,7 @@ import { deepCompare } from "matrix-js-sdk/lib/utils";
let testScope: ObservableScope; let testScope: ObservableScope;
let ecConnectionFactory: ECConnectionFactory; let ecConnectionFactory: ECConnectionFactory;
let mockClient: ClientOpenIDParts; let mockClient: ClientGetTokenParts & ClientOpenIDParts;
let lkRoomFactory: () => LivekitRoom; let lkRoomFactory: () => LivekitRoom;
const createdMockLivekitRooms: Map<string, LivekitRoom> = new Map(); const createdMockLivekitRooms: Map<string, LivekitRoom> = new Map();
@@ -49,6 +52,7 @@ beforeEach(() => {
testScope = new ObservableScope(); testScope = new ObservableScope();
mockClient = { mockClient = {
getOpenIdToken: vi.fn().mockReturnValue(""), getOpenIdToken: vi.fn().mockReturnValue(""),
_unstable_getLivekitToken: vi.fn().mockResolvedValue({ jwt: testJWTToken }),
}; };
lkRoomFactory = vi.fn().mockImplementation(() => { lkRoomFactory = vi.fn().mockImplementation(() => {
@@ -82,7 +86,7 @@ beforeEach(() => {
); );
//TODO a bit annoying to have to do a http mock? //TODO a bit annoying to have to do a http mock?
const sfuConfigResponse = (url: string): { status: number; body: object } => { fetchMock.post(`path:/sfu/get`, (url) => {
const domain = new URL(url).hostname; // Extract the domain from the URL const domain = new URL(url).hostname; // Extract the domain from the URL
return { return {
status: 200, status: 200,
@@ -91,9 +95,7 @@ beforeEach(() => {
jwt: testJWTToken, jwt: testJWTToken,
}, },
}; };
}; });
fetchMock.post(`path:/sfu/get`, sfuConfigResponse);
fetchMock.post(`path:/get_token`, sfuConfigResponse);
}); });
afterEach(() => { afterEach(() => {
+10 -3
View File
@@ -64,16 +64,23 @@ export const daveRTL = mockMatrixRoomMember(daveRTLRtcMember, {
rawDisplayName: "\u202eevaD", rawDisplayName: "\u202eevaD",
}); });
export const testJWTToken = [ export function createJWTToken(sub: string, room: string): string {
return [
{}, // header {}, // header
{ {
// payload // payload
sub: "@me:example.org:ABCDEF", sub,
video: { video: {
room: "!example_room_id", room,
}, },
}, },
{}, // signature {}, // signature
] ]
.map((d) => global.btoa(JSON.stringify(d))) .map((d) => global.btoa(JSON.stringify(d)))
.join("."); .join(".");
}
export const testJWTToken = createJWTToken(
"@me:example.org:ABCDEF",
"!example_room_id",
);