chat/v2: send two way chat notifications.

Also refactor a bit of the notifier system to not cause a circular
dependency.

Author: mfycheng

pkg/code/chat/chat.go

@@ -8,6 +8,7 @@ const (
 	KinPurchasesName     = "Kin Purchases"
 	PaymentsName         = "Payments" // Renamed to Web Payments on client
 	TipsName             = "Tips"
+	TwoWayChatName       = "Two Way Chat"
 
 	// Test chats used for unit/integration testing only
 	TestCantMuteName        = "TestCantMute"
@@ -45,6 +46,11 @@ var (
 			CanMute:              true,
 			CanUnsubscribe:       false,
 		},
+		TwoWayChatName: {
+			TitleLocalizationKey: localization.ChatTitleTwoWay,
+			CanMute:              true,
+			CanUnsubscribe:       false,
+		},
 
 		TestCantMuteName: {
 			TitleLocalizationKey: "n/a",

pkg/code/chat/message_tips.go

@@ -18,15 +18,14 @@ import (
 	chat_v1 "github.com/code-payments/code-server/pkg/code/data/chat/v1"
 	chat_v2 "github.com/code-payments/code-server/pkg/code/data/chat/v2"
 	"github.com/code-payments/code-server/pkg/code/data/intent"
-	chat_server "github.com/code-payments/code-server/pkg/code/server/grpc/chat/v2"
 )
 
 // SendTipsExchangeMessage sends a message to the Tips chat with exchange data
 // content related to the submitted intent. Intents that don't belong in the
 // Tips chat will be ignored.
 //
 // Note: Tests covered in SubmitIntent history tests
-func SendTipsExchangeMessage(ctx context.Context, data code_data.Provider, notifier chat_server.Notifier, intentRecord *intent.Record) ([]*MessageWithOwner, error) {
+func SendTipsExchangeMessage(ctx context.Context, data code_data.Provider, notifier Notifier, intentRecord *intent.Record) ([]*MessageWithOwner, error) {
 	intentIdRaw, err := base58.Decode(intentRecord.IntentId)
 	if err != nil {
 		return nil, fmt.Errorf("invalid intent id: %w", err)

pkg/code/server/grpc/chat/v2/notifier.go pkg/code/chat/notifier.gopkg/code/server/grpc/chat/v2/notifier.go renamed to pkg/code/chat/notifier.go

@@ -1,4 +1,4 @@
-package chat_v2
+package chat
 
 import (
 	"context"

pkg/code/chat/sender.go

@@ -17,7 +17,6 @@ import (
 	code_data "github.com/code-payments/code-server/pkg/code/data"
 	chat_v1 "github.com/code-payments/code-server/pkg/code/data/chat/v1"
 	chat_v2 "github.com/code-payments/code-server/pkg/code/data/chat/v2"
-	chatserver "github.com/code-payments/code-server/pkg/code/server/grpc/chat/v2"
 )
 
 // SendNotificationChatMessageV1 sends a chat message to a receiving owner account.
@@ -124,7 +123,7 @@ func SendNotificationChatMessageV1(
 func SendNotificationChatMessageV2(
 	ctx context.Context,
 	data code_data.Provider,
-	notifier chatserver.Notifier,
+	notifier Notifier,
 	chatTitle string,
 	isVerifiedChat bool,
 	receiver *common.Account,

pkg/code/data/chat/v2/model.go

@@ -70,6 +70,11 @@ type MemberRecord struct {
 	Platform   Platform
 	PlatformId string
 
+	// If Platform != PlatformCode, this store the owner
+	// of the account (at time of creation). This allows
+	// us to send push notifications for non-code users.
+	OwnerAccount string
+
 	DeliveryPointer *MessageId
 	ReadPointer     *MessageId
 
@@ -79,6 +84,14 @@ type MemberRecord struct {
 	JoinedAt time.Time
 }
 
+func (m *MemberRecord) GetOwner() string {
+	if m.Platform == PlatformCode {
+		return m.PlatformId
+	}
+
+	return m.OwnerAccount
+}
+
 type MessageRecord struct {
 	Id        int64
 	ChatId    ChatId
@@ -292,6 +305,9 @@ func (r *MemberRecord) Validate() error {
 	if len(r.PlatformId) == 0 {
 		return errors.New("platform id is required")
 	}
+	if r.Platform != PlatformCode && len(r.OwnerAccount) == 0 {
+		return errors.New("owner account is required for non code platform members")
+	}
 
 	switch r.Platform {
 	case PlatformCode:
@@ -349,8 +365,9 @@ func (r *MemberRecord) Clone() MemberRecord {
 		ChatId:   r.ChatId,
 		MemberId: r.MemberId,
 
-		Platform:   r.Platform,
-		PlatformId: r.PlatformId,
+		Platform:     r.Platform,
+		PlatformId:   r.PlatformId,
+		OwnerAccount: r.OwnerAccount,
 
 		DeliveryPointer: deliveryPointerCopy,
 		ReadPointer:     readPointerCopy,
@@ -370,6 +387,7 @@ func (r *MemberRecord) CopyTo(dst *MemberRecord) {
 
 	dst.Platform = r.Platform
 	dst.PlatformId = r.PlatformId
+	dst.OwnerAccount = r.OwnerAccount
 
 	if r.DeliveryPointer != nil {
 		cloned := r.DeliveryPointer.Clone()

pkg/code/localization/keys.go

@@ -43,6 +43,7 @@ const (
 	ChatTitleKinPurchases     = "title.chat.kinPurchases"
 	ChatTitlePayments         = "title.chat.payments"
 	ChatTitleTips             = "title.chat.tips"
+	ChatTitleTwoWay           = "title.chat.twoWay"
 
 	// Message Bodies
 

pkg/code/push/notifications.go

@@ -9,6 +9,7 @@ import (
 	"google.golang.org/protobuf/proto"
 
 	chatpb "github.com/code-payments/code-protobuf-api/generated/go/chat/v1"
+	chatv2pb "github.com/code-payments/code-protobuf-api/generated/go/chat/v2"
 	commonpb "github.com/code-payments/code-protobuf-api/generated/go/common/v1"
 
 	chat_util "github.com/code-payments/code-server/pkg/code/chat"
@@ -412,3 +413,147 @@ func SendChatMessagePushNotification(
 	}
 	return nil
 }
+
+func SendChatMessagePushNotificationV2(
+	ctx context.Context,
+	data code_data.Provider,
+	pusher push_lib.Provider,
+	chatTitle string,
+	owner *common.Account,
+	chatMessage *chatv2pb.ChatMessage,
+) error {
+	log := logrus.StandardLogger().WithFields(logrus.Fields{
+		"method": "SendChatMessagePushNotificationV2",
+		"owner":  owner.PublicKey().ToBase58(),
+		"chat":   chatTitle,
+	})
+
+	// Best-effort try to update the badge count before pushing message content
+	//
+	// Note: Only chat messages generate badge counts
+	err := UpdateBadgeCount(ctx, data, pusher, owner)
+	if err != nil {
+		log.WithError(err).Warn("failure updating badge count on device")
+	}
+
+	locale, err := data.GetUserLocale(ctx, owner.PublicKey().ToBase58())
+	if err != nil {
+		log.WithError(err).Warn("failure getting user locale")
+		return err
+	}
+
+	var localizedPushTitle string
+
+	chatProperties, ok := chat_util.InternalChatProperties[chatTitle]
+	if ok {
+		localized, err := localization.Localize(locale, chatProperties.TitleLocalizationKey)
+		if err != nil {
+			return nil
+		}
+		localizedPushTitle = localized
+	} else {
+		domainDisplayName, err := thirdparty.GetDomainDisplayName(chatTitle)
+		if err == nil {
+			localizedPushTitle = domainDisplayName
+		} else {
+			return nil
+		}
+	}
+
+	var anyErrorPushingContent bool
+	for _, content := range chatMessage.Content {
+		var contentToPush *chatv2pb.Content
+		switch typedContent := content.Type.(type) {
+		case *chatv2pb.Content_Localized:
+			localizedPushBody, err := localization.Localize(locale, typedContent.Localized.KeyOrText)
+			if err != nil {
+				continue
+			}
+
+			contentToPush = &chatv2pb.Content{
+				Type: &chatv2pb.Content_Localized{
+					Localized: &chatv2pb.LocalizedContent{
+						KeyOrText: localizedPushBody,
+					},
+				},
+			}
+		case *chatv2pb.Content_ExchangeData:
+			var currencyCode currency_lib.Code
+			var nativeAmount float64
+			if typedContent.ExchangeData.GetExact() != nil {
+				exchangeData := typedContent.ExchangeData.GetExact()
+				currencyCode = currency_lib.Code(exchangeData.Currency)
+				nativeAmount = exchangeData.NativeAmount
+			} else {
+				exchangeData := typedContent.ExchangeData.GetPartial()
+				currencyCode = currency_lib.Code(exchangeData.Currency)
+				nativeAmount = exchangeData.NativeAmount
+			}
+
+			localizedPushBody, err := localization.LocalizeFiatWithVerb(
+				locale,
+				chatpb.ExchangeDataContent_Verb(typedContent.ExchangeData.Verb),
+				currencyCode,
+				nativeAmount,
+				true,
+			)
+			if err != nil {
+				continue
+			}
+
+			contentToPush = &chatv2pb.Content{
+				Type: &chatv2pb.Content_Localized{
+					Localized: &chatv2pb.LocalizedContent{
+						KeyOrText: localizedPushBody,
+					},
+				},
+			}
+		case *chatv2pb.Content_NaclBox, *chatv2pb.Content_Text:
+			contentToPush = content
+		case *chatv2pb.Content_ThankYou:
+			contentToPush = &chatv2pb.Content{
+				Type: &chatv2pb.Content_Localized{
+					Localized: &chatv2pb.LocalizedContent{
+						// todo: localize this
+						KeyOrText: "🙏 They thanked you for their tip",
+					},
+				},
+			}
+		}
+
+		if contentToPush == nil {
+			continue
+		}
+
+		marshalledContent, err := proto.Marshal(contentToPush)
+		if err != nil {
+			log.WithError(err).Warn("failure marshalling chat content")
+			return err
+		}
+
+		kvs := map[string]string{
+			"chat_title":      localizedPushTitle,
+			"message_content": base64.StdEncoding.EncodeToString(marshalledContent),
+		}
+
+		err = sendMutableNotificationToOwner(
+			ctx,
+			data,
+			pusher,
+			owner,
+			chatMessageDataPush,
+			chatTitle,
+			kvs,
+		)
+		if err != nil {
+			anyErrorPushingContent = true
+			log.WithError(err).Warn("failure sending data push notification")
+		}
+	}
+
+	if anyErrorPushingContent {
+		return errors.New("at least one piece of content failed to push")
+	}
+
+	return nil
+}