@observertc/observer-js 0.30.6-beta → 0.40.1-beta

package/src/ObservedDataChannel.ts

@@ -0,0 +1,186 @@
+import { EventEmitter } from 'events';
+import { ObservedPeerConnection } from './ObservedPeerConnection';
+import { DataChannel } from '@observertc/sample-schemas-js';
+import { ClientDataChannelReport } from '@observertc/report-schemas-js';
+
+export type ObservedDataChannelState = 'connecting' | 'open' | 'closing' | 'closed';
+
+export type ObservedDataChannelModel = {
+	channelId: number;
+}
+
+export type ObservedDataChannelEvents = {
+	update: [],
+	close: [],
+};
+
+export type ObservedInboundTrackStats = {
+	ssrc: number;
+	bitrate: number;
+	fractionLost: number;
+	rttInMs?: number;
+	lostPackets?: number;
+	receivedPackets?: number;
+	receivedFrames?: number;
+	decodedFrames?: number;
+	droppedFrames?: number;
+	receivedSamples?: number;
+	silentConcealedSamples?: number;
+	fractionLoss?: number;
+};
+
+// {
+// 	[Property in keyof ObservedInboundTrackStats<K>]: ObservedInboundTrackStats<K>[Property];
+// }
+
+export declare interface ObservedDataChannel {
+	on<U extends keyof ObservedDataChannelEvents>(event: U, listener: (...args: ObservedDataChannelEvents[U]) => void): this;
+	off<U extends keyof ObservedDataChannelEvents>(event: U, listener: (...args: ObservedDataChannelEvents[U]) => void): this;
+	once<U extends keyof ObservedDataChannelEvents>(event: U, listener: (...args: ObservedDataChannelEvents[U]) => void): this;
+	emit<U extends keyof ObservedDataChannelEvents>(event: U, ...args: ObservedDataChannelEvents[U]): boolean;
+	update(sample: DataChannel, timestamp: number): void;
+}
+
+export class ObservedDataChannel extends EventEmitter	{
+	public readonly created = Date.now();
+
+	private _stats?: DataChannel;
+	
+	private _closed = false;
+	private _updated = Date.now();
+	public bitrate = 0;
+
+	public totalReceivedMessages = 0;
+	public totalSentMessages = 0;
+	public totalBytesReceived = 0;
+	public totalBytesSent = 0;
+	
+	public deltaReceivedMessages = 0;
+	public deltaSentMessages = 0;
+	public deltaBytesReceived = 0;
+	public deltaBytesSent = 0;
+
+	public constructor(
+		private readonly _model: ObservedDataChannelModel,
+		public readonly peerConnection: ObservedPeerConnection,
+	) {
+		super();
+	}
+
+	public get serviceId() {
+		return this.peerConnection.serviceId;
+	}
+
+	public get roomId() {
+		return this.peerConnection.roomId;
+	}
+
+	public get callId() {
+		return this.peerConnection.callId;
+	}
+
+	public get clientId() {
+		return this.peerConnection.clientId;
+	}
+
+	public get mediaUnitId() {
+		return this.peerConnection.mediaUnitId;
+	}
+
+	public get peerConnectionId() {
+		return this.peerConnection.peerConnectionId;
+	}
+
+	public get channelId() {
+		return this._model.channelId;
+	}
+
+	public get updated() {
+		return this._updated;
+	}
+
+	public get state(): ObservedDataChannelState | undefined {
+		return this._stats?.state as ObservedDataChannelState | undefined;
+	}
+
+	public get label() {
+		return this._stats?.label;
+	}
+
+	public get protocol() {
+		return this._stats?.protocol;
+	}
+
+	public get reports() {
+		return this.peerConnection.reports;
+	}
+
+	public get stats() {
+		return this._stats;
+	}
+
+	public get closed() {
+		return this._closed;
+	}
+
+	public close() {
+		if (this._closed) return;
+
+		this._closed = true;
+
+		this.emit('close');
+	}
+
+	public resetMetrics() {
+		this.bitrate = 0;
+		this.totalReceivedMessages = 0;
+		this.totalSentMessages = 0;
+		this.totalBytesReceived = 0;
+		this.totalBytesSent = 0;
+		this.deltaReceivedMessages = 0;
+		this.deltaSentMessages = 0;
+		this.deltaBytesReceived = 0;
+	}
+
+	public update(sample: DataChannel, timestamp: number) {
+		if (this._closed) return;
+		
+		const now = Date.now();
+
+		const report: ClientDataChannelReport = {
+			serviceId: this.peerConnection.client.call.serviceId,
+			roomId: this.peerConnection.client.call.roomId,
+			callId: this.peerConnection.client.call.callId,
+			clientId: this.peerConnection.client.clientId,
+			userId: this.peerConnection.client.userId,
+			mediaUnitId: this.peerConnection.client.mediaUnitId,
+			...sample,
+			timestamp,
+			sampleSeq: -1,
+		};
+
+		this.reports.addClientDataChannelReport(report);
+
+		sample.bytesReceived;
+		sample.bytesSent;
+		sample.messageReceived;
+		sample.messageSent;
+		
+		const elapsedTimeInMs = Math.max(1, now - this._updated);
+
+		this.bitrate = ((sample.bytesReceived ?? 0) - (this._stats?.bytesReceived ?? 0)) * 8 / (elapsedTimeInMs / 1000);
+		this.deltaSentMessages = (sample.messageSent ?? 0) - (this._stats?.messageSent ?? 0);
+		this.deltaReceivedMessages = (sample.messageReceived ?? 0) - (this._stats?.messageReceived ?? 0);
+		this.deltaBytesSent = (sample.bytesSent ?? 0) - (this._stats?.bytesSent ?? 0);
+		this.deltaBytesReceived = (sample.bytesReceived ?? 0) - (this._stats?.bytesReceived ?? 0);
+
+		this.totalBytesReceived = sample.bytesReceived ?? 0;
+		this.totalBytesSent = sample.bytesSent ?? 0;
+		this.totalReceivedMessages = sample.messageReceived ?? 0;
+		this.totalSentMessages = sample.messageSent ?? 0;
+
+		this._stats = sample;
+		this._updated = timestamp;
+		this.emit('update');
+	}
+}

