Skip to content

Commit

Permalink
Log consolidated server info when connected (#391)
Browse files Browse the repository at this point in the history 
* log consolidated server info when connected

* formatting

* changeset
  • Loading branch information
@lukasIO
lukasIO committed Aug 12, 2022
1 parent b9ca04f commit e5851ea
Show file tree
Hide file tree
Showing 6 changed files with 193 additions and 19 deletions.
5 changes: 5 additions & 0 deletions .changeset/eleven-chefs-swim.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'livekit-client': patch
---

Log consolidated serverinfo on connect
2 changes: 1 addition & 1 deletion protocol
Submodule protocol updated 18 files
+4 −11 .github/workflows/generate.yaml
+29 −4 go.mod
+18 −8 go.sum
+2 −2 livekit/livekit_analytics.pb.go
+1 −1 livekit/livekit_analytics_grpc.pb.go
+12 −2 livekit/livekit_egress.pb.go
+5 −2 livekit/livekit_egress.twirp.go
+100 −90 livekit/livekit_ingress.pb.go
+59 −58 livekit/livekit_ingress.twirp.go
+4 −2 livekit/livekit_internal.pb.go
+248 −82 livekit/livekit_models.pb.go
+2 −2 livekit/livekit_room.pb.go
+5 −2 livekit/livekit_rpc_internal.pb.go
+258 −238 livekit/livekit_rtc.pb.go
+2 −2 livekit/livekit_webhook.pb.go
+1 −0 livekit_ingress.proto
+15 −0 livekit_models.proto
+3 −0 livekit_rtc.proto
2 changes: 1 addition & 1 deletion src/proto/google/protobuf/timestamp.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ export type DeepPartial<T> = T extends Builtin
type KeysOfUnion<T> = T extends T ? keyof T : never;
export type Exact<P, I extends P> = P extends Builtin
? P
: P & { [K in keyof P]: Exact<P[K], I[K]> } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
: P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };

