feat(messaging): add support for setDeliveryMetricsExportToBigQuery #6529

pavan168 · 2022-09-13T04:56:16Z

Description

We have had very specific requirements to send out push notifications using FCM and have implemented an in-house solution using the Firebase Admin SDK. However, we don't get access to the message delivery information in the Firebase Console anymore and want to use BigQuery to analyse this information.

Reading through the documentation we found that the message delivery data export needs to be enabled on the device (after asking for consent of course) and both ios and android native methods are not exposed as per the RNFirebase documentation.

With this PR, we can use setDeliveryMetricsExportToBigQuery method to pass down the status (a boolean value) and have used deliveryMetricsExportToBigQueryEnabled() method that exist already on android to return the updated status whilst iOS does not have a similar method, isDeliveryMetricsExportToBigQueryEnabled is introduced that holds the most up-to-date status that can be used as per your requirement.

Related issues

n/a

Release Summary

n/a

Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
- Yes 🔥
My change supports the following platforms;
- Android
- iOS
My change includes tests;
- e2e tests added or updated in packages/\*\*/e2e
- jest tests added or updated in packages/\*\*/__tests__
I have updated TypeScript types that are affected by my change.
This is a breaking change;
- Yes
- No

Test Plan

iOS test cases

Android test cases

Think react-native-firebase is great? Please consider supporting the project with any of the below:

👉 Star this repo on GitHub ⭐️
👉 Follow React Native Firebase and Invertase on Twitter

CLAassistant · 2022-09-13T04:56:21Z

All committers have signed the CLA.

vercel · 2022-09-13T04:56:21Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
react-native-firebase	✅ Ready (Inspect)	Visit Preview	Sep 13, 2022 at 5:01AM (UTC)

1 Ignored Deployment

Name	Status	Preview	Updated
react-native-firebase-next	⬜️ Ignored (Inspect)		Sep 13, 2022 at 5:01AM (UTC)

vercel · 2022-09-13T04:56:22Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
react-native-firebase-next	🔄 Building (Inspect)		Sep 13, 2022 at 4:56AM (UTC)

mikehardy · 2022-09-17T16:00:25Z

Hey! Thanks for your patience on this - I'm still catching up (as fast as I can, but never fast enough...) after summer travels. Queued for review

codecov · 2022-09-17T16:02:34Z

Codecov Report

Merging #6529 (8030aba) into main (a05f63d) will decrease coverage by 17.75%.
The diff coverage is 88.89%.

❗ Current head 8030aba differs from pull request most recent head 8ea07fb. Consider uploading reports for the commit 8ea07fb to get more accurate results

@@              Coverage Diff              @@
##               main    #6529       +/-   ##
=============================================
- Coverage     72.30%   54.56%   -17.74%     
- Complexity        0      682      +682     
=============================================
  Files           109      208       +99     
  Lines          4657    10375     +5718     
  Branches       1048     1645      +597     
=============================================
+ Hits           3367     5660     +2293     
- Misses         1212     4433     +3221     
- Partials         78      282      +204

mikehardy

This looks great. For a little bit I was confused why the iOS implementation wasn't actually doing anything, then I remembered our previous conversation where it came out that on the iOS side you can only send things per-message + on receipt. At which point the property is perfect as it may be queried by an extension

Great work here, all around

mikehardy · 2022-09-17T18:49:44Z