package/src/ObservedInboundTrack.ts

@@ -1,14 +1,11 @@
 import { EventEmitter } from 'events';
-import { StorageProvider } from './storages/StorageProvider';
-import * as Models from './models/Models';
 import { ObservedPeerConnection } from './ObservedPeerConnection';
 import { InboundAudioTrack, InboundVideoTrack } from '@observertc/sample-schemas-js';
 import { ObservedOutboundTrack } from './ObservedOutboundTrack';
 import { InboundAudioTrackReport, InboundVideoTrackReport } from '@observertc/report-schemas-js';
 import { MediaKind } from './common/types';
-import { createSingleExecutor } from './common/SingleExecutor';
 
-export type ObservedInboundTrackConfig<K extends MediaKind> = {
+export type ObservedInboundTrackModel<K extends MediaKind> = {
 	trackId: string;
 	kind: K;
 	sfuStreamId?: string;
@@ -51,35 +48,9 @@ export declare interface ObservedInboundTrack<Kind extends MediaKind> {
 }
 
 export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
-	public static async create<K extends MediaKind>(
-		config: ObservedInboundTrackConfig<K>,
-		peerConnection: ObservedPeerConnection,
-		storageProvider: StorageProvider,
-	) {
-		const model = new Models.InboundTrack({
-			serviceId: peerConnection.client.serviceId,
-			roomId: peerConnection.client.roomId,
-			callId: peerConnection.client.callId,
-			clientId: peerConnection.client.clientId,
-			mediaUnitId: peerConnection.client.mediaUnitId,
-			peerConnectionId: peerConnection.peerConnectionId,
-			trackId: config.trackId,
-			kind: config.kind,
-			sfuStreamId: config.sfuStreamId,
-			sfuSinkId: config.sfuSinkId,
-		});
-
-		const alreadyInserted = await storageProvider.inboundTrackStorage.insert(config.trackId, model);
-
-		if (alreadyInserted) throw new Error(`InboundAudioTrack with id ${config.trackId} already exists`);
-
-		return new ObservedInboundTrack<K>(model, peerConnection, storageProvider);
-	}
-	
-	public created = Date.now();
+	public readonly created = Date.now();
 
 	private readonly _stats = new Map<number, ObservedInboundTrackStats<Kind>>();
-	private readonly _execute = createSingleExecutor();
 	
 	private _closed = false;
 	private _updated = Date.now();
@@ -106,52 +77,43 @@ export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
 	public deltaReceivedSamples = 0;
 	public deltaSilentConcealedSamples = 0;
 	
-	private constructor(
-		private readonly _model: Models.InboundTrack,
+	public constructor(
+		private readonly _model: ObservedInboundTrackModel<Kind>,
 		public readonly peerConnection: ObservedPeerConnection,
-		private readonly _storageProvider: StorageProvider,
 	) {
 		super();
 	}
 
 	public get serviceId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.serviceId!;
+		return this.peerConnection.serviceId;
 	}
 
 	public get roomId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.roomId!;
+		return this.peerConnection.roomId;
 	}
 
 	public get callId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.callId!;
+		return this.peerConnection.callId;
 	}
 
 	public get clientId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.clientId!;
