Improve chat message pushes for APNS (#51)

* Improve chat message pushes for APNS

* Set default body of mutable APNS push to ...

* Fix comments and adjust code placement

Author: jeffyanta

pkg/code/push/data.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/code-payments/code-server/pkg/code/common"
 	code_data "github.com/code-payments/code-server/pkg/code/data"
+	push_data "github.com/code-payments/code-server/pkg/code/data/push"
 	push_lib "github.com/code-payments/code-server/pkg/push"
 )
 
@@ -18,11 +19,11 @@ const (
 	chatMessageDataPush dataPushType = "ChatMessage"
 )
 
-// sendDataPushNotificationToOwner is a generic utility for sending data push
+// sendRawDataPushNotificationToOwner is a generic utility for sending raw data push
 // notification to the devices linked to an owner account.
 //
 // todo: Duplicated code with other send push utitilies
-func sendDataPushNotificationToOwner(
+func sendRawDataPushNotificationToOwner(
 	ctx context.Context,
 	data code_data.Provider,
 	pusher push_lib.Provider,
@@ -31,7 +32,7 @@ func sendDataPushNotificationToOwner(
 	kvs map[string]string,
 ) error {
 	log := logrus.StandardLogger().WithFields(logrus.Fields{
-		"method": "sendDataPushNotificationToOwner",
+		"method": "sendRawDataPushNotificationToOwner",
 		"owner":  owner.PublicKey().ToBase58(),
 	})
 
@@ -68,3 +69,69 @@ func sendDataPushNotificationToOwner(
 	}
 	return nil
 }
+
+// sendMutableNotificationToOwner is a generic utility for sending mutable
+// push notification to the devices linked to an owner account. It's a
+// special data push where the notification content is replaced by the contents
+// of a kv pair payload.
+//
+// todo: Duplicated code with other send push utitilies
+func sendMutableNotificationToOwner(
+	ctx context.Context,
+	data code_data.Provider,
+	pusher push_lib.Provider,
+	owner *common.Account,
+	notificationType dataPushType,
+	titleKey string,
+	kvs map[string]string,
+) error {
+	log := logrus.StandardLogger().WithFields(logrus.Fields{
+		"method": "sendMutableNotificationToOwner",
+		"owner":  owner.PublicKey().ToBase58(),
+	})
+
+	kvs[dataPushTypeKey] = string(notificationType)
+
+	pushTokenRecords, err := getPushTokensForOwner(ctx, data, owner)
+	if err != nil {
+		log.WithError(err).Warn("failure getting push tokens for owner")
+		return err
+	}
+
+	seenPushTokens := make(map[string]struct{})
+	for _, pushTokenRecord := range pushTokenRecords {
+		// Dedup push tokens, since they may appear more than once per app install
+		if _, ok := seenPushTokens[pushTokenRecord.PushToken]; ok {
+			continue
+		}
+
+		log := log.WithField("push_token", pushTokenRecord.PushToken)
+
+		// Try push
+		var err error
+		switch pushTokenRecord.TokenType {
+		case push_data.TokenTypeFcmApns:
+			err = pusher.SendMutableAPNSPush(
+				ctx,
+				pushTokenRecord.PushToken,
+				titleKey,
+				kvs,
+			)
+		case push_data.TokenTypeFcmAndroid:
+			// todo: anything special required for Android?
+			err = pusher.SendDataPush(
+				ctx,
+				pushTokenRecord.PushToken,
+				kvs,
+			)
+		}
+
+		if err != nil {
+			log.WithError(err).Warn("failure sending push notification")
+			onPushError(ctx, data, pusher, pushTokenRecord)
+		}
+
+		seenPushTokens[pushTokenRecord.PushToken] = struct{}{}
+	}
+	return nil
+}

pkg/code/push/notifications.go

@@ -199,12 +199,13 @@ func SendChatMessagePushNotification(
 			"message_content": base64.StdEncoding.EncodeToString(marshalledContent),
 		}
 
-		err = sendDataPushNotificationToOwner(
+		err = sendMutableNotificationToOwner(
 			ctx,
 			data,
 			pusher,
 			owner,
 			chatMessageDataPush,
+			chatTitle,
 			kvs,
 		)
 		if err != nil {

pkg/push/fcm/provider.go

@@ -130,6 +130,28 @@ func (p *provider) SendLocalizedAndroidPush(ctx context.Context, pushToken, titl
 	})
 }
 
+// SendMutableAPNSPush implements push.Provider.SendMutableAPNSPush
+func (p *provider) SendMutableAPNSPush(ctx context.Context, pushToken, titleKey string, kvs map[string]string) error {
+	defer metrics.TraceMethodCall(ctx, metricsStructName, "SendMutableAPNSPush").End()
+
+	_, err := p.client.Send(ctx, &messaging.Message{
+		Token: pushToken,
+		Data:  kvs,
+		APNS: &messaging.APNSConfig{
+			Payload: &messaging.APNSPayload{
+				Aps: &messaging.Aps{
+					Alert: &messaging.ApsAlert{
+						TitleLocKey: titleKey,
+						Body:        "...",
+					},
+					MutableContent: true,
+				},
+			},
+		},
+	})
+	return err
+}
+
 // SendDataPush implements push.Provider.SendDataPush
 func (p *provider) SendDataPush(ctx context.Context, pushToken string, kvs map[string]string) error {
 	defer metrics.TraceMethodCall(ctx, metricsStructName, "SendDataPush").End()

pkg/push/memory/provider.go

@@ -44,6 +44,11 @@ func (p *provider) SendLocalizedAndroidPush(ctx context.Context, pushToken, titl
 	return simulateSendingPush(pushToken)
 }
 
+// SendMutableAPNSPush implements push.Provider.SendMutableAPNSPush
+func (p *provider) SendMutableAPNSPush(ctx context.Context, pushToken, titleKey string, kvs map[string]string) error {
+	return simulateSendingPush(pushToken)
+}
+
 // SendDataPush implements push.Provider.SendDataPush
 func (p *provider) SendDataPush(ctx context.Context, pushToken string, kvs map[string]string) error {
 	return simulateSendingPush(pushToken)

pkg/push/provider.go

@@ -14,6 +14,10 @@ type Provider interface {
 	// SendLocalizedAPNSPush sends a localized APNS push
 	SendLocalizedAPNSPush(ctx context.Context, pushToken, titleKey, bodyKey string, bodyArgs ...string) error
 
+	// SendMutableAPNSPush sends a push over APNS with a text body that's mutable
+	// on the client using custom key value pairs
+	SendMutableAPNSPush(ctx context.Context, pushToken, titleKey string, kvs map[string]string) error
+
 	// SendLocalizedAndroidPush sends a localized Android push
 	SendLocalizedAndroidPush(ctx context.Context, pushToken, titleKey, bodyKey string, bodyArgs ...string) error