Added Additional WebpushNotification Fields (#165)

* Updating WebpushNotification type

* Added additional fields and tests

* Testing for action serialization

* Fixing a formatting error

* Supporting auto in the Direction field

Author: hiranya911

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 - [fixed] Fixing a regression introduced in 3.2.0, where `VerifyIDToken()`
   cannot be used in App Engine.
+- [added] `messaging.WebpushNotification` type now supports arbitrary key-value
+  pairs in its payload.
 
 # v3.2.0
 

messaging/messaging.go

@@ -227,11 +227,82 @@ type WebpushConfig struct {
 	Notification *WebpushNotification `json:"notification,omitempty"`
 }
 
+// WebpushNotificationAction represents an action that can be performed upon receiving a WebPush notification.
+type WebpushNotificationAction struct {
+	Action string `json:"action,omitempty"`
+	Title  string `json:"title,omitempty"`
+	Icon   string `json:"icon,omitempty"`
+}
+
 // WebpushNotification is a notification to send via WebPush protocol.
+//
+// See https://developer.mozilla.org/en-US/docs/Web/API/notification/Notification for additional
+// details.
 type WebpushNotification struct {
-	Title string `json:"title,omitempty"` // if specified, overrides the Title field of the Notification type
-	Body  string `json:"body,omitempty"`  // if specified, overrides the Body field of the Notification type
-	Icon  string `json:"icon,omitempty"`
+	Actions            []*WebpushNotificationAction
+	Title              string      `json:"title,omitempty"` // if specified, overrides the Title field of the Notification type
+	Body               string      `json:"body,omitempty"`  // if specified, overrides the Body field of the Notification type
+	Icon               string      `json:"icon,omitempty"`
+	Badge              string      `json:"badge,omitempty"`
+	Direction          string      `json:"dir,omitempty"` // one of 'ltr' or 'rtl'
+	Data               interface{} `json:"data,omitempty"`
+	Image              string      `json:"image,omitempty"`
+	Language           string      `json:"lang,omitempty"`
+	Renotify           bool        `json:"renotify,omitempty"`
+	RequireInteraction bool        `json:"requireInteraction,omitempty"`
+	Silent             bool        `json:"silent,omitempty"`
+	Tag                string      `json:"tag,omitempty"`
+	TimestampMillis    *int64      `json:"timestamp,omitempty"`
+	Vibrate            []int       `json:"vibrate,omitempty"`
+	CustomData         map[string]interface{}
+}
+
+// standardFields creates a map containing all the fields except the custom data.
+func (n *WebpushNotification) standardFields() map[string]interface{} {
+	m := make(map[string]interface{})
+	addNonEmpty := func(key, value string) {
+		if value != "" {
+			m[key] = value
+		}
+	}
+	addTrue := func(key string, value bool) {
+		if value {
+			m[key] = value
+		}
+	}
+	if len(n.Actions) > 0 {
+		m["actions"] = n.Actions
+	}
+	addNonEmpty("title", n.Title)
+	addNonEmpty("body", n.Body)
+	addNonEmpty("icon", n.Icon)
+	addNonEmpty("badge", n.Badge)
+	addNonEmpty("dir", n.Direction)
+	addNonEmpty("image", n.Image)
+	addNonEmpty("lang", n.Language)
+	addTrue("renotify", n.Renotify)
+	addTrue("requireInteraction", n.RequireInteraction)
+	addTrue("silent", n.Silent)
+	addNonEmpty("tag", n.Tag)
+	if n.Data != nil {
+		m["data"] = n.Data
+	}
+	if n.TimestampMillis != nil {
+		m["timestamp"] = *n.TimestampMillis
+	}
+	if len(n.Vibrate) > 0 {
+		m["vibrate"] = n.Vibrate
+	}
+	return m
+}
+
+// MarshalJSON marshals a WebpushNotification into JSON (for internal use only).
+func (n *WebpushNotification) MarshalJSON() ([]byte, error) {
+	m := n.standardFields()
+	for k, v := range n.CustomData {
+		m[k] = v
+	}
+	return json.Marshal(m)
 }
 
 // APNSConfig contains messaging options specific to the Apple Push Notification Service (APNS).

messaging/messaging_test.go

@@ -44,8 +44,9 @@ var (
 	ttl          = time.Duration(10) * time.Second
 	invalidTTL   = time.Duration(-10) * time.Second
 
-	badge     = 42
-	badgeZero = 0
+	badge           = 42
+	badgeZero       = 0
+	timestampMillis = int64(12345)
 )
 
 var validMessages = []struct {
@@ -199,18 +200,60 @@ var validMessages = []struct {
 					"k2": "v2",
 				},
 				Notification: &WebpushNotification{
-					Title: "t",
-					Body:  "b",
-					Icon:  "i",
+					Title: "title",
+					Body:  "body",
+					Icon:  "icon",
+					Actions: []*WebpushNotificationAction{
+						{
+							Action: "a1",
+							Title:  "a1-title",
+						},
+						{
+							Action: "a2",
+							Title:  "a2-title",
+							Icon:   "a2-icon",
+						},
+					},
+					Badge:              "badge",
+					Data:               "data",
+					Image:              "image",
+					Language:           "lang",
+					Renotify:           true,
+					RequireInteraction: true,
+					Silent:             true,
+					Tag:                "tag",
+					TimestampMillis:    &timestampMillis,
+					Vibrate:            []int{100, 200, 100},
+					CustomData:         map[string]interface{}{"k1": "v1", "k2": "v2"},
 				},
 			},
 			Topic: "test-topic",
 		},
 		want: map[string]interface{}{
 			"webpush": map[string]interface{}{
-				"headers":      map[string]interface{}{"h1": "v1", "h2": "v2"},
-				"data":         map[string]interface{}{"k1": "v1", "k2": "v2"},
-				"notification": map[string]interface{}{"title": "t", "body": "b", "icon": "i"},
+				"headers": map[string]interface{}{"h1": "v1", "h2": "v2"},
+				"data":    map[string]interface{}{"k1": "v1", "k2": "v2"},
+				"notification": map[string]interface{}{
+					"title": "title",
+					"body":  "body",
+					"icon":  "icon",
+					"actions": []interface{}{
+						map[string]interface{}{"action": "a1", "title": "a1-title"},
+						map[string]interface{}{"action": "a2", "title": "a2-title", "icon": "a2-icon"},
+					},
+					"badge":              "badge",
+					"data":               "data",
+					"image":              "image",
+					"lang":               "lang",
+					"renotify":           true,
+					"requireInteraction": true,
+					"silent":             true,
+					"tag":                "tag",
+					"timestamp":          float64(12345),
+					"vibrate":            []interface{}{float64(100), float64(200), float64(100)},
+					"k1":                 "v1",
+					"k2":                 "v2",
+				},
 			},
 			"topic": "test-topic",
 		},