...ndroid/src/main/java/io/invertase/firebase/messaging/ReactNativeFirebaseMessagingModule.java

  @Override
  public Map<String, Object> getConstants() {
    final Map<String, Object> constants = new HashMap<>();
    constants.put("isAutoInitEnabled", FirebaseMessaging.getInstance().isAutoInitEnabled());
+    constants.put("isDeliveryMetricsExportToBigQueryEnabled", FirebaseMessaging.getInstance().deliveryMetricsExportToBigQueryEnabled());


Interesting - I was under the impression that constants were fetched once and cached such that setting new values into constants would not be reflected in future checks, but your test probes this, so, 👍

I had the same thought at first. Gotta say that the tests were super helpful for a starter 👍

Thank you very much @mikehardy Hoping to contribute more in future!

mikehardy · 2022-09-17T22:13:27Z

v15.6.0 just went out with this feature - good luck with your project!

mattThousand · 2022-09-28T00:21:45Z

@mikehardy @pavan168 in order for an iOS app to export message data to BigQuery, I will still need to make my own Notification Service Extension, is that correct? But on Android, all I would need to do is call setDeliveryMetricsExportToBigQuery(true) from the javascript layer?

Or do the changes introduced in this PR mean that we no longer need to make our own Notification Service Extension?

I suppose I am a bit confused about how to use the changes introduced in this PR to send message data to BigQuery on iOS 🤔

mikehardy · 2022-09-28T00:28:29Z

I don't believe there is a way to avoid the extension on iOS bec you have to send it every notification. The PR made the status of user acceptance very accessible, but it still requires an extension. If this isn't clear in the docs you can hit the edit button at the top of any page and drop a note in to help future intrepid explorers 😁

feat: add support for setDeliveryMetricsExportToBigQuery

8ea07fb

pavan168 mentioned this pull request Sep 13, 2022

feat(messaging): add support for setDeliveryMetricsExportToBigQuery #6528

Closed

8 tasks

vercel bot deployed to Preview – react-native-firebase September 13, 2022 05:01 View deployment

mikehardy added the Workflow: Needs Review Pending feedback or review from a maintainer. label Sep 17, 2022

mikehardy approved these changes Sep 17, 2022

View reviewed changes

mikehardy merged commit 930abd6 into invertase:main Sep 17, 2022

mikehardy removed the Workflow: Needs Review Pending feedback or review from a maintainer. label Sep 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(messaging): add support for setDeliveryMetricsExportToBigQuery #6529

feat(messaging): add support for setDeliveryMetricsExportToBigQuery #6529

pavan168 commented Sep 13, 2022

CLAassistant commented Sep 13, 2022 •

edited

Loading

vercel bot commented Sep 13, 2022 •

edited

Loading

vercel bot commented Sep 13, 2022

mikehardy commented Sep 17, 2022

codecov bot commented Sep 17, 2022 •

edited

Loading

mikehardy left a comment

mikehardy Sep 17, 2022

pavan168 Sep 19, 2022

pavan168 Sep 19, 2022

mikehardy commented Sep 17, 2022

mattThousand commented Sep 28, 2022 •

edited

Loading

mikehardy commented Sep 28, 2022

feat(messaging): add support for setDeliveryMetricsExportToBigQuery #6529

feat(messaging): add support for setDeliveryMetricsExportToBigQuery #6529

Conversation

pavan168 commented Sep 13, 2022

Description

Related issues

Release Summary

Checklist

Test Plan

CLAassistant commented Sep 13, 2022 • edited Loading

vercel bot commented Sep 13, 2022 • edited Loading

vercel bot commented Sep 13, 2022

mikehardy commented Sep 17, 2022

codecov bot commented Sep 17, 2022 • edited Loading

Codecov Report

mikehardy left a comment

Choose a reason for hiding this comment

mikehardy Sep 17, 2022

Choose a reason for hiding this comment

pavan168 Sep 19, 2022

Choose a reason for hiding this comment

pavan168 Sep 19, 2022

Choose a reason for hiding this comment

mikehardy commented Sep 17, 2022

mattThousand commented Sep 28, 2022 • edited Loading

mikehardy commented Sep 28, 2022

CLAassistant commented Sep 13, 2022 •

edited

Loading

vercel bot commented Sep 13, 2022 •

edited

Loading

codecov bot commented Sep 17, 2022 •

edited

Loading

mattThousand commented Sep 28, 2022 •

edited

Loading