Merge pull request #247494 from sethmanheim/docs-editor/notification-hubs-firebase-dep-1691424151

JamesJBarnett · web-flow · commit b03d544f81fa · 2023-08-14T12:36:55.000-07:00
Notification Hubs: add FCM to GCM migration procedure
diff --git a/articles/notification-hubs/android-sdk.md b/articles/notification-hubs/android-sdk.md
@@ -1,5 +1,4 @@
 ---
-
 title: Send push notifications to Android using Azure Notification Hubs and Firebase SDK version 1.0.0-preview1
 description: In this tutorial, you learn how to use Azure Notification Hubs and Google Firebase Cloud Messaging to send push notifications to Android devices (version 1.0.0-preview1).
 author: sethmanheim
@@ -16,7 +15,8 @@ ms.custom: devx-track-csharp
 
 This tutorial shows how to use Azure Notification Hubs and the updated version of the Firebase Cloud Messaging (FCM) SDK (version 1.0.0-preview1) to send push notifications to an Android application. In this tutorial, you create a blank Android app that receives push notifications using Firebase Cloud Messaging (FCM).
 
-[!INCLUDE [notification-hubs-firebase-deprecation](../../includes/notification-hubs-firebase-deprecation.md)]
+> [!NOTE]
+> For information about Firebase Cloud Messaging deprecation and migration steps, see [Google Firebase Cloud Messaging migration](notification-hubs-gcm-to-fcm.md).
 
 You can download the completed code for this tutorial from [GitHub](https://github.com/Azure/azure-notificationhubs-android/tree/v1-preview/notification-hubs-test-app-refresh).
 
@@ -304,3 +304,4 @@ The following is a list of some other tutorials for sending notifications:
 - Azure Notification Hubs Java SDK: See [How to use Notification Hubs from Java](notification-hubs-java-push-notification-tutorial.md) for sending notifications from Java. This has been tested in Eclipse for Android Development.
 
 - PHP: [How to use Notification Hubs from PHP](notification-hubs-php-push-notification-tutorial.md).
+
diff --git a/articles/notification-hubs/configure-google-firebase-cloud-messaging.md b/articles/notification-hubs/configure-google-firebase-cloud-messaging.md
@@ -18,7 +18,8 @@ ms.lastreviewed: 03/25/2019
 
 This article shows you how to configure Google Firebase Cloud Messaging (FCM) settings for an Azure notification hub using the Azure portal.
 
-[!INCLUDE [notification-hubs-firebase-deprecation](../../includes/notification-hubs-firebase-deprecation.md)]  
+> [!NOTE]
+> For information about Firebase Cloud Messaging deprecation and migration steps, see [Google Firebase Cloud Messaging migration](notification-hubs-gcm-to-fcm.md).
 
 ## Prerequisites
 
@@ -37,3 +38,4 @@ The following procedure describes the steps to configure Google Firebase Cloud M
 ## Next steps
 
 For a tutorial with step-by-step instructions for sending notifications to Android devices by using Azure Notification Hubs and Google Firebase Cloud Messaging, see [Send push notifications to Android devices by using Notification Hubs and Google FCM](notification-hubs-android-push-notification-google-fcm-get-started.md).
+
diff --git a/articles/notification-hubs/configure-notification-hub-portal-pns-settings.md b/articles/notification-hubs/configure-notification-hub-portal-pns-settings.md
@@ -20,7 +20,8 @@ Azure Notification Hubs provides a push engine that's easy to use and that scale
 
 In this quickstart, you'll use the platform notification system (PNS) settings in Notification Hubs to set up push notifications on multiple platforms. The quickstart shows you the steps to take in the Azure portal. [Google Firebase Cloud Messaging](?tabs=azure-cli#google-firebase-cloud-messaging-fcm) includes instructions for using the Azure CLI.
 
-[!INCLUDE [notification-hubs-firebase-deprecation](../../includes/notification-hubs-firebase-deprecation.md)]
+> [!NOTE]
+> For information about Firebase Cloud Messaging deprecation and migration steps, see [Google Firebase Cloud Messaging migration](notification-hubs-gcm-to-fcm.md).
 
 If you haven't already created a notification hub, create one now. For more information, see [Create an Azure notification hub in the Azure portal](create-notification-hub-portal.md) or [Create an Azure notification hub using the Azure CLI](create-notification-hub-azure-cli.md).
 
@@ -168,3 +169,4 @@ To learn more about how to push notifications to various platforms, see these tu
 * [Send notifications to a UWP app running on a Windows device](notification-hubs-windows-store-dotnet-get-started-wns-push-notification.md)
 * [Send notifications to a Windows Phone 8 app by using MPNS](notification-hubs-windows-mobile-push-notifications-mpns.md)
 * [Send notifications by using Notification Hubs and Baidu cloud push](notification-hubs-baidu-china-android-notifications-get-started.md)
+
diff --git a/articles/notification-hubs/notification-hubs-gcm-to-fcm.md b/articles/notification-hubs/notification-hubs-gcm-to-fcm.md
@@ -21,42 +21,4 @@ ms.lastreviewed: 04/10/2019
 
 [!INCLUDE [notification-hubs-firebase-deprecation](../../includes/notification-hubs-firebase-deprecation.md)]
 
-## Current state
 
-When Google announced its migration from Google Cloud Messaging (GCM) to Firebase Cloud Messaging (FCM), push services like ours had to adjust how we sent notifications to Android devices to accommodate the change.
-
-We updated our service backend, then published updates to our API and SDKs as needed. With our implementation, we made the decision to maintain compatibility with existing GCM notification schemas to minimize customer impact. This means that we currently send notifications to Android devices using FCM in FCM Legacy Mode. Ultimately, we want to add true support for FCM, including the new features and payload format. That is a longer-term change and the current migration is focused on maintaining compatibility with existing applications and SDKs. You can use either the GCM or FCM SDKs in your app (along with our SDK) and we make sure the notification is sent correctly.
-
-Some customers recently received an email from Google warning about apps using a GCM endpoint for notifications. This was just a warning, and nothing is broken – your app's Android notifications are still sent to Google for processing and Google still processes them. Some customers who specified the GCM endpoint explicitly in their service configuration were still using the deprecated endpoint. We had already identified this gap and were working on fixing the issue when Google sent the email.
-
-We replaced that deprecated endpoint and the fix is deployed.
-
-## Going forward
-
-Google's FCM FAQ says you don't have to do anything. In the [FCM FAQ](https://developers.google.com/cloud-messaging/faq), Google said "client SDKs and GCM tokens will continue to work indefinitely. However, you won't be able to target the latest version of Google Play Services in your Android app unless you migrate to FCM."
-
-If your app uses the GCM library, go ahead and follow Google's instructions to upgrade to the FCM library in your app. Our SDK is compatible with either, so you won't have to update anything in your app on our side (as long as you're up to date with our SDK version).
-
-## Questions and answers
-
-Here's some answers to common questions we've heard from customers:
-
-**Q:** What do I need to do to be compatible by the cutoff date (Google's current cutoff date is May 29th and may change)?
-
-**A:** Nothing. We will maintain compatibility with existing GCM notification schema. Your GCM key will continue to work as normal as will any GCM SDKs and libraries used by your application.
-
-If/when you decide to upgrade to the FCM SDKs and libraries to take advantage of new features, your GCM key will still work. You may switch to using an FCM key if you wish, but ensure you are adding Firebase to your existing GCM project when creating the new Firebase project. This will guarantee backward compatibility with your customers that are running older versions of the app that still use GCM SDKs and libraries.
-
-If you are creating a new FCM project and not attaching to the existing GCM project, once you update Notification Hubs with the new FCM secret you will lose the ability to push notifications to your current app installations, since the new FCM key has no link to the old GCM project.
-
-**Q:** Why am I getting this email about old GCM endpoints being used? What do I have to do?
-
-**A:** Nothing. We have been migrating to the new endpoints and will be finished soon, so no change is necessary. Nothing is broken, our one missed endpoint simply caused warning messages from Google.
-
-**Q:** How can I transition to the new FCM SDKs and libraries without breaking existing users?
-
-A: Upgrade at any time. Google has not yet announced any deprecation of existing GCM SDKs and libraries. To ensure you don't break push notifications to your existing users, make sure when you create the new Firebase project you are associating with your existing GCM project. This will ensure new Firebase secrets will work for users running the older versions of your app with GCM SDKs and libraries, as well as new users of your app with FCM SDKs and libraries.
-
-**Q:** When can I use new FCM features and schemas for my notifications?
-
-**A:** Once we publish an update to our API and SDKs, stay tuned – we expect to have something for you in the coming months.
diff --git a/articles/notification-hubs/notification-hubs-push-notification-fixer.md b/articles/notification-hubs/notification-hubs-push-notification-fixer.md
@@ -61,7 +61,8 @@ If you inadvertently upload different types of certificates to the same hub, you
 
 ### FCM configuration
 
-[!INCLUDE [notification-hubs-firebase-deprecation](../../includes/notification-hubs-firebase-deprecation.md)]
+> [!NOTE]
+> For information about Firebase Cloud Messaging deprecation and migration steps, see [Google Firebase Cloud Messaging migration](notification-hubs-gcm-to-fcm.md).
 
 1. Ensure that the *server key* you obtained from Firebase matches the server key you registered in the Azure portal.
 
diff --git a/articles/notification-hubs/notification-hubs-push-notification-overview.md b/articles/notification-hubs/notification-hubs-push-notification-overview.md
@@ -30,7 +30,8 @@ Azure Notification Hubs provide an easy-to-use and scaled-out push engine that e
 - Notify users of enterprise events such as new messages and work items.
 - Send codes for multi-factor authentication.
 
-[!INCLUDE [notification-hubs-firebase-deprecation](../../includes/notification-hubs-firebase-deprecation.md)]
+> [!NOTE]
+> For information about Firebase Cloud Messaging deprecation and migration steps, see [Google Firebase Cloud Messaging migration](notification-hubs-gcm-to-fcm.md).
 
 ## What are push notifications?
 
@@ -99,10 +100,6 @@ Notification Hubs is your ready-to-use push engine with the following advantages
   - Scheduled push: You can schedule notifications to be sent anytime.
   - Direct push: You can skip registering devices with the Notification Hubs service and directly batch push to a list of device handles.
   - Personalized push: Device push variables help you send device-specific personalized push notifications with customized key-value pairs.
-- **Rich telemetry**
-  - General push, device, error, and operation telemetry are available both in the Azure portal and programmatically.
-  - Per-message telemetry tracks each push from your initial request call to the Notification Hubs service successfully sending the pushes.
-  - Platform Notification System feedback communicates all feedback from PNSes to assist in debugging.
 - **Scalability**
   - Send fast messages to millions of devices without re-architecting or device sharding.
 - **Security**
@@ -113,20 +110,36 @@ Notification Hubs is your ready-to-use push engine with the following advantages
 Get started with creating and using a notification hub by following the [Tutorial: Push notifications to mobile applications](notification-hubs-android-push-notification-google-fcm-get-started.md).
 
 [0]: ./media/notification-hubs-overview/registration-diagram.png
+
 [1]: ./media/notification-hubs-overview/notification-hub-diagram.png
 
 [How customers are using Notification Hubs]: https://azure.microsoft.com/services/notification-hubs
+
 [Notification Hubs tutorials and guides]: ./index.yml
+
 [iOS]: ./notification-hubs-push-notification-fixer.md
+
 [Android]: ./notification-hubs-android-push-notification-google-gcm-get-started.md
+
 [Windows Universal]: ./notification-hubs-windows-store-dotnet-get-started-wns-push-notification.md
+
 [Windows Phone]: ./notification-hubs-windows-mobile-push-notifications-mpns.md
+
 [Kindle]: ./notification-hubs-android-push-notification-google-fcm-get-started.md
+
 [Xamarin.iOS]: ./xamarin-notification-hubs-ios-push-notification-apns-get-started.md
+
 [Xamarin.Android]: ./xamarin-notification-hubs-push-notifications-android-gcm.md
+
 [Microsoft.WindowsAzure.Messaging.NotificationHub]: /previous-versions/azure/reference/dn339221(v=azure.100)
+
 [Microsoft.ServiceBus.Notifications]: /previous-versions/azure/
+
 [App Service Mobile Apps]: /previous-versions/azure/app-service-mobile/app-service-mobile-value-prop
+
 [templates]: notification-hubs-templates-cross-platform-push-messages.md
+
 [Azure portal]: https://portal.azure.com
-[tags]: (https://msdn.microsoft.com/library/azure/dn530749.aspx)
+
+[tags]: (https://msdn.microsoft.com/library/azure/dn530749.aspx)
+
diff --git a/includes/notification-hubs-firebase-deprecation.md b/includes/notification-hubs-firebase-deprecation.md
@@ -1,5 +1,5 @@
 ---
- title: include file
+title: include file
  description: include file
  services: notification-hubs
  author: sethmanheim
@@ -9,5 +9,19 @@
  ms.author: sethm
  ms.custom: include file
 ---
+
 > [!IMPORTANT]
-> Firebase Cloud Messaging (FCM) is a service that, among other things, facilitates developers sending push notifications to Google Play-supported Android devices. Azure Notification Hubs currently communicates with FCM using the legacy HTTP protocol. FCM v1 is an updated API that offers more features and capabilities. Google announced that they are deprecating FCM legacy HTTP and will stop supporting it on June 20, 2024. Therefore, developers who use Azure Notification Hubs to communicate with Google Play-supported Android devices today, will need to migrate their applications and notification payloads to the newer format. Azure Notification Hubs will continue to support FCM legacy HTTP until Google stops accepting requests. Once the new FCM integration is complete, Azure Notification Hubs will announce when you can begin migrating. A migration plan with more details will be available by July 31st, 2023.
+> Firebase Cloud Messaging (FCM) is a service that, among other things, facilitates developers sending push notifications to Google Play-supported Android devices. Azure Notification Hubs currently communicates with FCM using the legacy HTTP protocol. FCM v1 is an updated API that offers more features and capabilities. Google announced that they are deprecating FCM legacy HTTP and will stop supporting it on June 20, 2024. Therefore, developers who use Azure Notification Hubs to communicate with Google Play-supported Android devices today, will need to migrate their applications and notification payloads to the newer format. Azure Notification Hubs will continue to support FCM legacy HTTP until Google stops accepting requests. Once the new FCM integration is complete, Azure Notification Hubs will announce when you can begin migrating. FOr more details, see the [migration steps](#migration-steps) in the next section.
+
+## Migration steps
+
+Firebase Cloud Messaging (FCM) legacy API will be deprecated by July 2024. You can begin migrating from the legacy HTTP protocol to FCM v1. You can start the migration process by Feb 1, 2024, and must be migrated by June 2024. To migrate from FCM legacy to FCM v1, follow these steps:
+
+1. Migrate credentials to FCM v1: enter your FCM v1 credentials to set up notifications. You can find the [instructions on how to do this here](/azure/notification-hubs/configure-notification-hub-portal-pns-settings?tabs=azure-portal#google-firebase-cloud-messaging-fcm).
+1. Update your client app to start registering as FCMv1 devices: once you’re ready to start supporting FCMv1 devices, update your client app so that any new devices will start registering as FCM v1 instead of the legacy. When existing FCM legacy registrations expire, they are re-registered as FCM v1. This ensures that notifications are sent to users appropriately, once the FCM legacy is deprecated.
+1. Delete the FCM legacy registrations: once the FCM v1 registrations have been created, delete the corresponding records from the FCM legacy. This prevents duplicate notifications from being sent to your users if you use both APIs. Duplicate notifications can occur and be sent to users if FCM legacy registrations are not deleted.
+1. Update the server app to send notifications to FCM v1: once you have completed the previous steps, you can start sending notifications using the new API.
+1. Stop sending notifications to FCM legacy: once you have removed all FCM legacy devices, stop sending notifications to FCM legacy. All notifications should be sent exclusively to FCM v1 at this point, and you should be fully migrated.
+
+If you have any questions or issues, please contact our support team.
+
