[🐛] logEvent versus logScreenView

[faljabi]

Issue

When switching to modular api for logging screens

await logEvent(analytics, 'screen_view', {
                firebase_screen: currentRouteName,
                firebase_screen_class: currentRouteName
});

I see UIViewController or MainActivity on the Analytics Dashboard. It was working fine with showing my screen names instead using the below:

await logScreenView(analytics, {
                screen_name: currentRouteName,
                screen_class: currentRouteName
});

---

Project Files

Javascript

Click To Expand

package.json:

"@react-native-firebase/analytics": "^22.4.0",
    "@react-native-firebase/app": "^22.4.0",
    "@react-native-firebase/crashlytics": "^22.4.0",
    "@react-native-firebase/firestore": "^22.4.0",
    "@react-native-firebase/remote-config": "^22.4.0",

firebase.json for react-native-firebase v6:

{
    "react-native": {
        "analytics_auto_collection_enabled": true,
        "google_analytics_automatic_screen_reporting_enabled": false,
        "crashlytics_debug_enabled": true,
        "crashlytics_disable_auto_disabler": true,
        "crashlytics_auto_collection_enabled": true,
        "crashlytics_is_error_generation_on_js_crash_enabled": true,
        "crashlytics_javascript_exception_handler_chaining_enabled": false
    }
}

Any advise?

iOS

Click To Expand

ios/Podfile:

• [ ] I'm not using Pods
• [x] I'm using Pods and my Podfile looks like:

[goltra]

If I use directly logEvent passing analytics app instance, my IDE throw this:

TS2769: No overload matches this call. The last overload gave the following error. Argument of type "screen_view" is not assignable to parameter of type "add_to_cart" | "add_to_wishlist" | "remove_from_cart" index.d.ts(422, 25): The last overload is declared here.

I don't know if it could be relationated.

[MichaelVerdon]

Hi there, I am not sure what your issue is, could you please rephrase it? Are you saying that using Modular API does not work?

[goltra]

Firstly my function was like this and work but I have a warning in console inviting me to use Modular api:

const analytic = getAnalytics();
const trackScreen = async (screenName: string, screenClass: string) => {
        await analytic.logEvent('screen_view',{screen_name: screenName, screen_class: screenClass});
    }

I have change for this:

const analytic = getAnalytics();
const trackScreen = async (screenName: string, screenClass: string) => {
        logEvent(analytic, "screen_view", {screen_name: screenName, screen_class: screenClass});
    }

but my IDE (phpstorm) show a warning

If I launch the app, it works, but it's quite confusing and makes you doubt if you're doing it correctly

[goltra]

sorry, I have seen my mistake. I have to pass firebase_screen and firebase_screen_class instead of screen_name and screen_class

[faljabi]

Hi there, I am not sure what your issue is, could you please rephrase it? Are you saying that using Modular API does not work?

Hi @MichaelVerdon, the issue is that when using logScreenView I can see my screens names correctly on the firebase dashboard, but when using

await logEvent(analytics, 'screen_view', {
                firebase_screen: currentRouteName,
                firebase_screen_class: currentRouteName
});

All screens are logged as "UIViewController" for iOS or "MainActivity" for Android and not my screen names provided! so for now I'm sticking with logScreenView and accepting the warning.

[MichaelVerdon]

Hi there, thanks for further clarification, so simply, the screen names are not logged properly when using the modular reference as opposed to namespaced (which does show the correct names of all of your screens)?

[MichaelVerdon]

I believe you were using the correct method before. logScreenView is a method that exists on Modular references here: https://github.com/invertase/react-native-firebase/blob/main/packages/analytics/lib/modular/index.d.ts#L682 What you were previously doing was the correct Modular approach.

Just stick to:

await logEvent(analytics, 'screen_view', {
                firebase_screen: currentRouteName,
                firebase_screen_class: currentRouteName
});

Another way you can tell its modular is that you pass analytics as a parameter through it.

