chore(repo): make ringing work when example app is in the background (#1105)

* make ringing work when example app is in the background

* readme

* tweaks

Author: Brazol

packages/stream_video/test/src/call/call_coordinator_events_test.dart

@@ -1742,7 +1742,7 @@ void main() {
 
         final initialState = createActiveCallState(
           currentByUser: currentUser,
-          status: CallStatus.outgoing(acceptedByCallee: false),
+          status: CallStatus.outgoing(),
         );
         final stateManager = CallStateNotifier(initialState);
 

packages/stream_video_flutter/example/README.md

@@ -1,20 +1,27 @@
 # Stream Video Flutter Example App
 
-This is an example app built using the [Stream Video Flutter](https://pub.dev/packages/stream_video_flutter) package, designed to showcase both core features of the package. It's a great starting point to explore how the Stream Video SDK works in real-world scenarios.
+This example app showcases core features of the [Stream Video Flutter](https://pub.dev/packages/stream_video_flutter) package. It's a great starting point to see how the Stream Video SDK works in real-world scenarios.
 
 For a more advanced example of how to use the Stream Video Flutter package, check out the [dogfooding app here](https://github.com/GetStream/stream-video-flutter/tree/main/dogfooding).
 
 ## Features
 
-- **Video Calls**: Test various aspects of video call functionality.
-    - Create or join a video meeting (with or without a Lobby).
-    - Make direct calls to other users (without CallKit integration - only in-app ringing screen)
+- **Video calls**: Explore core calling functionality.
+    - Create or join a meeting (with or without a lobby).
+    - Make direct calls to other users (with CallKit/ringing integration; calls work in the background).
+
+> Note: In this example, ringing does not work when the app is terminated. For a more robust implementation of ringing with background capabilities, see the [dogfooding app](https://github.com/GetStream/stream-video-flutter/tree/main/dogfooding).
+
+## Prerequisites
+
+- Flutter installed and available on your PATH
+- A connected device or simulator/emulator
 
 ## Getting Started
 
 To set up and run the app, follow these steps:
 
-1. Clone the repo and install the dependencies
+1. Clone the repository and install dependencies
 First, clone the repository to your local machine and install the required Flutter packages:
 
 ```bash
@@ -23,11 +30,10 @@ cd stream-video-flutter/packages/stream_video_flutter/example
 flutter pub get
 ```
 
-2. Run the app
+2. Run the example
 Once the setup is complete, you can run the app using Flutter:
 
 ```bash
-## Ensure you're in the example directory
 flutter run
 ```
 
@@ -42,11 +48,17 @@ Licensed under the Stream License;
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-   https://github.com/GetStream/stream-video-android/blob/main/LICENSE
+   https://github.com/GetStream/stream-video-flutter/blob/main/LICENSE
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-```
+```
+
+## Links
+
+- Package on pub.dev: https://pub.dev/packages/stream_video_flutter
+- Docs: https://getstream.io/video/docs/flutter/
+- Advanced example (dogfooding app): https://github.com/GetStream/stream-video-flutter/tree/main/dogfooding

packages/stream_video_flutter/example/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>12.0</string>
+  <string>15.0</string>
 </dict>
 </plist>

packages/stream_video_flutter/example/ios/Podfile

@@ -1,5 +1,5 @@
 # Uncomment this line to define a global platform for your project
-platform :ios, '14'
+platform :ios, '15'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'

packages/stream_video_flutter/example/ios/Runner.xcodeproj/project.pbxproj

@@ -34,6 +34,7 @@
 		1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = "<group>"; };
 		2D45EC435B9C349C8F075378 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
 		3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = "<group>"; };
+		60368AB02EC74DD600B3618A /* RunnerDebug.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = RunnerDebug.entitlements; sourceTree = "<group>"; };
 		63C4214F6AF6EDCA0297B4E0 /* Pods-Runner.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.release.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"; sourceTree = "<group>"; };
 		74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Runner-Bridging-Header.h"; sourceTree = "<group>"; };
 		74858FAE1ED2DC5600515810 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
@@ -112,6 +113,7 @@
 		97C146F01CF9000F007C117D /* Runner */ = {
 			isa = PBXGroup;
 			children = (
+				60368AB02EC74DD600B3618A /* RunnerDebug.entitlements */,
 				97C146FA1CF9000F007C117D /* Main.storyboard */,
 				97C146FD1CF9000F007C117D /* Assets.xcassets */,
 				97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */,
@@ -383,7 +385,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				PRODUCT_BUNDLE_IDENTIFIER = com.example.example;
+				PRODUCT_BUNDLE_IDENTIFIER = io.getstream.video.flutter.dogfooding;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_VERSION = 5.0;
@@ -504,6 +506,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_ENTITLEMENTS = Runner/RunnerDebug.entitlements;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
 				DEVELOPMENT_TEAM = EHV7XZLAHA;
 				ENABLE_BITCODE = NO;
@@ -512,7 +515,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				PRODUCT_BUNDLE_IDENTIFIER = com.example.example;
+				PRODUCT_BUNDLE_IDENTIFIER = io.getstream.video.flutter.dogfooding;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
@@ -535,7 +538,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				PRODUCT_BUNDLE_IDENTIFIER = com.example.example;
+				PRODUCT_BUNDLE_IDENTIFIER = io.getstream.video.flutter.dogfooding;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_VERSION = 5.0;

packages/stream_video_flutter/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme

@@ -26,6 +26,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      customLLDBInitFile = "$(SRCROOT)/Flutter/ephemeral/flutter_lldbinit"
       shouldUseLaunchSchemeArgsEnv = "YES">
       <MacroExpansion>
          <BuildableReference
@@ -43,11 +44,13 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      customLLDBInitFile = "$(SRCROOT)/Flutter/ephemeral/flutter_lldbinit"
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">

packages/stream_video_flutter/example/ios/Runner/AppDelegate.swift

@@ -1,5 +1,6 @@
-import UIKit
 import Flutter
+import UIKit
+import stream_video_push_notification
 
 @main
 @objc class AppDelegate: FlutterAppDelegate {
@@ -8,6 +9,7 @@ import Flutter
     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
   ) -> Bool {
     GeneratedPluginRegistrant.register(with: self)
+    StreamVideoPKDelegateManager.shared.registerForPushNotifications()
     return super.application(application, didFinishLaunchingWithOptions: launchOptions)
   }
 }

packages/stream_video_flutter/example/ios/Runner/Info.plist

@@ -2,6 +2,10 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
+	<key>BGTaskSchedulerPermittedIdentifiers</key>
+	<array>
+		<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	</array>
 	<key>CADisableMinimumFrameDurationOnPhone</key>
 	<true/>
 	<key>CFBundleDevelopmentRegion</key>
@@ -35,6 +39,10 @@
 	<key>UIBackgroundModes</key>
 	<array>
 		<string>audio</string>
+		<string>processing</string>
+		<string>remote-notification</string>
+		<string>voip</string>
+		<string>fetch</string>
 	</array>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>

packages/stream_video_flutter/example/ios/Runner/RunnerDebug.entitlements

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>aps-environment</key>
+	<string>development</string>
+</dict>
+</plist>

packages/stream_video_flutter/example/lib/app.dart

@@ -9,6 +9,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_local_notifications/flutter_local_notifications.dart'
     as ln;
 import 'package:google_fonts/google_fonts.dart';
+import 'package:rxdart/rxdart.dart';
 import 'package:stream_video_flutter/stream_video_flutter.dart';
 
 import 'core/auth_repository.dart';
@@ -22,11 +23,9 @@ Future<void> _onFirebaseBackgroundMessage(RemoteMessage message) async {
   debugPrint(
     '[onFirebaseBackgroundMessage] message: ${jsonEncode(message.toMap())}',
   );
+
   // Initialise Firebase
   await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
-  await initNotifications();
-
-  // Initialise Stream Video
 
   final authRepository = await AuthRepository.getInstance();
   final credentials = authRepository.getCredentials();
@@ -38,51 +37,15 @@ Future<void> _onFirebaseBackgroundMessage(RemoteMessage message) async {
     userToken: credentials.token,
   );
 
-  client.observeCallDeclinedRingingEvent();
-
-  await _handlePushNotification(message);
-
-  await StreamVideo.reset(disconnect: true);
-}
-
-Future<bool> _handlePushNotification(RemoteMessage message) async {
-  try {
-    final payload = message.data;
-    // Only handle messages from stream.video
-    final sender = payload['sender'] as String?;
-    if (sender != 'stream.video') {
-      debugPrint('Not a stream.video message');
-      return false;
-    }
-
-    // Only handle ringing calls.
-    final type = payload['type'] as String?;
-    if (type != 'call.ring' && type != 'call.missed') {
-      debugPrint('Not a call.ring or call.missed message');
-      return false;
-    }
-
-    // Return if the payload does not contain a call cid.
-    final callCid = payload['call_cid'] as String?;
-    if (callCid == null) {
-      debugPrint('No call cid in payload');
-      return false;
-    }
-
-    final createdByDisplayName = payload['created_by_display_name'] as String?;
-    if (createdByDisplayName == null) {
-      debugPrint('No created_by_display_name in payload');
-      return false;
-    }
+  final subscription = client.observeCallDeclinedRingingEvent();
 
-    await showNotification(callCid, type, createdByDisplayName);
-    return true;
-  } catch (e, stk) {
-    debugPrint('Error handling remote message: $e');
-    debugPrint(stk.toString());
+  client.disposeAfterResolvingRinging(
+    disposingCallback: () {
+      subscription?.cancel();
+    },
+  );
 
-    return false;
-  }
+  await client.handleRingingFlowNotifications(message.data);
 }
 
 final ln.FlutterLocalNotificationsPlugin flutterLocalNotificationsPlugin =
@@ -151,34 +114,57 @@ class MyApp extends StatefulWidget {
 }
 
 class _MyAppState extends State<MyApp> {
+  final navigatorKey = GlobalKey<NavigatorState>();
+
   @override
   void initState() {
     super.initState();
-
-    _observeFcmMessages();
   }
 
   @override
   void dispose() {
-    _fcmSubscription?.cancel();
+    _compositeSubscription.clear();
     super.dispose();
   }
 
-  StreamSubscription<RemoteMessage>? _fcmSubscription;
-
-  Future<void> _observeFcmMessages() async {
-    // Requests notification permission.
-    await FirebaseMessaging.instance.requestPermission();
+  final _compositeSubscription = CompositeSubscription();
+
+  void _observeRingingEvents() {
+    _compositeSubscription.clear();
+
+    // On mobile we depend on call kit notifications.
+    // On desktop and web they are (currently) not available, so we depend on a
+    // websocket which can receive a call when the app is open.
+    if (CurrentPlatform.isMobile) {
+      _compositeSubscription.add(
+        StreamVideo.instance.observeCoreRingingEvents(
+          onCallAccepted: _navigateToCall,
+        ),
+      );
+    } else {
+      _compositeSubscription.add(
+        StreamVideo.instance.state.incomingCall.listen((call) {
+          if (call == null) return;
+
+          // Navigate to the call screen.
+          _navigateToCall(call);
+        }),
+      );
+    }
+  }
 
+  void _observeFcmMessages() {
     FirebaseMessaging.onBackgroundMessage(_onFirebaseBackgroundMessage);
-    _fcmSubscription = FirebaseMessaging.onMessage.listen(
-      _onFirebaseForegroundMessage,
-    );
   }
 
-  Future<bool> _onFirebaseForegroundMessage(RemoteMessage message) async {
-    debugPrint('[onFirebaseForegroundMessage] message: ${message.toMap()}');
-    return _handlePushNotification(message);
+  void _navigateToCall(Call call) {
+    navigatorKey.currentState?.push(
+      MaterialPageRoute<dynamic>(
+        builder: (context) => StreamCallContainer(
+          call: call,
+        ),
+      ),
+    );
   }
 
   @override
@@ -188,6 +174,7 @@ class _MyAppState extends State<MyApp> {
 
     return MaterialApp(
       title: 'Stream Video Example',
+      navigatorKey: navigatorKey,
       theme: ThemeData(
         textTheme: GoogleFonts.robotoMonoTextTheme(),
         extensions: <ThemeExtension<dynamic>>[lightAppTheme],
@@ -197,7 +184,16 @@ class _MyAppState extends State<MyApp> {
         extensions: <ThemeExtension<dynamic>>[darkAppTheme],
       ),
       themeMode: ThemeMode.dark,
-      home: LoginScreen(connectUser: widget.connectUser),
+      home: LoginScreen(
+        connectUser: (user) async {
+          await widget.connectUser(user);
+
+          _observeRingingEvents();
+          _observeFcmMessages();
+
+          return const Result.success(none);
+        },
+      ),
       debugShowCheckedModeBanner: false,
     );
   }