@observertc/observer-js 0.30.1-beta → 0.30.2-beta

package/src/ObservedPeerConnection.ts

@@ -1,12 +1,13 @@
 import { EventEmitter } from 'events';
 import * as Models from './models/Models';
 import { StorageProvider } from './storages/StorageProvider';
-import { PeerConnectionTransport } from '@observertc/sample-schemas-js';
+import { IceLocalCandidate, IceRemoteCandidate, PeerConnectionTransport } from '@observertc/sample-schemas-js';
 import { ObservedClient } from './ObservedClient';
 import { ObservedInboundTrack, ObservedInboundTrackConfig } from './ObservedInboundTrack';
 import { ObservedOutboundTrack, ObservedOutboundTrackConfig } from './ObservedOutboundTrack';
 import { PeerConnectionTransportReport } from '@observertc/report-schemas-js';
 import { createSingleExecutor } from './common/SingleExecutor';
+import { ObservedICE } from './ObservedICE';
 
 export type ObservedPeerConnectionEvents = {
 	update: [],
@@ -15,6 +16,10 @@ export type ObservedPeerConnectionEvents = {
 	newinboudvideotrack: [ObservedInboundTrack<'video'>],
 	newoutboundaudiotrack: [ObservedOutboundTrack<'audio'>],
 	newoutboundvideotrack: [ObservedOutboundTrack<'video'>],
+
+	iceconnectionstatechange: [string],
+	icegatheringstatechange: [string],
+	connectionstatechange: [string],
 };
 
 export type ObservedPeerConnectionConfig = {
@@ -51,10 +56,43 @@ export class ObservedPeerConnection extends EventEmitter {
 		return new ObservedPeerConnection(model, client, storageProvider);
 	}
 
+	public totalInboundPacketsLost = 0;
+	public totalInboundPacketsReceived = 0;
+	public totalOutboundPacketsLost = 0;
+	public totalOutboundPacketsReceived = 0;
+	public totalOutboundPacketsSent = 0;
+	public totalDataChannelBytesSent = 0;
+	public totalDataChannelBytesReceived = 0;
+	public totalSentAudioBytes = 0;
+	public totalSentVideoBytes = 0;
+	public totalReceivedAudioBytes = 0;
+	public totalReceivedVideoBytes = 0;
+
+	public deltaInboundPacketsLost = 0;
+	public deltaInboundPacketsReceived = 0;
+	public deltaOutboundPacketsLost = 0;
+	public deltaOutboundPacketsReceived	= 0;
+	public deltaOutboundPacketsSent = 0;
+	public deltaDataChannelBytesSent = 0;
+	public deltaDataChannelBytesReceived = 0;
+	public deltaReceivedAudioBytes = 0;
+	public deltaReceivedVideoBytes = 0;
+	public deltaSentAudioBytes = 0;
+	public deltaSentVideoBytes = 0;
+	public sendingAudioBitrate = 0;
+	public sendingVideoBitrate = 0;
+	public receivingAudioBitrate = 0;
+	public receivingVideoBitrate = 0;
+    
+	public avgRttInS?: number;
+
 	private _closed = false;
 	private _updated = Date.now();
 	private _sample?: ObservedPeerConnectionStats;
+	private _selectedLocalIceCandidate?: IceLocalCandidate;
+	private _selectedRemoteIceCandidate?: IceRemoteCandidate;
 
+	public readonly ICE = ObservedICE.create(this);
 	private readonly _inboundAudioTracks = new Map<string, ObservedInboundTrack<'audio'>>();
 	private readonly _inboundVideoTracks = new Map<string, ObservedInboundTrack<'video'>>();
 	private readonly _outboundAudioTracks = new Map<string, ObservedOutboundTrack<'audio'>>();
@@ -86,6 +124,14 @@ export class ObservedPeerConnection extends EventEmitter {
 		return this._updated;
 	}
 
+	public get selectedLocalIceCandidate() {
+		return this._selectedLocalIceCandidate;
+	}
+
+	public get selectedRemoteIceCandidate() {
+		return this._selectedRemoteIceCandidate;
+	}
+
 	public get inboundAudioTracks(): ReadonlyMap<string, ObservedInboundTrack<'audio'>> {
 		return this._inboundAudioTracks;
 	}
@@ -120,6 +166,32 @@ export class ObservedPeerConnection extends EventEmitter {
 			.finally(() => this.emit('close')); 
 	}
 
+	public updateMetrics() {
+		this.deltaInboundPacketsLost = 0;
+		this.deltaInboundPacketsReceived = 0;
+		this.deltaOutboundPacketsLost = 0;
+		this.deltaOutboundPacketsReceived = 0;
+		this.deltaOutboundPacketsSent = 0;
+		this.sendingAudioBitrate = 0;
+		this.sendingVideoBitrate = 0;
+		this.receivingAudioBitrate = 0;
+		this.receivingVideoBitrate = 0;
+		this.deltaDataChannelBytesSent = 0;
+		this.deltaDataChannelBytesReceived = 0;
+		this.deltaReceivedAudioBytes = 0;
+		this.deltaReceivedVideoBytes = 0;
+		this.deltaSentAudioBytes = 0;
+		this.deltaSentVideoBytes = 0;
+
+		this._inboundAudioTracks.forEach((track) => {
+			this.deltaReceivedAudioBytes += track.receivedPackets;
+		});
+
+		this._inboundVideoTracks.forEach((track) => {
+			this.deltaReceivedVideoBytes += track.receivedPackets;
+		});
+	}
+
 	public update(sample: PeerConnectionTransport, timestamp: number) {
 		if (this._closed) return;
 		if (sample.peerConnectionId !== this._model.peerConnectionId) throw new Error(`TransportId mismatch. PeerConnectionId: ${ this._model.peerConnectionId } TransportId: ${ sample.transportId}`);
@@ -144,6 +216,11 @@ export class ObservedPeerConnection extends EventEmitter {
 		this.emit('update');
 	}
 
+	public updateSelectedCandidate(localCandidate: IceLocalCandidate, remoteCandidate: IceRemoteCandidate) {
+		this._selectedLocalIceCandidate = localCandidate;
+		this._selectedRemoteIceCandidate = remoteCandidate;
+	}
+
 	public async createInboundAudioTrack(config: Omit<ObservedInboundTrackConfig<'audio'>, 'kind'>): Promise<ObservedInboundTrack<'audio'>> {
 		if (this._closed) throw new Error(`PeerConnection ${this.peerConnectionId} is closed`);
 
@@ -151,7 +228,7 @@ export class ObservedPeerConnection extends EventEmitter {
 			kind: 'audio',
 			trackId: config.trackId,
 		}, this, this._storageProvider);
-
+		
 		result.on('close', () => {
 			this._inboundAudioTracks.delete(result.trackId);
 			this._model.inboundTrackIds = this._model.inboundTrackIds.filter((id) => id !== result.trackId);

package/src/common/CallEventType.ts

@@ -0,0 +1,23 @@
+// eslint-disable-next-line no-shadow
+
+export enum CallEventType {
+	CALL_STARTED = 'CALL_STARTED',
+	CALL_ENDED = 'CALL_ENDED',
+	CLIENT_JOINED = 'CLIENT_JOINED',
+	CLIENT_LEFT = 'CLIENT_LEFT',
+	PEER_CONNECTION_OPENED = 'PEER_CONNECTION_OPENED',
+	PEER_CONNECTION_CLOSED = 'PEER_CONNECTION_CLOSED',
+	MEDIA_TRACK_ADDED = 'MEDIA_TRACK_ADDED',
+	MEDIA_TRACK_REMOVED = 'MEDIA_TRACK_REMOVED',
+	MEDIA_TRACK_RESUMED = 'MEDIA_TRACK_RESUMED',
+	MEDIA_TRACK_MUTED = 'MEDIA_TRACK_MUTED',
+	MEDIA_TRACK_UNMUTED = 'MEDIA_TRACK_UNMUTED',
+	ICE_GATHERING_STATE_CHANGED = 'ICE_GATHERING_STATE_CHANGED',
+	PEER_CONNECTION_STATE_CHANGED = 'PEER_CONNECTION_STATE_CHANGED',
+	ICE_CONNECTION_STATE_CHANGED = 'ICE_CONNECTION_STATE_CHANGED',
+	DATA_CHANNEL_OPEN = 'DATA_CHANNEL_OPEN',
+	DATA_CHANNEL_CLOSED = 'DATA_CHANNEL_CLOSED',
+	DATA_CHANNEL_ERROR = 'DATA_CHANNEL_ERROR',
+	NEGOTIATION_NEEDED = 'NEGOTIATION_NEEDED',
+	SIGNALING_STATE_CHANGE = 'SIGNALING_STATE_CHANGE',
+}

package/src/common/callEventReports.ts

@@ -1,16 +1,6 @@
 import { CallEventReport } from '@observertc/report-schemas-js';
+import { CallEventType } from './CallEventType';
 
-// eslint-disable-next-line no-shadow
-export enum CallEventType {
-	CALL_STARTED = 'CALL_STARTED',
-	CALL_ENDED = 'CALL_ENDED',
-	CLIENT_JOINED = 'CLIENT_JOINED',
-	CLIENT_LEFT = 'CLIENT_LEFT',
-	PEER_CONNECTION_OPENED = 'PEER_CONNECTION_OPENED',
-	PEER_CONNECTION_CLOSED = 'PEER_CONNECTION_CLOSED',
-	MEDIA_TRACK_ADDED = 'MEDIA_TRACK_ADDED',
-	MEDIA_TRACK_REMOVED = 'MEDIA_TRACK_REMOVED',
-}
 export function createCallStartedEventReport(
 	serviceId: string,
 	roomId: string,

package/src/models/Models.ts

@@ -1,11 +1,11 @@
-// @generated by protoc-gen-es v1.1.1 with parameter "target=ts"
+// @generated by protoc-gen-es v1.7.2 with parameter "target=ts"
 // @generated from file models.proto (package org.observertc.observer.models, syntax proto2)
 /* eslint-disable */
 // @ts-nocheck
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto2 } from "@bufbuild/protobuf";
-import { Samples_ClientSample_Browser, Samples_ClientSample_Engine, Samples_ClientSample_IceCandidatePair, Samples_ClientSample_IceLocalCandidate, Samples_ClientSample_IceRemoteCandidate, Samples_ClientSample_InboundAudioTrack, Samples_ClientSample_InboundVideoTrack, Samples_ClientSample_OperationSystem, Samples_ClientSample_OutboundAudioTrack, Samples_ClientSample_OutboundVideoTrack, Samples_ClientSample_PeerConnectionTransport, Samples_ClientSample_Platform } from "./samples_pb";
+import { Samples_ClientSample_Browser, Samples_ClientSample_Engine, Samples_ClientSample_OperationSystem, Samples_ClientSample_Platform } from "./samples_pb";
 
 /**
  * @generated from message org.observertc.observer.models.Call
@@ -68,49 +68,6 @@ export class Call extends Message<Call> {
   }
 }
 
-/**
- * @generated from message org.observertc.observer.models.ClientCoordinate
- */
-export class ClientCoordinate extends Message<ClientCoordinate> {
-  /**
-   * @generated from field: required float latitude = 1;
-   */
-  latitude?: number;
-
-  /**
-   * @generated from field: required float longitude = 2;
-   */
-  longitude?: number;
-
-  constructor(data?: PartialMessage<ClientCoordinate>) {
-    super();
-    proto2.util.initPartial(data, this);
-  }
-
-  static readonly runtime: typeof proto2 = proto2;
-  static readonly typeName = "org.observertc.observer.models.ClientCoordinate";
-  static readonly fields: FieldList = proto2.util.newFieldList(() => [
-    { no: 1, name: "latitude", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
-    { no: 2, name: "longitude", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
-  ]);
-
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ClientCoordinate {
-    return new ClientCoordinate().fromBinary(bytes, options);
-  }
-
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ClientCoordinate {
-    return new ClientCoordinate().fromJson(jsonValue, options);
-  }
-
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ClientCoordinate {
-    return new ClientCoordinate().fromJsonString(jsonString, options);
-  }
-
-  static equals(a: ClientCoordinate | PlainMessage<ClientCoordinate> | undefined, b: ClientCoordinate | PlainMessage<ClientCoordinate> | undefined): boolean {
-    return proto2.util.equals(ClientCoordinate, a, b);
-  }
-}
-
 /**
  * @generated from message org.observertc.observer.models.Client
  */
@@ -190,19 +147,6 @@ export class Client extends Message<Client> {
    */
   engine?: Samples_ClientSample_Engine;
 
-  /**
-   *  message Stats {
-   *    optional double maxRttInS = 1;
-   *    optional double minRttInS = 2;
-   *    optional string location = 3;
-   *  }
-   *
-   *  optional Stats stats = 13;
-   *
-   * @generated from field: optional org.observertc.observer.models.ClientCoordinate coordinates = 16;
-   */
-  coordinates?: ClientCoordinate;
-
   constructor(data?: PartialMessage<Client>) {
     super();
     proto2.util.initPartial(data, this);
@@ -226,7 +170,6 @@ export class Client extends Message<Client> {
     { no: 13, name: "operationSystem", kind: "message", T: Samples_ClientSample_OperationSystem, opt: true },
     { no: 14, name: "platform", kind: "message", T: Samples_ClientSample_Platform, opt: true },
     { no: 15, name: "engine", kind: "message", T: Samples_ClientSample_Engine, opt: true },
-    { no: 16, name: "coordinates", kind: "message", T: ClientCoordinate, opt: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Client {
@@ -310,26 +253,6 @@ export class PeerConnection extends Message<PeerConnection> {
    */
   outboundTrackIds: string[] = [];
 
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.IceLocalCandidate icelocalCandidates = 13;
-   */
-  icelocalCandidates: Samples_ClientSample_IceLocalCandidate[] = [];
-
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.IceRemoteCandidate iceRemoteCandidates = 14;
-   */
-  iceRemoteCandidates: Samples_ClientSample_IceRemoteCandidate[] = [];
-
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.IceCandidatePair iceCandidatePairs = 15;
-   */
-  iceCandidatePairs: Samples_ClientSample_IceCandidatePair[] = [];
-
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.PeerConnectionTransport transports = 16;
-   */
-  transports: Samples_ClientSample_PeerConnectionTransport[] = [];
-
   /**
    * @generated from field: optional uint64 touched = 17;
    */
@@ -355,10 +278,6 @@ export class PeerConnection extends Message<PeerConnection> {
     { no: 10, name: "label", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 11, name: "inboundTrackIds", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
     { no: 12, name: "outboundTrackIds", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
-    { no: 13, name: "icelocalCandidates", kind: "message", T: Samples_ClientSample_IceLocalCandidate, repeated: true },
-    { no: 14, name: "iceRemoteCandidates", kind: "message", T: Samples_ClientSample_IceRemoteCandidate, repeated: true },
-    { no: 15, name: "iceCandidatePairs", kind: "message", T: Samples_ClientSample_IceCandidatePair, repeated: true },
-    { no: 16, name: "transports", kind: "message", T: Samples_ClientSample_PeerConnectionTransport, repeated: true },
     { no: 17, name: "touched", kind: "scalar", T: 4 /* ScalarType.UINT64 */, opt: true },
   ]);
 
@@ -389,15 +308,12 @@ export class InboundTrackVideoStats extends Message<InboundTrackVideoStats> {
   ssrc?: number;
 
   /**
+   * optional org.observertc.schemas.protobuf.Samples.ClientSample.InboundVideoTrack sample = 4;
+   *
    * @generated from field: optional float fps = 2;
    */
   fps?: number;
 
-  /**
-   * @generated from field: optional org.observertc.schemas.protobuf.Samples.ClientSample.InboundVideoTrack sample = 4;
-   */
-  sample?: Samples_ClientSample_InboundVideoTrack;
-
   constructor(data?: PartialMessage<InboundTrackVideoStats>) {
     super();
     proto2.util.initPartial(data, this);
@@ -408,7 +324,6 @@ export class InboundTrackVideoStats extends Message<InboundTrackVideoStats> {
   static readonly fields: FieldList = proto2.util.newFieldList(() => [
     { no: 1, name: "ssrc", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
     { no: 2, name: "fps", kind: "scalar", T: 2 /* ScalarType.FLOAT */, opt: true },
-    { no: 4, name: "sample", kind: "message", T: Samples_ClientSample_InboundVideoTrack, opt: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): InboundTrackVideoStats {
@@ -551,16 +466,6 @@ export class InboundTrack extends Message<InboundTrack> {
    */
   ssrc: bigint[] = [];
 
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.InboundAudioTrack audioStats = 15;
-   */
-  audioStats: Samples_ClientSample_InboundAudioTrack[] = [];
-
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.InboundVideoTrack videoStats = 16;
-   */
-  videoStats: Samples_ClientSample_InboundVideoTrack[] = [];
-
   /**
    * @generated from field: optional uint64 touched = 17;
    */
@@ -588,8 +493,6 @@ export class InboundTrack extends Message<InboundTrack> {
     { no: 12, name: "sfuSinkId", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 13, name: "sfuStreamId", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 14, name: "ssrc", kind: "scalar", T: 3 /* ScalarType.INT64 */, repeated: true },
-    { no: 15, name: "audioStats", kind: "message", T: Samples_ClientSample_InboundAudioTrack, repeated: true },
-    { no: 16, name: "videoStats", kind: "message", T: Samples_ClientSample_InboundVideoTrack, repeated: true },
     { no: 17, name: "touched", kind: "scalar", T: 4 /* ScalarType.UINT64 */, opt: true },
   ]);
 
@@ -679,16 +582,6 @@ export class OutboundTrack extends Message<OutboundTrack> {
    */
   ssrc: bigint[] = [];
 
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.OutboundAudioTrack audioStats = 14;
-   */
-  audioStats: Samples_ClientSample_OutboundAudioTrack[] = [];
-
-  /**
-   * @generated from field: repeated org.observertc.schemas.protobuf.Samples.ClientSample.OutboundVideoTrack videoStats = 15;
-   */
-  videoStats: Samples_ClientSample_OutboundVideoTrack[] = [];
-
   /**
    * @generated from field: optional uint64 touched = 16;
    */
@@ -715,8 +608,6 @@ export class OutboundTrack extends Message<OutboundTrack> {
     { no: 11, name: "marker", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 12, name: "sfuStreamId", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 13, name: "ssrc", kind: "scalar", T: 3 /* ScalarType.INT64 */, repeated: true },
-    { no: 14, name: "audioStats", kind: "message", T: Samples_ClientSample_OutboundAudioTrack, repeated: true },
-    { no: 15, name: "videoStats", kind: "message", T: Samples_ClientSample_OutboundVideoTrack, repeated: true },
     { no: 16, name: "touched", kind: "scalar", T: 4 /* ScalarType.UINT64 */, opt: true },
   ]);
 

package/src/models/samples_pb.ts

@@ -1,4 +1,4 @@
-// @generated by protoc-gen-es v1.1.1 with parameter "target=ts"
+// @generated by protoc-gen-es v1.7.2 with parameter "target=ts"
 // @generated from file samples.proto (package org.observertc.schemas.protobuf, syntax proto2)
 /* eslint-disable */
 // @ts-nocheck