Merge pull request #78 from andrei-m-code/feature/fcm-http-v1

Firebase HTTP v1 API

Author: andrei-m-code

CorePush.Tester/CorePush.Tester.csproj

@@ -2,11 +2,15 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\CorePush\CorePush.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="FirebaseAdmin" Version="2.3.0" />
+  </ItemGroup>
+
 </Project>

CorePush.Tester/FirebaseNotification.cs

@@ -0,0 +1,19 @@
+namespace CorePush.Tester;
+
+public class FirebasePayload
+{
+    public FirebaseMessage Message { get; set; }
+}
+
+public class FirebaseMessage
+{
+    public string Token { get; set; }
+    public FirebaseNotification Notification { get; set; }
+    public object Data { get; set; }
+}
+
+public class FirebaseNotification
+{
+    public string Title { get; set; }
+    public string Body { get; set; }
+}

CorePush.Tester/Program.cs

@@ -1,8 +1,9 @@
 using System;
 using System.Net.Http;
 using System.Threading.Tasks;
+
 using CorePush.Apple;
-using CorePush.Google;
+using CorePush.Firebase;
 
 namespace CorePush.Tester
 {
@@ -15,21 +16,26 @@ class Program
         private const string apnP8PrivateKeyId = "TODO";
         private const string apnTeamId = "TODO";
         private const string apnDeviceToken = "TODO";
-        private const ApnServerType apnServerType = ApnServerType.Development;
+        private const ApnServerType apnServerType = ApnServerType.Production;
 
         #endregion
 
         #region FCM Sender Settings
+        
+        private const string googleProjectId = "TODO";
+        private const string fcmBearerToken = "TODO";
         private const string fcmReceiverToken = "TODO";
-        private const string fcmSenderId = "TODO";
-        private const string fcmServerKey = "TODO";
-
+        
         # endregion
 
-        private static readonly HttpClient http = new HttpClient();
+        private static readonly HttpClient http = new();
 
         static async Task Main()
         {
+            // var serviceAccountJsonFilepath ="path-to-your-service-account-json-file/yourproject-123456-e883841.json";
+            // await Utils.GenerateFirebaseJWTAsync(serviceAccountJsonFilepath);
+            // await Utils.SendNotificationViaFirebaseSDKAsync(serviceAccountJsonFilepath, fcmReceiverToken);
+
             //await SendApnNotificationAsync();
             //await SendFcmNotificationAsync();
 
@@ -60,16 +66,24 @@ private static async Task SendApnNotificationAsync()
 
         private static async Task SendFcmNotificationAsync()
         {
-            var settings = new FcmSettings
+            var settings = new FirebaseSettings
             {
-                SenderId = fcmSenderId,
-                ServerKey = fcmServerKey
+                GoogleProjectId = googleProjectId,
+                FcmBearerToken = fcmBearerToken
             };
 
-            var fcm = new FcmSender(settings, http);
-            var payload = new 
+            var fcm = new FirebaseSender(settings, http);
+            var payload = new FirebasePayload
             {
-                notification = new { body = "Hello World!" }
+                Message = new FirebaseMessage
+                {
+                    Token = fcmReceiverToken,
+                    Notification = new FirebaseNotification
+                    {
+                        Title = "Test",
+                        Body = "Test Body"
+                    }
+                }
             };
 
             var response = await fcm.SendAsync(payload);

CorePush.Tester/Utils.cs

@@ -0,0 +1,37 @@
+using System.Threading.Tasks;
+using FirebaseAdmin;
+using FirebaseAdmin.Messaging;
+using Google.Apis.Auth.OAuth2;
+
+namespace CorePush.Tester;
+
+public class Utils
+{
+    public static async Task SendNotificationViaFirebaseSDKAsync(string pathToJsonServiceAccountFile, string token)
+    {
+        var credential = GoogleCredential.FromFile(pathToJsonServiceAccountFile);
+        FirebaseApp.Create(new AppOptions {Credential = credential});
+
+        var message = new Message
+        {
+            Notification = new Notification
+            {
+                Title = "Hello!",
+                Body = "World!"
+            },
+            Token = token,
+        };
+        var messaging = FirebaseMessaging.DefaultInstance;
+        var result = await messaging.SendAsync(message);
+    }
+
+    public static async Task GenerateFirebaseJWTAsync(string pathToJsonServiceAccountFile)
+    {
+        var credential = GoogleCredential.FromFile(pathToJsonServiceAccountFile);
+        FirebaseApp.Create(new AppOptions {Credential = credential});
+
+        var jwt = await credential
+            .CreateScoped("https://www.googleapis.com/auth/firebase.messaging")
+            .UnderlyingCredential.GetAccessTokenForRequestAsync();
+    }
+}

CorePush/CorePush.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 
     <Title>Server Side library for sending ✅Web, ✅Android and ✅iOS Push Notifications</Title>
@@ -10,8 +10,8 @@
     <Summary>Server Side library for sending ✅Web, ✅Android and ✅iOS Push Notifications</Summary>
     <Authors>andrei-m-code</Authors>
 
-    <AssemblyVersion>4.0.0-beta01</AssemblyVersion>
-    <FileVersion>4.0.0-beta01</FileVersion>
+    <AssemblyVersion>4.0.0</AssemblyVersion>
+    <FileVersion>4.0.0</FileVersion>
     <Version>4.0.0-beta01</Version>
 
     <PackageProjectUrl>https://github.com/andrei-m-code/CorePush</PackageProjectUrl>
@@ -26,7 +26,7 @@
 
     <PackageReleaseNotes>
 v4.0.0
-- Use .NET 6.0 as a target framework
+- Use .NET 7.0 as a target framework
 - Use System.Text.Json as a default serializer
 
 v3.1.x 

CorePush/Firebase/FirebaseResponse.cs

@@ -0,0 +1,7 @@
+namespace CorePush.Firebase
+{
+    public class FirebaseResponse
+    {
+        public string Name { get; set; }
+    }
+}

CorePush/Google/FcmSender.cs renamed to CorePush/Firebase/FirebaseSender.cs

@@ -7,59 +7,58 @@
 using CorePush.Interfaces;
 using CorePush.Serialization;
 
-namespace CorePush.Google
+namespace CorePush.Firebase
 {
     /// <summary>
     /// Firebase message sender
     /// </summary>
-    public class FcmSender : IFcmSender
+    public class FirebaseSender : IFirebaseSender
     {
-        // TODO: Migrate to the new API: https://firebase.google.com/docs/cloud-messaging/send-message
-        private const string fcmUrl = "https://fcm.googleapis.com/fcm/send";
-        
-        private readonly FcmSettings settings;
+        private readonly FirebaseSettings settings;
         private readonly HttpClient http;
-        private readonly Serialization.IJsonSerializer serializer;
+        private readonly IJsonSerializer serializer;
 
-        public FcmSender(FcmSettings settings, HttpClient http) : this(settings, http, new DefaultJsonSerializer())
+        public FirebaseSender(FirebaseSettings settings, HttpClient http) : this(settings, http, new DefaultJsonSerializer())
         {
+            
         }
 
-        public FcmSender(FcmSettings settings, HttpClient http, IJsonSerializer serializer)
+        public FirebaseSender(FirebaseSettings settings, HttpClient http, IJsonSerializer serializer)
         {
-            this.settings = settings ?? throw new ArgumentNullException(nameof(settings));
             this.http = http ?? throw new ArgumentNullException(nameof(http));
             this.serializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
+            this.settings = settings ?? throw new ArgumentNullException(nameof(settings));
 
+            if (string.IsNullOrWhiteSpace(settings.GoogleProjectId) ||
+                string.IsNullOrWhiteSpace(settings.FcmBearerToken))
+            {
+                throw new ArgumentException("Some settings are not defined", nameof(settings));
+            }
+            
             if (http.BaseAddress == null)
             {
-                http.BaseAddress = new Uri(fcmUrl);    
+                var url = $"https://fcm.googleapis.com/v1/projects/{settings.GoogleProjectId}/messages:send";
+                http.BaseAddress = new Uri(url);
             }
         }
 
         /// <summary>
-        /// Send firebase notification.
+        /// Send firebase notification. Token must be present in order to send direct push notification.
         /// Please check out payload formats:
         /// https://firebase.google.com/docs/cloud-messaging/concept-options#notifications
-        /// The SendAsync method will add/replace "to" value with deviceId
+        /// https://firebase.google.com/docs/cloud-messaging/send-message
         /// </summary>
         /// <param name="payload">Notification payload that will be serialized using Newtonsoft.Json package</param>
         /// <param name="cancellationToken">Cancellation token</param>
         /// <exception cref="HttpRequestException">Throws exception when not successful</exception>
-        public async Task<FcmResponse> SendAsync(object payload, CancellationToken cancellationToken = default)
+        public async Task<FirebaseResponse> SendAsync(object payload, CancellationToken cancellationToken = default)
         {
             var json = serializer.Serialize(payload);
 
             using var message = new HttpRequestMessage();
 
             message.Method = HttpMethod.Post;
-            message.Headers.Add("Authorization", $"key = {settings.ServerKey}");
-
-            if (!string.IsNullOrEmpty(settings.SenderId))
-            {
-                message.Headers.Add("Sender", $"id = {settings.SenderId}");
-            }
-
+            message.Headers.Add("Authorization", $"Bearer {settings.FcmBearerToken}");
             message.Content = new StringContent(json, Encoding.UTF8, "application/json");
 
             using var response = await http.SendAsync(message, cancellationToken);
@@ -70,7 +69,7 @@ public async Task<FcmResponse> SendAsync(object payload, CancellationToken cance
                 throw new HttpRequestException("Firebase notification error: " + responseString);
             }
 
-            return serializer.Deserialize<FcmResponse>(responseString);
+            return serializer.Deserialize<FirebaseResponse>(responseString);
         }
     }
 }

CorePush/Firebase/FirebaseSettings.cs

@@ -0,0 +1,15 @@
+namespace CorePush.Firebase
+{
+    public class FirebaseSettings
+    {
+        /// <summary>
+        /// Google Project ID. E.g. your-project-123456
+        /// </summary>
+        public string GoogleProjectId { get; set; }
+
+        /// <summary>
+        /// FCM Service Account Bearer Token
+        /// </summary>
+        public string FcmBearerToken { get; set; }
+    }
+}