feat(stats): local call stats added + stats documentation (#601)

* local call stats added + stats documentation

* typos

* tweaks

Author: Brazol

docusaurus/docs/Flutter/03-core-concepts/08-call-statistics.mdx

@@ -0,0 +1,41 @@
+---
+title: Call Statistics
+slug: /call-statistics
+description: How to listen and leverage call statistics
+---
+
+There are two sources of statistics you can use to monitor the performance of your calls:
+- `Call.stats` stream that provides real-time webRTC statistics
+- `CallState` properties that contain some of the webRTC statistics processed and more useful for display purposes
+
+## Stats stream
+
+If you want to tap in directly into the stream of webRTC stats you can do this with `stats` steam inside `Call` object. It provides a stream of [`CallStats`](https://github.com/GetStream/stream-video-flutter/blob/main/packages/stream_video/lib/src/models/call_stats.dart) objects for publisher and subscriber connections.
+We provide those statistics in three ways for ease of use:
+
+* `raw` - raw stats as they come from the webRTC
+* `printable` - representation of the stats that can be easily printed to the console or as a block of text
+* `stats` - webRTC stats but in a structured form
+
+## CallState properties
+
+You can also access more processed data with useful information about the call. This data is available in [`CallState`](https://github.com/GetStream/stream-video-flutter/blob/main/packages/stream_video/lib/src/call_state.dart) object. Here are some of the properties that you can use:
+
+`publisherStats` and `subscriberStats` - objects that contain the following data:
+* `latency` - the time it takes to deliver the data between the server and the app
+* `jitterInMs` -  the variation in the delay of receiving packets of data over a network
+* `bitrateKbps` - the rate at which data is transmitted from the app to the server (publisher) or from the server to the app (subscriber)
+
+`localStats` - object that contain the following data:
+* `sfu` - the server we are connected to
+* `sdkVersion` - the version of the Stream SDK
+* `webRtcVersion` - the version of the webRTC
+
+`latencyHistory` - array of latency values for the last 10 seconds
+
+## Example usage
+
+You can check the example of the stats screen in our [demo app](https://github.com/GetStream/stream-video-flutter/blob/main/dogfooding/lib/screens/call_stats_screen.dart)
+
+![Sample Call Stats screen](../assets/core_concepts/stats_screen.jpeg)
+

docusaurus/docs/Flutter/assets/core_concepts/stats_screen.jpeg

@@ -124,6 +124,7 @@ class _CallScreenState extends State<CallScreen> {
 
   @override
   Widget build(BuildContext context) {
+    // ignore: deprecated_member_use
     return WillPopScope(
       onWillPop: () async {
         return !Navigator.of(context).userGestureInProgress;

dogfooding/lib/screens/call_screen.dart

@@ -111,7 +111,7 @@ class CallStatsScreen extends StatelessWidget {
                     const Padding(
                       padding: EdgeInsets.symmetric(horizontal: 16.0),
                       child: Text(
-                        'Very high latency values may reduce call quality, cause lag, and make the call less enjoyable.',
+                        'Review the key data points below to assess call performance.',
                         style: TextStyle(color: Colors.white),
                       ),
                     ),
@@ -131,8 +131,16 @@ class CallStatsScreen extends StatelessWidget {
                       value: state.publisherStats?.jitterInMs,
                     ),
                     StatsItem(
-                      title: 'Publish quality drop reason',
-                      value: state.publisherStats?.qualityDropReason,
+                      title: 'Region',
+                      value: state.localStats?.sfu,
+                    ),
+                    StatsItem(
+                      title: 'SDK Version',
+                      value: state.localStats?.sdkVersion,
+                    ),
+                    StatsItem(
+                      title: 'WebRTC Version',
+                      value: state.localStats?.webRtcVersion,
                     ),
                     StatsItem(
                       title: 'Publish bitrate',
@@ -205,24 +213,28 @@ class StatsItem extends StatelessWidget {
       padding: const EdgeInsets.all(16),
       child: Row(
         children: [
-          Column(
-            crossAxisAlignment: CrossAxisAlignment.start,
-            children: [
-              Text(
-                title,
-                style: theme.textTheme.footnote.apply(
-                  color: AppColorPalette.secondaryText,
+          Expanded(
+            child: Column(
+              crossAxisAlignment: CrossAxisAlignment.start,
+              children: [
+                Text(
+                  title,
+                  style: theme.textTheme.footnote.apply(
+                    color: AppColorPalette.secondaryText,
+                  ),
                 ),
-              ),
-              const SizedBox(height: 4),
-              Text(
-                value ?? '',
-                style: theme.textTheme.title3,
-              ),
-            ],
+                const SizedBox(height: 4),
+                Text(
+                  value ?? '',
+                  style: theme.textTheme.title3,
+                ),
+              ],
+            ),
           ),
-          const Spacer(),
-          if (trailing != null) trailing!,
+          if (trailing != null) ...[
+            const Spacer(),
+            trailing!,
+          ],
         ],
       ),
     );

dogfooding/lib/screens/call_stats_screen.dart

@@ -1,3 +1,14 @@
+## 0.3.3
+
+* Added `StreamCallType` class that replaces depricated String `type` parameter
+* Exapanded `CallStats` class with more structured WebRTC statistics as `stats` field
+* Changed `raw` statistics in `CallStats` to be of a Map<Stirng, dynamic> type
+* Added `publisherStats`, `subsciberStats` and `latencyHistory` to the `CallState` that hold some of the processed statistcs 
+
+Bug fixes
+* Fixes incoming call behavior when both CallKit and Stream incoming screen component is used 
+* Fixes the issue on Android that caused missed call notification when ringing with reused call id
+
 ## 0.3.2
 
 🐞 Fixed

packages/stream_video/CHANGELOG.md

@@ -9,6 +9,7 @@ import 'package:meta/meta.dart';
 import 'package:rxdart/rxdart.dart';
 
 import '../../stream_video.dart';
+import '../../version.g.dart';
 import '../action/internal/lifecycle_action.dart';
 import '../coordinator/models/coordinator_models.dart';
 import '../errors/video_error_composer.dart';
@@ -600,8 +601,19 @@ class Call {
       }),
     );
 
-    _stateManager
-        .lifecycleCallSessionStart(CallSessionStart(session.sessionId));
+    var localStats = state.value.localStats ?? LocalStats.empty();
+    localStats = localStats.copyWith(
+      sfu: session.config.sfuUrl,
+      sdkVersion: streamVideoVersion,
+      webRtcVersion:
+          CurrentPlatform.isAndroid ? androidWebRTCVersion : iosWebRTCVersion,
+    );
+
+    _stateManager.lifecycleCallSessionStart(
+      CallSessionStart(session.sessionId),
+      localStats: localStats,
+    );
+
     final result = await session.start();
     _logger.v(() => '[startSession] completed: $result');
     return result;

packages/stream_video/lib/src/call/call.dart

@@ -65,6 +65,9 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
         DisconnectReason.ended(),
       ),
       sessionId: '',
+      localStats: LocalStats.empty(),
+      publisherStats: PeerConnectionStats.empty(),
+      subscriberStats: PeerConnectionStats.empty(),
     );
   }
 
@@ -185,6 +188,9 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
       ),
       sessionId: '',
       callParticipants: const [],
+      localStats: LocalStats.empty(),
+      publisherStats: PeerConnectionStats.empty(),
+      subscriberStats: PeerConnectionStats.empty(),
     );
   }
 
@@ -197,6 +203,9 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
         const DisconnectReason.timeout(),
       ),
       sessionId: '',
+      localStats: LocalStats.empty(),
+      publisherStats: PeerConnectionStats.empty(),
+      subscriberStats: PeerConnectionStats.empty(),
     );
   }
 
@@ -226,15 +235,20 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
       status: CallStatus.disconnected(
         DisconnectReason.failure(stage.error),
       ),
+      localStats: LocalStats.empty(),
+      publisherStats: PeerConnectionStats.empty(),
+      subscriberStats: PeerConnectionStats.empty(),
     );
   }
 
   void lifecycleCallSessionStart(
-    CallSessionStart action,
-  ) {
+    CallSessionStart action, {
+    LocalStats? localStats,
+  }) {
     _logger.d(() => '[lifecycleCallSessionStart] state: $state');
     state = state.copyWith(
       sessionId: action.sessionId,
+      localStats: localStats,
       //status: CallStatus.connecting(),
     );
   }