+		return this.peerConnection.clientId;
 	}
 
 	public get mediaUnitId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.mediaUnitId!;
+		return this.peerConnection.mediaUnitId;
 	}
 
 	public get peerConnectionId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.peerConnectionId!;
+		return this.peerConnection.peerConnectionId;
 	}
 
 	public get trackId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.trackId!;
+		return this._model.trackId;
 	}
 
 	public get kind(): Kind {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.kind! as Kind;
+		return this._model.kind as Kind;
 	}
 
 	public get sfuStreamId() {
@@ -174,10 +136,6 @@ export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
 		return this.peerConnection.reports;
 	}
 
-	public get uptimeInMs() {
-		return this._updated - this.created;
-	}
-
 	public set remoteOutboundTrack(track: ObservedOutboundTrack<Kind> | undefined) {
 		if (this._closed) return;
 		if (this._remoteOutboundTrack) return;
@@ -202,9 +160,7 @@ export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
 
 		this._closed = true;
 
-		this._execute(() => this._storageProvider.inboundTrackStorage.remove(this.trackId))
-			.catch(() => void 0)
-			.finally(() => this.emit('close'));
+		this.emit('close');
 	}
 
 	public resetMetrics() {
@@ -220,10 +176,10 @@ export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
 		this.fractionLoss = 0;
 	}
 