[faljabi]

Please read my issue.

I am using logEvent but it does not log the screen names I provide. It just logs UIViewController instead of the name I pass. And if I use logScreenView (although I am using the modular API) I get the deprecation warning to use logEvent.

[MichaelVerdon]

Please read my issue.

I am using logEvent but it does not log the screen names I provide. It just logs UIViewController instead of the name I pass. And if I use logScreenView (although I am using the modular API) I get the deprecation warning to use logEvent.

Hi there, yes I realise that that function is meant to be deprecated as well https://github.com/invertase/react-native-firebase/blob/main/packages/analytics/tests/analytics.test.ts#L1085. I will keep investigating. Is this only being experienced on Android?

[MichaelVerdon]

Analytics should automatically track screens. Try putting this in your manifest for now and see if it works whilst the problem gets diagnosed.

<meta-data android:name="google_analytics_automatic_screen_reporting_enabled" android:value="true" />

[faljabi]

I do not want to automatically log screens, and it is happening for both iOS and Android as I mentioned earlier.

[faljabi]

Also note I posted my firebase json file where I disabled automatic screen view logging.

[andrewwardmt]

Using logEvent with "screen_view" does not work because of this issue: https://github.com/invertase/react-native-firebase/issues/8612

[alvinisasi]

It seems like logEvent is not working properly on Android or iOS and logScreenView has been deprecated.

[MichaelVerdon]

The call you use to logScreenView is here as I mentioned before and we should be using logEvent here instead. Ill talk with the team and see if I can go ahead and migrate it to logEvent as logScreenView is deprecated.

[MichaelVerdon]

Hi there, having investigated further, we do use logEvent here and it should work as logScreenView does use logEvent under the hood so we know logEvent should work. It could be down to how you are passing names in. You can see here for more information https://reactnavigation.org/docs/screen-tracking/ and mimic here https://rnfirebase.io/analytics/screen-tracking except using logEvent instead

[andrewwardmt]

The docs there use logScreenView which raises a deprecation message. Using logEvent as documented by the Firebase modular web API:

logEvent(getAnalytics(), "screen_view", {
        firebase_screen: screenName, 
        firebase_screen_class: screenName,
});

produces the following error:

[App.debug.dylib] 11.15.0 - [FirebaseAnalytics][I-removed]
Parameter name uses reserved prefix. Ignoring parameter: firebase_screen
[App.debug.dylib] 11.15.0 - [FirebaseAnalytics][I-removed]
Parameter name uses reserved prefix. Ignoring parameter:
firebase_screen_class

Are you saying we should be doing this instead?

logEvent(getAnalytics(), "screen_view", {
        screen_name: screenName, 
        screen_class: screenName,
});

It would be great if this could be documented as this does not match the Firebase modular web API

[NX-Michael]

+1

Facing the same issue as @andrewwardmt. Documented my side from the Firebase debug console, showing that it is throwing an error as well link.

If this is so, then the typing here needs to be updated as well then

[dawidzawada]

Facing the same issue. I've tested this solution on Android Emulator & Firebase Console DebugView and it works:

await logEvent(analytics, 'screen_view', {
  screen_name: screenName,
  screen_class: screenName,
})

The only issue is it gives following typescript error:

So it should be either adjusted to use:

firebase_screen: screenName, 
firebase_screen_class: screenName,

or it should accept screen_name & screen_class

[goltra]

Yes, I know and this is the bug. Hope can resolve because has no sense use different parameters depending platform and have a typescript error

[tux2nicolae]

+1 after updating to modular api, the screen names are not logged correctly anymore

[MKSisti]

+1 having the same exact issues :

• when using the old way (which is the one documented) I get the deprecation warning.
• when using the new modular :
  • if I use firebase_screen and firebase_screen_class I get a warning saying these options a re being ignored.
  • if I use screen_name and screen_class I get a typescript error saying : Argument of type '"screen_view"' is not assignable to parameter of type '"add_to_cart" | "add_to_wishlist" | "remove_from_cart"'.

