Перейти к основному содержимому

Web Push-уведомления

Веб-приложения ChurchApps доставляют push-уведомления через W3C Web Push API -- тот же механизм, который использует Firebase Cloud Messaging на стороне сервера, но доставляемый через нативный PushManager браузера, а не через FCM. Одна пара ключей VAPID на MessagingApi обслуживает всех потребителей (B1Admin, B1App и будущие PWA).

Когда срабатывает push​

Push -- один из уровней единого прохода доставки внутри NotificationHelper.attemptDeliveryWithEscalation() (Api/src/modules/messaging/helpers/NotificationHelper.ts): сначала шлюз настроек для уведомлений в приложении, затем socket-доставка и push, которые пытаются за один проход (каждый со своим шлюзом настроек, и ни один не блокирует другой), затем email. Получатель, заглушивший категорию, до push не доходит. Успешная доставка через socket больше не останавливает push -- все типы уведомлений теперь работают так же, как личные сообщения: установленное PWA, которое находится в фоне, по-прежнему показывает уведомление на уровне ОС, даже если доставка через socket уже прошла. Дубликаты баннеров подавляет клиентская сторона, через service worker (см. Требование к service worker). Запланированные напоминания и массовые рассылки от сотрудников начинаются сразу с уровня push и пропускают шаг socket. Email по-прежнему управляется таймером: он эскалирует непрочитанные строки по собственному расписанию, а не как часть этого прохода.

Наиболее распространённые пути, которые приводят к push:

  1. Уведомления о контенте -- ответ в переписке, на которую подписан человек, упоминание или другое событие, направленное через NotificationHelper.createNotifications().
  2. Личные сообщения -- личное сообщение проходит через ту же функцию доставки и всегда пытается отправить push вместе с доставкой через socket.
  3. Запланированные напоминания -- напоминания о мероприятиях, задачах и служении, которые разворачивает и отправляет движок напоминаний; он начинает новые вхождения сразу с уровня push.
  4. Push от сотрудников по событию -- POST /messaging/notifications/create, /ping и /group/send для разовых или групповых рассылок.
  5. Запланированные push от сотрудников -- POST /messaging/scheduledNotifications сохраняет push для всех, у кого есть приложение (audience: "church"), или для одной группы, а таймер на одну минуту отправляет его в срок (см. Архитектуру уведомлений). Общецерковный push без ссылки открывает /mobile/notifications; групповой push без ссылки открывает эту группу.

Серверный поток​

NotificationHelper.createNotifications(...) / checkShouldNotify(...) / ReminderEngine.scan(...)
│
└─ NotificationHelper.attemptDeliveryWithEscalation(...)
├─ in-app preference gate ← muted recipients stop here, no push
├─ same pass, both attempted (neither gates the other):
│ ├─ socket delivery via DeliveryHelper ← skipped for reminders/broadcasts (they start at push)
│ └─ push preference gate
│ └─ WebPushHelper.sendBulkTypedMessages(tokens, title, body, type, contentId)
│ └─ web-push library → VAPID-signed POST → browser push service
└─ email preference gate → timer-driven, escalates unread rows separately

Обязательные переменные окружения​

Ключи VAPID хранятся в Environment и должны присутствовать, чтобы push был включён:

Переменная окруженияНастройка EnvironmentОписание
WEB_PUSH_PUBLIC_KEYwebPushPublicKeyОткрытый ключ VAPID (base64url). Передаётся клиентам через GET /messaging/webpush/publicKey
WEB_PUSH_PRIVATE_KEYwebPushPrivateKeyЗакрытый ключ VAPID. Используется для подписи каждого исходящего push
WEB_PUSH_SUBJECTwebPushSubjectURI mailto:, который передаётся службам push. По умолчанию mailto:support@churchapps.org

WebPushHelper.isEnabled() возвращает false, если отсутствует любой из ключей -- модуль messaging продолжает работать, но push-доставка просто ничего не делает. Мобильный сайт B1App тогда сообщает участникам, что push не включён, вместо того чтобы предлагать настройку.

Генерация пары ключей VAPID​

npx web-push generate-vapid-keys

Добавьте результат в свой .env (локально) или в AWS SSM Parameter Store (для развёрнутых сред). Смена ключей делает недействительными все существующие подписки -- клиентам нужно повторно зарегистрироваться при следующей загрузке страницы.

Модель хранения​

Подписки Web Push хранятся в существующей таблице devices вместе с записями устройств FCM. Их отличает префикс webpush: в столбце fcmToken:

fcmToken = "webpush:" + JSON.stringify({ endpoint, keys: { p256dh, auth } })

Это позволяет одному вызову loadByPersonId вернуть все устройства пользователя независимо от платформы. WebPushHelper.isWebPushToken(token) и decodeSubscription(token) обрабатывают логику префикса.

Эндпоинты​

Базовый путь: /messaging/webpush

МетодПутьАутентификацияОписание
GET/publicKeyПубличныйВозвращает { publicKey, enabled }. Клиенты передают publicKey в pushManager.subscribe({ applicationServerKey })
POST/subscribeJWTРегистрирует (или обновляет) подписку для аутентифицированного пользователя. Тело: { subscription: { endpoint, keys: { p256dh, auth } }, appName?, deviceInfo?, label? }
POST/unsubscribeПубличныйУдаляет любую строку устройства, чей fcmToken содержит указанный endpoint. Тело: { endpoint }
DELETE/subscription/:idJWTУдаляет конкретную строку устройства по её серверному id

