[firebase_messaging] Android: Receiving Data messages if app terminated #1898

ivk1800 · 2019-07-24T17:25:37Z

Description

Adding support receiving data messages if app terminated on Android.

Related Issues

flutter/flutter#22072

flutter/flutter#31365
flutter/flutter#32751

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

[] Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
No, this is not a breaking change.

fix message structure from intent

# Conflicts: # packages/firebase_messaging/README.md

collinjackson

Thanks for the PR!

flutter/flutter#22072 is a high priority issue and I'd love to get a fix landed.

I'm trying to wrap my head around this implementation and I'm curious how your approach compares to what React Native Firebase is doing. Let me know if you have any thoughts on that.

FlutterBackgroundMessagesReceiver has a lot of new code for building up notifications and sending them to the NotificationManager. I just want to make sure I understand why we need to do that. It sounds like we're going down different paths for notifications handling depending on whether data messages are enabled and I'm wondering if it would make more sense to handle all notifications the same way for consistency.

collinjackson · 2019-07-24T17:29:35Z

packages/firebase_messaging/README.md

+            android:name="flutter.firebase.data.message"
+            android:value="true" />
+  ```
+2. implement onReceive method. onReceive called if app terminated or app in background.


Suggested change

2. implement onReceive method. onReceive called if app terminated or app in background.

2. Implement the `onReceive` method. `onReceive` called if the app is terminated or in the background.

collinjackson · 2019-07-24T17:33:20Z

packages/firebase_messaging/README.md

@@ -108,6 +108,35 @@ Future<void> _handleNotification (Map<dynamic, dynamic> message, bool dialog) as
 }
 ````

+## Receiving Data messages(Android)


Suggested change

## Receiving Data messages(Android)

## Receiving data messages (Android)

collinjackson · 2019-07-24T17:34:03Z

packages/firebase_messaging/README.md

@@ -88,7 +88,7 @@ Messages are sent to your Flutter app via the `onMessage`, `onLaunch`, and `onRe
 | --------------------------: | ----------------- | ----------------- | -------------- |
 | **Notification on Android** | `onMessage` | Notification is delivered to system tray. When the user clicks on it to open app `onResume` fires if `click_action: FLUTTER_NOTIFICATION_CLICK` is set (see below). | Notification is delivered to system tray. When the user clicks on it to open app `onLaunch` fires if `click_action: FLUTTER_NOTIFICATION_CLICK` is set (see below). |
 | **Notification on iOS** | `onMessage` | Notification is delivered to system tray. When the user clicks on it to open app `onResume` fires. | Notification is delivered to system tray. When the user clicks on it to open app `onLaunch` fires. |
-| **Data Message on Android** | `onMessage` | `onMessage` while app stays in the background. | *not supported by plugin, message is lost* |
+| **Data Message on Android** | `onMessage` | `onMessage` while app stays in the background. | see "Receiving Data messages(Android)" |


collinjackson · 2019-07-24T17:34:38Z

packages/firebase_messaging/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.2.0
+
+* Android: Receiving Data messages if app terminated


Suggested change

* Android: Receiving Data messages if app terminated

* On Android, now supports receiving data messages if the app is terminated.

collinjackson · 2019-07-24T17:41:47Z

