Add SendMessageToUsers method. Part of status-im/status-mobile#7268

Author: Pedro Pombeiro

Gopkg.lock

@@ -35,6 +35,11 @@
   name = "github.com/golang/protobuf"
   version = "1.1.0"
 
+[[constraint]]
+  name = "github.com/NaySoftware/go-fcm"
+  revision = "024ca6a2c5444c93980f558f91c35a2defebd362"
+  source = "github.com/status-im/go-fcm"
+
 # * * * * * `go-ethereum` dependencies * * * * *
 # Pinned down SHAs from `go-ethereum/vendor/vendor.json`
 # When upgrading upstream, upgrade these values too.

Gopkg.toml

@@ -473,6 +473,18 @@ func (b *StatusBackend) NotifyUsers(message string, payload fcmlib.NotificationP
 	return err
 }
 
+// SendMessageToUsers sends a message to users, which can be used to display a push notification.
+func (b *StatusBackend) SendMessageToUsers(dataPayloadJSON string, tokens ...string) error {
+	log.Debug("sending message")
+
+	err := b.newNotification().SendMessage(dataPayloadJSON, tokens...)
+	if err != nil {
+		b.log.Error("SendMessage failed", "dataPayloadJSON", dataPayloadJSON, "error", err)
+	}
+
+	return err
+}
+
 func appendIf(condition bool, services []gethnode.ServiceConstructor, service gethnode.ServiceConstructor) []gethnode.ServiceConstructor {
 	if !condition {
 		return services

api/backend.go

@@ -468,6 +468,46 @@ func NotifyUsers(message, payloadJSON, tokensArray *C.char) (outCBytes *C.char)
 	return
 }
 
+// SendMessageToUsers sends messages to users represented by given tokens.
+//export SendMessageToUsers
+func SendMessageToUsers(dataPayloadJSON, tokensArray *C.char) (outCBytes *C.char) {
+	var (
+		err      error
+		outBytes []byte
+	)
+	errString := ""
+
+	defer func() {
+		out := NotifyResult{
+			Status: err == nil,
+			Error:  errString,
+		}
+
+		outBytes, err = json.Marshal(out)
+		if err != nil {
+			logger.Error("failed to marshal SendMessageToUsers output", "error", err)
+			outCBytes = makeJSONResponse(err)
+			return
+		}
+
+		outCBytes = C.CString(string(outBytes))
+	}()
+
+	tokens, err := ParseJSONArray(C.GoString(tokensArray))
+	if err != nil {
+		errString = err.Error()
+		return
+	}
+
+	err = statusBackend.SendMessageToUsers(C.GoString(dataPayloadJSON), tokens...)
+	if err != nil {
+		errString = err.Error()
+		return
+	}
+
+	return
+}
+
 // UpdateMailservers updates mail servers in status backend.
 //export UpdateMailservers
 func UpdateMailservers(data *C.char) *C.char {

lib/library.go

@@ -1,6 +1,7 @@
 package fcm
 
 import (
+	"encoding/json"
 	"fmt"
 
 	"github.com/NaySoftware/go-fcm"
@@ -9,6 +10,7 @@ import (
 // Notifier manages Push Notifications.
 type Notifier interface {
 	Send(body string, payload fcm.NotificationPayload, tokens ...string) error
+	SendMessage(dataPayloadJSON string, tokens ...string) error
 }
 
 // NotificationConstructor returns constructor of configured instance Notifier interface.
@@ -25,6 +27,7 @@ func NewNotification(key string) NotificationConstructor {
 		client := fcm.NewFcmClient(key).
 			SetDelayWhileIdle(true).
 			SetContentAvailable(true).
+			SetPriority(fcm.Priority_HIGH). // Message needs to be marked as high-priority so that background task in an Android's recipient device can be invoked (https://github.com/invertase/react-native-firebase/blob/d13f0af53f1c8f20db8bc8d4b6f8c6d210e108b9/android/src/main/java/io/invertase/firebase/messaging/RNFirebaseMessagingService.java#L56)
 			SetTimeToLive(fcm.MAX_TTL)
 
 		return &Notification{client}
@@ -52,3 +55,24 @@ func (n *Notification) Send(body string, payload fcm.NotificationPayload, tokens
 
 	return err
 }
+
+// SendMessage sends a message to the tokens list.
+func (n *Notification) SendMessage(dataPayloadJSON string, tokens ...string) error {
+	var dataPayload map[string]string
+	err := json.Unmarshal([]byte(dataPayloadJSON), &dataPayload)
+	if err != nil {
+		return err
+	}
+
+	n.client.NewFcmRegIdsMsg(tokens, dataPayload)
+	resp, err := n.client.Send()
+	if err != nil {
+		return err
+	}
+
+	if resp != nil && !resp.Ok {
+		return fmt.Errorf("FCM error sending message, code=%d err=%s", resp.StatusCode, resp.Err)
+	}
+
+	return nil
+}

notifications/push/fcm/client_mock.go

@@ -1,6 +1,7 @@
 package fcm
 
 import (
+	"encoding/json"
 	"errors"
 	"testing"
 
@@ -69,3 +70,53 @@ func (s *NotifierTestSuite) TestNotifyError() {
 func getPayload() fcm.NotificationPayload {
 	return fcm.NotificationPayload{Title: "Status - new message", Body: "sum"}
 }
+
+func (s *NotifierTestSuite) TestSendSuccess() {
+	ids := []string{"1"}
+	dataPayload := make(map[string]string)
+	dataPayload["from"] = "a"
+	dataPayload["to"] = "b"
+	dataPayloadByteArray, err := json.Marshal(dataPayload)
+	s.Require().NoError(err)
+	dataPayloadJSON := string(dataPayloadByteArray)
+
+	s.fcmClientMock.EXPECT().NewFcmRegIdsMsg(ids, dataPayload).Times(1)
+	s.fcmClientMock.EXPECT().SendMessage().Return(nil, nil).Times(1)
+	fcmClient := Notification{s.fcmClientMock}
+
+	err = fcmClient.SendMessage(dataPayloadJSON, ids...)
+
+	s.NoError(err)
+}
+
+func (s *NotifierTestSuite) TestSendError() {
+	expectedError := errors.New("error")
+	ids := []string{"2"}
+	dataPayload := make(map[string]string)
+	dataPayload["from"] = "c"
+	dataPayload["to"] = "d"
+	dataPayloadByteArray, err := json.Marshal(dataPayload)
+	s.Require().NoError(err)
+	dataPayloadJSON := string(dataPayloadByteArray)
+
+	s.fcmClientMock.EXPECT().NewFcmRegIdsMsg(ids, dataPayload).Times(1)
+	s.fcmClientMock.EXPECT().SendMessage().Return(nil, expectedError).Times(1)
+	fcmClient := Notification{s.fcmClientMock}
+
+	err = fcmClient.SendMessage(dataPayloadJSON, ids...)
+
+	s.Equal(expectedError, err)
+}
+
+func (s *NotifierTestSuite) TestSendWithInvalidJSON() {
+	ids := []string{"3"}
+	dataPayloadJSON := "{a=b}"
+
+	fcmClient := Notification{s.fcmClientMock}
+
+	err := fcmClient.SendMessage(dataPayloadJSON, ids...)
+	s.Require().Error(err)
+
+	_, ok := err.(*json.SyntaxError)
+	s.True(ok)
+}