Push Notification via ASP.NET Core
Недавно запустили на роботі новий функціонал інбоксів. Якщо коротко, то це універсальний месенджер з підтримкою різних платформ та каналів що дозволяє вести комунікацію з кінцевими клієнтами в одному місці.
Для кращого UX треба було добавити пуш нотифікації. На цей момент у нас уже були підключені веб сокети по яким ганяли різні дані, в тому числі і про нові повідомлення. Але такі сповіщення можна відобразити тільки коли відкрита сторінка в браузері.
Тому вирішили добавити підтримку браузерних пушів. Саме про те як їх підключити та використовувати в звʼязці з ASP.NET Core я хочу розказати.
Як це працює?
Процес роботи технології пуш нотифікацій у браузері досить простий. Спочатку ми запрошуємо права на отримання сповіщень у користувача. Браузер покаже йому модалку із запитанням «Do you want to receive push notifications?».
Після того як він підтвердить вибір нам потрібно підписати користувача на отримання нотифікацій використовуючи Push API браузера. Під капотом браузер робить запит на спеціальний push service та повертає нам обʼєкт PushSubscription в якому є вся необхідна інформація для відправки пушів:
{
"endpoint": "https://fcm.googleapis.com/fcm/send/c1KrmpTuRm…",
"expirationTime": null,
"keys": {
"p256dh": "BGyyVt9FFV…",
"auth": "R9sidzkcdf…"
}
}Далі ми берем цей обʼєкт і відправляємо на наш сервер, де кладемо його у базу даних або зберігаємо іншим способом щоб використовувати його в подальшому.
Якщо придивитися до структури PushSubscription, можна помітити адрес ендпоінта. Суть в тому, що наш сервер не відправляє сповіщення напряму в браузер. Для цього використовується спеціальний push service, який у кожного розробника браузера свій.
Нам повезло, що браузери змогли домовитись і стандартизувати протокол push сервіса, тому нам можна не паритись за формат даних для кожного вендора. Усі вони приймають один формат даних, який містить:
- Контент повідомлення
- Кому його відправити
- Як саме його відправити, з яким пріорітетом, в який топік та з яким таймаутом.
Кожне повідомлення шифрується за допомогою ключів, що були створені при генерації підписки. Крім цього, потрібно також підписувати повідомлення за допомогою приватного ключа, щоб підтвердити, що це саме наш сервер відправляє повідомлення. Виглядає це ось так:
- Генеруємо пару публічного та приватного ключа, які ще називають VAPID ключами. Цей крок треба зробити всього один раз. В інтернеті купа онлайн сервісів де можна згенерувати ключі.
- Публічний ключ використовуємо при створенні підписки на стороні браузера. Дальше цей ключ асоціюється з ендпоінтом для конкретної підписки.
- Приватний ключ використовуємо для підписки повідомлення на стороні нашого сервера.
- Дальше за допомогою публічного ключа ми можемо перевірити що повідомлення було відправлено саме нашим сервером а не кимось іншим.
Структура VAPID ключа:
{
"sub": "mailto:[email protected]",
"public_key": "sdgdklsnvi2f0m-12dgsg...",
"private_key": "1fn0ASFfnaksf..."
}Але, як в тому жарті, є нюанс. Subject в VAPID ключі є опціональним і його не обовʼязково відправляти разом з запитом на push сервіс. Проте Сафарі так не вважає, ще й вимагає специфічний формат. Коли я генерував ключі, то мав ось такий sub mailto: <[email protected]>.
В хромі все працювало чудово, а сафарі кидав помилку, що запит невалідний. Виявилось, що вони не підтримують пробіли та кутові лапки, замінив sub на mailto:[email protected] і все запрацювало.
Реалізація бекенду
Якщо у вас macOS, то ви не зможете локально протестувати сповіщення. Проблема в тому що .NET не підтримує шифрування AesGcm на маках, тому при відправці вилетить ексепшен. Поки я не знайшов як це обійти.
На стороні сервера будемо використовувати бібліотеку Lib.Net.Http.WebPush яка під капотом буде шифрувати, підписувати та відправляти наші сповіщення. Для цього вона дає декілька базових модельок та один клас для відправки пушів.
Почнемо з реалізації створення та видалення підписок та зберігання їх в БД. Для цього добавимо клас ApplicationPushSubscription, який описує структуру таблиці та підключимо його в Entity Framework контекст:
public class ApplicationPushSubscription
{
[Key]
public string P256Dh { get; set; }
public string Endpoint { get; set; }
public string Auth { get; set; }
public Guid UserId { get; set } // Id користувача в нашій системі
}
public class DatabaseContext : DbContext
{
public DbSet<ApplicationPushSubscription> PushSubscriptions { get; set; }
}Тепер створимо клас PushNotificationsService в який добавимо методи для створення та видалення підписок. Метод створення буде приймати екземпляр класу PushSubscription з бібліотеки Lib.Net.Http.WebPush.
Його можна було б змінити на свій клас, щоб логіка бібліотеки не просочувалась в інші модулі але задля простоти залишимо так як є.
public class PushNotificationsService
{
private readonly DatabaseContext _context;
private readonly PushServiceClient _pushClient;
public PushNotificationsService (DatabaseContext context, PushServiceClient pushClient)
{
_context = context;
_pushClient = pushClient;
}
public async Task CreateSubscription(Guid userId, PushSubscription pushSubscription)
{
var subscription = new ApplicationPushSubscription()
{
UserId = userId,
AccountId = currentUser.AccountId,
Endpoint = subscription.Endpoint,
P256Dh = subscription.GetKey(PushEncryptionKeyName.P256DH),
Auth = subscription.GetKey(PushEncryptionKeyName.Auth)
};
if (await _context.PushSubscriptions.AnyAsync(x => x.P256Dh == subscription.P256Dh))
{
return;
}
_context.PushSubscriptions.Add(subscription);
try
{
await _context.SaveChangesAsync();
}
catch (DbUpdateException)
{
var alreadyExists = await _context.PushSubscriptions.AnyAsync(x => x.P256Dh == subscription.P256Dh);
if (!alreadyExists)
{
throw;
}
}
}
public async Task DeleteSubscription(Guid userId, string endpoint)
{
var subscription = await _context.PushSubscriptions
.FirstOrDefaultAsync(x => x.UserId == userId && x.Endpoint == endpoint);
if (subscription == null)
{
return;
}
_context.PushSubscriptions.Remove(subscription);
await _context.SaveChangesAsync();
}
}Реалізовуємо метод для відправки сповіщень нашим користувачам. Він буде приймати Id користувача якому ми відправляємо повідомлення і модель з даними.
Нам залишається отримати підписку з БД, серіалізувати повідомлення в JSON і скормити це все бібліотеці.
public async Task SendNotificationAsync(Guid userId, PushNotificationModel model)
{
try
{
var applicationPushSubscriptions = await _context.PushNotifications
.Where(x => x.UserId == userId)
.ToList();
foreach(var applicationPushSubscription in applicationPushSubscriptions)
{
var pushSubscription = new PushSubscription();
pushSubscription.Endpoint = applicationPushSubscription.Endpoint;
pushSubscription.SetKey(PushEncryptionKeyName.P256DH, applicationPushSubscription.P256Dh);
pushSubscription.SetKey(PushEncryptionKeyName.Auth, applicationPushSubscription.Auth);
var settings = new JsonSerializerSettings { ContractResolver = new CamelCasePropertyNamesContractResolver() };
var payload = JsonConvert.SerializeObject(model, settings);
var pushMessage = new PushMessage(payload);
await _pushClient.RequestPushMessageDeliveryAsync(
pushSubscription,
pushMessage,
_pushClient.DefaultAuthentication,
VapidAuthenticationScheme.WebPush);
}
}
catch (PushServiceClientException exception)
{
if (exception.StatusCode is HttpStatusCode.NotFound or HttpStatusCode.Gone)
{
_context.PushSubscriptions.Remove(subscription);
await _context.SaveChangesAsync();
}
else
{
// Re-Throw exception or log
}
}
catch (Exception exception)
{
// Re-Throw exception or log
}
}Структура класу PushNotificationModel досить проста та універсальна. Я передаю заголовок сповіщення, текст та додаткові дані:
public class PushNotificationModel
{
public string Title { get; set; }
public string Body { get; set; }
public object AdditionalData { get; set; }
}Підключаємо наш сервіс в ендопінт:
[Route("api/push-notifications")]
[Authorize]
[ApiController]
public class PushNotificationsController : ControllerBase
{
private readonly PushNotificationService _pushNotificationService;
public PushNotificationsController(PushNotificationService pushNotificationService)
{
_pushNotificationService = pushNotificationService;
}
[HttpPost("subscriptions")]
public async Task<IActionResult> CreateSubscription([FromBody] PushSubscription subscription)
{
var user = HttpContext.GetCurrentUser(); // Our custom method to get current logged-in user
await _pushNotificationService.CreateSubscription(user.Id, subscription);
return Ok();
}
[HttpDelete("subscriptions")]
public async Task<IActionResult> DeleteSubscription([FromQuery] string endpoint)
{
var user = HttpContext.GetCurrentUser();
await _pushNotificationService.DeleteSubscription(user.Id, endpoint);
return Ok();
}
}Все що залишається — підключити наші класи в DI і все готово. Для простоти підключення можемо добавити ще один пакет Lib.AspNetCore.WebPush.
services.AddTransient<PushNotificationService>();
services.AddMemoryVapidTokenCache();
services.AddPushServiceClient(options =>
{
var clientOptions = configuration.GetSection(nameof(PushServiceClient));
options.Subject = clientOptions.GetValue<string>(nameof(options.Subject));
options.PublicKey = clientOptions.GetValue<string>(nameof(options.PublicKey));
options.PrivateKey = clientOptions.GetValue<string>(nameof(options.PrivateKey));
});Реалізація фронтенда
Підтримка технології Web Push була додана в Сафарі тільки в версії MacOS 13 та вище.
Перше, що потрібно реалізувати на стороні клієнта — це запит прав на отримання сповіщень. Для цього використовуємо обʼєкт Notification:
// Запит у браузера прав на підключення пушей
async function askPermission() {
const permissionPromiseResult = await new Promise(function (resolve, reject) {
const permissionResult = Notification.requestPermission(function (result) {
resolve(result);
});
if (permissionResult) {
permissionResult.then(resolve, reject);
}
});
if (permissionPromiseResult !== 'granted') {
alert("We weren't granted permission.");
} else {
await subscribeUserToPush();
}
}Після того, як отримали права, нам потрібно зареєструвати service worker в якому буде логіка відображення сповіщень, створити підписку та відправити її на наш сервер.
При створенні підписки необхідно передати наш публічний ключ. Але він повинен бути в форматі масиву байтів, тому треба спочатку його декодувати і вже тоді передавати.
В результаті отримуємо обʼєкт pushSubscription, який ми відправляємо на створений раніше ендпоінт. Крім цього, ще відправляємо Bearer токен, щоб розуміти до якого користувача привʼязати підписку.
const publicKey = "vapid-public-key";
async function subscribeUserToPush() {
const registration = await navigator.serviceWorker.register('/service-worker.js');
const subscribeOptions = {
userVisibleOnly: true,
applicationServerKey: urlBase64ToUint8Array(publicKey),
};
var pushSubscription = await registration.pushManager.subscribe(subscribeOptions);
fetch('http://localhost:5000/api/push-notifications/subscriptions', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer 1245'
},
body: JSON.stringify(pushSubscription)
}).then(function (response) {
if (response.ok) {
alert('Successfully subscribed for Push Notifications');
} else {
alert('Failed to store the Push Notifications subscription on server');
}
}).catch(function (error) {
console.log('Failed to store the Push Notifications subscription on server: ' + error);
});
return pushSubscription;
}
function urlBase64ToUint8Array(base64String) {
var padding = '='.repeat((4 - (base64String.length % 4)) % 4);
var base64 = (base64String + padding).replace(/\-/g, '+').replace(/_/g, '/');
var rawData = window.atob(base64);
var outputArray = new Uint8Array(rawData.length);
for (var i = 0; i < rawData.length; ++i) {
outputArray[i] = rawData.charCodeAt(i);
}
return outputArray;
};Наш сервіс воркер буде максимально простим. Для початку додамо логіку відображення пушей та передачі в них додаткових даних з сервера.
Також необхідно додати логіку обробки кліку по сповіщенню. Ми будемо перевіряти чи відкритий сайт в браузері. Якщо ні, то відкривати його в новій вкладці. А якщо у нас вже є вкладка з сайтом, то переключаємось на неї і робимо редірект на потрібну сторінку.
self.addEventListener('push', function (event) {
var data = event.data.json();
// {
// "title": "New Notification",
// "body": "This is the body of the notification"
// "additionalData": {
// "pageId": "12512515"
// }
// }
event.waitUntil(self.registration.showNotification(data.title, {
body: data.body,
icon: '/logo.png',
data: {
pageId: data.additionalData?.pageId,
},
}));
});
self.addEventListener('notificationclick', function (event) {
var notification = event.notification;
event.waitUntil(
self.clients.matchAll().then(function (allClients) {
if (allClients.length === 0) {
self.clients.openWindow(
`${self.location.origin}/page/${notification?.data?.pageId}`,
);
notification.close();
return;
}
allClients[0]?.navigate(`/page/${notification?.data?.pageId}`);
allClients[0]?.focus();
notification.close();
}),
);
});В результаті всіх цих маніпуляцій у нас є сервер, який вміє відправляти сповіщення та клієнт, який вміє створювати підписки, відображати сповіщення та обробляти кліки.
Окремо ще можна поговорити про топіки та пріоритети сповіщень, але це виходить за рамки цієї статті. Можливо, розкажу про це пізніше :)
