Merge pull request #100 from firebase/hkj-topic-mgt

hiranya911 · web-flow · commit bc29211f6b71 · 2019-08-06T16:16:50.000-07:00
feat(fcm): Added the SubscribtToTopicAsync() and UnsubscribeFromTopicAsync() APIs
diff --git a/FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseMessagingTest.cs b/FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseMessagingTest.cs
@@ -125,7 +125,8 @@ public async Task SendMulticast()
         [Fact]
         public async Task SubscribeToTopic()
         {
-            var response = await FirebaseMessaging.DefaultInstance.SubscribeToTopicAsync("test-topic", new List<string> { "token1", "token2" });
+            var response = await FirebaseMessaging.DefaultInstance.SubscribeToTopicAsync(
+                new List<string> { "token1", "token2" }, "test-topic");
             Assert.NotNull(response);
             Assert.Equal(2, response.FailureCount);
             Assert.Equal("invalid-argument", response.Errors[0].Reason);
@@ -137,7 +138,8 @@ public async Task SubscribeToTopic()
         [Fact]
         public async Task UnsubscribeFromTopic()
         {
-            var response = await FirebaseMessaging.DefaultInstance.UnsubscribeFromTopicAsync("test-topic", new List<string> { "token1", "token2" });
+            var response = await FirebaseMessaging.DefaultInstance.UnsubscribeFromTopicAsync(
+                new List<string> { "token1", "token2" }, "test-topic");
             Assert.NotNull(response);
             Assert.Equal(2, response.FailureCount);
             Assert.Equal("invalid-argument", response.Errors[0].Reason);
diff --git a/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseMessagingSnippets.cs b/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseMessagingSnippets.cs
@@ -14,7 +14,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading.Tasks;
 using FirebaseAdmin.Messaging;
 
@@ -321,5 +320,47 @@ internal static Message CreateMultiPlatformsMessage()
             // [END multi_platforms_message]
             return message;
         }
+
+        internal static async Task SubscribeToTopicAsync(string topic)
+        {
+            // [START subscribe_to_topic]
+            // These registration tokens come from the client FCM SDKs.
+            var registrationTokens = new List<string>()
+            {
+                "YOUR_REGISTRATION_TOKEN_1",
+                // ...
+                "YOUR_REGISTRATION_TOKEN_n",
+            };
+
+            // Subscribe the devices corresponding to the registration tokens to the
+            // topic
+            var response = await FirebaseMessaging.DefaultInstance.SubscribeToTopicAsync(
+                registrationTokens, topic);
+            // See the TopicManagementResponse reference documentation
+            // for the contents of response.
+            Console.WriteLine($"{response.SuccessCount} tokens were subscribed successfully");
+            // [END subscribe_to_topic]
+        }
+
+        internal static async Task UnsubscribeFromTopicAsync(string topic)
+        {
+            // [START unsubscribe_from_topic]
+            // These registration tokens come from the client FCM SDKs.
+            var registrationTokens = new List<string>()
+            {
+                "YOUR_REGISTRATION_TOKEN_1",
+                // ...
+                "YOUR_REGISTRATION_TOKEN_n",
+            };
+
+            // Unsubscribe the devices corresponding to the registration tokens from the
+            // topic
+            var response = await FirebaseMessaging.DefaultInstance.UnsubscribeFromTopicAsync(
+                registrationTokens, topic);
+            // See the TopicManagementResponse reference documentation
+            // for the contents of response.
+            Console.WriteLine($"{response.SuccessCount} tokens were unsubscribed successfully");
+            // [END unsubscribe_from_topic]
+        }
     }
 }
diff --git a/FirebaseAdmin/FirebaseAdmin.Tests/Messaging/FirebaseMessagingTest.cs b/FirebaseAdmin/FirebaseAdmin.Tests/Messaging/FirebaseMessagingTest.cs
@@ -138,7 +138,7 @@ public async Task SubscribeWithClientFactory()
             Assert.NotNull(messaging);
             Assert.Same(messaging, FirebaseMessaging.GetMessaging(app));
 
-            var response = await messaging.SubscribeToTopicAsync("test-topic", new List<string> { "test-token" });
+            var response = await messaging.SubscribeToTopicAsync(new List<string> { "test-token" }, "test-topic");
             Assert.Equal(0, response.FailureCount);
             Assert.Equal(1, response.SuccessCount);
             app.Delete();