@@ -525,6 +568,31 @@ var invalidMessages = []struct {
 		},
 		want: "locKey is required when specifying locArgs",
 	},
+	{
+		name: "InvalidWebpushNotificationDirection",
+		req: &Message{
+			Webpush: &WebpushConfig{
+				Notification: &WebpushNotification{
+					Direction: "invalid",
+				},
+			},
+			Topic: "topic",
+		},
+		want: "direction must be 'ltr', 'rtl' or 'auto'",
+	},
+	{
+		name: "WebpushNotificationMultipleFieldSpecifications",
+		req: &Message{
+			Webpush: &WebpushConfig{
+				Notification: &WebpushNotification{
+					Direction:  "ltr",
+					CustomData: map[string]interface{}{"dir": "rtl"},
+				},
+			},
+			Topic: "topic",
+		},
+		want: `multiple specifications for the key "dir"`,
+	},
 }
 
 var invalidTopicMgtArgs = []struct {

messaging/messaging_utils.go

@@ -48,6 +48,11 @@ func validateMessage(message *Message) error {
 		return err
 	}
 
+	// validate WebpushConfig
+	if err := validateWebpushConfig(message.Webpush); err != nil {
+		return err
+	}
+
 	// validate APNSConfig
 	return validateAPNSConfig(message.APNS)
 }
@@ -126,6 +131,23 @@ func validateApsAlert(alert *ApsAlert) error {
 	return nil
 }
 
+func validateWebpushConfig(webpush *WebpushConfig) error {
+	if webpush == nil || webpush.Notification == nil {
+		return nil
+	}
+	dir := webpush.Notification.Direction
+	if dir != "" && dir != "ltr" && dir != "rtl" && dir != "auto" {
+		return fmt.Errorf("direction must be 'ltr', 'rtl' or 'auto'")
+	}
+	m := webpush.Notification.standardFields()
+	for k := range webpush.Notification.CustomData {
+		if _, contains := m[k]; contains {
+			return fmt.Errorf("multiple specifications for the key %q", k)
+		}
+	}
+	return nil
+}
+
 func countNonEmpty(strings ...string) int {
 	count := 0
 	for _, s := range strings {