Push-события

К этому моменту мы рассмотрели подписку пользователя и отправку push-сообщения. Следующий шаг – получить это push-сообщение на устройстве пользователя и показать уведомление (а также выполнить любые другие действия, которые могут потребоваться).

Событие push

Когда сообщение получено, в сервис-воркере отправляется событие push.

Код для настройки прослушивателя событий push-уведомлений должен быть похож на любой другой прослушиватель событий, который вы пишете на JavaScript:

self.addEventListener('push', function(event) {
    if (event.data) {
    console.log('This push event has data: ', event.data.text());
    } else {
    console.log('This push event has no data.');
    }
});

Самая странная часть этого кода для большинства разработчиков, которые только начинают работать с сервис-воркерами, – это переменная self. self часто используется в веб-воркерах, к которым относится и сервисный воркер. self относится к глобальной области видимости, как и window на веб-странице. Но для веб-воркеров и сервис-воркеров self относится к самому воркеру.

В примере выше self.addEventListener() можно рассматривать как добавление прослушивателя событий к самому сервисному скрипту.

В примере события push мы проверяем, есть ли данные, и выводим что-то в консоль.

Есть и другие способы обработки данных из события push:

// Returns string
event.data.text()

// Parses data as JSON string and returns an Object
event.data.json()

// Returns blob of data
event.data.blob()

// Returns an arrayBuffer
event.data.arrayBuffer()

Большинство пользователей выбирают json() или text() в зависимости от того, что они ожидают от своего приложения.

В этом примере показано, как добавить прослушиватель событий push и как получить доступ к данным, но в нем отсутствуют две очень важные функции. Оно не показывает уведомление и не использует event.waitUntil().

Подождать до

Одна из вещей, которую нужно понимать о сервисных работниках, заключается в том, что у вас мало контроля над тем, когда код сервисного работника будет запущен. Браузер решает, когда его разбудить и когда завершить. Единственный способ сообщить браузеру, что вы заняты важным делом, – передать обещание в метод event.waitUntil(). В этом случае браузер будет поддерживать работу сервисного работника до тех пор, пока не будет урегулировано переданное вами обещание.

Для событий push-уведомлений есть дополнительное требование: вы должны показать уведомление до того, как будет выполнено переданное обещание.

Вот простой пример показа уведомления:

self.addEventListener('push', function(event) {
    const promiseChain = self.registration.showNotification('Hello, World.');

    event.waitUntil(promiseChain);
});

Вызов self.registration.showNotification() – это метод, который показывает уведомление пользователю и возвращает обещание, которое будет выполнено после показа уведомления.

Чтобы этот пример был максимально понятным, я присвоил это обещание переменной с именем promiseChain. Затем он передается в event.waitUntil(). Я знаю, что это очень многословно, но я видел ряд проблем, которые возникли в результате неправильного понимания того, что должно быть передано в waitUntil(), или в результате разорванных цепочек обещаний.

Более сложный пример с сетевым запросом данных и отслеживанием push-события с помощью аналитики может выглядеть следующим образом:

self.addEventListener('push', function(event) {
    const analyticsPromise = pushReceivedTracking();
    const pushInfoPromise = fetch('/api/get-more-data')
    .then(function(response) {
        return response.json();
    })
    .then(function(response) {
        const title = response.data.userName + ' says...';
        const message = response.data.message;

        return self.registration.showNotification(title, {
        body: message
        });
    });

    const promiseChain = Promise.all([
    analyticsPromise,
    pushInfoPromise
    ]);

    event.waitUntil(promiseChain);
});

Здесь мы вызываем функцию, которая возвращает обещание pushReceivedTracking(). В нашем примере оно отправляет сетевой запрос поставщику аналитики. Мы также делаем сетевой запрос, получаем ответ и показываем уведомление, используя данные ответов для заголовка и сообщения уведомления.

Чтобы сервисный скрипт не прекращал работу, пока выполняются обе задачи, объедините промисы с помощью Promise.all(). Полученный промис передается в event.waitUntil(). Это означает, что браузер будет ждать завершения обоих промисов, прежде чем проверить, было ли показано уведомление, и завершить работу сервисного работника.

Почему мы должны беспокоиться о waitUntil() и как его использовать? Одна из самых распространенных проблем, с которыми сталкиваются разработчики, заключается в том, что когда цепочка обещаний неверна или разорвана, Chrome показывает это уведомление "по умолчанию":

Изображение уведомления по умолчанию в Chrome

Chrome показывает уведомление "Этот сайт был обновлен в фоновом режиме", только когда получено push-сообщение, а событие push в сервис-воркере не показывает уведомление после того, как промис, переданный в event.waitUntil(), завершился.

Основная причина, по которой разработчики сталкиваются с этой проблемой, заключается в том, что их код часто вызывает self.registration.showNotification(), но они ничего не делают с возвращаемым обещанием. В результате иногда показывается уведомление по умолчанию. Например, если мы удалим возврат для self.registration.showNotification() в примере выше, то можем увидеть это уведомление.

self.addEventListener('push', function(event) {
    const analyticsPromise = pushReceivedTracking();
    const pushInfoPromise = fetch('/api/get-more-data')
    .then(function(response) {
        return response.json();
    })
    .then(function(response) {
        const title = response.data.userName + ' says...';
        const message = response.data.message;

        self.registration.showNotification(title, {
        body: message
        });
    });

    const promiseChain = Promise.all([
    analyticsPromise,
    pushInfoPromise
    ]);

    event.waitUntil(promiseChain);
});

Вы можете видеть, как легко это пропустить.

Просто помните: если вы видите это уведомление, проверьте цепочки промисов и event.waitUntil().

В следующем разделе мы рассмотрим, как можно стилизовать уведомления и какой контент можно отображать.

Куда отправиться дальше

Практические работы