@@ -163,7 +163,7 @@ public async Task UnsubscribeWithClientFactory()
             Assert.NotNull(messaging);
             Assert.Same(messaging, FirebaseMessaging.GetMessaging(app));
 
-            var response = await messaging.UnsubscribeFromTopicAsync("test-topic", new List<string> { "test-token" });
+            var response = await messaging.UnsubscribeFromTopicAsync(new List<string> { "test-token" }, "test-topic");
             Assert.Equal(0, response.FailureCount);
             Assert.Equal(1, response.SuccessCount);
             app.Delete();
diff --git a/FirebaseAdmin/FirebaseAdmin.Tests/Messaging/InstanceIdClientTest.cs b/FirebaseAdmin/FirebaseAdmin.Tests/Messaging/InstanceIdClientTest.cs
@@ -41,7 +41,7 @@ public async Task SubscribeToTopicAsync()
 
             var client = new InstanceIdClient(factory, MockCredential);
 
-            var result = await client.SubscribeToTopicAsync("test-topic", new List<string> { "abc123" });
+            var result = await client.SubscribeToTopicAsync(new List<string> { "abc123" }, "test-topic");
 
             Assert.Equal(1, result.SuccessCount);
         }
@@ -57,7 +57,7 @@ public async Task UnsubscribeFromTopicAsync()
 
             var client = new InstanceIdClient(factory, MockCredential);
 
-            var result = await client.UnsubscribeFromTopicAsync("test-topic", new List<string> { "abc123" });
+            var result = await client.UnsubscribeFromTopicAsync(new List<string> { "abc123" }, "test-topic");
 
             Assert.Equal(1, result.SuccessCount);
         }
@@ -75,7 +75,7 @@ public async Task BadRequest()
             var client = new InstanceIdClient(factory, MockCredential);
 
             var exception = await Assert.ThrowsAsync<FirebaseMessagingException>(
-               () => client.SubscribeToTopicAsync("test-topic", new List<string> { "abc123" }));
+               () => client.SubscribeToTopicAsync(new List<string> { "abc123" }, "test-topic"));
 
             Assert.Equal(ErrorCode.InvalidArgument, exception.ErrorCode);
             Assert.Equal("Unexpected HTTP response with status: 400 (BadRequest)\nBadRequest", exception.Message);
@@ -97,7 +97,7 @@ public async Task Unauthorized()
             var client = new InstanceIdClient(factory, MockCredential);
 
             var exception = await Assert.ThrowsAsync<FirebaseMessagingException>(
-               () => client.SubscribeToTopicAsync("test-topic", new List<string> { "abc123" }));
+               () => client.SubscribeToTopicAsync(new List<string> { "abc123" }, "test-topic"));
 
             Assert.Equal(ErrorCode.Unauthenticated, exception.ErrorCode);
             Assert.Equal("Unexpected HTTP response with status: 401 (Unauthorized)\nUnauthorized", exception.Message);
@@ -119,7 +119,7 @@ public async Task Forbidden()
             var client = new InstanceIdClient(factory, MockCredential);
 
             var exception = await Assert.ThrowsAsync<FirebaseMessagingException>(
-               () => client.SubscribeToTopicAsync("test-topic", new List<string> { "abc123" }));
+               () => client.SubscribeToTopicAsync(new List<string> { "abc123" }, "test-topic"));
 
             Assert.Equal(ErrorCode.PermissionDenied, exception.ErrorCode);
             Assert.Equal("Unexpected HTTP response with status: 403 (Forbidden)\nForbidden", exception.Message);
@@ -141,7 +141,7 @@ public async Task NotFound()
             var client = new InstanceIdClient(factory, MockCredential);
 
             var exception = await Assert.ThrowsAsync<FirebaseMessagingException>(
-               () => client.SubscribeToTopicAsync("test-topic", new List<string> { "abc123" }));
+               () => client.SubscribeToTopicAsync(new List<string> { "abc123" }, "test-topic"));
 
             Assert.Equal(ErrorCode.NotFound, exception.ErrorCode);
             Assert.Equal("Unexpected HTTP response with status: 404 (NotFound)\nNotFound", exception.Message);
