@observertc/observer-js 1.0.1-797e5af.0 → 1.0.1-7be4daa.0

package/src/ObservedClient.ts

@@ -10,7 +10,6 @@ import { ClientMetaTypes } from './schema/ClientMetaTypes';
 import { parseJsonAs } from './common/utils';
 import { CalculatedScore } from './scores/CalculatedScore';
 import { Detectors } from './detectors/Detectors';
-import { ObservedClientEventMonitor } from './ObservedClientEventMonitor';
 
 const logger = createLogger('ObservedClient');
 
@@ -34,8 +33,9 @@ export type ObservedClientEvents = {
 	left: [];
 	usingturn: [boolean];
 	usermediaerror: [string];
+	extensionStats: [ExtensionStat];
+	clientEvent: [ClientEvent];
 
-	// do we need this?
 	newpeerconnection: [ObservedPeerConnection];
 };
 
@@ -471,8 +471,8 @@ export class ObservedClient<AppData extends Record<string, unknown> = Record<str
 				}
 				break;
 			}
-			
 		}
+		this.emit('clientEvent', event);
 	}
 
 	public injectMetaData(metaData: ClientMetaData) {
@@ -550,6 +550,7 @@ export class ObservedClient<AppData extends Record<string, unknown> = Record<str
 
 	public addExtensionStats(stats: ExtensionStat) {
 		this.call.observer.emit('client-extension-stats', this, stats);
+		this.emit('extensionStats', stats);
 	}
 
 	private _updatePeerConnection(sample: PeerConnectionSample): ObservedPeerConnection | undefined {
@@ -578,10 +579,6 @@ export class ObservedClient<AppData extends Record<string, unknown> = Record<str
 		return observedPeerConnection;
 	}
 
-	public createEventMonitor<CTX = unknown>(ctx?: CTX): ObservedClientEventMonitor<CTX> {
-		return new ObservedClientEventMonitor<CTX>(this, ctx ?? {} as CTX);
-	}
-
 	private _mergeInjections(sample: ClientSample): ClientSample {
 		if (this.closed) return sample;
 

package/src/ObservedIceCandidatePair.ts

@@ -8,7 +8,7 @@ export class ObservedIceCandidatePair implements IceCandidatePairStats {
 	transportId?: string | undefined;
 	localCandidateId?: string | undefined;
 	remoteCandidateId?: string | undefined;
-	state?: 'new' | 'inProgress' | 'failed' | 'succeeded' | undefined;
+	state?: 'new' | 'in-progress' | 'waiting' | 'failed' | 'succeeded' | undefined;
 	nominated?: boolean | undefined;
 	packetsSent?: number | undefined;
 	packetsReceived?: number | undefined;
@@ -93,7 +93,7 @@ export class ObservedIceCandidatePair implements IceCandidatePairStats {
 		this.transportId = stats.transportId;
 		this.localCandidateId = stats.localCandidateId;
 		this.remoteCandidateId = stats.remoteCandidateId;
-		this.state = stats.state;
+		this.state = this._convertState(stats.state);
 		this.nominated = stats.nominated;
 		this.packetsSent = stats.packetsSent;
 		this.packetsReceived = stats.packetsReceived;
@@ -115,4 +115,20 @@ export class ObservedIceCandidatePair implements IceCandidatePairStats {
 		this.attachments = stats.attachments;
 	}
 
+	private _convertState(state: string | undefined) {
+		switch (state) {
+			case 'new':
+			case 'in-progress':
+			case 'waiting':
+			case 'failed':
+			case 'succeeded':
+				return state;
+			case 'cancelled':
+				return 'failed';
+			case 'inprogress':
+				return 'in-progress';
+			default:
+				return undefined;
+		}
+	}
 }

package/src/ObservedPeerConnection.ts

@@ -644,12 +644,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedCertificate = new ObservedCertificate(stats.timestamp, stats.id, this);
 
+			observedCertificate.update(stats);
+
 			this.observedCertificates.set(stats.id, observedCertificate);
 			this.emit('added-certificate', observedCertificate);
+		} else {
+			observedCertificate.update(stats);
 		}
 
-		observedCertificate.update(stats);
-
 		return observedCertificate;
 	}
 
@@ -666,12 +668,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedCodec = new ObservedCodec(stats.timestamp, stats.id, stats.mimeType, this);
 
+			observedCodec.update(stats);
+			
 			this.observedCodecs.set(stats.id, observedCodec);
 			this.emit('added-codec', observedCodec);
+		} else {
+			observedCodec.update(stats);
 		}
 