The documentation needs to be updated and include a clear and correct way on how to use the new modular approach...

[peterfajner-ensemble]

I'm seeing this issue too. We're looking to migrate our analytics to Firebase, and my first impression is that the documentation does not match the API at all.

The docs say:

logScreenView(params: ScreenViewParameters): Promise<void>;

So I do this:

logScreenView(getAnalytics(), { screen_name: screenName, screen_class: screenName });

But I get a warning:

This method is deprecated (as well as all React Native Firebase namespaced API) and will be removed in the next major release as part of move to match Firebase Web modular SDK API. Please see migration guide for more details: https://rnfirebase.io/migrating-to-v22. Method called was `logScreenView`. Please use `logEvent()` instead.

So I change it to this, which matches the API spec here:

logEvent(getAnalytics(), 'screen_view', {
    firebase_screen: screenName,
    firebase_screen_class: screenName,
  });

But now I get an error in logcat (not even in the React Native console? It's a good thing I checked!):

 E  Name starts with reserved prefix. Type, name: event param, firebase_screen
 E  Name starts with reserved prefix. Type, name: event param, firebase_screen_class

After some googling, I try this:

logEvent(getAnalytics(), 'screen_view', {
    screen_name: screenName,
    screen_class: screenName,
  });

But I get a type error:

No overload matches this call.
  The last overload gave the following error.
    Argument of type '"screen_view"' is not assignable to parameter of type '"add_to_cart" | "add_to_wishlist" | "remove_from_cart"'.ts(2769)

Given that the documentation is entirely out of sync with the API spec and the native SDK, I get the impression that this package is unmaintained and unreliable.

[TaylorDale]

Definitive answer, the way to go v22+ screen tracking is:

logEvent(getAnalytics(), 'screen_view' as any, {
  screen_class: fullRouteName,
  screen_name: fullRouteName,
});

Looks like it's just a typing issue, hopefully that will get fixed. As you can see, in GA backend it gets reported the same way as usual:

The depreciation of this method definitely warrants at least a mention in the v22 migration guide, as it was confusing for a second after I was 99% sure that I'd moved entirely to the new import system and it wasn't related to this.

This shows a deprecation error in strict mode:

logScreenView(getAnalytics(), {
                screen_class: fullRouteName,
                screen_name: fullRouteName,
});
// Causes warning, "Method called was `logScreenView`. Please use `logEvent()` instead. "

Then when we use logEvent() with firebase screen params, it won't report due to reserved names:

So I am guessing this will be the answer in the future, once the typings are fixed?

logEvent(getAnalytics(), 'screen_view', {
  screen_class: fullRouteName,
  screen_name: fullRouteName,
});

(Just realised this is mostly the same comment as above, oh well). Am hoping that the change of parameter config won't interrupt reports, too.

[goltra]

I have seen there is a new version (23) and I update package.. Now the error Event parameter name is reserved has disappear but in iOS screen_view doesn't work.

I haven't test in Android.

[mikehardy]

Looking into this

@peterfajner-ensemble -->

Given that the documentation is entirely out of sync with the API spec and the native SDK, I get the impression that this package is unmaintained and unreliable.

Neither is the case however it is true that we are dealing with a few large-scale changes that cross-cut the entire set of packages at once - the API move from namespaced to modular for firebase ecosystem compatibility - as well as the react-native move to New Architecture (which implies a move to typescript and native code rewrite.

To keep things spicy there's been the tiny matter of AI becoming ascendant and the need to spin up the vertexai (soon to be just "ai") package.

All to say, it's busy here. We're doing our best but have resource constraints just like everyone, we do appreciate the patience

[github-actions[bot]]

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

[GoodSir42]

I opened a pr to fix the issue, keep it open, please. (Hope this comment marks it as active)

[github-actions[bot]]

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

[GoodSir42]

The issue is still not stale, because there is a pr fixing it