@@ -163,7 +163,7 @@ public async Task ServiceUnavailable()
             var client = new InstanceIdClient(factory, MockCredential);
 
             var exception = await Assert.ThrowsAsync<FirebaseMessagingException>(
-               () => client.SubscribeToTopicAsync("test-topic", new List<string> { "abc123" }));
+               () => client.SubscribeToTopicAsync(new List<string> { "abc123" }, "test-topic"));
 
             Assert.Equal(ErrorCode.Unavailable, exception.ErrorCode);
             Assert.Equal("Unexpected HTTP response with status: 503 (ServiceUnavailable)\nServiceUnavailable", exception.Message);
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/FirebaseMessaging.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/FirebaseMessaging.cs
@@ -315,23 +315,25 @@ public async Task<BatchResponse> SendMulticastAsync(
         /// <summary>
         /// Subscribes a list of registration tokens to a topic.
         /// </summary>
-        /// <param name="topic">The topic name to subscribe to. /topics/ will be prepended to the topic name provided if absent.</param>
         /// <param name="registrationTokens">A list of registration tokens to subscribe.</param>
+        /// <param name="topic">The topic name to subscribe to. /topics/ will be prepended to the topic name provided if absent.</param>
         /// <returns>A task that completes with a <see cref="TopicManagementResponse"/>, giving details about the topic subscription operations.</returns>
-        public async Task<TopicManagementResponse> SubscribeToTopicAsync(string topic, List<string> registrationTokens)
+        public async Task<TopicManagementResponse> SubscribeToTopicAsync(
+            IReadOnlyList<string> registrationTokens, string topic)
         {
-            return await this.instanceIdClient.SubscribeToTopicAsync(topic, registrationTokens);
+            return await this.instanceIdClient.SubscribeToTopicAsync(registrationTokens, topic);
         }
 
         /// <summary>
         /// Unsubscribes a list of registration tokens from a topic.
         /// </summary>
-        /// <param name="topic">The topic name to unsubscribe from. /topics/ will be prepended to the topic name provided if absent.</param>
         /// <param name="registrationTokens">A list of registration tokens to unsubscribe.</param>
+        /// <param name="topic">The topic name to unsubscribe from. /topics/ will be prepended to the topic name provided if absent.</param>
         /// <returns>A task that completes with a <see cref="TopicManagementResponse"/>, giving details about the topic unsubscription operations.</returns>
-        public async Task<TopicManagementResponse> UnsubscribeFromTopicAsync(string topic, List<string> registrationTokens)
+        public async Task<TopicManagementResponse> UnsubscribeFromTopicAsync(
+            IReadOnlyList<string> registrationTokens, string topic)
         {
-            return await this.instanceIdClient.UnsubscribeFromTopicAsync(topic, registrationTokens);
+            return await this.instanceIdClient.UnsubscribeFromTopicAsync(registrationTokens, topic);
         }
 
         /// <summary>
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/InstanceIdClient.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/InstanceIdClient.cs
@@ -14,7 +14,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Net.Http;
 using System.Threading.Tasks;
 using FirebaseAdmin.Util;
@@ -61,30 +60,30 @@ public InstanceIdClient(HttpClientFactory clientFactory, GoogleCredential creden
         /// <summary>
         /// Subscribes a list of registration tokens to a topic.
         /// </summary>
+        /// <param name="registrationTokens">A list of registration tokens to subscribe.</param>
         /// <param name="topic">The topic name to subscribe to. /topics/ will be prepended to the
         /// topic name provided if absent.</param>
-        /// <param name="registrationTokens">A list of registration tokens to subscribe.</param>
         /// <returns>A task that completes with a <see cref="TopicManagementResponse"/>, giving
         /// details about the topic subscription operations.</returns>
         public async Task<TopicManagementResponse> SubscribeToTopicAsync(
-            string topic, List<string> registrationTokens)
+            IReadOnlyList<string> registrationTokens, string topic)
         {
-            return await this.SendInstanceIdRequest(topic, registrationTokens, IidSubscriberPath)
+            return await this.SendInstanceIdRequest(registrationTokens, topic, IidSubscriberPath)
                 .ConfigureAwait(false);
         }
 
         /// <summary>
         /// Unsubscribes a list of registration tokens from a topic.
         /// </summary>
+        /// <param name="registrationTokens">A list of registration tokens to unsubscribe.</param>
         /// <param name="topic">The topic name to unsubscribe from. /topics/ will be prepended to
         /// the topic name provided if absent.</param>
-        /// <param name="registrationTokens">A list of registration tokens to unsubscribe.</param>
         /// <returns>A task that completes with a <see cref="TopicManagementResponse"/>, giving
         /// details about the topic unsubscription operations.</returns>
         public async Task<TopicManagementResponse> UnsubscribeFromTopicAsync(
-            string topic, List<string> registrationTokens)
+            IReadOnlyList<string> registrationTokens, string topic)
         {
-            return await this.SendInstanceIdRequest(topic, registrationTokens, IidUnsubscribePath)
+            return await this.SendInstanceIdRequest(registrationTokens, topic, IidUnsubscribePath)
                 .ConfigureAwait(false);
         }
 