-	public async update(sample: ObservedInboundTrackStatsUpdate<Kind>, timestamp: number) {
+	public update(sample: ObservedInboundTrackStatsUpdate<Kind>, timestamp: number) {
 		if (this._closed) return;
-		let executeSave = false;
-
+		
+		const now = Date.now();
 		const report: InboundAudioTrackReport | InboundVideoTrackReport = {
 			serviceId: this.peerConnection.client.call.serviceId,
 			roomId: this.peerConnection.client.call.roomId,
@@ -247,15 +203,13 @@ export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
 		
 		if (!this._model.sfuStreamId && sample.sfuStreamId) {
 			this._model.sfuStreamId = sample.sfuStreamId;
-			executeSave = true;
 		}
 
 		if (!this._model.sfuSinkId && sample.sfuSinkId) {
 			this._model.sfuSinkId = sample.sfuSinkId;
-			executeSave = true;
 		}
 
-		const elapsedTimeInMs = Math.max(1, timestamp - this._updated);
+		const elapsedTimeInMs = Math.max(1, now - this._updated);
 		const lastStat = this._stats.get(sample.ssrc);
 		const rttInMs = sample.roundTripTime ? sample.roundTripTime * 1000 : undefined;
 		const bitrate = ((sample.bytesReceived ?? 0) - (lastStat?.bytesReceived ?? 0)) * 8 / (elapsedTimeInMs / 1000);
@@ -318,15 +272,7 @@ export class ObservedInboundTrack<Kind extends MediaKind> extends EventEmitter	{
 		this.deltaSilentConcealedSamples = [ ...this._stats.values() ].reduce((acc, stat) => acc + (stat.silentConcealedSamples ?? 0), 0);
 		this.fractionLoss = 0 < this.deltaReceivedPackets && 0 < this.deltaLostPackets ? (this.deltaLostPackets / (this.deltaReceivedPackets + this.deltaLostPackets)) : 0;
 
-		if (executeSave) await this._save();
-
-		this._updated = timestamp;
+		this._updated = now;
 		this.emit('update');
 	}
-
-	private async _save() {
-		if (this._closed) throw new Error(`OutboundTrack ${this.trackId} is closed`);
-		
-		return this._storageProvider.inboundTrackStorage.set(this.trackId, this._model);
-	}
 }

package/src/ObservedOutboundTrack.ts

@@ -1,14 +1,11 @@
 import { EventEmitter } from 'events';
-import { StorageProvider } from './storages/StorageProvider';
-import * as Models from './models/Models';
 import { ObservedPeerConnection } from './ObservedPeerConnection';
 import { OutboundAudioTrack, OutboundVideoTrack } from '@observertc/sample-schemas-js';
 import { ObservedInboundTrack } from './ObservedInboundTrack';
 import { OutboundAudioTrackReport, OutboundVideoTrackReport } from '@observertc/report-schemas-js';
 import { MediaKind } from './common/types';
-import { createSingleExecutor } from './common/SingleExecutor';
 
-export type ObservedOutboundTrackConfig<K extends MediaKind> = {
+export type ObservedOutboundTrackModel<K extends MediaKind> = {
 	trackId: string;
 	kind: K;
 	sfuStreamId?: string;
@@ -46,29 +43,7 @@ export declare interface ObservedOutboundTrack<Kind extends MediaKind> {
 }
 
 export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter	{
-	public static async create<K extends MediaKind>(
-		config: ObservedOutboundTrackConfig<K>,
-		peerConnection: ObservedPeerConnection,
-		storageProvider: StorageProvider,
-	) {
-		const model = new Models.OutboundTrack({
-			serviceId: peerConnection.client.serviceId,
-			roomId: peerConnection.client.roomId,
-			callId: peerConnection.client.callId,
-			clientId: peerConnection.client.clientId,
-			mediaUnitId: peerConnection.client.mediaUnitId,
-			peerConnectionId: peerConnection.peerConnectionId,
-			trackId: config.trackId,
-			kind: config.kind,
-			sfuStreamId: config.sfuStreamId,
-		});
-
-		const alreadyInserted = await storageProvider.outboundTrackStorage.insert(config.trackId, model);
-
-		if (alreadyInserted) throw new Error(`OutboundAudioTrack with id ${config.trackId} already exists`);
-
-		return new ObservedOutboundTrack<K>(model, peerConnection, storageProvider);
-	}
+	public readonly created = Date.now();
 
 	public bitrate = 0;
 	public rttInMs?: number;
@@ -84,31 +59,49 @@ export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter
 	public deltaSentFrames = 0;
 	public deltaEncodedFrames = 0;
 
-	public created = Date.now();
-
 	private readonly _stats = new Map<number, ObservedOutboundTrackStats<Kind>>();
-	private readonly _execute = createSingleExecutor();
 	
 	private _closed = false;
 	private _updated = Date.now();
 	private _remoteInboundTracks = new Map<string, ObservedInboundTrack<Kind>>();
 
-	private constructor(
-		private readonly _model: Models.OutboundTrack,
+	public constructor(
+		private readonly _model: ObservedOutboundTrackModel<Kind>,
 		public readonly peerConnection: ObservedPeerConnection,
-		private readonly _storageProvider: StorageProvider,
 	) {
 		super();
 	}
 
+	public get serviceId() {
+		return this.peerConnection.serviceId;
+	}
+
+	public get roomId() {
+		return this.peerConnection.roomId;
+	}
+
+	public get callId() {
+		return this.peerConnection.callId;
+	}
+
+	public get clientId() {
+		return this.peerConnection.clientId;
+	}
+
+	public get mediaUnitId() {
+		return this.peerConnection.mediaUnitId;
+	}
+
+	public get peerConnectionId() {
+		return this.peerConnection.peerConnectionId;
+	}
+
 	public get kind(): Kind {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.kind! as Kind;
+		return this._model.kind as Kind;
 	}
 	
 	public get trackId() {
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		return this._model.trackId!;
+		return this._model.trackId;
 	}
 
 	public get sfuStreamId() {
@@ -131,22 +124,15 @@ export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter
 		return this._stats;
 	}
 
-	public get uptimeInMs() {
-		return this._updated - this.created;
-	}
-
 	public get closed() {
 		return this._closed;
 	}
 	
 	public close() {
 		if (this._closed) return;
-
 		this._closed = true;
 
-		this._execute(() => this._storageProvider.inboundTrackStorage.remove(this.trackId))
-			.catch(() => void 0)
-			.finally(() => this.emit('close'));
+		this.emit('close');
 	}
 
 	public resetMetrics() {
@@ -160,10 +146,10 @@ export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter
 		this.deltaEncodedFrames = 0;
 	}
 
-	public async update(sample: ObservedOutboundTrackStatsUpdate<Kind>, timestamp: number): Promise<void> {
+	public update(sample: ObservedOutboundTrackStatsUpdate<Kind>, timestamp: number): void {
 		if (this._closed) return;
-		let executeSave = false;
-
+		
+		const now = Date.now();
 		const report: OutboundAudioTrackReport | OutboundVideoTrackReport = {
 			serviceId: this.peerConnection.client.serviceId,
 			roomId: this.peerConnection.client.call.roomId,
@@ -180,7 +166,7 @@ export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter
 		if (this.kind === 'audio') this.reports.addOutboundAudioTrackReport(report);
 		else if (this.kind === 'video') this.reports.addOutboundVideoTrackReport(report);
 
-		const elapsedTimeInMs = Math.max(1, timestamp - this._updated);
+		const elapsedTimeInMs = Math.max(1, now - this._updated);
 		const lastStat = this._stats.get(sample.ssrc);
 		const rttInMs = sample.roundTripTime ? sample.roundTripTime * 1000 : undefined;
 		const bitrate = ((sample.bytesSent ?? 0) - (lastStat?.bytesSent ?? 0)) * 8 / (elapsedTimeInMs / 1000);
@@ -237,13 +223,9 @@ export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter
 
 			if (this.kind === 'audio') this.peerConnection.client.call.sfuStreamIdToOutboundAudioTrack.set(this._model.sfuStreamId, this as ObservedOutboundTrack<'audio'>);
 			else if (this.kind === 'video') this.peerConnection.client.call.sfuStreamIdToOutboundVideoTrack.set(this._model.sfuStreamId, this as ObservedOutboundTrack<'video'>);
-
-			executeSave = true;
 		}
 
-		if (executeSave) await this._save();
-
-		this._updated = timestamp;
+		this._updated = now;
 		this.emit('update');
 	}
 
@@ -257,10 +239,4 @@ export class ObservedOutboundTrack<Kind extends MediaKind> extends EventEmitter
 
 		this._remoteInboundTracks.set(track.trackId, track);
 	}
-
-	private async _save() {
-		if (this._closed) throw new Error(`OutboundTrack ${this.trackId} is closed`);
-		
-		return this._storageProvider.outboundTrackStorage.set(this.trackId, this._model);
-	}
 }