@@ -260,16 +274,14 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
     required List<int> latencyHistory,
     PeerConnectionStats? publisherStats,
     PeerConnectionStats? subscriberStats,
-    LocalStats? localStats,
   }) {
     _logger.d(
       () =>
-          '[lifecycleCallStats] publisherStats: $publisherStats, subscriberStats: $subscriberStats, localStats: $localStats, state: $state',
+          '[lifecycleCallStats] publisherStats: $publisherStats, subscriberStats: $subscriberStats, state: $state',
     );
     state = state.copyWith(
       publisherStats: publisherStats,
       subscriberStats: subscriberStats,
-      localStats: localStats,
       latencyHistory: latencyHistory,
     );
   }

packages/stream_video/lib/src/call/state/mixins/state_lifecycle_mixin.dart

@@ -164,48 +164,48 @@ class MediaStatsInfo {
 @immutable
 class LocalStats {
   const LocalStats({
-    required this.resolution,
-    required this.availableResolutions,
-    required this.maxResolution,
     required this.sfu,
-    required this.os,
     required this.sdkVersion,
-    required this.deviceModel,
+    required this.webRtcVersion,
   });
 
+  factory LocalStats.empty() => const LocalStats(
+        sfu: '',
+        sdkVersion: '',
+        webRtcVersion: '',
+      );
+
   final String sfu;
-  final String os;
   final String sdkVersion;
-  final String deviceModel;
-  final String? resolution;
-  final List<String>? availableResolutions;
-  final String? maxResolution;
+  final String webRtcVersion;
 
   @override
   String toString() {
-    return 'LocalStats{resolution: $resolution, availableResolutions: $availableResolutions, maxResolution: $maxResolution, sfu: $sfu, os: $os, sdkVersion: $sdkVersion, deviceModel: $deviceModel}';
+    return 'LocalStats{sfu: $sfu, sdkVersion: $sdkVersion, webRtcVersion: $webRtcVersion}';
+  }
+
+  LocalStats copyWith({
+    String? sfu,
+    String? sdkVersion,
+    String? webRtcVersion,
+  }) {
+    return LocalStats(
+      sfu: sfu ?? this.sfu,
+      sdkVersion: sdkVersion ?? this.sdkVersion,
+      webRtcVersion: webRtcVersion ?? this.webRtcVersion,
+    );
   }
 
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
       other is LocalStats &&
           runtimeType == other.runtimeType &&
-          resolution == other.resolution &&
-          availableResolutions == other.availableResolutions &&
-          maxResolution == other.maxResolution &&
           sfu == other.sfu &&
-          os == other.os &&
           sdkVersion == other.sdkVersion &&
-          deviceModel == other.deviceModel;
+          webRtcVersion == other.webRtcVersion;
 
   @override
   int get hashCode =>
-      resolution.hashCode ^
-      availableResolutions.hashCode ^
-      maxResolution.hashCode ^
-      sfu.hashCode ^
-      os.hashCode ^
-      sdkVersion.hashCode ^
-      deviceModel.hashCode;
+      sfu.hashCode ^ sdkVersion.hashCode ^ webRtcVersion.hashCode;
 }

packages/stream_video/lib/src/models/call_stats.dart

@@ -1,3 +1,5 @@
 // This file is generated. Do not manually edit.
 /// Current package version.
 const String streamVideoVersion = '0.3.2';
+const String androidWebRTCVersion = 'libwebrtc-m114.5735.05';
+const String iosWebRTCVersion = 'libwebrtc-m114.5735.08';

packages/stream_video/lib/version.g.dart

@@ -116,7 +116,9 @@ class _StreamCallParticipantsState extends State<StreamCallParticipants> {
     super.didUpdateWidget(oldWidget);
 
     if (!const ListEquality<CallParticipantState>().equals(
-        widget.participants.toList(), oldWidget.participants.toList())) {
+      widget.participants.toList(),
+      oldWidget.participants.toList(),
+    )) {
       _recalculateParticipants();
     }
   }