fix call preference initialization during ringing (#921)

Author: Brazol

dogfooding/lib/screens/call_screen.dart

@@ -143,10 +143,12 @@ class _CallScreenState extends State<CallScreen> {
           },
           onCallDisconnected: (disconnectedProperties) {
             final reason = disconnectedProperties.reason;
+
+            Navigator.of(context).pop();
+
             if (reason is DisconnectReasonCancelled ||
                 reason is DisconnectReasonEnded ||
                 reason is DisconnectReasonLastParticipantLeft) {
-              Navigator.of(context).pop();
               showFeedbackDialog(context, call: widget.call);
             }
           },

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

@@ -189,7 +189,6 @@ class Call {
     return Call._(
       coordinatorClient: coordinatorClient,
       streamVideo: streamVideo,
-      preferences: finalCallPreferences,
       stateManager: stateManager,
       credentials: credentials,
       retryPolicy: finalRetryPolicy,
@@ -201,7 +200,6 @@ class Call {
   Call._({
     required CoordinatorClient coordinatorClient,
     required StreamVideo streamVideo,
-    required CallPreferences preferences,
     required CallStateNotifier stateManager,
     required PermissionsManager permissionManager,
     required RetryPolicy retryPolicy,
@@ -217,7 +215,6 @@ class Call {
         _permissionsManager = permissionManager,
         _coordinatorClient = coordinatorClient,
         _streamVideo = streamVideo,
-        _preferences = preferences,
         _retryPolicy = retryPolicy,
         _credentials = credentials,
         dynascaleManager = DynascaleManager(stateManager: stateManager) {
@@ -239,7 +236,6 @@ class Call {
   final CoordinatorClient _coordinatorClient;
   final StreamVideo _streamVideo;
   final RetryPolicy _retryPolicy;
-  final CallPreferences _preferences;
   final CallSessionFactory _sessionFactory;
   final CallStateNotifier _stateManager;
   final PermissionsManager _permissionsManager;
@@ -468,7 +464,8 @@ class Call {
         return _handleClosedCaptionEvent(event);
       case StreamCallReactionEvent _:
         _reactionTimers.add(
-          Timer(_preferences.reactionAutoDismissTime, () {
+          Timer(_stateManager.callState.preferences.reactionAutoDismissTime,
+              () {
             _stateManager.resetCallReaction(event.user.id);
           }),
         );
@@ -488,6 +485,11 @@ class Call {
     }
   }
 
+  void updateCallPreferences(CallPreferences preferences) {
+    _logger.i(() => '[updateCallPreferences] $preferences');
+    _stateManager.updateCallPreferences(preferences);
+  }
+
   /// Accepts the incoming call.
   Future<Result<None>> accept() async {
     final state = this.state.value;
@@ -592,7 +594,7 @@ class Call {
 
       final status = await state.firstWhere(
         (it) => it.status is CallStatusConnected,
-        timeLimit: _preferences.connectTimeout,
+        timeLimit: _stateManager.callState.preferences.connectTimeout,
       );
 
       if (status is! CallStatusConnected) {
@@ -710,7 +712,8 @@ class Call {
               });
             }
           },
-          clientPublishOptions: _preferences.clientPublishOptions,
+          clientPublishOptions:
+              _stateManager.callState.preferences.clientPublishOptions,
         );
 
         dynascaleManager.init(
@@ -1004,7 +1007,10 @@ class Call {
           rtcManager: session.rtcManager!,
           stateManager: _stateManager,
         )
-            .run(interval: _preferences.callStatsReportingInterval)
+            .run(
+          interval:
+              _stateManager.callState.preferences.callStatsReportingInterval,
+        )
             .listen((stats) {
           _stats.emit(stats);
         }),
@@ -1044,7 +1050,7 @@ class Call {
       if (callParticipants.length == 1 &&
           callParticipants.first.userId == _streamVideo.currentUser.id &&
           state.value.isRingingFlow &&
-          _stateManager.callPreferences.dropIfAloneInRingingFlow) {
+          _stateManager.callState.preferences.dropIfAloneInRingingFlow) {
         await leave();
       }
     } else if (sfuEvent is SfuHealthCheckResponseEvent) {
@@ -1585,9 +1591,10 @@ class Call {
 
       final newQueue = [...queue, currentCaption];
 
-      final visibilityDurationMs =
-          _preferences.closedCaptionsVisibilityDurationMs;
-      final visibileCaptions = _preferences.closedCaptionsVisibleCaptions;
+      final visibilityDurationMs = _stateManager
+          .callState.preferences.closedCaptionsVisibilityDurationMs;
+      final visibileCaptions =
+          _stateManager.callState.preferences.closedCaptionsVisibleCaptions;
 
       try {
         // schedule the removal of the closed caption after the retention time
@@ -2572,10 +2579,10 @@ CallStateNotifier _makeStateManager(
 
   return CallStateNotifier(
     CallState(
+      preferences: callPreferences,
       currentUserId: currentUserId,
       callCid: callCid,
     ),
-    callPreferences,
   );
 }
 

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

@@ -2,7 +2,7 @@ import 'package:state_notifier/state_notifier.dart';
 
 import '../../call_state.dart';
 import '../../logger/impl/tagged_logger.dart';
-import '../../models/call_preferences.dart';
+import '../../models/models.dart';
 import '../../state_emitter.dart';
 import 'mixins/state_call_actions_mixin.dart';
 import 'mixins/state_coordinator_mixin.dart';
@@ -19,17 +19,13 @@ class CallStateNotifier extends StateNotifier<CallState>
         StateRtcMixin,
         StateSfuMixin,
         StateCallActionsMixin {
-  CallStateNotifier(CallState initialState, this.callPreferences)
-      : super(initialState) {
+  CallStateNotifier(CallState initialState) : super(initialState) {
     callStateStream =
         MutableStateEmitterImpl<CallState>(initialState, sync: true);
   }
 
   final _logger = taggedLogger(tag: 'CallStateNotifier');
 
-  @override
-  final CallPreferences callPreferences;
-
   late final MutableStateEmitterImpl<CallState> callStateStream;
   CallState get callState => callStateStream.value;
 
@@ -43,6 +39,11 @@ class CallStateNotifier extends StateNotifier<CallState>
     callStateStream.value = value;
   }
 
+  void updateCallPreferences(CallPreferences preferences) {
+    _logger.v(() => '[updateCallPreferences] $preferences');
+    state = state.copyWith(preferences: preferences);
+  }
+
   @override
   void dispose() {
     super.dispose();

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

@@ -5,7 +5,6 @@ import '../../../call_state.dart';
 import '../../../logger/impl/tagged_logger.dart';
 import '../../../models/call_participant_pin.dart';
 import '../../../models/call_participant_state.dart';
-import '../../../models/call_preferences.dart';
 import '../../../models/call_track_state.dart';
 import '../../../sfu/data/events/sfu_events.dart';
 import '../../../sfu/data/models/sfu_pin.dart';
@@ -14,8 +13,6 @@ import '../../../sfu/sfu_extensions.dart';
 final _logger = taggedLogger(tag: 'SV:CoordNotifier');
 
 mixin StateSfuMixin on StateNotifier<CallState> {
-  CallPreferences get callPreferences;
-
   void sfuParticipantLeft(
     SfuParticipantLeftEvent event,
   ) {

packages/stream_video/lib/src/call_state.dart

@@ -12,8 +12,10 @@ class CallState extends Equatable {
   factory CallState({
     required String currentUserId,
     required StreamCallCid callCid,
+    required CallPreferences preferences,
   }) {
     return CallState._(
+      preferences: preferences,
       currentUserId: currentUserId,
       callCid: callCid,
       createdByUserId: '',
@@ -55,6 +57,7 @@ class CallState extends Equatable {
   }
 
   const CallState._({
+    required this.preferences,
     required this.currentUserId,
     required this.callCid,
     required this.createdByUserId,
@@ -94,6 +97,7 @@ class CallState extends Equatable {
     required this.custom,
   });
 
+  final CallPreferences preferences;
   final String currentUserId;
   final StreamCallCid callCid;
   final String createdByUserId;
@@ -151,6 +155,7 @@ class CallState extends Equatable {
   /// Returns a copy of this [CallState] with the given fields replaced
   /// with the new values.
   CallState copyWith({
+    CallPreferences? preferences,
     String? currentUserId,
     StreamCallCid? callCid,
     String? createdByUserId,
@@ -190,6 +195,7 @@ class CallState extends Equatable {
     Map<String, Object>? custom,
   }) {
     return CallState._(
+      preferences: preferences ?? this.preferences,
       currentUserId: currentUserId ?? this.currentUserId,
       callCid: callCid ?? this.callCid,
       createdByUserId: createdByUserId ?? this.createdByUserId,

packages/stream_video/lib/src/stream_video.dart

@@ -419,7 +419,6 @@ class StreamVideo extends Disposable {
         event.data.ringing) {
       _logger.v(() => '[onCoordinatorEvent] onCallRinging: ${event.data}');
       final call = _makeCallFromRinging(data: event.data);
-
       _state.incomingCall.value = call;
     } else if (event is CoordinatorConnectedEvent) {
       _logger.i(() => '[onCoordinatorEvent] connected ${event.userId}');
@@ -505,7 +504,7 @@ class StreamVideo extends Disposable {
       streamVideo: this,
       retryPolicy: _options.retryPolicy,
       sdpPolicy: _options.sdpPolicy,
-      preferences: preferences,
+      preferences: preferences ?? _options.defaultCallPreferences,
     );
   }
 
@@ -519,7 +518,7 @@ class StreamVideo extends Disposable {
       streamVideo: this,
       retryPolicy: _options.retryPolicy,
       sdpPolicy: _options.sdpPolicy,
-      preferences: preferences,
+      preferences: preferences ?? _options.defaultCallPreferences,
     );
   }
 
@@ -695,19 +694,26 @@ class StreamVideo extends Disposable {
     final cid = event.data.callCid;
     if (uuid == null || cid == null) return;
 
-    final call = await consumeIncomingCall(
+    final consumeResult = await consumeIncomingCall(
       uuid: uuid,
       cid: cid,
       preferences: callPreferences,
     );
-    final callToJoin = call.getDataOrNull();
+
+    if (consumeResult.isFailure) {
+      _logger.w(
+        () => '[onCallAccept] error consuming incoming call}',
+      );
+      return;
+    }
+
+    final callToJoin = consumeResult.getDataOrNull();
     if (callToJoin == null) return;
 
     final acceptResult = await callToJoin.accept();
 
-    // Return if cannot accept call
     if (acceptResult.isFailure) {
-      _logger.d(() => '[onCallAccept] error accepting call: $call');
+      _logger.d(() => '[onCallAccept] error accepting call: $callToJoin');
       return;
     }
 
@@ -925,8 +931,13 @@ class StreamVideo extends Disposable {
       );
     }
 
+    // If call was already created by consuming ringing event, use the same instance.
     if (_state.incomingCall.valueOrNull?.callCid.value == cid) {
-      return Result.success(_state.incomingCall.value!);
+      final call = _state.incomingCall.value!;
+      if (preferences != null) {
+        call.updateCallPreferences(preferences);
+      }
+      return Result.success(call);
     }
 
     final callCid = StreamCallCid(cid: cid);
@@ -941,7 +952,7 @@ class StreamVideo extends Disposable {
         ringing: true,
         metadata: callResult.data.metadata,
       ),
-      preferences: preferences,
+      preferences: preferences ?? _options.defaultCallPreferences,
     );
 
     return Result.success(call);
@@ -1069,6 +1080,7 @@ class StreamVideoOptions {
     this.coordinatorWsUrl = _defaultCoordinatorWsUrl,
     this.latencySettings = const LatencySettings(),
     this.retryPolicy = const RetryPolicy(),
+    this.defaultCallPreferences,
     this.sdpPolicy = const SdpPolicy(spdEditingEnabled: false),
     this.audioProcessor,
     this.logPriority = Priority.none,
@@ -1086,6 +1098,7 @@ class StreamVideoOptions {
 
   /// Returns the current [RetryPolicy].
   final RetryPolicy retryPolicy;
+  final CallPreferences? defaultCallPreferences;
 
   /// Returns the current [SdpPolicy].
   final SdpPolicy sdpPolicy;