fix(push): send createDevice request only once per token change (#777)

* send createDevice request only once per token change

* store token when request succeeds

* PR tweaks

---------

Co-authored-by: Deven Joshi <[email protected]>

Author: Brazol

packages/stream_video/lib/src/stream_video.dart

@@ -262,6 +262,7 @@ class StreamVideo extends Disposable {
   /// Connects the user to the Stream Video service.
   Future<Result<UserToken>> connect({
     bool includeUserDetails = true,
+    bool registerPushDevice = true,
   }) async {
     if (currentUserType == UserType.anonymous) {
       _logger.w(() => '[connect] rejected (anonymous user)');
@@ -271,6 +272,7 @@ class StreamVideo extends Disposable {
     }
     _connectOperation ??= _connect(
       includeUserDetails: includeUserDetails,
+      registerPushDevice: registerPushDevice,
     ).asCancelable();
     return _connectOperation!
         .valueOrDefault(Result.error('connect was cancelled'))
@@ -293,6 +295,7 @@ class StreamVideo extends Disposable {
 
   Future<Result<UserToken>> _connect({
     bool includeUserDetails = false,
+    bool registerPushDevice = true,
   }) async {
     _logger.i(() => '[connect] currentUser.id: ${_state.currentUser.id}');
     if (_connectionState.isConnected) {
@@ -339,7 +342,9 @@ class StreamVideo extends Disposable {
       _subscriptions.add(_idAppState, lifecycle.appState.listen(_onAppState));
 
       // Register device with push notification manager.
-      pushNotificationManager?.registerDevice();
+      if (registerPushDevice) {
+        pushNotificationManager?.registerDevice();
+      }
 
       if (pushNotificationManager != null) {
         _subscriptions.add(

packages/stream_video_flutter/CHANGELOG.md

@@ -1,3 +1,14 @@
+## Unreleased
+
+🔄 Dependency updates
+* Updated firebase dependencies to fix Xcode 16 build issues
+
+✅ Added
+* Added `registerPushDevice` optional parameter (default as true) to `StreamVideo.connect()` method that can prevent automatic push token registration.
+
+🐞 Fixed
+* Automatic push token registration done by `StreamVideo` now stores registered token in `SharedPreferences` and will now only perform API call when token changes.
+
 ## 0.5.5
 
 🐞 Fixed

packages/stream_video_push_notification/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+
+🔄 Dependency updates
+* Updated firebase dependencies to fix Xcode 16 build issues
+
 ## 0.5.5
 * Sync version with `stream_video_flutter` 0.5.5
 

packages/stream_video_push_notification/lib/src/stream_video_push_notification.dart

@@ -4,6 +4,7 @@ import 'package:firebase_messaging/firebase_messaging.dart';
 import 'package:flutter_callkit_incoming/entities/entities.dart';
 import 'package:flutter_callkit_incoming/flutter_callkit_incoming.dart';
 import 'package:rxdart/rxdart.dart';
+import 'package:shared_preferences/shared_preferences.dart';
 import 'package:stream_video/stream_video.dart' hide CallEvent;
 import 'package:stream_video_push_notification/stream_video_push_notification_platform_interface.dart';
 
@@ -20,6 +21,9 @@ const _idCallRejected = 6;
 
 /// Implementation of [PushNotificationManager] for Stream Video.
 class StreamVideoPushNotificationManager implements PushNotificationManager {
+  static const userDeviceTokenKey = 'io.getstream.userDeviceToken';
+  static const userDeviceTokenVoIPKey = 'io.getstream.userDeviceTokenVoIP';
+
   /// Factory for creating a new instance of [StreamVideoPushNotificationManager].
   ///   /// Parameters:
   /// * [callerCustomizationCallback] callback providing customized caller data used for call screen and CallKit call. (for iOS this will only work for foreground calls)
@@ -67,6 +71,8 @@ class StreamVideoPushNotificationManager implements PushNotificationManager {
   }) : _client = client {
     if (CurrentPlatform.isWeb) return;
 
+    SharedPreferences.getInstance().then((prefs) => _sharedPreferences = prefs);
+
     subscribeToEvents() {
       _subscriptions.add(
         _idCallEnded,
@@ -155,6 +161,7 @@ class StreamVideoPushNotificationManager implements PushNotificationManager {
   final StreamVideoPushParams pushParams;
   final CallerCustomizationFunction? callerCustomizationCallback;
   final bool registerApnDeviceToken;
+  late SharedPreferences _sharedPreferences;
 
   final _logger = taggedLogger(tag: 'SV:PNManager');
   bool? _wasWsConnected;
@@ -174,13 +181,24 @@ class StreamVideoPushNotificationManager implements PushNotificationManager {
       return;
     }
 
-    void registerDevice(String token, bool isVoIP) {
-      _client.createDevice(
+    void registerDevice(String token, bool isVoIP) async {
+      final tokenKey = isVoIP ? userDeviceTokenVoIPKey : userDeviceTokenKey;
+
+      final storedToken = _sharedPreferences.getString(tokenKey);
+      if (storedToken == token) return;
+
+      _client
+          .createDevice(
         id: token,
         voipToken: isVoIP,
         pushProvider: pushProvider.type,
         pushProviderName: pushProvider.name,
-      );
+      )
+          .then((result) {
+        if (result is Success) {
+          _sharedPreferences.setString(tokenKey, token);
+        }
+      });
     }
 
     if (CurrentPlatform.isIos && registerApnDeviceToken) {
@@ -197,6 +215,11 @@ class StreamVideoPushNotificationManager implements PushNotificationManager {
             .listen((token) => registerDevice(token, true)));
   }
 
+  Future<void> removedStoredTokens() async {
+    await _sharedPreferences.remove(userDeviceTokenKey);
+    await _sharedPreferences.remove(userDeviceTokenVoIPKey);
+  }
+
   @override
   void unregisterDevice() async {
     final token = await getDevicePushTokenVoIP();
@@ -209,6 +232,8 @@ class StreamVideoPushNotificationManager implements PushNotificationManager {
     if (apnToken != null) {
       _client.deleteDevice(id: apnToken);
     }
+
+    removedStoredTokens();
   }
 
   @override

packages/stream_video_push_notification/pubspec.yaml

@@ -24,7 +24,8 @@ dependencies:
   rxdart: ^0.28.0
   stream_video: ^0.5.5
   uuid: ^4.2.1
-
+  shared_preferences: ^2.3.2
+  
 dev_dependencies:
   build_runner: ^2.4.4
   flutter_lints: ^2.0.2