-		observedCodec.update(stats);
-
 		return observedCodec;
 	}
 
@@ -688,12 +692,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedDataChannel = new ObservedDataChannel(stats.timestamp, stats.id, this);
 
+			observedDataChannel.update(stats);
+
 			this.observedDataChannels.set(stats.id, observedDataChannel);
 			this.emit('added-data-channel', observedDataChannel);
+		} else {
+			observedDataChannel.update(stats);
 		}
 
-		observedDataChannel.update(stats);
-
 		return observedDataChannel;
 	}
 
@@ -710,12 +716,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedIceCandidate = new ObservedIceCandidate(stats.timestamp, stats.id, this);
 
+			observedIceCandidate.update(stats);
+
 			this.observedIceCandidates.set(stats.id, observedIceCandidate);
 			this.emit('added-ice-candidate', observedIceCandidate);
+		} else {
+			observedIceCandidate.update(stats);
 		}
 
-		observedIceCandidate.update(stats);
-
 		return observedIceCandidate;
 	}
 
@@ -732,12 +740,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedIceCandidatePair = new ObservedIceCandidatePair(stats.timestamp, stats.id, this);
 
+			observedIceCandidatePair.update(stats);
+			
 			this.observedIceCandidatesPair.set(stats.id, observedIceCandidatePair);
 			this.emit('added-ice-candidate-pair', observedIceCandidatePair);
+		} else {
+			observedIceCandidatePair.update(stats);
 		}
 
-		observedIceCandidatePair.update(stats);
-
 		return observedIceCandidatePair;
 	}
 
@@ -754,12 +764,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedIceTransport = new ObservedIceTransport(stats.timestamp, stats.id, this);
 
+			observedIceTransport.update(stats);
+			
 			this.observedIceTransports.set(stats.id, observedIceTransport);
 			this.emit('added-ice-transport', observedIceTransport);
+		} else {
+			observedIceTransport.update(stats);
 		}
 
-		observedIceTransport.update(stats);
-
 		return observedIceTransport;
 	}
 
@@ -782,13 +794,15 @@ export class ObservedPeerConnection extends EventEmitter {
 				stats.trackIdentifier,
 				this
 			);
+			
+			observedInboundRtp.update(stats);
 
 			this.observedInboundRtps.set(stats.ssrc, observedInboundRtp);
 			this.emit('added-inbound-rtp', observedInboundRtp);
+		} else {
+			observedInboundRtp.update(stats);
 		}
 
-		observedInboundRtp.update(stats);
-
 		return observedInboundRtp;
 	}
 
@@ -816,12 +830,14 @@ export class ObservedPeerConnection extends EventEmitter {
 				mediaPlayout,
 			);
 
+			observedInboundTrack.update(stats);
+			
 			this.observedInboundTracks.set(stats.id, observedInboundTrack);
 			this.emit('added-inbound-track', observedInboundTrack);
+		} else {
+			observedInboundTrack.update(stats);
 		}
 
-		observedInboundTrack.update(stats);
-
 		return observedInboundTrack;
 	}
 
@@ -843,12 +859,14 @@ export class ObservedPeerConnection extends EventEmitter {
 				this
 			);
 