@@ -97,7 +96,7 @@ public void Dispose()
         }
 
         private async Task<TopicManagementResponse> SendInstanceIdRequest(
-            string topic, List<string> registrationTokens, string path)
+            IReadOnlyList<string> registrationTokens, string topic, string path)
         {
             this.ValidateRegistrationTokenList(registrationTokens);
 
@@ -123,19 +122,20 @@ private async Task<TopicManagementResponse> SendInstanceIdRequest(
             return new TopicManagementResponse(response.Result);
         }
 
-        private void ValidateRegistrationTokenList(List<string> registrationTokens)
+        private void ValidateRegistrationTokenList(IReadOnlyList<string> registrationTokens)
         {
             if (registrationTokens == null)
             {
                 throw new ArgumentNullException("Registration token list must not be null");
             }
 
-            if (registrationTokens.Count() == 0)
+            var count = registrationTokens.Count;
+            if (count == 0)
             {
                 throw new ArgumentException("Registration token list must not be empty");
             }
 
-            if (registrationTokens.Count() > 1000)
+            if (count > 1000)
             {
                 throw new ArgumentException("Registration token list must not contain more than 1000 tokens");
             }
@@ -167,7 +167,7 @@ private class InstanceIdServiceRequest
             public string Topic { get; set; }
 
             [JsonProperty("registration_tokens")]
-            public List<string> RegistrationTokens { get; set; }
+            public IEnumerable<string> RegistrationTokens { get; set; }
         }
     }
 }