...roid/src/main/java/io/flutter/plugins/firebasemessaging/FlutterFirebaseMessagingService.java

  /**
   * Called when message is received.
   *
   * @param remoteMessage Object representing the message received from Firebase Cloud Messaging.
   */
  @Override
  public void onMessageReceived(RemoteMessage remoteMessage) {
-    Intent intent = new Intent(ACTION_REMOTE_MESSAGE);
+    if (!isDataMessages) {
+      sendForegroundBroadcast(remoteMessage);


It seems like you're broadcasting twice here if !isDataMessages evaluates to true. Is that what you intended? Should you return?

collinjackson · 2019-07-24T17:50:48Z

...main/java/io/flutter/plugins/firebasemessagingexample/FlutterBackgroundMessagesReceiver.java

+      messageDataIntent.putExtra(key, value);
+    }
+
+    PendingIntent pendingIntent = PendingIntent.getActivity(context, 123, messageDataIntent, 0);


Suggested change

PendingIntent pendingIntent = PendingIntent.getActivity(context, 123, messageDataIntent, 0);

PendingIntent pendingIntent = PendingIntent.getActivity(context, 123, messageDataIntent, 0);

The 123 here looks a little magical, perhaps we should move it out into a constant?

collinjackson · 2019-07-24T18:01:18Z

...ndroid/src/main/java/io/flutter/plugins/firebasemessaging/FlutterFirebaseMessagingUtils.java

+
+  private static final String DATA_MESSAGES_KEY = "flutter.firebase.data.message";
+
+  static boolean isDataMessages(Context context) {


This method name came across as a bit confusing.

collinjackson · 2019-07-24T18:19:50Z

...roid/src/main/java/io/flutter/plugins/firebasemessaging/FlutterFirebaseMessagingService.java

+   * true, if application receive messages with type "Data messages" About FCM messages
+   * {@https://firebase.google.com/docs/cloud-messaging/concept-options}
+   */
+  private boolean isDataMessages;


If this is private it probably doesn't need a doc comment.

collinjackson · 2019-07-24T18:22:12Z

...ndroid/src/main/java/io/flutter/plugins/firebasemessaging/FlutterFirebaseMessagingUtils.java

+
+  private static final String DATA_MESSAGES_KEY = "flutter.firebase.data.message";
+
+  static boolean isDataMessages(Context context) {


I found this method name kind of confusing. I think it might make sense to call it dataMessagesEnabled since you're intending this as an app-wide flag. Would it make sense to just do something by default? React Native Firebase doesn't seem to have this flag so I'm wondering how the approaches compare.

kroikie · 2019-07-24T19:43:24Z

@ivk1800 Thanks for the PR, could you provide more details on the exact problem that this PR is attempting to solve? Background messaging is an issue but I'm not sure if this PR addresses it completely.

kroikie · 2019-07-24T23:41:05Z

It looks like any background notification converted into a display notification then when the user clicks on the notification it can be handled. @ivk1800 Could you confirm what your approach here is?

ivk1800 · 2019-07-29T18:03:57Z

@kroikie my PR resolve problem of "lost data messages". programmer must choose way for handle data message. In example simply displayed notification, but you can chose another way for prevent lost message, for example accumulate their in preferences and handle in dart code after launch application.

kroikie · 2019-07-29T20:23:06Z

Would the developer using the background feature have to write their own FlutterBackgroundMessagesReceiver?

ivk1800 · 2019-07-30T06:50:03Z

yes, receiver with intent filter

io.flutter.plugins.firebasemessaging.BACKGROUND_NOTIFICATION

kroikie · 2019-07-30T16:18:07Z

In #1900 background messages are handled by Dart code defined by the developer without having to write custom native code. I believe that PR covers the use case solved here, would you mind confirming?

ivk1800 · 2019-07-30T16:21:29Z

In #1900 background messages are handled by Dart code defined by the developer without having to write custom native code. I believe that PR covers the use case solved here, would you mind confirming?

yes, you right

kroikie · 2019-07-30T16:22:53Z

Sounds good, I'll add you as a reviewer on #1900 and close this PR, thanks again for this PR.

pafnat · 2019-08-20T12:33:19Z

In #1900 background messages are handled by Dart code defined by the developer without having to write custom native code. I believe that PR covers the use case solved here, would you mind confirming?

yes, you right

is there way to retrieve callback on Dart side when app is closed?

kroikie · 2019-08-20T20:41:19Z

That may be possible however that would have to be something outside of the firebase_messaging plugin.

braysonjohn148 · 2020-07-07T07:34:10Z

Although i couldn't understand what exactly is happening here, but this seem cool. Am trying to find a workaround for receiving data message when app is completely terminated. Is it possible..?

ivk1800 added 10 commits December 5, 2018 14:30

Update FirebaseMessagingPlugin.java

d5c1495

fix message structure from intent

handle background messages

526169d

explicit intent

58723cf

Merge branch 'master' into handle_data_messages

bc5538b

implement example

195ae31

Update README.md

7a7f432

Merge branch 'master' into handle_data_messages

8177bcf

# Conflicts: # packages/firebase_messaging/README.md

Update README.md

1c3f7c0

version

44180c3

formatting

5b59684

ivk1800 requested review from collinjackson and kroikie as code owners July 24, 2019 17:25

googlebot added the cla: yes label Jul 24, 2019

kroikie self-assigned this Jul 24, 2019

kroikie added the flutterfire label Jul 24, 2019

collinjackson reviewed Jul 24, 2019

View reviewed changes

kroikie mentioned this pull request Jul 24, 2019

[firebase_messaging] Add support for handling messages in background #1900

Closed

kroikie closed this Jul 30, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[firebase_messaging] Android: Receiving Data messages if app terminated #1898

[firebase_messaging] Android: Receiving Data messages if app terminated #1898

ivk1800 commented Jul 24, 2019 •

edited

Loading

collinjackson left a comment

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

collinjackson Jul 24, 2019

kroikie commented Jul 24, 2019 •

edited

Loading

kroikie commented Jul 24, 2019

ivk1800 commented Jul 29, 2019

kroikie commented Jul 29, 2019

ivk1800 commented Jul 30, 2019

kroikie commented Jul 30, 2019

ivk1800 commented Jul 30, 2019

kroikie commented Jul 30, 2019

pafnat commented Aug 20, 2019

kroikie commented Aug 20, 2019

braysonjohn148 commented Jul 7, 2020

	2. implement onReceive method. onReceive called if app terminated or app in background.
	2. Implement the `onReceive` method. `onReceive` called if the app is terminated or in the background.

	## Receiving Data messages(Android)
	## Receiving data messages (Android)

	\| Data Message on Android \| `onMessage` \| `onMessage` while app stays in the background. \| see "Receiving Data messages(Android)" \|
	\| Data Message on Android \| `onMessage` \| `onMessage` while app stays in the background. \| see "Receiving Data messages (Android)" \|

		@@ -1,3 +1,7 @@
		## 5.2.0

		* Android: Receiving Data messages if app terminated

	* Android: Receiving Data messages if app terminated
	* On Android, now supports receiving data messages if the app is terminated.

	PendingIntent pendingIntent = PendingIntent.getActivity(context, 123, messageDataIntent, 0);
	PendingIntent pendingIntent = PendingIntent.getActivity(context, 123, messageDataIntent, 0);


		private static final String DATA_MESSAGES_KEY = "flutter.firebase.data.message";

		static boolean isDataMessages(Context context) {

[firebase_messaging] Android: Receiving Data messages if app terminated #1898

[firebase_messaging] Android: Receiving Data messages if app terminated #1898

Conversation

ivk1800 commented Jul 24, 2019 • edited Loading

Description

Related Issues

Checklist

Breaking Change

collinjackson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kroikie commented Jul 24, 2019 • edited Loading

kroikie commented Jul 24, 2019

ivk1800 commented Jul 29, 2019

kroikie commented Jul 29, 2019

ivk1800 commented Jul 30, 2019

kroikie commented Jul 30, 2019

ivk1800 commented Jul 30, 2019

kroikie commented Jul 30, 2019

pafnat commented Aug 20, 2019

kroikie commented Aug 20, 2019

braysonjohn148 commented Jul 7, 2020

ivk1800 commented Jul 24, 2019 •

edited

Loading

kroikie commented Jul 24, 2019 •

edited

Loading