+			observedMediaPlayout.update(stats);
+
 			this.observedMediaPlayouts.set(stats.id, observedMediaPlayout);
 			this.emit('added-media-playout', observedMediaPlayout);
+		} else {
+			observedMediaPlayout.update(stats);
 		}
 
-		observedMediaPlayout.update(stats);
-
 		return observedMediaPlayout;
 	}
 
@@ -870,12 +888,14 @@ export class ObservedPeerConnection extends EventEmitter {
 				this
 			);
 
+			observedMediaSource.update(stats);
+
 			this.observedMediaSources.set(stats.id, observedMediaSource);
 			this.emit('added-media-source', observedMediaSource);
+		} else {
+			observedMediaSource.update(stats);
 		}
 
-		observedMediaSource.update(stats);
-
 		return observedMediaSource;
 	}
 
@@ -898,11 +918,13 @@ export class ObservedPeerConnection extends EventEmitter {
 				this
 			);
 
+			observedOutboundRtp.update(stats);
+
 			this.observedOutboundRtps.set(stats.ssrc, observedOutboundRtp);
 			this.emit('added-outbound-rtp', observedOutboundRtp);
+		} else {
+			observedOutboundRtp.update(stats);
 		}
-
-		observedOutboundRtp.update(stats);
 		
 		return observedOutboundRtp;
 	}
@@ -930,12 +952,14 @@ export class ObservedPeerConnection extends EventEmitter {
 				observedMediaSource,
 			);
 
+			observedOutboundTrack.update(stats);
+
 			this.observedOutboundTracks.set(stats.id, observedOutboundTrack);
 			this.emit('added-outbound-track', observedOutboundTrack);
+		} else {
+			observedOutboundTrack.update(stats);
 		}
 
-		observedOutboundTrack.update(stats);
-
 		return observedOutboundTrack;
 	}
 
@@ -952,12 +976,14 @@ export class ObservedPeerConnection extends EventEmitter {
 
 			observedPeerConnectionTransport = new ObservedPeerConnectionTransport(stats.timestamp, stats.id, this);
 
+			observedPeerConnectionTransport.update(stats);
+
 			this.observedPeerConnectionTransports.set(stats.id, observedPeerConnectionTransport);
 			this.emit('added-peer-connection-transport', observedPeerConnectionTransport);
+		} else {
+			observedPeerConnectionTransport.update(stats);
 		}
 
-		observedPeerConnectionTransport.update(stats);
-
 		return observedPeerConnectionTransport;
 	}
 
@@ -980,12 +1006,14 @@ export class ObservedPeerConnection extends EventEmitter {
 				this
 			);
 
+			observedRemoteInboundRtp.update(stats);
+
 			this.observedRemoteInboundRtps.set(stats.ssrc, observedRemoteInboundRtp);
 			this.emit('added-remote-inbound-rtp', observedRemoteInboundRtp);
+		} else {
+			observedRemoteInboundRtp.update(stats);
 		}
 
-		observedRemoteInboundRtp.update(stats);
-
 		return observedRemoteInboundRtp;
 	}
 
@@ -1008,12 +1036,14 @@ export class ObservedPeerConnection extends EventEmitter {
 				this
 			);
 
+			observedRemoteOutboundRtp.update(stats);
+
 			this.observedRemoteOutboundRtps.set(stats.ssrc, observedRemoteOutboundRtp);
 			this.emit('added-remote-outbound-rtp', observedRemoteOutboundRtp);
+		} else {
+			observedRemoteOutboundRtp.update(stats);
 		}
 
-		observedRemoteOutboundRtp.update(stats);
-
 		return observedRemoteOutboundRtp;
 	}
 }

package/src/Observer.ts

@@ -7,8 +7,10 @@ import { ObservedTURN } from './ObservedTURN';
 import { Detectors } from './detectors/Detectors';
 import { Updater } from './updaters/Updater';
 import { OnIntervalUpdater } from './updaters/OnIntervalUpdater';