Клиентский примитив: WebPushHelper​

WebPushHelper из @churchapps/apphelper -- единая клиентская точка входа. Хосты настраивают его один раз при запуске и вызывают subscribe() после входа.

import { WebPushHelper } from "@churchapps/apphelper";

// In your app's bootstrap (e.g., _app.tsx, layout.tsx)
WebPushHelper.configure({
scope: "/", // service worker scope; matches sw.js registration
appName: "B1AppPwa" // stored on the device row, useful for filtering by surface
});

// After login (and after every userChurch change)
await WebPushHelper.subscribe();

Поведение, которое потребители получают бесплатно:

  • Проверка поддержки -- isSupported() возвращает false в браузерах без serviceWorker / PushManager / Notification.
  • Пауза между запросами -- canPromptNow() задаёт паузу в 7 дней между запросами через localStorage, чтобы пользователи, которые отклонили системный запрос, не видели его при каждом сеансе.
  • Отказ -- setOptedOut(true) и unsubscribe() блокируют повторные запросы и удаляют строку устройства на сервере.
  • Определение standalone-PWA -- isStandalone() позволяет хостам показывать запросы push на iOS только тогда, когда пользователь установил PWA на главный экран (на iOS push работает только из установленных PWA).
  • Повторная регистрация при смене церкви -- refreshEnrollment() повторно отправляет существующую подписку браузера для нового userChurch без повторного запроса пользователю. Вызывайте его из обработчика смены userChurch.

Требование к service worker​

PushManager браузера разрешает подписку только тогда, когда service worker зарегистрирован в настроенной области. PWA ChurchApps используют Serwist (приложения Next.js) или workbox для генерации service worker. Поскольку сервер теперь всегда пытается отправить push вместе с доставкой через socket (см. Когда срабатывает push), service worker -- точка дедупликации: его обработчик push должен подавлять showNotification, когда видимый или активный клиент уже открыл цель ссылки уведомления, но всегда обновлять значок приложения, независимо от того, был ли показан баннер:

// public/sw.js (or whatever Serwist/workbox emits)
self.addEventListener("push", (event) => {
const data = event.data?.json() ?? {};
const title = data.title || "ChurchApps";
const target = deepLinkFor(data.type, data.contentId, data);

event.waitUntil((async () => {
if (typeof data.badgeCount === "number") await updateAppBadge(data.badgeCount); // always runs, even if the banner is suppressed

const clients = await self.clients.matchAll({ type: "window", includeUncontrolled: true });
// Same pathname; for private messages, also same conversationId.
const alreadyViewing = clients.some((client) => (client.focused || client.visibilityState === "visible") && clientMatchesTarget(client.url, target));
if (alreadyViewing) return;

await self.registration.showNotification(title, {
body: data.body,
data: { type: data.type, contentId: data.contentId, url: target },
icon: "/icons/icon-192.png"
});
})());
});

self.addEventListener("notificationclick", (event) => {
event.notification.close();
const { url: target } = event.notification.data || {};
event.waitUntil((async () => {
const clients = await self.clients.matchAll({ type: "window", includeUncontrolled: true });

const exact = clients.find((client) => clientMatchesTarget(client.url, target));
if (exact) return exact.focus(); // already on the target: focus, don't navigate

const mobileClient = clients.find((client) => new URL(client.url).pathname.startsWith("/mobile"));
if (mobileClient) {
await mobileClient.focus();
return mobileClient.navigate(target);
}

return self.clients.openWindow(target);
})());
});

deepLinkFor и clientMatchesTarget зависят от конкретного потребителя -- см. референсную реализацию в B1App/src/app/sw.ts. B1App направляет privateMessage на /mobile/messages/:personId, B1Admin направляет notification на свою панель оповещений и т. д.

Эксплуатационные заметки​

  • Результаты gone: true -- WebPushHelper.sendBulk возвращает { token, success, gone, errorMessage } для каждого получателя. Результат gone: true (служба push ответила 404 или 410) означает, что подписка окончательно недействительна; код в NotificationHelper удаляет такие строки устройств, чтобы больше не пытаться отправлять на них.
  • TTL -- push-сообщения отправляются с TTL: 86400 (24 часа). Если браузер пользователя не подключился к службе push в течение 24 часов, push отбрасывается.
  • Без повторов -- временная ошибка (таймаут, 5xx) записывается в лог и не повторяется. Push -- доставка по возможности: надёжность обеспечивают сокет на странице и уровень email.
  • Отключённые среды -- в средах разработки ключи VAPID можно оставить пустыми; WebPushHelper.isEnabled() вернёт false, и push будет сразу завершаться. Это ожидаемое поведение для сред без собственной идентичности VAPID.
  • Архитектура уведомлений -- полная воронка уведомлений в приложении, push и email и движок напоминаний
  • Архитектура реального времени -- доставка по WebSocket; push теперь срабатывает из той же воронки в приложении параллельно с доставкой через socket в том же проходе, а не только как запасной вариант, когда доставка через socket не прошла
  • Эндпоинты обмена сообщениями -- уведомления, устройства и остальной интерфейс messaging
  • AppHelper -- npm-пакет, который поставляет WebPushHelper