@stream-io/video-client 0.6.1 → 0.6.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+### [0.6.3](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-0.6.2...@stream-io/video-client-0.6.3) (2024-03-25)
+
+
+### Features
+
+* SFU stats reporting ([#1297](https://github.com/GetStream/stream-video-js/issues/1297)) ([f46e927](https://github.com/GetStream/stream-video-js/commit/f46e927cbd650bc9af64a01cd5ebcec6cf2cfda8)), closes [#1276](https://github.com/GetStream/stream-video-js/issues/1276)
+
+### [0.6.2](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-0.6.1...@stream-io/video-client-0.6.2) (2024-03-25)
+
+
+### Features
+
+* **call:** Add getCallStats method ([#1296](https://github.com/GetStream/stream-video-js/issues/1296)) ([b64a19e](https://github.com/GetStream/stream-video-js/commit/b64a19ecd2fcc74f5f531397ed34732d55b0f815))
+
 ### [0.6.1](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-0.6.0...@stream-io/video-client-0.6.1) (2024-03-13)
 
 

package/dist/index.browser.es.js

@@ -2446,6 +2446,159 @@ var models = /*#__PURE__*/Object.freeze({
 // @generated from protobuf file "video/sfu/signal_rpc/signal.proto" (package "stream.video.sfu.signal", syntax proto3)
 // tslint:disable
 // @generated message type with reflection information, may provide speed optimized methods
+class SendStatsRequest$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.SendStatsRequest', [
+            { no: 1, name: 'session_id', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            {
+                no: 2,
+                name: 'subscriber_stats',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
+            {
+                no: 3,
+                name: 'publisher_stats',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
+            {
+                no: 4,
+                name: 'webrtc_version',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
+            { no: 5, name: 'sdk', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            {
+                no: 6,
+                name: 'sdk_version',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
+        ]);
+    }
+    create(value) {
+        const message = globalThis.Object.create(this.messagePrototype);
+        message.sessionId = '';
+        message.subscriberStats = '';
+        message.publisherStats = '';
+        message.webrtcVersion = '';
+        message.sdk = '';
+        message.sdkVersion = '';
+        if (value !== undefined)
+            reflectionMergePartial(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader, length, options, target) {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* string session_id */ 1:
+                    message.sessionId = reader.string();
+                    break;
+                case /* string subscriber_stats */ 2:
+                    message.subscriberStats = reader.string();
+                    break;
+                case /* string publisher_stats */ 3:
+                    message.publisherStats = reader.string();
+                    break;
+                case /* string webrtc_version */ 4:
+                    message.webrtcVersion = reader.string();
+                    break;
+                case /* string sdk */ 5:
+                    message.sdk = reader.string();
+                    break;
+                case /* string sdk_version */ 6:
+                    message.sdkVersion = reader.string();
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === 'throw')
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message, writer, options) {
+        /* string session_id = 1; */
+        if (message.sessionId !== '')
+            writer.tag(1, WireType.LengthDelimited).string(message.sessionId);
+        /* string subscriber_stats = 2; */
+        if (message.subscriberStats !== '')
+            writer.tag(2, WireType.LengthDelimited).string(message.subscriberStats);
+        /* string publisher_stats = 3; */
+        if (message.publisherStats !== '')
+            writer.tag(3, WireType.LengthDelimited).string(message.publisherStats);
+        /* string webrtc_version = 4; */
+        if (message.webrtcVersion !== '')
+            writer.tag(4, WireType.LengthDelimited).string(message.webrtcVersion);
+        /* string sdk = 5; */
+        if (message.sdk !== '')
+            writer.tag(5, WireType.LengthDelimited).string(message.sdk);
+        /* string sdk_version = 6; */
+        if (message.sdkVersion !== '')
+            writer.tag(6, WireType.LengthDelimited).string(message.sdkVersion);
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.SendStatsRequest
+ */
+const SendStatsRequest = new SendStatsRequest$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class SendStatsResponse$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.SendStatsResponse', [
+            { no: 1, name: 'error', kind: 'message', T: () => Error$2 },
+        ]);
+    }
+    create(value) {
+        const message = globalThis.Object.create(this.messagePrototype);
+        if (value !== undefined)
+            reflectionMergePartial(this, message, value);
+        return message;
+    }
+    internalBinaryRead(reader, length, options, target) {
+        let message = target ?? this.create(), end = reader.pos + length;
+        while (reader.pos < end) {
+            let [fieldNo, wireType] = reader.tag();
+            switch (fieldNo) {
+                case /* stream.video.sfu.models.Error error */ 1:
+                    message.error = Error$2.internalBinaryRead(reader, reader.uint32(), options, message.error);
+                    break;
+                default:
+                    let u = options.readUnknownField;
+                    if (u === 'throw')
+                        throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
+                    let d = reader.skip(wireType);
+                    if (u !== false)
+                        (u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
+            }
+        }
+        return message;
+    }
+    internalBinaryWrite(message, writer, options) {
+        /* stream.video.sfu.models.Error error = 1; */
+        if (message.error)
+            Error$2.internalBinaryWrite(message.error, writer.tag(1, WireType.LengthDelimited).fork(), options).join();
+        let u = options.writeUnknownFields;
+        if (u !== false)
+            (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
+        return writer;
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.SendStatsResponse
+ */
+const SendStatsResponse = new SendStatsResponse$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class ICERestartRequest$Type extends MessageType {
     constructor() {
         super('stream.video.sfu.signal.ICERestartRequest', [
@@ -3336,6 +3489,12 @@ const SignalServer = new ServiceType('stream.video.sfu.signal.SignalServer', [
         I: ICERestartRequest,
         O: ICERestartResponse,
     },
+    {
+        name: 'SendStats',
+        options: {},
+        I: SendStatsRequest,
+        O: SendStatsResponse,
+    },
 ]);
 
 /**
@@ -5631,6 +5790,13 @@ class SignalServerClient {
         const method = this.methods[5], opt = this._transport.mergeOptions(options);
         return stackIntercept('unary', this._transport, method, opt, input);
     }
+    /**
+     * @generated from protobuf rpc: SendStats(stream.video.sfu.signal.SendStatsRequest) returns (stream.video.sfu.signal.SendStatsResponse);
+     */
+    sendStats(input, options) {
+        const method = this.methods[6], opt = this._transport.mergeOptions(options);
+        return stackIntercept('unary', this._transport, method, opt, input);
+    }
 }
 
 const defaultOptions = {
@@ -5885,6 +6051,7 @@ function getIceCandidate(candidate) {
 let sdkInfo;
 let osInfo;
 let deviceInfo;
+let webRtcInfo;
 const setSdkInfo = (info) => {
     sdkInfo = info;
 };
@@ -5903,6 +6070,12 @@ const setDeviceInfo = (info) => {
 const getDeviceInfo = () => {
     return deviceInfo;
 };
+const getWebRTCInfo = () => {
+    return webRtcInfo;
+};
+const setWebRTCInfo = (info) => {
+    webRtcInfo = info;
+};
 const getClientDetails = () => {
     if (isReactNative()) {
         // Since RN doesn't support web, sharing browser info is not required
@@ -5926,7 +6099,9 @@ const getClientDetails = () => {
             architecture: cpu.architecture || '',
         },
         device: {
-            name: `${device.vendor || ''} ${device.model || ''} ${device.type || ''}`,
+            name: [device.vendor, device.model, device.type]
+                .filter(Boolean)
+                .join(' '),
             version: '',
         },
     };
@@ -7904,7 +8079,8 @@ class Publisher {
         this.onIceCandidateError = (e) => {
             const errorMessage = e instanceof RTCPeerConnectionIceErrorEvent &&
                 `${e.errorCode}: ${e.errorText}`;
-            const logLevel = this.pc.iceConnectionState === 'connected' ? 'debug' : 'error';
+            const iceState = this.pc.iceConnectionState;
+            const logLevel = iceState === 'connected' || iceState === 'checking' ? 'debug' : 'warn';
             logger$3(logLevel, `ICE Candidate error`, errorMessage);
         };
         this.onIceConnectionStateChange = () => {
@@ -8224,7 +8400,8 @@ class Subscriber {
         this.onIceCandidateError = (e) => {
             const errorMessage = e instanceof RTCPeerConnectionIceErrorEvent &&
                 `${e.errorCode}: ${e.errorText}`;
-            const logLevel = this.pc.iceConnectionState === 'connected' ? 'debug' : 'error';
+            const iceState = this.pc.iceConnectionState;
+            const logLevel = iceState === 'connected' || iceState === 'checking' ? 'debug' : 'warn';
             logger$2(logLevel, `ICE Candidate error`, errorMessage);
         };
         this.sfuClient = sfuClient;
@@ -8482,6 +8659,12 @@ class StreamSfuClient {
                 sessionId: this.sessionId,
             }), this.logger);
         };
+        this.sendStats = async (stats) => {
+            return retryable(() => this.rpc.sendStats({
+                ...stats,
+                sessionId: this.sessionId,
+            }), this.logger);
+        };
         this.join = async (data) => {
             const joinRequest = JoinRequest.create({
                 ...data,
@@ -9016,8 +9199,7 @@ const registerRingingCallEventHandlers = (call) => {
  * @param data the data for the call.
  */
 const join = async (httpClient, type, id, data) => {
-    const joinCallResponse = await doJoin(httpClient, type, id, data);
-    const { call, credentials, members, own_capabilities } = joinCallResponse;
+    const { call, credentials, members, own_capabilities, stats_options } = await doJoin(httpClient, type, id, data);
     return {
         connectionConfig: toRtcConfiguration(credentials.ice_servers),
         sfuServer: credentials.server,
@@ -9025,6 +9207,7 @@ const join = async (httpClient, type, id, data) => {
         metadata: call,
         members,
         ownCapabilities: own_capabilities,
+        statsOptions: stats_options,
     };
 };
 const doJoin = async (httpClient, type, id, data) => {
@@ -9048,6 +9231,19 @@ const toRtcConfiguration = (config) => {
     return rtcConfig;
 };
 
+/**
+ * Flatten the stats report into an array of stats objects.
+ *
+ * @param report the report to flatten.
+ */
+const flatten$1 = (report) => {
+    const stats = [];
+    report.forEach((s) => {
+        stats.push(s);
+    });
+    return stats;
+};
+
 /**
  * Creates a new StatsReporter instance that collects metrics about the ongoing call and reports them to the state store
  */
@@ -9268,18 +9464,58 @@ const aggregate = (stats) => {
     }
     return report;
 };
-/**
- * Flatten the stats report into an array of stats objects.
- *
- * @param report the report to flatten.
- */
-const flatten$1 = (report) => {
-    const stats = [];
-    report.forEach((s) => {
-        stats.push(s);
-    });
-    return stats;
-};
+
+class SfuStatsReporter {
+    constructor(sfuClient, { options, clientDetails, subscriber, publisher }) {
+        this.logger = getLogger(['SfuStatsReporter']);
+        this.run = async () => {
+            const [subscriberStats, publisherStats] = await Promise.all([
+                this.subscriber.getStats().then(flatten$1).then(JSON.stringify),
+                this.publisher.getStats().then(flatten$1).then(JSON.stringify),
+            ]);
+            await this.sfuClient.sendStats({
+                sdk: this.sdkName,
+                sdkVersion: this.sdkVersion,
+                webrtcVersion: this.webRTCVersion,
+                subscriberStats,
+                publisherStats,
+            });
+        };
+        this.start = () => {
+            if (this.options.reporting_interval_ms <= 0)
+                return;
+            this.intervalId = setInterval(() => {
+                this.run().catch((err) => {
+                    this.logger('warn', 'Failed to report stats', err);
+                });
+            }, this.options.reporting_interval_ms);
+        };
+        this.stop = () => {
+            clearInterval(this.intervalId);
+            this.intervalId = undefined;
+        };
+        this.sfuClient = sfuClient;
+        this.options = options;
+        this.subscriber = subscriber;
+        this.publisher = publisher;
+        const webRTCInfo = getWebRTCInfo();
+        const { sdk, browser } = clientDetails;
+        this.sdkName =
+            sdk && sdk.type === SdkType.REACT
+                ? 'stream-react'
+                : sdk && sdk.type === SdkType.REACT_NATIVE
+                    ? 'stream-react-native'
+                    : 'stream-js';
+        this.sdkVersion = sdk
+            ? `${sdk.major}.${sdk.minor}.${sdk.patch}`
+            : '0.0.0-development';
+        // The WebRTC version if passed from the SDK, it is taken else the browser info is sent.
+        this.webRTCVersion =
+            webRTCInfo?.version ||
+                `${browser?.name || ''}-${browser?.version || ''}` ||
+                'N/A';
+    }
+}
 
 const DEFAULT_THRESHOLD = 0.35;
 class ViewportTracker {
@@ -11213,6 +11449,8 @@ class Call {
             }
             this.statsReporter?.stop();
             this.statsReporter = undefined;
+            this.sfuStatsReporter?.stop();
+            this.sfuStatsReporter = undefined;
             this.subscriber?.close();
             this.subscriber = undefined;
             this.publisher?.close();
@@ -11352,12 +11590,14 @@ class Call {
             let sfuServer;
             let sfuToken;
             let connectionConfig;
+            let statsOptions;
             try {
                 if (this.sfuClient?.isFastReconnecting) {
                     // use previous SFU configuration and values
                     connectionConfig = this.publisher?.connectionConfiguration;
                     sfuServer = this.sfuClient.sfuServer;
                     sfuToken = this.sfuClient.token;
+                    statsOptions = this.sfuStatsReporter?.options;
                 }
                 else {
                     // full join flow - let the Coordinator pick a new SFU for us
@@ -11368,6 +11608,7 @@ class Call {
                     connectionConfig = call.connectionConfig;
                     sfuServer = call.sfuServer;
                     sfuToken = call.token;
+                    statsOptions = call.statsOptions;
                 }
                 if (this.streamClient._hasConnectionID()) {
                     this.watching = true;
@@ -11424,6 +11665,8 @@ class Call {
                     this.publisher = undefined;
                     this.statsReporter?.stop();
                     this.statsReporter = undefined;
+                    this.sfuStatsReporter?.stop();
+                    this.sfuStatsReporter = undefined;
                     // clean up current connection
                     sfuClient.close(StreamSfuClient.NORMAL_CLOSURE, 'js-client: attempting full reconnect');
                 }
@@ -11564,10 +11807,10 @@ class Call {
                     connectionConfig,
                 });
             }
-            const audioSettings = this.state.settings?.audio;
-            const isDtxEnabled = !!audioSettings?.opus_dtx_enabled;
-            const isRedEnabled = !!audioSettings?.redundant_coding_enabled;
             if (!this.publisher) {
+                const audioSettings = this.state.settings?.audio;
+                const isDtxEnabled = !!audioSettings?.opus_dtx_enabled;
+                const isRedEnabled = !!audioSettings?.redundant_coding_enabled;
                 this.publisher = new Publisher({
                     sfuClient,
                     dispatcher: this.dispatcher,
@@ -11584,6 +11827,16 @@ class Call {
                     state: this.state,
                 });
             }
+            const clientDetails = getClientDetails();
+            if (!this.sfuStatsReporter && statsOptions) {
+                this.sfuStatsReporter = new SfuStatsReporter(sfuClient, {
+                    clientDetails,
+                    options: statsOptions,
+                    subscriber: this.subscriber,
+                    publisher: this.publisher,
+                });
+                this.sfuStatsReporter.start();
+            }
             try {
                 // 1. wait for the signal server to be ready before sending "joinRequest"
                 sfuClient.signalReady
@@ -11603,7 +11856,7 @@ class Call {
                         : undefined;
                     return sfuClient.join({
                         subscriberSdp: sdp || '',
-                        clientDetails: getClientDetails(),
+                        clientDetails,
                         migration,
                         fastReconnect: previousSfuClient?.isFastReconnecting ?? false,
                     });
@@ -12222,6 +12475,17 @@ class Call {
             }
             return this.streamClient.get(`${endpoint}/recordings`);
         };
+        /**
+         * Retrieve call statistics for a particular call session (historical).
+         * Here `callSessionID` is mandatory.
+         *
+         * @param callSessionID the call session ID to retrieve statistics for.
+         * @returns The call stats.
+         */
+        this.getCallStats = async (callSessionID) => {
+            const endpoint = `${this.streamClientBasePath}/stats/${callSessionID}`;
+            return this.streamClient.get(endpoint);
+        };
         /**
          * Sends a custom event to all call participants.
          *
@@ -13634,7 +13898,7 @@ const getLocationHint = async (hintUrl = HINT_URL, timeout = 2000) => {
     const abortController = new AbortController();
     const timeoutId = setTimeout(() => abortController.abort(), timeout);
     try {
-        const response = await fetch(HINT_URL, {
+        const response = await fetch(hintUrl, {
             method: 'HEAD',
             signal: abortController.signal,
         });
@@ -13643,7 +13907,7 @@ const getLocationHint = async (hintUrl = HINT_URL, timeout = 2000) => {
         return awsPop.substring(0, 3); // AMS1-P2 -> AMS
     }
     catch (e) {
-        logger('warn', `Failed to get location hint from ${HINT_URL}`, e);
+        logger('warn', `Failed to get location hint from ${hintUrl}`, e);
         return 'ERR';
     }
     finally {
@@ -14090,7 +14354,7 @@ class StreamClient {
             });
         };
         this.getUserAgent = () => {
-            const version = "0.6.1" ;
+            const version = "0.6.3" ;
             return (this.userAgent ||
                 `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
         };
@@ -14638,5 +14902,5 @@ class StreamVideoServerClient extends StreamVideoClient {
     }
 }
 
-export { AudioSettingsDefaultDeviceEnum, AudioSettingsRequestDefaultDeviceEnum, browsers as Browsers, Call, CallState, CallType, CallTypes, CallingState, CameraManager, CameraManagerState, CreateDeviceRequestPushProviderEnum, DebounceType, DynascaleManager, ErrorFromResponse, InputMediaDeviceManager, InputMediaDeviceManagerState, LayoutSettingsNameEnum, LayoutSettingsRequestNameEnum, MicrophoneManager, MicrophoneManagerState, OwnCapability, RecordSettingsRequestModeEnum, RecordSettingsRequestQualityEnum, rxUtils as RxUtils, ScreenShareManager, ScreenShareState, events as SfuEvents, models as SfuModels, SpeakerManager, SpeakerState, StreamSfuClient, StreamVideoClient, StreamVideoReadOnlyStateStore, StreamVideoServerClient, StreamVideoWriteableStateStore, TranscriptionSettingsModeEnum, TranscriptionSettingsRequestModeEnum, VideoSettingsCameraFacingEnum, VideoSettingsRequestCameraFacingEnum, ViewportTracker, VisibilityState, checkIfAudioOutputChangeSupported, combineComparators, conditional, createSoundDetector, defaultSortPreset, descending, deviceIds$, disposeOfMediaStream, dominantSpeaker, getAudioDevices, getAudioOutputDevices, getAudioStream, getClientDetails, getDeviceInfo, getLogger, getOSInfo, getScreenShareStream, getSdkInfo, getVideoDevices, getVideoStream, livestreamOrAudioRoomSortPreset, logLevels, logToConsole, name, noopComparator, paginatedLayoutSortPreset, pinned, publishingAudio, publishingVideo, reactionType, role, screenSharing, setDeviceInfo, setLogLevel, setLogger, setOSInfo, setSdkInfo, speakerLayoutSortPreset, speaking };
+export { AudioSettingsDefaultDeviceEnum, AudioSettingsRequestDefaultDeviceEnum, browsers as Browsers, Call, CallState, CallType, CallTypes, CallingState, CameraManager, CameraManagerState, CreateDeviceRequestPushProviderEnum, DebounceType, DynascaleManager, ErrorFromResponse, InputMediaDeviceManager, InputMediaDeviceManagerState, LayoutSettingsNameEnum, LayoutSettingsRequestNameEnum, MicrophoneManager, MicrophoneManagerState, OwnCapability, RecordSettingsRequestModeEnum, RecordSettingsRequestQualityEnum, rxUtils as RxUtils, ScreenShareManager, ScreenShareState, events as SfuEvents, models as SfuModels, SpeakerManager, SpeakerState, StreamSfuClient, StreamVideoClient, StreamVideoReadOnlyStateStore, StreamVideoServerClient, StreamVideoWriteableStateStore, TranscriptionSettingsModeEnum, TranscriptionSettingsRequestModeEnum, VideoSettingsCameraFacingEnum, VideoSettingsRequestCameraFacingEnum, ViewportTracker, VisibilityState, checkIfAudioOutputChangeSupported, combineComparators, conditional, createSoundDetector, defaultSortPreset, descending, deviceIds$, disposeOfMediaStream, dominantSpeaker, getAudioDevices, getAudioOutputDevices, getAudioStream, getClientDetails, getDeviceInfo, getLogger, getOSInfo, getScreenShareStream, getSdkInfo, getVideoDevices, getVideoStream, getWebRTCInfo, livestreamOrAudioRoomSortPreset, logLevels, logToConsole, name, noopComparator, paginatedLayoutSortPreset, pinned, publishingAudio, publishingVideo, reactionType, role, screenSharing, setDeviceInfo, setLogLevel, setLogger, setOSInfo, setSdkInfo, setWebRTCInfo, speakerLayoutSortPreset, speaking };
 //# sourceMappingURL=index.browser.es.js.map