-import { OnAllCallObserverUpdater } from './updaters/OnAllCallObserverUpdater_';
-import { OnAnyCallObserverUpdater } from './updaters/OnAnyCallObserverUpdater_';
+import { OnAllCallObserverUpdater } from './updaters/OnAllCallObserverUpdater';
+import { OnAnyCallObserverUpdater } from './updaters/OnAnyCallObserverUpdater';
+import { ObserverEventMonitor } from './ObserverEventMonitor';
+import { MediasoupRemoteTrackResolver } from './utils/MediasoupRemoteTrackResolver';
 
 const logger = createLogger('Observer');
 
@@ -23,11 +25,12 @@ export type ObserverEvents = {
 	'close': [],
 }
 
-export type ObserverConfig = {
+export type ObserverConfig<AppData extends Record<string, unknown> = Record<string, unknown>> = {
 	updatePolicy?: 'update-on-any-call-updated' | 'update-when-all-call-updated' | 'update-on-interval',
 	updateIntervalInMs?: number,
 	defaultCallUpdatePolicy?: ObservedCallSettings['updatePolicy'],
 	defaultCallUpdateIntervalInMs?: number,
+	appData?: AppData,
 }
 
 export declare interface Observer {
@@ -37,7 +40,7 @@ export declare interface Observer {
 	emit<U extends keyof ObserverEvents>(event: U, ...args: ObserverEvents[U]): boolean;
 }
 
-export class Observer extends EventEmitter {
+export class Observer<AppData extends Record<string, unknown> = Record<string, unknown>> extends EventEmitter {
 	public readonly detectors: Detectors;
 
 	public readonly observedTURN = new ObservedTURN();
@@ -67,9 +70,10 @@ export class Observer extends EventEmitter {
 
 	private _timer?: ReturnType<typeof setInterval>;
 
-	public constructor(public readonly config: ObserverConfig = {
+	public constructor(public readonly config: ObserverConfig<AppData> = {
 		updatePolicy: 'update-when-all-call-updated',
 		updateIntervalInMs: undefined,
+		appData: {} as AppData,
 	}) {
 		super();
 		this.setMaxListeners(Infinity);
@@ -108,6 +112,10 @@ export class Observer extends EventEmitter {
 		this.detectors = new Detectors();
 	}
 
+	public get appData() {
+		return this.config.appData;
+	}
+
 	public getObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(callId: string): ObservedCall<T> | undefined {
 		if (this.closed || !this.observedCalls.has(callId)) return;
 		
@@ -124,12 +132,15 @@ export class Observer extends EventEmitter {
 			settings.updatePolicy = this.config.defaultCallUpdatePolicy;
 			settings.updateIntervalInMs = this.config.defaultCallUpdateIntervalInMs;
 		}
-
 		const observedCall = new ObservedCall(settings, this);
 		const onCallUpdated = () => this._onObservedCallUpdated(observedCall);
 
 		if (this.observedCalls.has(observedCall.callId)) throw new Error(`Observed Call with id ${observedCall.callId} already exists`);
 
+		if (settings.remoteTrackResolvePolicy === 'mediasoup-sfu') {
+			observedCall.remoteTrackResolver = new MediasoupRemoteTrackResolver(observedCall);
+		}
+
 		observedCall.once('close', () => {
 			this.observedCalls.delete(observedCall.callId);
 			observedCall.off('update', onCallUpdated);
@@ -210,6 +221,10 @@ export class Observer extends EventEmitter {
 		this.totalClientIssues += call.deltaNumberOfIssues;
 	}
 
+	public createEventMonitor<CTX = unknown>(ctx?: CTX): ObserverEventMonitor<CTX> {
+		return new ObserverEventMonitor<CTX>(this, ctx ?? {} as CTX);
+	}
+
 	// public resetSummaryMetrics() {
 	// 	this.totalAddedCall = 0;
 	// 	this.totalRemovedCall = 0;