habitica-self-host/website/server/libs/pushNotifications.js

import _ from 'lodash';
import nconf from 'nconf';
import apn from '@parse/node-apn';
import admin from 'firebase-admin';
import got from 'got';
import logger from './logger';
import { // eslint-disable-line import/no-cycle
  model as User,
} from '../models/user';

const APN_ENABLED = nconf.get('PUSH_CONFIGS_APN_ENABLED') === 'true';
const apnProvider = APN_ENABLED ? new apn.Provider({
  token: {
    key: nconf.get('PUSH_CONFIGS_APN_KEY'),
    keyId: nconf.get('PUSH_CONFIGS_APN_KEY_ID'),
    teamId: nconf.get('PUSH_CONFIGS_APN_TEAM_ID'),
  },
  production: true,
}) : undefined;

function removePushDevice (user, pushDevice) {
  return User.updateOne({ _id: user._id }, {
    $pull: { pushDevices: { regId: pushDevice.regId } },
  }).exec().catch(err => {
    logger.error(err, `Error removing pushDevice ${pushDevice.regId} for user ${user._id}`);
  });
}

export const MAX_MESSAGE_LENGTH = 300;

async function sendFCMNotification (user, pushDevice, payload) {
  if (nconf.get('FIREBASE_PROJECT_ID') === undefined || nconf.get('FIREBASE_PROJECT_ID') === '') {
    logger.info('Will not send push notification, because Firebase is not configured.');
    return;
  }

  const messaging = admin.messaging();
  if (messaging === undefined) {
    return;
  }
  const message = {
    notification: {
      title: payload.title,
      body: payload.body,
    },
    data: {
      identifier: payload.identifier,
      notificationIdentifier: payload.identifier,
    },
    token: pushDevice.regId,
  };

  try {
    await messaging.send(message);
  } catch (error) {
    if (error.code === 'messaging/registration-token-not-registered') {
      removePushDevice(user, pushDevice);
      logger.error(new Error('FCM error, unregistered pushDevice'), {
        regId: pushDevice.regId, userId: user._id,
      });
    } else if (error.code === 'messaging/invalid-registration-token') {
      removePushDevice(user, pushDevice);
      logger.error(new Error('FCM error, invalid pushDevice'), {
        regId: pushDevice.regId, userId: user._id,
      });
    } else {
      logger.error(error, 'Unhandled FCM error.');
    }
  }
}

async function sendAPNNotification (user, pushDevice, details, payload) {
  if (apnProvider) {
    const notification = new apn.Notification({
      alert: {
        title: details.title,
        body: details.message,
      },
      sound: 'default',
      category: details.category,
      topic: 'com.habitrpg.ios.Habitica',
      payload,
    });
    try {
      const response = await apnProvider.send(notification, pushDevice.regId);
      // Handle failed push notifications deliveries
      response.failed.forEach(failure => {
        if (failure.error) { // generic error
          logger.error(new Error('Unhandled APN error'), {
            response, regId: pushDevice.regId, userId: user._id,
          });
        } else { // rejected
          // see https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html#//apple_ref/doc/uid/TP40008194-CH11-SW17
          // for a list of rejection reasons
          const { reason } = failure.response;
          if (reason === 'Unregistered') {
            removePushDevice(user, pushDevice);
            logger.error(new Error('APN error, unregistered pushDevice'), {
              regId: pushDevice.regId, userId: user._id,
            });
          } else {
            if (reason === 'BadDeviceToken') {
              // An invalid token was registered by mistake
              // Remove it but log the error differently so that it can be distinguished
              // from when reason === Unregistered
              removePushDevice(user, pushDevice);
            }
            logger.error(new Error('APN error'), {
              response, regId: pushDevice.regId, userId: user._id,
            });
          }
        }
      });
    } catch (err) {
      logger.error(err, 'Unhandled APN error.');
    }
  }
}

async function sendUnifiedPushNotification (user, pushDevice, details, payload) {
  const unifiedPushBaseUrl = nconf.get('PUSH_CONFIGS_UNIFIEDPUSH_URL');
  const unifiedPushAuthHeader = nconf.get('PUSH_CONFIGS_UNIFIEDPUSH_AUTHORIZATION');

  let endpoint = pushDevice.regId;
  let resolvedEndpoint;

  try {
    if (/^https?:\/\//i.test(endpoint)) {
      resolvedEndpoint = endpoint;
    } else if (unifiedPushBaseUrl) {
      resolvedEndpoint = new URL(endpoint, unifiedPushBaseUrl).toString();
    } else {
      throw new Error('Unified Push regId is not a full URL and no base URL configured');
    }
  } catch (err) {
    logger.error(err, {
      extraMessage: 'Unable to resolve Unified Push endpoint.',
      regId: pushDevice.regId,
      userId: user._id,
    });
    return;
  }

  const body = {
    title: details.title,
    message: details.message,
    identifier: details.identifier,
    payload,
  };

  const options = {
    json: body,
    timeout: 30000,
  };

  if (unifiedPushAuthHeader) {
    options.headers = {
      Authorization: unifiedPushAuthHeader,
    };
  }

  try {
    await got.post(resolvedEndpoint, options);
  } catch (err) {
    const statusCode = err?.response?.statusCode;

    if (statusCode && [404, 410].includes(statusCode)) {
      removePushDevice(user, pushDevice);
      logger.error(new Error('Unified Push endpoint is no longer valid'), {
        regId: pushDevice.regId,
        userId: user._id,
        statusCode,
      });
      return;
    }

    logger.error(err, {
      extraMessage: 'Unhandled Unified Push error.',
      regId: pushDevice.regId,
      userId: user._id,
      statusCode,
    });
  }
}

export async function sendNotification (user, details = {}) {
  if (!user) throw new Error('User is required.');
  if (user.preferences.pushNotifications.unsubscribeFromAll === true) return;
  const pushDevices = user.pushDevices.toObject ? user.pushDevices.toObject() : user.pushDevices;

  if (!details.identifier) throw new Error('details.identifier is required.');
  if (!details.title) throw new Error('details.title is required.');
  if (!details.message) throw new Error('details.message is required.');

  const payload = details.payload ? details.payload : {};
  payload.identifier = details.identifier;

  // Cut the message to 300 characters to avoid going over the limit of 4kb per notifications
  if (details.message.length > MAX_MESSAGE_LENGTH) {
    details.message = _.truncate(details.message, { length: MAX_MESSAGE_LENGTH });
  }

  if (payload.message && payload.message.length > MAX_MESSAGE_LENGTH) {
    payload.message = _.truncate(payload.message, { length: MAX_MESSAGE_LENGTH });
  }

  await _.each(pushDevices, async pushDevice => {
    switch (pushDevice.type) { // eslint-disable-line default-case
      case 'android':
        // Required for fcm to be received in background
        payload.title = details.title;
        payload.body = details.message;
        await sendFCMNotification(user, pushDevice, payload);
        break;
      case 'ios':
        sendAPNNotification(user, pushDevice, details, payload);
        break;
      case 'unifiedpush':
        await sendUnifiedPushNotification(user, pushDevice, details, payload);
        break;
    }
  });
}