Implementing support for APNS content-mutable field (firebase#156)

hiranya911 · web-flow · commit 76346cbddfd5 · 2018-04-13T16:10:22.000-07:00
* Implementing support for APNS content-mutable field

* Updated annotations and docs

* Corrected mutable-content option name

* Renamed customFields to customData

* Deleted test Main
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Unreleased
 
+- [added] Added new `setMutableContent()`, `putCustomData()` and
+  `putAllCustomData()` methods to the `Aps.Builder` API.
 - [fixed] Improved error handling in FCM by mapping more server-side
   errors to client-side error codes.
 
diff --git a/src/main/java/com/google/firebase/messaging/ApnsConfig.java b/src/main/java/com/google/firebase/messaging/ApnsConfig.java
@@ -45,7 +45,7 @@ private ApnsConfig(Builder builder) {
     this.headers = builder.headers.isEmpty() ? null : ImmutableMap.copyOf(builder.headers);
     this.payload = ImmutableMap.<String, Object>builder()
         .putAll(builder.customData)
-        .put("aps", builder.aps)
+        .put("aps", builder.aps.getFields())
         .build();
   }
 
diff --git a/src/main/java/com/google/firebase/messaging/Aps.java b/src/main/java/com/google/firebase/messaging/Aps.java
@@ -18,46 +18,53 @@
 
 import static com.google.common.base.Preconditions.checkArgument;
 
-import com.google.api.client.util.Key;
 import com.google.common.base.Strings;
+import com.google.common.collect.ImmutableMap;
+import com.google.firebase.internal.NonNull;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Represents the <a href="https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html">
  * aps dictionary</a> that is part of every APNS message.
  */
 public class Aps {
 
-  @Key("alert")
-  private final Object alert;
-
-  @Key("badge")
-  private final Integer badge;
-
-  @Key("sound")
-  private final String sound;
-
-  @Key("content-available")
-  private final Integer contentAvailable;
-
-  @Key("category")
-  private final String category;
-
-  @Key("thread-id")
-  private final String threadId;
+  private final Map<String, Object> fields;
 
   private Aps(Builder builder) {
     checkArgument(Strings.isNullOrEmpty(builder.alertString) || (builder.alert == null),
         "Multiple alert specifications (string and ApsAlert) found.");
+    ImmutableMap.Builder<String, Object> fields = ImmutableMap.builder();
     if (builder.alert != null) {
-      this.alert = builder.alert;
-    } else {
-      this.alert = builder.alertString;
-    }
-    this.badge = builder.badge;
-    this.sound = builder.sound;
-    this.contentAvailable = builder.contentAvailable ? 1 : null;
-    this.category = builder.category;
-    this.threadId = builder.threadId;
+      fields.put("alert", builder.alert);
+    } else if (builder.alertString != null) {
+      fields.put("alert", builder.alertString);
+    }
+    if (builder.badge != null) {
+      fields.put("badge", builder.badge);
+    }
+    if (builder.sound != null) {
+      fields.put("sound", builder.sound);
+    }
+    if (builder.contentAvailable) {
+      fields.put("content-available", 1);
+    }
+    if (builder.mutableContent) {
+      fields.put("mutable-content", 1);
+    }
+    if (builder.category != null) {
+      fields.put("category", builder.category);
+    }
+    if (builder.threadId != null) {
+      fields.put("thread-id", builder.threadId);
+    }
+    fields.putAll(builder.customData);
+    this.fields = fields.build();
+  }
+
+  Map<String, Object> getFields() {
+    return this.fields;
   }
 
   /**
@@ -76,8 +83,10 @@ public static class Builder {
     private Integer badge;
     private String sound;
     private boolean contentAvailable;
+    private boolean mutableContent;
     private String category;
     private String threadId;
+    private final Map<String, Object> customData = new HashMap<>();
 
     private Builder() {}
 
@@ -137,6 +146,41 @@ public Builder setContentAvailable(boolean contentAvailable) {
       return this;
     }
 
+    /**
+     * Specifies whether to set the {@code mutable-content} property on the message, so the
+     * clients can modify the notification via app extensions.
+     *
+     * @param mutableContent True to make the content mutable via app extensions.
+     * @return This builder.
+     */
+    public Builder setMutableContent(boolean mutableContent) {
+      this.mutableContent = mutableContent;
+      return this;
+    }
+
+    /**
+     * Puts a custom key-value pair to the aps dictionary.
+     *
+     * @param key A non-null key.
+     * @param value A non-null, json-serializable value.
+     * @return This builder.
+     */
+    public Builder putCustomData(@NonNull String key, @NonNull Object value) {
+      this.customData.put(key, value);
+      return this;
+    }
+
+    /**
+     * Puts all the key-value pairs in the specified map to the aps dictionary.
+     *
+     * @param fields A non-null map. Map must not contain null keys or values.
+     * @return This builder.
+     */
+    public Builder putAllCustomData(@NonNull Map<String, Object> fields) {
+      this.customData.putAll(fields);
+      return this;
+    }
+
     /**
      * Sets the notification type.
      *
@@ -159,6 +203,13 @@ public Builder setThreadId(String threadId) {
       return this;
     }
 
+    /**
+     * Builds a new {@link Aps} instance from the fields set on this builder.
+     *
+     * @return A non-null {@link Aps}.
+     * @throws IllegalArgumentException If the alert is specified both as an object and a string.
+     *     Or if the same field is set both using a setter method, and as a custom field.
+     */
     public Aps build() {
       return new Aps(this);
     }
diff --git a/src/test/java/com/google/firebase/messaging/MessageTest.java b/src/test/java/com/google/firebase/messaging/MessageTest.java
@@ -36,7 +36,7 @@
 public class MessageTest {
 
   @Test(expected = IllegalArgumentException.class)
-  public void testMessageWithoutTarget() throws IOException {
+  public void testMessageWithoutTarget() {
     Message.builder().build();
   }
 
@@ -214,7 +214,7 @@ public void testAndroidMessageWithoutLocalization() throws IOException {
   }
 
   @Test
-  public void testInvalidAndroidConfig() throws IOException {
+  public void testInvalidAndroidConfig() {
     try {
       AndroidConfig.builder().setTtl(-1).build();
       fail("No error thrown for invalid ttl");
@@ -363,6 +363,7 @@ public void testApnsMessageWithPayloadAndAps() throws IOException {
                 .setBadge(42)
                 .setCategory("test-category")
                 .setContentAvailable(true)
+                .setMutableContent(true)
                 .setSound("test-sound")
                 .setThreadId("test-thread-id")
                 .build())
@@ -376,6 +377,7 @@ public void testApnsMessageWithPayloadAndAps() throws IOException {
             .put("badge", new BigDecimal(42))
             .put("category", "test-category")
             .put("content-available", new BigDecimal(1))
+            .put("mutable-content", new BigDecimal(1))
             .put("sound", "test-sound")
             .put("thread-id", "test-thread-id")
             .build());
@@ -404,6 +406,8 @@ public void testApnsMessageWithPayloadAndAps() throws IOException {
                 .setCategory("test-category")
                 .setSound("test-sound")
                 .setThreadId("test-thread-id")
+                .putCustomData("ck1", "cv1")
+                .putAllCustomData(ImmutableMap.<String, Object>of("ck2", "cv2", "ck3", 1))
                 .build())
             .build())
         .setTopic("test-topic")
@@ -424,6 +428,9 @@ public void testApnsMessageWithPayloadAndAps() throws IOException {
             .put("category", "test-category")
             .put("sound", "test-sound")
             .put("thread-id", "test-thread-id")
+            .put("ck1", "cv1")
+            .put("ck2", "cv2")
+            .put("ck3", new BigDecimal(1))
             .build());
     assertJsonEquals(
         ImmutableMap.of(
@@ -456,6 +463,15 @@ public void testInvalidApnsConfig() {
       // expected
     }
 
+    builder = Aps.builder().setMutableContent(true).putCustomData("mutable-content", 1);
+    try {
+      builder.build();
+      fail("No error thrown for invalid aps");
+    } catch (IllegalArgumentException expected) {
+      // expected
+    }
+
+
     List<ApsAlert.Builder> notificationBuilders = ImmutableList.of(
         ApsAlert.builder().addLocalizationArg("foo"),
         ApsAlert.builder().addTitleLocalizationArg("foo")

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ private ApnsConfig(Builder builder) {`
`45`	`45`	`this.headers = builder.headers.isEmpty() ? null : ImmutableMap.copyOf(builder.headers);`
`46`	`46`	`this.payload = ImmutableMap.<String, Object>builder()`
`47`	`47`	`.putAll(builder.customData)`
`48`		`- .put("aps", builder.aps)`
	`48`	`+ .put("aps", builder.aps.getFields())`
`49`	`49`	`.build();`
`50`	`50`	`}`
`51`	`51`