You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

109 lines
4.4 KiB

Web Push Notifications (#3243) * feat: Register push subscription * feat: Notify when mentioned * feat: Boost, favourite, reply, follow, follow request * feat: Notification interaction * feat: Handle change of public key * feat: Unsubscribe if things go wrong * feat: Do not send normal notifications if push is enabled * feat: Focus client if open * refactor: Move push logic to WebPushSubscription * feat: Better title and body * feat: Localize messages * chore: Fix lint errors * feat: Settings * refactor: Lazy load * fix: Check if push settings exist * feat: Device-based preferences * refactor: Simplify logic * refactor: Pull request feedback * refactor: Pull request feedback * refactor: Create /api/web/push_subscriptions endpoint * feat: Spec PushSubscriptionController * refactor: WebPushSubscription => Web::PushSubscription * feat: Spec Web::PushSubscription * feat: Display first media attachment * feat: Support direction * fix: Stuff broken while rebasing * refactor: Integration with session activations * refactor: Cleanup * refactor: Simplify implementation * feat: Set VAPID keys via environment * chore: Comments * fix: Crash when no alerts * fix: Set VAPID keys in testing environment * fix: Follow link * feat: Notification actions * fix: Delete previous subscription * chore: Temporary logs * refactor: Move migration to a later date * fix: Fetch the correct session activation and misc bugs * refactor: Move migration to a later date * fix: Remove follow request (no notifications) * feat: Send administrator contact to push service * feat: Set time-to-live * fix: Do not show sensitive images * fix: Reducer crash in error handling * feat: Add badge * chore: Fix lint error * fix: Checkbox label overlap * fix: Check for payload support * fix: Rename action "type" (crash in latest Chrome) * feat: Action to expand notification * fix: Lint errors * fix: Unescape notification body * fix: Do not allow boosting if the status is hidden * feat: Add VAPID keys to the production sample environment * fix: Strip HTML tags from status * refactor: Better error messages * refactor: Handle browser not implementing the VAPID protocol (Samsung Internet) * fix: Error when target_status is nil * fix: Handle lack of image * fix: Delete reference to invalid subscriptions * feat: Better error handling * fix: Unescape HTML characters after tags are striped * refactor: Simpify code * fix: Modify to work with #4091 * Sort strings alphabetically * i18n: Updated Polish translation it annoys me that it's not fully localized :P * refactor: Use current_session in PushSubscriptionController * fix: Rebase mistake * fix: Set cacheName to mastodon * refactor: Pull request feedback * refactor: Remove logging statements * chore(yarn): Fix conflicts with master * chore(yarn): Copy latest from master * chore(yarn): Readd offline-plugin * refactor: Use save! and update! * refactor: Send notifications async * fix: Allow retry when push fails * fix: Save track for failed pushes * fix: Minify sw.js * fix: Remove account_id from fabricator
6 years ago
  1. import axios from 'axios';
  2. import { store } from './containers/mastodon';
  3. import { setBrowserSupport, setSubscription, clearSubscription } from './actions/push_notifications';
  4. // Taken from https://www.npmjs.com/package/web-push
  5. const urlBase64ToUint8Array = (base64String) => {
  6. const padding = '='.repeat((4 - base64String.length % 4) % 4);
  7. const base64 = (base64String + padding)
  8. .replace(/\-/g, '+')
  9. .replace(/_/g, '/');
  10. const rawData = window.atob(base64);
  11. const outputArray = new Uint8Array(rawData.length);
  12. for (let i = 0; i < rawData.length; ++i) {
  13. outputArray[i] = rawData.charCodeAt(i);
  14. }
  15. return outputArray;
  16. };
  17. const getApplicationServerKey = () => document.querySelector('[name="applicationServerKey"]').getAttribute('content');
  18. const getRegistration = () => navigator.serviceWorker.ready;
  19. const getPushSubscription = (registration) =>
  20. registration.pushManager.getSubscription()
  21. .then(subscription => ({ registration, subscription }));
  22. const subscribe = (registration) =>
  23. registration.pushManager.subscribe({
  24. userVisibleOnly: true,
  25. applicationServerKey: urlBase64ToUint8Array(getApplicationServerKey()),
  26. });
  27. const unsubscribe = ({ registration, subscription }) =>
  28. subscription ? subscription.unsubscribe().then(() => registration) : registration;
  29. const sendSubscriptionToBackend = (subscription) =>
  30. axios.post('/api/web/push_subscriptions', {
  31. data: subscription,
  32. }).then(response => response.data);
  33. // Last one checks for payload support: https://web-push-book.gauntface.com/chapter-06/01-non-standards-browsers/#no-payload
  34. const supportsPushNotifications = ('serviceWorker' in navigator && 'PushManager' in window && 'getKey' in PushSubscription.prototype);
  35. export function register () {
  36. store.dispatch(setBrowserSupport(supportsPushNotifications));
  37. if (supportsPushNotifications) {
  38. if (!getApplicationServerKey()) {
  39. // eslint-disable-next-line no-console
  40. console.error('The VAPID public key is not set. You will not be able to receive Web Push Notifications.');
  41. return;
  42. }
  43. getRegistration()
  44. .then(getPushSubscription)
  45. .then(({ registration, subscription }) => {
  46. if (subscription !== null) {
  47. // We have a subscription, check if it is still valid
  48. const currentServerKey = (new Uint8Array(subscription.options.applicationServerKey)).toString();
  49. const subscriptionServerKey = urlBase64ToUint8Array(getApplicationServerKey()).toString();
  50. const serverEndpoint = store.getState().getIn(['push_notifications', 'subscription', 'endpoint']);
  51. // If the VAPID public key did not change and the endpoint corresponds
  52. // to the endpoint saved in the backend, the subscription is valid
  53. if (subscriptionServerKey === currentServerKey && subscription.endpoint === serverEndpoint) {
  54. return subscription;
  55. } else {
  56. // Something went wrong, try to subscribe again
  57. return unsubscribe({ registration, subscription }).then(subscribe).then(sendSubscriptionToBackend);
  58. }
  59. }
  60. // No subscription, try to subscribe
  61. return subscribe(registration).then(sendSubscriptionToBackend);
  62. })
  63. .then(subscription => {
  64. // If we got a PushSubscription (and not a subscription object from the backend)
  65. // it means that the backend subscription is valid (and was set during hydration)
  66. if (!(subscription instanceof PushSubscription)) {
  67. store.dispatch(setSubscription(subscription));
  68. }
  69. })
  70. .catch(error => {
  71. if (error.code === 20 && error.name === 'AbortError') {
  72. // eslint-disable-next-line no-console
  73. console.warn('Your browser supports Web Push Notifications, but does not seem to implement the VAPID protocol.');
  74. } else if (error.code === 5 && error.name === 'InvalidCharacterError') {
  75. // eslint-disable-next-line no-console
  76. console.error('The VAPID public key seems to be invalid:', getApplicationServerKey());
  77. }
  78. // Clear alerts and hide UI settings
  79. store.dispatch(clearSubscription());
  80. try {
  81. getRegistration()
  82. .then(getPushSubscription)
  83. .then(unsubscribe);
  84. } catch (e) {
  85. }
  86. });
  87. } else {
  88. // eslint-disable-next-line no-console
  89. console.warn('Your browser does not support Web Push Notifications.');
  90. }
  91. }