diff --git a/FirebaseAdmin/FirebaseAdmin/Messaging/InstanceIdServiceResponse.cs b/FirebaseAdmin/FirebaseAdmin/Messaging/InstanceIdServiceResponse.cs
@@ -6,7 +6,8 @@ namespace FirebaseAdmin.Messaging
 {
     /// <summary>
     /// Response from an operation that subscribes or unsubscribes registration tokens to a topic.
-    /// See <see cref="FirebaseMessaging.SubscribeToTopicAsync(string, List{string})"/> and <see cref="FirebaseMessaging.UnsubscribeFromTopicAsync(string, List{string})"/>.
+    /// See <see cref="FirebaseMessaging.SubscribeToTopicAsync(IReadOnlyList{string}, string)"/> and
+    /// <see cref="FirebaseMessaging.UnsubscribeFromTopicAsync(IReadOnlyList{string}, string)"/>.
     /// </summary>
     internal class InstanceIdServiceResponse
     {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`
`15`	`15`	`using System;`
`16`	`16`	`using System.Collections.Generic;`
`17`		`-using System.Linq;`
`18`	`17`	`using System.Net.Http;`
`19`	`18`	`using System.Threading.Tasks;`
`20`	`19`	`using FirebaseAdmin.Util;`
`@@ -61,30 +60,30 @@ public InstanceIdClient(HttpClientFactory clientFactory, GoogleCredential creden`
`61`	`60`	`/// <summary>`
`62`	`61`	`/// Subscribes a list of registration tokens to a topic.`
`63`	`62`	`/// </summary>`
	`63`	`+ /// <param name="registrationTokens">A list of registration tokens to subscribe.</param>`
`64`	`64`	`/// <param name="topic">The topic name to subscribe to. /topics/ will be prepended to the`
`65`	`65`	`/// topic name provided if absent.</param>`
`66`		`- /// <param name="registrationTokens">A list of registration tokens to subscribe.</param>`
`67`	`66`	`/// <returns>A task that completes with a <see cref="TopicManagementResponse"/>, giving`
`68`	`67`	`/// details about the topic subscription operations.</returns>`
`69`	`68`	`public async Task<TopicManagementResponse> SubscribeToTopicAsync(`
`70`		`- string topic, List<string> registrationTokens)`
	`69`	`+ IReadOnlyList<string> registrationTokens, string topic)`
`71`	`70`	`{`
`72`		`- return await this.SendInstanceIdRequest(topic, registrationTokens, IidSubscriberPath)`
	`71`	`+ return await this.SendInstanceIdRequest(registrationTokens, topic, IidSubscriberPath)`
`73`	`72`	`.ConfigureAwait(false);`
`74`	`73`	`}`
`75`	`74`
`76`	`75`	`/// <summary>`
`77`	`76`	`/// Unsubscribes a list of registration tokens from a topic.`
`78`	`77`	`/// </summary>`
	`78`	`+ /// <param name="registrationTokens">A list of registration tokens to unsubscribe.</param>`
`79`	`79`	`/// <param name="topic">The topic name to unsubscribe from. /topics/ will be prepended to`
`80`	`80`	`/// the topic name provided if absent.</param>`
`81`		`- /// <param name="registrationTokens">A list of registration tokens to unsubscribe.</param>`
`82`	`81`	`/// <returns>A task that completes with a <see cref="TopicManagementResponse"/>, giving`
`83`	`82`	`/// details about the topic unsubscription operations.</returns>`
`84`	`83`	`public async Task<TopicManagementResponse> UnsubscribeFromTopicAsync(`
`85`		`- string topic, List<string> registrationTokens)`
	`84`	`+ IReadOnlyList<string> registrationTokens, string topic)`
`86`	`85`	`{`
`87`		`- return await this.SendInstanceIdRequest(topic, registrationTokens, IidUnsubscribePath)`
	`86`	`+ return await this.SendInstanceIdRequest(registrationTokens, topic, IidUnsubscribePath)`
`88`	`87`	`.ConfigureAwait(false);`
`89`	`88`	`}`
`90`	`89`
`@@ -97,7 +96,7 @@ public void Dispose()`
`97`	`96`	`}`
`98`	`97`
`99`	`98`	`private async Task<TopicManagementResponse> SendInstanceIdRequest(`
`100`		`- string topic, List<string> registrationTokens, string path)`
	`99`	`+ IReadOnlyList<string> registrationTokens, string topic, string path)`
`101`	`100`	`{`
`102`	`101`	`this.ValidateRegistrationTokenList(registrationTokens);`
`103`	`102`
`@@ -123,19 +122,20 @@ private async Task<TopicManagementResponse> SendInstanceIdRequest(`
`123`	`122`	`return new TopicManagementResponse(response.Result);`
`124`	`123`	`}`
`125`	`124`
`126`		`- private void ValidateRegistrationTokenList(List<string> registrationTokens)`
	`125`	`+ private void ValidateRegistrationTokenList(IReadOnlyList<string> registrationTokens)`
`127`	`126`	`{`
`128`	`127`	`if (registrationTokens == null)`
`129`	`128`	`{`
`130`	`129`	`throw new ArgumentNullException("Registration token list must not be null");`
`131`	`130`	`}`
`132`	`131`
`133`		`- if (registrationTokens.Count() == 0)`
	`132`	`+ var count = registrationTokens.Count;`
	`133`	`+ if (count == 0)`
`134`	`134`	`{`
`135`	`135`	`throw new ArgumentException("Registration token list must not be empty");`
`136`	`136`	`}`
`137`	`137`
`138`		`- if (registrationTokens.Count() > 1000)`
	`138`	`+ if (count > 1000)`
`139`	`139`	`{`
`140`	`140`	`throw new ArgumentException("Registration token list must not contain more than 1000 tokens");`
`141`	`141`	`}`
`@@ -167,7 +167,7 @@ private class InstanceIdServiceRequest`
`167`	`167`	`public string Topic { get; set; }`
`168`	`168`
`169`	`169`	`[JsonProperty("registration_tokens")]`
`170`		`- public List<string> RegistrationTokens { get; set; }`
	`170`	`+ public IEnumerable<string> RegistrationTokens { get; set; }`
`171`	`171`	`}`
`172`	`172`	`}`
`173`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,8 @@ namespace FirebaseAdmin.Messaging`
`6`	`6`	`{`
`7`	`7`	`/// <summary>`
`8`	`8`	`/// Response from an operation that subscribes or unsubscribes registration tokens to a topic.`
`9`		`- /// See <see cref="FirebaseMessaging.SubscribeToTopicAsync(string, List{string})"/> and <see cref="FirebaseMessaging.UnsubscribeFromTopicAsync(string, List{string})"/>.`
	`9`	`+ /// See <see cref="FirebaseMessaging.SubscribeToTopicAsync(IReadOnlyList{string}, string)"/> and`
	`10`	`+ /// <see cref="FirebaseMessaging.UnsubscribeFromTopicAsync(IReadOnlyList{string}, string)"/>.`
`10`	`11`	`/// </summary>`
`11`	`12`	`internal class InstanceIdServiceResponse`
`12`	`13`	`{`