fix(analytics): setCurrentScreen() was deprecated, using `logScreen…

…View()` instead (firebase#12085)
KKimj · Jan 5, 2024 · c6341b9 · c6341b9
1 parent 387e943
commit c6341b9
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 15 deletions.
diff --git a/packages/firebase_analytics/firebase_analytics/example/lib/main.dart b/packages/firebase_analytics/firebase_analytics/example/lib/main.dart
@@ -112,14 +112,6 @@ class _MyHomePageState extends State<MyHomePage> {
     setMessage('setUserId succeeded');
   }
 
-  Future<void> _testSetCurrentScreen() async {
-    await widget.analytics.setCurrentScreen(
-      screenName: 'Analytics Demo',
-      screenClassOverride: 'AnalyticsDemo',
-    );
-    setMessage('setCurrentScreen succeeded');
-  }
-
   Future<void> _testSetAnalyticsCollectionEnabled() async {
     await widget.analytics.setAnalyticsCollectionEnabled(false);
     await widget.analytics.setAnalyticsCollectionEnabled(true);
@@ -337,10 +329,6 @@ class _MyHomePageState extends State<MyHomePage> {
               onPressed: _testSetUserId,
               child: const Text('Test setUserId'),
             ),
-            MaterialButton(
-              onPressed: _testSetCurrentScreen,
-              child: const Text('Test setCurrentScreen'),
-            ),
             MaterialButton(
               onPressed: _testSetAnalyticsCollectionEnabled,
               child: const Text('Test setAnalyticsCollectionEnabled'),

diff --git a/packages/firebase_analytics/firebase_analytics/example/lib/tabs_page.dart b/packages/firebase_analytics/firebase_analytics/example/lib/tabs_page.dart
@@ -89,7 +89,7 @@ class _TabsPageState extends State<TabsPage>
   }
 
   void _sendCurrentTabToAnalytics() {
-    analytics.setCurrentScreen(
+    analytics.logScreenView(
       screenName: '${TabsPage.routeName}/tab$selectedIndex',
     );
   }

diff --git a/packages/firebase_analytics/firebase_analytics/lib/observer.dart b/packages/firebase_analytics/firebase_analytics/lib/observer.dart
@@ -83,7 +83,7 @@ class FirebaseAnalyticsObserver extends RouteObserver<ModalRoute<dynamic>> {
   void _sendScreenView(Route<dynamic> route) {
     final String? screenName = nameExtractor(route.settings);
     if (screenName != null) {
-      analytics.setCurrentScreen(screenName: screenName).catchError(
+      analytics.logScreenView(screenName: screenName).catchError(
         (Object error) {
           final _onError = this._onError;
           if (_onError == null) {

diff --git a/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart b/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart
@@ -189,6 +189,9 @@ class FirebaseAnalytics extends FirebasePluginPlatform {
   ///
   ///  * https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#setCurrentScreen(android.app.Activity, java.lang.String, java.lang.String)
   ///  * https://firebase.google.com/docs/reference/ios/firebaseanalytics/api/reference/Classes/FIRAnalytics#setscreennamescreenclass
+  @Deprecated(
+    'setCurrentScreen() has been deprecated. Please use logScreenView()',
+  )
   Future<void> setCurrentScreen({
     required String? screenName,
     String screenClassOverride = 'Flutter',

diff --git a/packages/firebase_analytics/firebase_analytics/test/firebase_analytics_test.dart b/packages/firebase_analytics/firebase_analytics/test/firebase_analytics_test.dart
@@ -1197,6 +1197,7 @@ void main() {
       });
 
       test('setCurrentScreen', () async {
+        // ignore: deprecated_member_use_from_same_package
         await analytics!.setCurrentScreen(
           screenName: 'test-screen-name',
           screenClassOverride: 'test-class-override',

diff --git a/tests/integration_test/firebase_analytics/firebase_analytics_e2e_test.dart b/tests/integration_test/firebase_analytics/firebase_analytics_e2e_test.dart
@@ -108,7 +108,7 @@ void main() {
         throwsA(isA<AssertionError>()),
       );
 
-      // test 2 reserved events
+      // test 3 reserved events
       await expectLater(
         FirebaseAnalytics.instance.logAdImpression(
           adPlatform: 'foo',
@@ -134,6 +134,14 @@ void main() {
         ),
         completes,
       );
+
+      await expectLater(
+        FirebaseAnalytics.instance.logScreenView(
+          screenClass: 'FooActivity',
+          screenName: 'bar',
+        ),
+        completes,
+      );
     });
 
     test(
@@ -171,6 +179,7 @@ void main() {
 
     test('setCurrentScreen', () async {
       await expectLater(
+        // ignore: deprecated_member_use
         FirebaseAnalytics.instance.setCurrentScreen(screenName: 'screen-name'),
         completes,
       );