@stream-io/video-client 1.10.5 → 1.11.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.11.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.10.5...@stream-io/video-client-1.11.0) (2024-11-13)
+
+
+### Features
+
+* Connection timing ([#1574](https://github.com/GetStream/stream-video-js/issues/1574)) ([ce1dc9a](https://github.com/GetStream/stream-video-js/commit/ce1dc9a01fc5b0e60e3dac6653c27e99fd4b3ecb))
+
 ## [1.10.5](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.10.4...@stream-io/video-client-1.10.5) (2024-11-07)
 
 

package/dist/index.browser.es.js

@@ -164,6 +164,41 @@ const VideoSettingsResponseCameraFacingEnum = {
 class ErrorFromResponse extends Error {
 }
 
+/* eslint-disable */
+// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+// @generated from protobuf file "google/protobuf/struct.proto" (package "google.protobuf", syntax proto3)
+// tslint:disable
+//
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc.  All rights reserved.
+// https://developers.google.com/protocol-buffers/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
 /**
  * `NullValue` is a singleton enumeration to represent the null value for the
  * `Value` type union.
@@ -395,6 +430,41 @@ class ListValue$Type extends MessageType {
  */
 const ListValue = new ListValue$Type();
 
+/* eslint-disable */
+// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+// @generated from protobuf file "google/protobuf/timestamp.proto" (package "google.protobuf", syntax proto3)
+// tslint:disable
+//
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc.  All rights reserved.
+// https://developers.google.com/protocol-buffers/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
 // @generated message type with reflection information, may provide speed optimized methods
 class Timestamp$Type extends MessageType {
     constructor() {
@@ -1094,36 +1164,83 @@ class VideoLayer$Type extends MessageType {
  */
 const VideoLayer = new VideoLayer$Type();
 // @generated message type with reflection information, may provide speed optimized methods
+class PublishOptions$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.models.PublishOptions', [
+            {
+                no: 1,
+                name: 'codecs',
+                kind: 'message',
+                repeat: 1 /*RepeatType.PACKED*/,
+                T: () => PublishOption,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.PublishOptions
+ */
+const PublishOptions = new PublishOptions$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class PublishOption$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.models.PublishOption', [
+            {
+                no: 1,
+                name: 'track_type',
+                kind: 'enum',
+                T: () => [
+                    'stream.video.sfu.models.TrackType',
+                    TrackType,
+                    'TRACK_TYPE_',
+                ],
+            },
+            { no: 2, name: 'codec', kind: 'message', T: () => Codec },
+            { no: 3, name: 'bitrate', kind: 'scalar', T: 5 /*ScalarType.INT32*/ },
+            { no: 4, name: 'fps', kind: 'scalar', T: 5 /*ScalarType.INT32*/ },
+            {
+                no: 5,
+                name: 'max_spatial_layers',
+                kind: 'scalar',
+                T: 5 /*ScalarType.INT32*/,
+            },
+            {
+                no: 6,
+                name: 'max_temporal_layers',
+                kind: 'scalar',
+                T: 5 /*ScalarType.INT32*/,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.PublishOption
+ */
+const PublishOption = new PublishOption$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class Codec$Type extends MessageType {
     constructor() {
         super('stream.video.sfu.models.Codec', [
             {
-                no: 1,
+                no: 11,
                 name: 'payload_type',
                 kind: 'scalar',
                 T: 13 /*ScalarType.UINT32*/,
             },
-            { no: 2, name: 'name', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
-            { no: 3, name: 'fmtp_line', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            { no: 10, name: 'name', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
             {
-                no: 4,
+                no: 14,
                 name: 'clock_rate',
                 kind: 'scalar',
                 T: 13 /*ScalarType.UINT32*/,
             },
             {
-                no: 5,
+                no: 13,
                 name: 'encoding_parameters',
                 kind: 'scalar',
                 T: 9 /*ScalarType.STRING*/,
             },
-            {
-                no: 6,
-                name: 'feedbacks',
-                kind: 'scalar',
-                repeat: 2 /*RepeatType.UNPACKED*/,
-                T: 9 /*ScalarType.STRING*/,
-            },
+            { no: 12, name: 'fmtp', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
         ]);
     }
 }
@@ -1454,6 +1571,8 @@ var models = /*#__PURE__*/Object.freeze({
     ParticipantCount: ParticipantCount,
     get PeerType () { return PeerType; },
     Pin: Pin,
+    PublishOption: PublishOption,
+    PublishOptions: PublishOptions,
     Sdk: Sdk,
     get SdkType () { return SdkType; },
     StreamQuality: StreamQuality,
@@ -1519,6 +1638,58 @@ class StopNoiseCancellationResponse$Type extends MessageType {
  */
 const StopNoiseCancellationResponse = new StopNoiseCancellationResponse$Type();
 // @generated message type with reflection information, may provide speed optimized methods
+class Reconnection$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.Reconnection', [
+            {
+                no: 1,
+                name: 'time_seconds',
+                kind: 'scalar',
+                T: 2 /*ScalarType.FLOAT*/,
+            },
+            {
+                no: 2,
+                name: 'strategy',
+                kind: 'enum',
+                T: () => [
+                    'stream.video.sfu.models.WebsocketReconnectStrategy',
+                    WebsocketReconnectStrategy,
+                    'WEBSOCKET_RECONNECT_STRATEGY_',
+                ],
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.Reconnection
+ */
+const Reconnection = new Reconnection$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class Telemetry$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.Telemetry', [
+            {
+                no: 1,
+                name: 'connection_time_seconds',
+                kind: 'scalar',
+                oneof: 'data',
+                T: 2 /*ScalarType.FLOAT*/,
+            },
+            {
+                no: 2,
+                name: 'reconnection',
+                kind: 'message',
+                oneof: 'data',
+                T: () => Reconnection,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.Telemetry
+ */
+const Telemetry = new Telemetry$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class SendStatsRequest$Type extends MessageType {
     constructor() {
         super('stream.video.sfu.signal.SendStatsRequest', [
@@ -1564,6 +1735,7 @@ class SendStatsRequest$Type extends MessageType {
                 oneof: 'deviceState',
                 T: () => AppleState,
             },
+            { no: 11, name: 'telemetry', kind: 'message', T: () => Telemetry },
         ]);
     }
 }
@@ -2033,6 +2205,20 @@ class SfuEvent$Type extends MessageType {
                 oneof: 'eventPayload',
                 T: () => ParticipantMigrationComplete,
             },
+            {
+                no: 26,
+                name: 'codec_negotiation_complete',
+                kind: 'message',
+                oneof: 'eventPayload',
+                T: () => CodecNegotiationComplete,
+            },
+            {
+                no: 27,
+                name: 'change_publish_options',
+                kind: 'message',
+                oneof: 'eventPayload',
+                T: () => ChangePublishOptions,
+            },
         ]);
     }
 }
@@ -2041,6 +2227,33 @@ class SfuEvent$Type extends MessageType {
  */
 const SfuEvent = new SfuEvent$Type();
 // @generated message type with reflection information, may provide speed optimized methods
+class ChangePublishOptions$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.event.ChangePublishOptions', [
+            {
+                no: 1,
+                name: 'publish_option',
+                kind: 'message',
+                T: () => PublishOption,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.event.ChangePublishOptions
+ */
+const ChangePublishOptions = new ChangePublishOptions$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class CodecNegotiationComplete$Type extends MessageType {
+    constructor() {
+        super('stream.video.sfu.event.CodecNegotiationComplete', []);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.event.CodecNegotiationComplete
+ */
+const CodecNegotiationComplete = new CodecNegotiationComplete$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class ParticipantMigrationComplete$Type extends MessageType {
     constructor() {
         super('stream.video.sfu.event.ParticipantMigrationComplete', []);
@@ -2272,6 +2485,12 @@ class JoinRequest$Type extends MessageType {
                 kind: 'scalar',
                 T: 9 /*ScalarType.STRING*/,
             },
+            {
+                no: 8,
+                name: 'publisher_sdp',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
             {
                 no: 4,
                 name: 'client_details',
@@ -2394,6 +2613,12 @@ class JoinResponse$Type extends MessageType {
                 kind: 'scalar',
                 T: 5 /*ScalarType.INT32*/,
             },
+            {
+                no: 4,
+                name: 'publish_options',
+                kind: 'message',
+                T: () => PublishOptions,
+            },
         ]);
     }
 }
@@ -2704,7 +2929,9 @@ var events = /*#__PURE__*/Object.freeze({
     AudioSender: AudioSender,
     CallEnded: CallEnded,
     CallGrantsUpdated: CallGrantsUpdated,
+    ChangePublishOptions: ChangePublishOptions,
     ChangePublishQuality: ChangePublishQuality,
+    CodecNegotiationComplete: CodecNegotiationComplete,
     ConnectionQualityChanged: ConnectionQualityChanged,
     ConnectionQualityInfo: ConnectionQualityInfo,
     DominantSpeakerChanged: DominantSpeakerChanged,
@@ -3108,7 +3335,7 @@ const retryable = async (rpc, signal) => {
     return result;
 };
 
-const version = "1.10.5";
+const version = "1.11.0";
 const [major, minor, patch] = version.split('.');
 let sdkInfo = {
     type: SdkType.PLAIN_JAVASCRIPT,
@@ -3357,6 +3584,8 @@ const sfuEventKinds = {
     callEnded: undefined,
     participantUpdated: undefined,
     participantMigrationComplete: undefined,
+    codecNegotiationComplete: undefined,
+    changePublishOptions: undefined,
 };
 const isSfuEvent = (eventName) => {
     return Object.prototype.hasOwnProperty.call(sfuEventKinds, eventName);
@@ -7162,7 +7391,10 @@ class SfuStatsReporter {
                 });
             });
         };
-        this.run = async () => {
+        this.sendTelemetryData = async (telemetryData) => {
+            return this.run(telemetryData);
+        };
+        this.run = async (telemetryData) => {
             const [subscriberStats, publisherStats] = await Promise.all([
                 this.subscriber.getStats().then(flatten).then(JSON.stringify),
                 this.publisher?.getStats().then(flatten).then(JSON.stringify) ?? '[]',
@@ -7176,6 +7408,7 @@ class SfuStatsReporter {
                 audioDevices: this.inputDevices.get('mic'),
                 videoDevices: this.inputDevices.get('camera'),
                 deviceState: { oneofKind: undefined },
+                telemetry: telemetryData,
             });
         };
         this.start = () => {
@@ -9803,6 +10036,7 @@ class Call {
          * @returns a promise which resolves once the call join-flow has finished.
          */
         this.join = async (data) => {
+            const connectStartTime = Date.now();
             await this.setup();
             const callingState = this.state.callingState;
             if ([CallingState.JOINED, CallingState.JOINING].includes(callingState)) {
@@ -9859,6 +10093,7 @@ class Call {
                     : undefined;
                 const { callState, fastReconnectDeadlineSeconds } = await sfuClient.join({
                     subscriberSdp: receivingCapabilitiesSdp,
+                    publisherSdp: '',
                     clientDetails,
                     fastReconnect: performingFastReconnect,
                     reconnectDetails,
@@ -9890,6 +10125,15 @@ class Call {
                     closePreviousInstances: !performingMigration,
                 });
             }
+            // make sure we only track connection timing if we are not calling this method as part of a reconnection flow
+            if (!performingRejoin && !performingFastReconnect && !performingMigration) {
+                this.sfuStatsReporter?.sendTelemetryData({
+                    data: {
+                        oneofKind: 'connectionTimeSeconds',
+                        connectionTimeSeconds: (Date.now() - connectStartTime) / 1000,
+                    },
+                });
+            }
             if (performingRejoin) {
                 const strategy = WebsocketReconnectStrategy[this.reconnectStrategy];
                 await previousSfuClient?.leaveAndClose(`Closing previous WS after reconnect with strategy: ${strategy}`);
@@ -10122,26 +10366,47 @@ class Call {
          * @internal
          */
         this.reconnectFast = async () => {
+            let reconnectStartTime = Date.now();
             this.reconnectStrategy = WebsocketReconnectStrategy.FAST;
             this.state.setCallingState(CallingState.RECONNECTING);
-            return this.join(this.joinCallData);
+            await this.join(this.joinCallData);
+            this.sfuStatsReporter?.sendTelemetryData({
+                data: {
+                    oneofKind: 'reconnection',
+                    reconnection: {
+                        timeSeconds: (Date.now() - reconnectStartTime) / 1000,
+                        strategy: WebsocketReconnectStrategy.FAST,
+                    },
+                },
+            });
         };
         /**
          * Initiates the reconnection flow with the "rejoin" strategy.
          * @internal
          */
         this.reconnectRejoin = async () => {
+            let reconnectStartTime = Date.now();
             this.reconnectStrategy = WebsocketReconnectStrategy.REJOIN;
             this.state.setCallingState(CallingState.RECONNECTING);
             await this.join(this.joinCallData);
             await this.restorePublishedTracks();
             this.restoreSubscribedTracks();
+            this.sfuStatsReporter?.sendTelemetryData({
+                data: {
+                    oneofKind: 'reconnection',
+                    reconnection: {
+                        timeSeconds: (Date.now() - reconnectStartTime) / 1000,
+                        strategy: WebsocketReconnectStrategy.REJOIN,
+                    },
+                },
+            });
         };
         /**
          * Initiates the reconnection flow with the "migrate" strategy.
          * @internal
          */
         this.reconnectMigrate = async () => {
+            let reconnectStartTime = Date.now();
             const currentSfuClient = this.sfuClient;
             if (!currentSfuClient) {
                 throw new Error('Cannot migrate without an active SFU client');
@@ -10180,6 +10445,15 @@ class Call {
                 // and close the previous SFU client, without specifying close code
                 currentSfuClient.close();
             }
+            this.sfuStatsReporter?.sendTelemetryData({
+                data: {
+                    oneofKind: 'reconnection',
+                    reconnection: {
+                        timeSeconds: (Date.now() - reconnectStartTime) / 1000,
+                        strategy: WebsocketReconnectStrategy.MIGRATE,
+                    },
+                },
+            });
         };
         /**
          * Registers the various event handlers for reconnection.
@@ -12703,7 +12977,7 @@ class StreamClient {
             });
         };
         this.getUserAgent = () => {
-            const version = "1.10.5";
+            const version = "1.11.0";
             return (this.userAgent ||
                 `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
         };