function longToNumber(long: Long): number {
if (long.gt(Number.MAX_SAFE_INTEGER)) {
Expand Down
172 changes: 157 additions & 15 deletions src/proto/livekit_models.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,50 @@ export interface ParticipantTracks {
trackSids: string[];
}

/** details about the server */
export interface ServerInfo {
edition: ServerInfo_Edition;
version: string;
protocol: number;
region: string;
nodeId: string;
/** additional debugging information. sent only if server is in development mode */
debugInfo: string;
}

export enum ServerInfo_Edition {
Standard = 0,
Cloud = 1,
UNRECOGNIZED = -1,
}

export function serverInfo_EditionFromJSON(object: any): ServerInfo_Edition {
switch (object) {
case 0:
case 'Standard':
return ServerInfo_Edition.Standard;
case 1:
case 'Cloud':
return ServerInfo_Edition.Cloud;
case -1:
case 'UNRECOGNIZED':
default:
return ServerInfo_Edition.UNRECOGNIZED;
}
}

export function serverInfo_EditionToJSON(object: ServerInfo_Edition): string {
switch (object) {
case ServerInfo_Edition.Standard:
return 'Standard';
case ServerInfo_Edition.Cloud:
return 'Cloud';
case ServerInfo_Edition.UNRECOGNIZED:
default:
return 'UNRECOGNIZED';
}
}

/** details about the client */
export interface ClientInfo {
sdk: ClientInfo_SDK;
Expand Down Expand Up @@ -1809,6 +1853,100 @@ export const ParticipantTracks = {
},
};

function createBaseServerInfo(): ServerInfo {
return { edition: 0, version: '', protocol: 0, region: '', nodeId: '', debugInfo: '' };
}

export const ServerInfo = {
encode(message: ServerInfo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
if (message.edition !== 0) {
writer.uint32(8).int32(message.edition);
}
if (message.version !== '') {
writer.uint32(18).string(message.version);
}
if (message.protocol !== 0) {
writer.uint32(24).int32(message.protocol);
}
if (message.region !== '') {
writer.uint32(34).string(message.region);
}
if (message.nodeId !== '') {
writer.uint32(42).string(message.nodeId);
}
if (message.debugInfo !== '') {
writer.uint32(50).string(message.debugInfo);
}
return writer;
},

decode(input: _m0.Reader | Uint8Array, length?: number): ServerInfo {
const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
let end = length === undefined ? reader.len : reader.pos + length;
const message = createBaseServerInfo();
while (reader.pos < end) {
const tag = reader.uint32();
switch (tag >>> 3) {
case 1:
message.edition = reader.int32() as any;
break;
case 2:
message.version = reader.string();
break;
case 3:
message.protocol = reader.int32();
break;
case 4:
message.region = reader.string();
break;
case 5:
message.nodeId = reader.string();
break;
case 6:
message.debugInfo = reader.string();
break;
default:
reader.skipType(tag & 7);
break;
}
}
return message;
},

fromJSON(object: any): ServerInfo {
return {
edition: isSet(object.edition) ? serverInfo_EditionFromJSON(object.edition) : 0,
version: isSet(object.version) ? String(object.version) : '',
protocol: isSet(object.protocol) ? Number(object.protocol) : 0,
region: isSet(object.region) ? String(object.region) : '',
nodeId: isSet(object.nodeId) ? String(object.nodeId) : '',
debugInfo: isSet(object.debugInfo) ? String(object.debugInfo) : '',
};
},

toJSON(message: ServerInfo): unknown {
const obj: any = {};
message.edition !== undefined && (obj.edition = serverInfo_EditionToJSON(message.edition));
message.version !== undefined && (obj.version = message.version);
message.protocol !== undefined && (obj.protocol = Math.round(message.protocol));
message.region !== undefined && (obj.region = message.region);
message.nodeId !== undefined && (obj.nodeId = message.nodeId);
message.debugInfo !== undefined && (obj.debugInfo = message.debugInfo);
return obj;
},

fromPartial<I extends Exact<DeepPartial<ServerInfo>, I>>(object: I): ServerInfo {
const message = createBaseServerInfo();
message.edition = object.edition ?? 0;
message.version = object.version ?? '';
message.protocol = object.protocol ?? 0;
message.region = object.region ?? '';
message.nodeId = object.nodeId ?? '';
message.debugInfo = object.debugInfo ?? '';
return message;
},
};

function createBaseClientInfo(): ClientInfo {
return {
sdk: 0,
Expand Down Expand Up @@ -2734,25 +2872,29 @@ var globalThis: any = (() => {
throw 'Unable to locate global object';
})();

const atob: (b64: string) => string =
globalThis.atob || ((b64) => globalThis.Buffer.from(b64, 'base64').toString('binary'));
function bytesFromBase64(b64: string): Uint8Array {
const bin = atob(b64);
const arr = new Uint8Array(bin.length);
for (let i = 0; i < bin.length; ++i) {
arr[i] = bin.charCodeAt(i);
if (globalThis.Buffer) {
return Uint8Array.from(globalThis.Buffer.from(b64, 'base64'));
} else {
const bin = globalThis.atob(b64);
const arr = new Uint8Array(bin.length);
for (let i = 0; i < bin.length; ++i) {
arr[i] = bin.charCodeAt(i);
}
return arr;
}
return arr;
}

const btoa: (bin: string) => string =
globalThis.btoa || ((bin) => globalThis.Buffer.from(bin, 'binary').toString('base64'));
function base64FromBytes(arr: Uint8Array): string {
const bin: string[] = [];
arr.forEach((byte) => {
bin.push(String.fromCharCode(byte));
});
return btoa(bin.join(''));
if (globalThis.Buffer) {
return globalThis.Buffer.from(arr).toString('base64');
} else {
const bin: string[] = [];
arr.forEach((byte) => {
bin.push(String.fromCharCode(byte));
});
return globalThis.btoa(bin.join(''));
}
}

type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
Expand All @@ -2772,7 +2914,7 @@ export type DeepPartial<T> = T extends Builtin
type KeysOfUnion<T> = T extends T ? keyof T : never;
export type Exact<P, I extends P> = P extends Builtin
? P
: P & { [K in keyof P]: Exact<P[K], I[K]> } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
: P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };

function toTimestamp(date: Date): Timestamp {
const seconds = date.getTime() / 1_000;
Expand Down
20 changes: 19 additions & 1 deletion src/proto/livekit_rtc.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
Room,
ParticipantInfo,
ClientConfiguration,
ServerInfo,
TrackInfo,
VideoQuality,
DisconnectReason,
Expand Down Expand Up @@ -207,6 +208,7 @@ export interface JoinResponse {
room?: Room;
participant?: ParticipantInfo;
otherParticipants: ParticipantInfo[];
/** deprecated. use server_info.version instead. */
serverVersion: string;
iceServers: ICEServer[];
/** use subscriber as the primary PeerConnection */
Expand All @@ -217,9 +219,11 @@ export interface JoinResponse {
*/
alternativeUrl: string;
clientConfiguration?: ClientConfiguration;
/** deprecated. use server_info.region instead. */
serverRegion: string;
pingTimeout: number;
pingInterval: number;
serverInfo?: ServerInfo;
}

export interface TrackPublishedResponse {
Expand Down Expand Up @@ -1567,6 +1571,7 @@ function createBaseJoinResponse(): JoinResponse {
serverRegion: '',
pingTimeout: 0,
pingInterval: 0,
serverInfo: undefined,
};
}

Expand Down Expand Up @@ -1605,6 +1610,9 @@ export const JoinResponse = {
if (message.pingInterval !== 0) {
writer.uint32(88).int32(message.pingInterval);
}
if (message.serverInfo !== undefined) {
ServerInfo.encode(message.serverInfo, writer.uint32(98).fork()).ldelim();
}
return writer;
},

Expand Down Expand Up @@ -1648,6 +1656,9 @@ export const JoinResponse = {
case 11:
message.pingInterval = reader.int32();
break;
case 12:
message.serverInfo = ServerInfo.decode(reader, reader.uint32());
break;
default:
reader.skipType(tag & 7);
break;
Expand Down Expand Up @@ -1679,6 +1690,7 @@ export const JoinResponse = {
serverRegion: isSet(object.serverRegion) ? String(object.serverRegion) : '',
pingTimeout: isSet(object.pingTimeout) ? Number(object.pingTimeout) : 0,
pingInterval: isSet(object.pingInterval) ? Number(object.pingInterval) : 0,
serverInfo: isSet(object.serverInfo) ? ServerInfo.fromJSON(object.serverInfo) : undefined,
};
},

Expand Down Expand Up @@ -1711,6 +1723,8 @@ export const JoinResponse = {
message.serverRegion !== undefined && (obj.serverRegion = message.serverRegion);
message.pingTimeout !== undefined && (obj.pingTimeout = Math.round(message.pingTimeout));
message.pingInterval !== undefined && (obj.pingInterval = Math.round(message.pingInterval));
message.serverInfo !== undefined &&
(obj.serverInfo = message.serverInfo ? ServerInfo.toJSON(message.serverInfo) : undefined);
return obj;
},

Expand All @@ -1735,6 +1749,10 @@ export const JoinResponse = {
message.serverRegion = object.serverRegion ?? '';
message.pingTimeout = object.pingTimeout ?? 0;
message.pingInterval = object.pingInterval ?? 0;
message.serverInfo =
object.serverInfo !== undefined && object.serverInfo !== null
? ServerInfo.fromPartial(object.serverInfo)
: undefined;
return message;
},
};
Expand Down Expand Up @@ -3462,7 +3480,7 @@ export type DeepPartial<T> = T extends Builtin
type KeysOfUnion<T> = T extends T ? keyof T : never;
export type Exact<P, I extends P> = P extends Builtin
? P
: P & { [K in keyof P]: Exact<P[K], I[K]> } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>;
: P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };

function longToNumber(long: Long): number {
if (long.gt(Number.MAX_SAFE_INTEGER)) {
Expand Down
11 changes: 10 additions & 1 deletion src/room/Room.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
ParticipantInfo_State,
ParticipantPermission,
Room as RoomModel,
ServerInfo,
SpeakerInfo,
UserPacket,
} from '../proto/livekit_models';
Expand Down Expand Up @@ -247,8 +248,16 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
},
this.abortController.signal,
);

let serverInfo: Partial<ServerInfo> | undefined = joinResponse.serverInfo;
if (!serverInfo) {
serverInfo = { version: joinResponse.serverVersion, region: joinResponse.serverRegion };
}

log.debug(
`connected to Livekit Server version: ${joinResponse.serverVersion}, region: ${joinResponse.serverRegion}`,
`connected to Livekit Server ${Object.entries(serverInfo)
.map(([key, value]) => `${key}: ${value}`)
.join(', ')}`,
);

if (!joinResponse.serverVersion) {
Expand Down

0 comments on commit e5851ea

Please sign in to comment.